view scripts/audio/@audiorecorder/__get_properties__.m @ 19538:d7b55fc1b37d

Add missing texinfo docstrings to all audio functions * libinterp/dldfcn/__player_audioplayer__.cc, libinterp/dldfcn/__recorder_audiorecorder__.cc, scripts/audio/@audioplayer/subsasgn.m, scripts/audio/@audioplayer/subsref.m, scripts/audio/@audiorecorder/__get_properties__.m, scripts/audio/@audiorecorder/subsasgn.m, scripts/audio/@audiorecorder/subsref.m: Add texinfo docstrings to all functions, internal or otherwise.
author Mike Miller <mtmiller@ieee.org>
date Thu, 03 Oct 2013 08:33:46 -0400
parents 36a26a131209
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} {@var{properties} =} __get_properties__ (@var{recorder})
## Return a struct containing all named properties of the recorder object
## @var{recorder}.
## @end deftypefn

function properties = __get_properties__ (recorder)
  properties.BitsPerSample = __recorder_get_nbits__ (struct (recorder).recorder);
  properties.CurrentSample = __recorder_get_sample_number__ (struct (recorder).recorder);
  properties.DeviceID = __recorder_get_id__ (struct (recorder).recorder);
  properties.NumberOfChannels = __recorder_get_channels__ (struct (recorder).recorder);
  if __recorder_isrecording__ (struct (recorder).recorder)
    running = "on";
  else
    running = "off";
  endif
  properties.Running = running;
  properties.SampleRate = __recorder_get_fs__ (struct (recorder).recorder);
  properties.TotalSamples = __recorder_get_total_samples__ (struct (recorder).recorder);
  properties.Tag = __recorder_get_tag__ (struct (recorder).recorder);
  properties.Type = "audiorecorder";
  properties.UserData = __recorder_get_userdata__ (struct (recorder).recorder);
endfunction