lauchmelder/SFML
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added rdoc comments to all audio classes.

Browse source 
git-svn-id: https://sfml.svn.sourceforge.net/svnroot/sfml/branches/sfml2@1714 4e206d99-4929-0410-ac5d-dfc041789085
This commit is contained in:
groogy 2010-11-25 19:30:10 +00:00
parent 191776fbec
commit 50a5ecd79f
7 changed files with 336 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

29
bindings/ruby/sfml-audio/audio/SoundBuffer.cpp
View file

@ -115,7 +115,7 @@ static VALUE SoundBuffer_SaveToFile( VALUE self, VALUE aFileName )
}
/* call-seq:
* image.getSamples() -> array of samples
* sound_buffer.getSamples() -> array of samples
*
* Get the array of audio samples stored in the buffer.
*
@ -138,6 +138,13 @@ static VALUE SoundBuffer_GetSamples( VALUE self )
return samples;
}
/* call-seq:
* sound_buffer.getSamplesCount() -> fixnum
*
* Get the number of samples stored in the buffer.
*
* The array of samples can be accessed with the getSamples() function.
*/
static VALUE SoundBuffer_GetSamplesCount( VALUE self )
{
sf::SoundBuffer *object = NULL;
@ -145,6 +152,14 @@ static VALUE SoundBuffer_GetSamplesCount( VALUE self )
return INT2FIX( object->GetSamplesCount() );
}
/* call-seq:
* sound_buffer.getSampleRate() -> fixnum
*
* Get the sample rate of the sound.
*
* The sample rate is the number of samples played per second. The higher, the better the quality (for example,
* 44100 samples/s is CD quality).
*/
static VALUE SoundBuffer_GetSampleRate( VALUE self )
{
sf::SoundBuffer *object = NULL;
@ -152,6 +167,11 @@ static VALUE SoundBuffer_GetSampleRate( VALUE self )
return INT2FIX( object->GetSampleRate() );
}
/* call-seq:
* sound_buffer.getChannelsCount() -> float
*
* Get the total duration of the sound.
*/
static VALUE SoundBuffer_GetChannelsCount( VALUE self )
{
sf::SoundBuffer *object = NULL;
@ -159,6 +179,13 @@ static VALUE SoundBuffer_GetChannelsCount( VALUE self )
return INT2FIX( object->GetChannelsCount() );
}
/* call-seq:
* sound_buffer.getDuration() -> fixnum
*
* Get the number of channels used by the sound.
*
* If the sound is mono then the number of channels will be 1, 2 for stereo, etc.
*/
static VALUE SoundBuffer_GetDuration( VALUE self )
{
sf::SoundBuffer *object = NULL;