API Sound
From Flowcode Help
Jump to navigationJump to search
<sidebar>API Contents</sidebar>
Audio streaming interface
Contents
Functions provided for this class
Play | Plays a formatted file sound, returns true if the sound played OK |
LoadWav | Loads a wave file into memory, providing the values needed to play it |
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
Type | Name | Value | Description |
---|---|---|---|
LONG | Fmt_Signed8 | 4 | Source data is in the range -128 to 127 |
LONG | Fmt_Unsigned8 | 5 | Source data is in the range 0 to 255 |
LONG | Fmt_Signed16 | 8 | Source data is in the range -32768 to 32767 |
LONG | Fmt_Unsigned16 | 9 | Source data is in the range 0 to 65535 |
LONG | Fmt_Signed32 | 16 | Source data is a signed 32-bit value |
LONG | Fmt_Unsigned32 | 17 | Source data is an unsigned 32-bit value |
LONG | Fmt_Float32 | 18 | Source data is a 32-bit float from 0 to 1 |
LONG | Fmt_Float64 | 34 | Source data is a 64-bit float from 0 to 1 |
LONG | Fmt_Mono | 256 | Set this flag to set a single source element per sample |
LONG | Fmt_Stereo | 512 | Set this flag to two source elements per sample |
Examples
No additional examples
See also
No additional information