Difference between revisions of "API Sound"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| Line 46: | Line 46: | ||
==Constants provided for this class== | ==Constants provided for this class== | ||
| − | {| class="wikitable" | | + | {| class="wikitable" |
| + | |- | ||
| + | !width="20%"|Type | ||
| + | !width="30%"|Name | ||
| + | !width="40%"|Value | ||
| + | |- | ||
|LONG | |LONG | ||
| − | |Fmt_Signed8|4 | + | |Fmt_Signed8 |
| + | |4 | ||
|- | |- | ||
|LONG | |LONG | ||
| − | |Fmt_Unsigned8|5 | + | |Fmt_Unsigned8 |
| + | |5 | ||
|- | |- | ||
|LONG | |LONG | ||
| − | |Fmt_Signed16|8 | + | |Fmt_Signed16 |
| + | |8 | ||
|- | |- | ||
|LONG | |LONG | ||
| − | |Fmt_Unsigned16|9 | + | |Fmt_Unsigned16 |
| + | |9 | ||
|- | |- | ||
|LONG | |LONG | ||
| − | |Fmt_Signed32|16 | + | |Fmt_Signed32 |
| + | |16 | ||
|- | |- | ||
|LONG | |LONG | ||
| − | |Fmt_Unsigned32|17 | + | |Fmt_Unsigned32 |
| + | |17 | ||
|- | |- | ||
|LONG | |LONG | ||
| − | |Fmt_Float32|18 | + | |Fmt_Float32 |
| + | |18 | ||
|- | |- | ||
|LONG | |LONG | ||
| − | |Fmt_Float64|34 | + | |Fmt_Float64 |
| + | |34 | ||
|- | |- | ||
|LONG | |LONG | ||
| − | |Fmt_Mono|256 | + | |Fmt_Mono |
| + | |256 | ||
|- | |- | ||
|LONG | |LONG | ||
| − | |Fmt_Stereo|512 | + | |Fmt_Stereo |
| + | |512 | ||
|} | |} | ||
Revision as of 21:47, 11 May 2013
<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 | 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
| Type | Name | Value |
|---|---|---|
| LONG | Fmt_Signed8 | 4 |
| LONG | Fmt_Unsigned8 | 5 |
| LONG | Fmt_Signed16 | 8 |
| LONG | Fmt_Unsigned16 | 9 |
| LONG | Fmt_Signed32 | 16 |
| LONG | Fmt_Unsigned32 | 17 |
| LONG | Fmt_Float32 | 18 |
| LONG | Fmt_Float64 | 34 |
| LONG | Fmt_Mono | 256 |
| LONG | Fmt_Stereo | 512 |
Examples
No examples available
