Mercurial > octave-nkf
view scripts/audio/@audioplayer/__get_properties__.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} {@var{properties} =} __get_properties__ (@var{player}) ## Return a struct containing all named properties of the audioplayer ## object @var{player}. ## @end deftypefn function properties = __get_properties__ (player) properties.BitsPerSample = __player_get_nbits__ (struct (player).player); properties.CurrentSample = __player_get_sample_number__ (struct (player).player); properties.DeviceID = __player_get_id__ (struct (player).player); properties.NumberOfChannels = __player_get_channels__ (struct (player).player); if __player_isplaying__ (struct (player).player) running = "on"; else running = "off"; endif properties.Running = running; properties.SampleRate = __player_get_fs__ (struct (player).player); properties.TotalSamples = __player_get_total_samples__ (struct (player).player); properties.Tag = __player_get_tag__ (struct (player).player); properties.Type = "audioplayer"; properties.UserData = __player_get_userdata__ (struct (player).player); endfunction