API Sound.QueueEx: Difference between revisions
XML import |
XML import |
||
| Line 22: | Line 22: | ||
:Format of the samples | :Format of the samples | ||
''Typical values for this parameter:'' | ''Typical values for this parameter:'' | ||
{| class="wikitable" |-width="20%"|Type | {| class="wikitable" width="75%" | ||
|-LONG|Fmt_Unsigned8| | |- | ||
|-LONG|Fmt_Signed16| | ! width="20%" |Type | ||
|-LONG|Fmt_Unsigned16| | ! width="30%" |Name | ||
|-LONG|Fmt_Signed32| | ! width="50%" |Description | ||
|-LONG|Fmt_Unsigned32| | |- | ||
|-LONG|Fmt_Float32| | |LONG | ||
|-LONG|Fmt_Float64| | |Fmt_Signed8 | ||
|-LONG|Fmt_Mono| | |Source data is in the range -128 to 127 | ||
|-LONG|Fmt_Stereo| | |- | ||
|LONG | |||
|Fmt_Unsigned8 | |||
|Source data is in the range 0 to 255 | |||
|- | |||
|LONG | |||
|Fmt_Signed16 | |||
|Source data is in the range -32768 to 32767 | |||
|- | |||
|LONG | |||
|Fmt_Unsigned16 | |||
|Source data is in the range 0 to 65535 | |||
|- | |||
|LONG | |||
|Fmt_Signed32 | |||
|Source data is a signed 32-bit value | |||
|- | |||
|LONG | |||
|Fmt_Unsigned32 | |||
|Source data is an unsigned 32-bit value | |||
|- | |||
|LONG | |||
|Fmt_Float32 | |||
|Source data is a 32-bit float from 0 to 1 | |||
|- | |||
|LONG | |||
|Fmt_Float64 | |||
|Source data is a 64-bit float from 0 to 1 | |||
|- | |||
|LONG | |||
|Fmt_Mono | |||
|Set this flag to set a single source element per sample | |||
|- | |||
|LONG | |||
|Fmt_Stereo | |||
|Set this flag to two source elements per sample | |||
|} | |} | ||
Revision as of 21:17, 12 May 2013
<sidebar>API contents</sidebar> Queues a sound for playing, with the format provided
Parameters
HANDLE Sounds
- The handle of the sound object to queue to
BYTE[] Data
- The array to play data from
ULONG ByteOffset
- The byte-offset in the array to start at
UINT SampleFormat
- Format of the samples
Typical values for this parameter:
| Type | Name | Description |
|---|---|---|
| LONG | Fmt_Signed8 | Source data is in the range -128 to 127 |
| LONG | Fmt_Unsigned8 | Source data is in the range 0 to 255 |
| LONG | Fmt_Signed16 | Source data is in the range -32768 to 32767 |
| LONG | Fmt_Unsigned16 | Source data is in the range 0 to 65535 |
| LONG | Fmt_Signed32 | Source data is a signed 32-bit value |
| LONG | Fmt_Unsigned32 | Source data is an unsigned 32-bit value |
| LONG | Fmt_Float32 | Source data is a 32-bit float from 0 to 1 |
| LONG | Fmt_Float64 | Source data is a 64-bit float from 0 to 1 |
| LONG | Fmt_Mono | Set this flag to set a single source element per sample |
| LONG | Fmt_Stereo | Set this flag to two source elements per sample |
ULONG Elements
- The number of sample elements to play
FLOAT RateMul
- A multiplier to the sounds sample rate
- The default value for this parameter is: 1
Return value
No additional information
Detailed description
No additional information
Examples
Calling in a calculation
- Declare a variable 'result' of type BOOL
- Add to a calculation icon:
result = ::Sound.QueueEx(sounds, _arraydata, byteoffset, ::Sound.Fmt_Signed8, elements, ratemul)
No additional information