view scripts/audio/@audiorecorder/set.m @ 30561:1c6e04afe50d

doc: improvements to documentation for classes in scripts/ dir. * +containers/Map.m (remove): Document calling form which returns a Map object. * @ftp/cd.m: Document calling forms which return CWD. * @ftp/dir.m: Document calling form which returns struct array. * @ftp/mput.m: Document calling form which returns cellstr. * @ftp/rename.m: Use @code{} macro around "ftp" for conformity with other functions. * @audioplayer/__get_properties__.m: Match documentation variable names to function prototype names. * @audioplayer/set.m: Match function prototype names to documentation. * @audiorecorder/__get_properties__.m: Match documentation variable names to function prototype names. * @audiorecorder/set.m: Match function prototype names to documentation.
author Rik <rik@octave.org>
date Tue, 28 Dec 2021 08:11:59 -0800
parents 0a5b15007766
children 83f9f8bda883
line wrap: on
line source

########################################################################
##
## Copyright (C) 2013-2021 The Octave Project Developers
##
## See the file COPYRIGHT.md in the top-level directory of this
## distribution or <https://octave.org/copyright/>.
##
## 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
## <https://www.gnu.org/licenses/>.
##
########################################################################

## -*- texinfo -*-
## @deftypefn  {} {} set (@var{recorder}, @var{name}, @var{value})
## @deftypefnx {} {} set (@var{recorder}, @var{properties})
## @deftypefnx {} {@var{properties} =} set (@var{recorder})
## Set the value of property specified by @var{name} to a given @var{value}.
##
## If @var{name} and @var{value} are cell arrays of the same size, set each
## property to a corresponding value.  Given a structure with fields
## corresponding to property names, set the value of those properties to the
## corresponding field values.  Given only the recorder object, return a
## configurable properties (i.e., writeable properties).
## @end deftypefn

function properties = set (varargin)

  if (nargin < 1 || nargin > 3)
    print_usage ();
  endif

  recorder = struct (varargin{1}).recorder;

  if (nargin == 1)
    properties.SampleRate = {};
    properties.Tag = {};
    properties.UserData = {};
  elseif (nargin == 2)
    for [value, property] = varargin{2}
      setproperty (recorder, property, value);
    endfor
  elseif (nargin == 3)
    if (iscell (varargin{2}))
      index = 1;
      for property = varargin{2}
        setproperty (recorder, char (property), varargin{3}{index});
        index += 1;
      endfor
    else
      setproperty (recorder, varargin{2}, varargin{3});
    endif
  endif

endfunction

function setproperty (recorder, property, value)

  switch (property)
    case "SampleRate"
      __recorder_set_fs__ (recorder, value);
    case "Tag"
      __recorder_set_tag__ (recorder, value);
    case "UserData"
      __recorder_set_userdata__ (recorder, value);
    otherwise
      error ("@audiorecorder/set: no such property or the property specified is read-only");
  endswitch

endfunction