Mercurial > octave-nkf
view scripts/audio/@audioplayer/set.m @ 19539:ce02743b6f2a
Fix texinfo docstring syntax for all audio functions
* libinterp/dldfcn/audiodevinfo.cc, libinterp/dldfcn/audioinfo.cc,
libinterp/dldfcn/audioread.cc, libinterp/dldfcn/audiowrite.cc,
scripts/audio/@audioplayer/__get_properties__.m,
scripts/audio/@audioplayer/audioplayer.m,
scripts/audio/@audioplayer/display.m, scripts/audio/@audioplayer/get.m,
scripts/audio/@audioplayer/isplaying.m, scripts/audio/@audioplayer/pause.m,
scripts/audio/@audioplayer/play.m,
scripts/audio/@audioplayer/playblocking.m,
scripts/audio/@audioplayer/resume.m, scripts/audio/@audioplayer/set.m,
scripts/audio/@audioplayer/stop.m,
scripts/audio/@audiorecorder/audiorecorder.m,
scripts/audio/@audiorecorder/display.m, scripts/audio/@audiorecorder/get.m,
scripts/audio/@audiorecorder/getaudiodata.m,
scripts/audio/@audiorecorder/getplayer.m,
scripts/audio/@audiorecorder/isrecording.m,
scripts/audio/@audiorecorder/pause.m, scripts/audio/@audiorecorder/play.m,
scripts/audio/@audiorecorder/record.m,
scripts/audio/@audiorecorder/recordblocking.m,
scripts/audio/@audiorecorder/resume.m, scripts/audio/@audiorecorder/set.m,
scripts/audio/@audiorecorder/stop.m: Fix texinfo docstring formatting, wrap
long lines, and use consistent lowercase variable names.
author | Mike Miller <mtmiller@ieee.org> |
---|---|
date | Thu, 03 Oct 2013 09:50:01 -0400 |
parents | 36a26a131209 |
children | fdb8a62ef17a |
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}) ## Set the value of property specified by @var{name} to a given @var{value}. ## @end deftypefn ## @deftypefn {Function File} {} set (@var{player}, @var{names}, @var{values}) ## Given a cell array of property @var{names} and a cell array of @var{values}, ## set each property to a corresponding value. ## @end deftypefn ## @deftypefn {Function File} {} set (@var{player}, @var{properties}) ## Given a structure @var{properties} where fields are property names, set ## the value of those properties for an audioplayer object to corresponding ## values. ## @end deftypefn ## @deftypefn {Function File} {@var{properties} =} set (@var{player}) ## 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