AudioObjectType enumeration

[Some information relates to pre-released product which may be substantially modified before it's commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.]

Specifies the type of an ISpatialAudioObject. A spatial audio object can be dynamic, meaning that it's spatial properties can change over time, or static, which means that its spatial properties are fixed. There are 17 audio channels to which a static spatial audio object can be assigned, each representing a real or virtualized speaker. The static channel values of the enumeration can be combined as a mask to assign a spatial audio object to multiple channels. All of the enumeration values except for AudioObjectType_None and AudioObjectType_Dynamic represent static channels.

Syntax


typedef enum _AudioObjectType { 
  AudioObjectType_None              = 0,
  AudioObjectType_Dynamic           = 1 << 0,
  AudioObjectType_FrontLeft         = 1 << 1,
  AudioObjectType_FrontRight        = 1 << 2,
  AudioObjectType_FrontCenter       = 1 << 3,
  AudioObjectType_LowFrequency      = 1 << 4,
  AudioObjectType_SideLeft          = 1 << 5,
  AudioObjectType_SideRight         = 1 << 6,
  AudioObjectType_BackLeft          = 1 << 7,
  AudioObjectType_BackRight         = 1 << 8,
  AudioObjectType_TopFrontLeft      = 1 << 9,
  AudioObjectType_TopFrontRight     = 1 << 10,
  AudioObjectType_TopBackLeft       = 1 << 11,
  AudioObjectType_TopBackRight      = 1 << 12,
  AudioObjectType_BottomFrontLeft   = 1 << 13,
  AudioObjectType_BottomFrontRight  = 1 << 14,
  AudioObjectType_BottomBackLeft    = 1 << 15,
  AudioObjectType_BottomBackRight   = 1 << 16,
  AudioObjectType_BackCenter        = 1 << 17
} AudioObjectType;

Constants

AudioObjectType_None

The spatial audio object is not spatialized.

AudioObjectType_Dynamic

The spatial audio object is dynamic. It's spatial properties can be changed over time.

AudioObjectType_FrontLeft

The spatial audio object is assigned the front left channel. The equivalent channel mask of DirectShow's WAVEFORMATEXTENSIBLE enumeration is SPEAKER_FRONT_LEFT.

AudioObjectType_FrontRight

The spatial audio object is assigned the front right channel. The equivalent channel mask of DirectShow's WAVEFORMATEXTENSIBLE enumeration is SPEAKER_FRONT_RIGHT.

AudioObjectType_FrontCenter

The spatial audio object is assigned the front center channel. The equivalent channel mask of DirectShow's WAVEFORMATEXTENSIBLE enumeration is SPEAKER_FRONT_CENTER.

AudioObjectType_LowFrequency

The spatial audio object is assigned the low frequency channel. Because this channel is not spatialized, it does not count toward the system resource limits for spatialized audio objects. The equivalent channel mask of DirectShow's WAVEFORMATEXTENSIBLE enumeration is SPEAKER_LOW_FREQUENCY.

AudioObjectType_SideLeft

The spatial audio object is assigned the side left channel. The equivalent channel mask of DirectShow's WAVEFORMATEXTENSIBLE enumeration is SPEAKER_SIDE_LEFT.

AudioObjectType_SideRight

The spatial audio object is assigned the side right channel. The equivalent channel mask of DirectShow's WAVEFORMATEXTENSIBLE enumeration is SPEAKER_SIDE_RIGHT.

AudioObjectType_BackLeft

The spatial audio object is assigned the back left channel. The equivalent channel mask of DirectShow's WAVEFORMATEXTENSIBLE enumeration is SPEAKER_BACK_LEFT.

AudioObjectType_BackRight

The spatial audio object is assigned the back right channel. The equivalent channel mask of DirectShow's WAVEFORMATEXTENSIBLE enumeration is SPEAKER_BACK_RIGHT.

AudioObjectType_TopFrontLeft

The spatial audio object is assigned the top front left channel. The equivalent channel mask of DirectShow's WAVEFORMATEXTENSIBLE enumeration is SPEAKER_TOP_FRONT_LEFT.

AudioObjectType_TopFrontRight

The spatial audio object is assigned the top front right channel. The equivalent channel mask of DirectShow's WAVEFORMATEXTENSIBLE enumeration is SPEAKER_TOP_FRONT_RIGHT.

AudioObjectType_TopBackLeft

The spatial audio object is assigned the top back left channel. The equivalent channel mask of DirectShow's WAVEFORMATEXTENSIBLE enumeration is SPEAKER_TOP_BACK_LEFT.

AudioObjectType_TopBackRight

The spatial audio object is assigned the top back right channel. The equivalent channel mask of DirectShow's WAVEFORMATEXTENSIBLE enumeration is SPEAKER_TOP_BACK_RIGHT.

AudioObjectType_BottomFrontLeft

The spatial audio object is assigned the bottom front left channel.

AudioObjectType_BottomFrontRight

The spatial audio object is assigned the bottom front right channel.

AudioObjectType_BottomBackLeft

The spatial audio object is assigned the bottom back left channel.

AudioObjectType_BottomBackRight

The spatial audio object is assigned the bottom back right channel.

AudioObjectType_BackCenter

The spatial audio object is assigned the back center channel.

Requirements

Header

Spatialaudioclient.h

 

 

Show: