TSdlAudioFormat
Audio format.
Definition
Unit: Neslib.Sdl3.Audio
Enumeration Values
Unknown = SDL_AUDIO_UNKNOWN
Unspecified audio format
U8 = SDL_AUDIO_U8
Unsigned 8-bit samples
S8 = SDL_AUDIO_S8
Signed 8-bit samples
S16 = SDL_AUDIO_S16
Signed 16-bit samples
S32 = SDL_AUDIO_S32
32-bit integer samples
F32 = SDL_AUDIO_F32
S16LE = SDL_AUDIO_S16LE
Signed 16-bit samples, in little-endian byte order
S16BE = SDL_AUDIO_S16BE
Signed 16-bit samples, big-endian byte order
S32LE = SDL_AUDIO_S32LE
32-bit integer samples, in little-endian byte order
S32BE = SDL_AUDIO_S32BE
32-bit integer samples, in big-endian byte order
F32LE = SDL_AUDIO_F32LE
32-bit floating point samples, in little-endian byte order
F32BE = SDL_AUDIO_F32BE
32-bit floating point samples, in big-endian byte order
Properties
| Name | Description |
|---|---|
| BitSize | The size, in bits. |
| ByteSize | The size, in bytes. |
| IsBigEndian | Whether this format represents big-endian data. |
| IsFloat | Whether this format represents floating point data. |
| IsInteger | Whether this format represents integer data. |
| IsLittleEndian | Whether this format represents little-endian data. |
| IsSigned | Whether this format represents signed data. |
| IsUnsigned | Whether this format represents unsigned data. |
| Name | The human readable name of the audio format. |
| SilenceValue | Get the appropriate FillChar value for silencing this audio format. |
Property Descriptions
BitSize
The size, in bits.
For example, TSdlAudioFormat.S16 returns 16.
property BitSize: Byte read GetBitSize
Type: Byte
ByteSize
The size, in bytes.
For example, TSdlAudioFormat.S16 returns 2.
property ByteSize: Byte read GetByteSize
Type: Byte
IsBigEndian
Whether this format represents big-endian data.
For example, TSdlAudioFormat.S16LE returns False.
property IsBigEndian: Boolean read GetIsBigEndian
Type: Boolean
IsFloat
Whether this format represents floating point data.
For example, TSdlAudioFormat.S16 returns False.
property IsFloat: Boolean read GetIsFloat
Type: Boolean
IsInteger
Whether this format represents integer data.
For example, TSdlAudioFormat.S16 returns True.
property IsInteger: Boolean read GetIsInteger
Type: Boolean
IsLittleEndian
Whether this format represents little-endian data.
For example, TSdlAudioFormat.S16LE returns True.
property IsLittleEndian: Boolean read GetIsLittleEndian
Type: Boolean
IsSigned
Whether this format represents signed data.
For example, TSdlAudioFormat.U8 returns False.
property IsSigned: Boolean read GetIsSigned
Type: Boolean
IsUnsigned
Whether this format represents unsigned data.
For example, TSdlAudioFormat.U8 returns True.
property IsUnsigned: Boolean read GetIsUnsigned
Type: Boolean
Name
The human readable name of the audio format.
property Name: String read GetName
Type: String
Remarks
It is safe to use this property from any thread
SilenceValue
Get the appropriate FillChar value for silencing this audio format.
The value returned by this property can be used as the third argument to FillChar to set an audio buffer in this format to silence.
property SilenceValue: Byte read GetSilenceValue
Type: Byte
Remarks
It is safe to use this property from any thread