API Sound: Difference between revisions
XML import |
XML import |
||
| Line 1: | Line 1: | ||
<sidebar>API contents</sidebar> | <sidebar>API contents</sidebar> | ||
Audio streaming interface | Audio streaming interface | ||
__TOC__ | |||
==Functions provided for this class== | ==Functions provided for this class== | ||
| Line 79: | Line 81: | ||
==Examples== | ==Examples== | ||
''No examples available'' | ''No examples available'' | ||
==See also== | |||
Revision as of 21:22, 11 May 2013
<sidebar>API contents</sidebar> Audio streaming interface
Functions provided for this class
| Play | Plays a formatted file sound, returns true if the sound played OK |
| LoadWav | Queues a sound for playing, with the format provided |
| Create | Creates a sound object that data can be played through |
| SetVolume | Sets the volume of playbacks for this sound |
| GetVolume | Gets the volume of playbacks for this sound in the range 0 to 1 |
| GetBits | Gets the number of bits per sample for the sound |
| GetRate | Gets the current sample rate for the sound |
| SetRate | Sets the current sample rate for the sound - this will stop the playing sound |
| Queue | Queues a sound for playing |
| QueueEx | Queues a sound for playing, with the format provided |
| Flush | Stops all playing and queued sounds |
| GetPending | Gets the number of sample blocks queued or playing for the sound |
Constants provided for this class
| LONG | 4 |
| LONG | 5 |
| LONG | 8 |
| LONG | 9 |
| LONG | 16 |
| LONG | 17 |
| LONG | 18 |
| LONG | 34 |
| LONG | 256 |
| LONG | 512 |
Examples
No examples available