Mercurial > octave
view scripts/audio/@audiorecorder/__get_properties__.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 | 7854d5752dd2 |
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 {} {@var{props} =} __get_properties__ (@var{recorder}) ## Return a struct containing all named properties of the recorder object ## @var{recorder}. ## @end deftypefn function props = __get_properties__ (recorder) if (nargin < 1) print_usage (); endif if (__recorder_isrecording__ (struct (recorder).recorder)) running = "on"; else running = "off"; endif props = struct ("BitsPerSample", __recorder_get_nbits__ (struct (recorder).recorder), "CurrentSample", __recorder_get_sample_number__ (struct (recorder).recorder), "DeviceID", __recorder_get_id__ (struct (recorder).recorder), "NumberOfChannels", __recorder_get_channels__ (struct (recorder).recorder), "Running", running, "SampleRate", __recorder_get_fs__ (struct (recorder).recorder), "TotalSamples", __recorder_get_total_samples__ (struct (recorder).recorder), "Tag", __recorder_get_tag__ (struct (recorder).recorder), "Type", "audiorecorder", "UserData", __recorder_get_userdata__ (struct (recorder).recorder)); endfunction