Mercurial > octave-nkf

comparison scripts/audio/@audioplayer/__get_properties__.m @ 19539:ce02743b6f2a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
comparison
equal deleted inserted replaced
19538:d7b55fc1b37d 19539:ce02743b6f2a
15 ## You should have received a copy of the GNU General Public License 15 ## You should have received a copy of the GNU General Public License
16 ## along with Octave; see the file COPYING. If not, see 16 ## along with Octave; see the file COPYING. If not, see
17 ## <http://www.gnu.org/licenses/>. 17 ## <http://www.gnu.org/licenses/>.
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn{Function File} @var{Properties} = __get_properties__ (@var{playerObj}) 20 ## @deftypefn {Function File} {@var{properties} =} __get_properties__ (@var{player})
21 ## For a given audioplayer object this function gathers and returns the current values of all properties. 21 ## Return a struct containing all named properties of the player object
22 ## @var{player}.
22 ## @end deftypefn 23 ## @end deftypefn
23 24
24 function properties = __get_properties__ (player) 25 function properties = __get_properties__ (player)
25 properties.BitsPerSample = __player_get_nbits__ (struct (player).player); 26 properties.BitsPerSample = __player_get_nbits__ (struct (player).player);
26 properties.CurrentSample = __player_get_sample_number__ (struct (player).player); 27 properties.CurrentSample = __player_get_sample_number__ (struct (player).player);