view scripts/audio/@audioplayer/set.m @ 19530:a9c67ed90fc0

fix audioplayer docstrings to work with new texinfo * audioplayer.m, get.m, play.m, playblocking.m, set.m: fix docstrings using stand alone deftypefnx tags
author Vytautas Jančauskas <unaudio@gmail.com>
date Fri, 20 Sep 2013 00:46:16 +0300
parents ee3ec3f02358
children 8bb399569393
line wrap: on
line source

## -*- texinfo -*-
## @deftypefn{Function File} set (@var{playerObj}, @var{Name}, @var{Value})
## Set the value of property specified by @var{Name} to a given @var{Value}.
## @end deftypefn
## @deftypefn{Function File} set (@var{playerObj}, @var{CellOfNames}, @var{CellOfValues})
## Given a cell array of property names and a cell array of values, set each property to a corresponding value.
## @end deftypefn
## @deftypefn{Function File} set (@var{playerObj}, @var{StructOfProperties})
## Given a structure where fields are property names, set the value of those properties for an audioplayer object to corresponding values.
## @end deftypefn
## @deftypefn{Function File} @var{settableProperties} = set (@var{playerObj})
## Returns a structure of settable properties.
## @end deftypefn

function settable = set (varargin)
  if nargin < 1 || nargin > 3
    print_usage();
  endif
  player = struct (varargin{1}).player;
  if nargin == 1
    settable.SampleRate = {};
    settable.Tag = {};
    settable.UserData = {};
  elseif nargin == 2
    for [value, property] = varargin{2}
      setproperty (player, property, value);
    endfor
  elseif nargin == 3
    if iscell (varargin{2})
      index = 1;
      for property = varargin{2}
        setproperty (player, char(property), varargin{3}{index});
        index = index + 1;
      endfor
    else
      setproperty (player, varargin{2}, varargin{3});
    endif
  else
    error ('audioplayer: wrong number of arguments to the set method');
  endif
endfunction

function setproperty (player, property, value)
  switch property
    case 'SampleRate'
      __player_set_fs__ (player, value);
    case 'Tag'
      __player_set_tag__ (player, value);
    case 'UserData'
      __player_set_userdata__ (player, value);
    otherwise
      error ('audioplayer: no such property or the property specified is read-only');
  endswitch
endfunction