IAUDIO - XDM Audio Interface

Enumerations
enum	IAUDIO_ChannelId {   IAUDIO_MONO = 0,   IAUDIO_STEREO = 1,   IAUDIO_THREE_ZERO = 2,   IAUDIO_FIVE_ZERO = 3,   IAUDIO_FIVE_ONE = 4,   IAUDIO_SEVEN_ONE = 5 }
	XDM supported audio channel configurations. More...
enum	IAUDIO_ChannelMode {   IAUDIO_1_0 = 0,   IAUDIO_2_0 = 1,   IAUDIO_11_0 = 2,   IAUDIO_3_0 = 3,   IAUDIO_2_1 = 4,   IAUDIO_3_1 = 5,   IAUDIO_2_2 = 6,   IAUDIO_3_2 = 7,   IAUDIO_2_3 = 8,   IAUDIO_3_3 = 9,   IAUDIO_3_4 = 10 }
	Channel modes for audio streams. More...
enum	IAUDIO_DualMonoMode {   IAUDIO_DUALMONO_LR = 0,   IAUDIO_DUALMONO_LEFT = 1,   IAUDIO_DUALMONO_RIGHT = 2,   IAUDIO_DUALMONO_LR_MIX = 3 }
	Dual Mono Channel modes for audio streams. More...
enum	IAUDIO_PcmFormat {   IAUDIO_BLOCK = 0,   IAUDIO_INTERLEAVED = 1 }
	XDM supported audio PCM formats. More...
enum	IAUDIO_EncMode {   IAUDIO_CBR = 0,   IAUDIO_VBR = 1 }
	Audio encoding modes. More...

---

Detailed Description

This is the XDM audio interface shared between the various codecs.

---

Enumeration Type Documentation

enum IAUDIO_ChannelId

XDM supported audio channel configurations.

Deprecated:

This enumeration is only supported on 0.9 XDM. To use it, you must define "XDM_INCLUDE_DOT9_SUPPORT" prior to including this file. In XDM 1.00, this has been superceded by IAUDIO_ChannelMode.

Enumerator:

IAUDIO_MONO	Single channel.
IAUDIO_STEREO	Two channel.
IAUDIO_THREE_ZERO	Three channel.
IAUDIO_FIVE_ZERO	Five channel.
IAUDIO_FIVE_ONE	5.1 channel.
IAUDIO_SEVEN_ONE	7.1 channel.

enum IAUDIO_ChannelMode

Channel modes for audio streams.

The channel modes not only indicate the number of channels, but also indicate the order in which the channels are placed in the input or output buffer. The placement of channels is indicated next to each channel mode.

Remarks:

This enumeration data type should not be used for storage, but rather only for its constant values.

This enumeration defines a base set of values. Algorithms which require proprietary enumeration values may define them - much like extended fields in base structures. These extended enums should be between XDM_CUSTOMENUMBASE and 0x7FFF.

See also:

XDM_CUSTOMENUMBASE

Enumerator:

IAUDIO_1_0	Mono.
IAUDIO_2_0	Stereo.
IAUDIO_11_0	Dual Mono. See also: IAUDIO_DualMonoMode
IAUDIO_3_0	Left, Right, Center.
IAUDIO_2_1	Left, Right, Sur.
IAUDIO_3_1	Left, Right, Center, Sur.
IAUDIO_2_2	Left, Right, SurL, SurR.
IAUDIO_3_2	Left, Right, Center, SurL, SurR.
IAUDIO_2_3	Left, Right, SurL, SurR, surC.
IAUDIO_3_3	Left, Right, Center, SurL, SurR, surC.
IAUDIO_3_4	Left, Right, Center, SurL, SurR, sideL, sideR.

enum IAUDIO_DualMonoMode

Dual Mono Channel modes for audio streams.

Remarks:

In case of Dual Mono the application can play both channels; Left Only, Right Only or Mix and Play both. The default case in most of the applications is the first case of IAUDIO_DUALMONO_LR. That is to play both Left and Right Channel.

This enumeration data type should not be used for storage, but rather only for its constant values.

This enumeration defines a base set of values. Algorithms which require proprietary enumeration values may define them - much like extended fields in base structures. These extended enums should be between XDM_CUSTOMENUMBASE and 0x7FFF.

See also:

XDM_CUSTOMENUMBASE

Enumerator:

IAUDIO_DUALMONO_LR	Play/encode both left and right channel
IAUDIO_DUALMONO_LEFT	Play/encode only left channel.
IAUDIO_DUALMONO_RIGHT	Play/encode only right channel.
IAUDIO_DUALMONO_LR_MIX	Mix and play.

enum IAUDIO_PcmFormat

XDM supported audio PCM formats.

Remarks:

This enumeration data type should not be used for storage, but rather only for its constant values.

This enumeration defines a base set of values. Algorithms which require proprietary enumeration values may define them - much like extended fields in base structures. These extended enums should be between XDM_CUSTOMENUMBASE and 0x7FFF.

See also:

XDM_CUSTOMENUMBASE

Enumerator:

IAUDIO_BLOCK	Left channel data followed by right channel data. Note, for single channel (mono), right channel data will be the same as the left channel data.
IAUDIO_INTERLEAVED	Left and right channel data interleaved. Note, for single channel (mono), right channel data will be the same as the left channel data.

enum IAUDIO_EncMode

Audio encoding modes.

Remarks:

This enumeration data type should not be used for storage, but rather only for its constant values.

This enumeration defines a base set of values. Algorithms which require proprietary enumeration values may define them - much like extended fields in base structures. These extended enums should be between XDM_CUSTOMENUMBASE and 0x7FFF.

See also:

XDM_CUSTOMENUMBASE

Enumerator:

IAUDIO_CBR	Constant bit rate.
IAUDIO_VBR	Variable bit rate.