view scripts/audio/@audioplayer/set.m @ 19540:fdb8a62ef17a

fix docstring style in .m files * @audioplayer/__get_properties__.m, @audioplayer/audioplayer.m, @audioplayer/get.m, @audioplayer/isplaying.m, @audioplayer/pause.m, @audioplayer/play.m, @audioplayer/playblocking.m, @audioplayer/resume.m, @audioplayer/set.m, @audioplayer/stop.m, @audiorecorder/audiorecorder.m,@audiorecorder/get.m, @audiorecorder/getaudiodata.m, @audiorecorder/getplayer.m, @audiorecorder/isrecording.m, @audiorecorder/pause.m, @audiorecorder/play.m, @audiorecorder/record.m, @audiorecorder/recordblocking.m, @audiorecorder/resume.m, @audiorecorder/set.m, @audiorecorder/stop.m: Fix docstring style.
author John W. Eaton <jwe@octave.org>
date Wed, 31 Dec 2014 13:45:45 -0500
parents ce02743b6f2a
children dac3191a5301
line wrap: on
line source

## Copyright (C) 2013 Vytautas JanĨauskas
##
## This file is part of Octave.
##
## Octave is free software; you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 3 of the License, or (at
## your option) any later version.
##
## Octave is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
## General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Octave; see the file COPYING.  If not, see
## <http://www.gnu.org/licenses/>.

## -*- texinfo -*-
## @deftypefn {Function File} {} set (@var{player}, @var{name}, @var{value})
## @deftypefnx {Function File} {} set (@var{player}, @var{properties})
## @deftypefnx {Function File} {@var{properties} =} set (@var{player})
## Set the value of property specified by @var{name} to a given @var{value}.
## If @var{name} and @var{value} are cell arrays, set each property to the
## corresponding value.  Given a structure of @var{properties} with
## fields corresponding to property names, set the value of those
## properties to the field values.  Given only the audioplayer object,
## return 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