IXAudio2MasteringVoice interface

A mastering voice is used to represent the audio output device.

Data buffers cannot be submitted directly to mastering voices, but data submitted to other types of voices must be directed to a mastering voice to be heard.

IXAudio2MasteringVoice inherits directly from IXAudio2Voice, but does not implement methods specific to mastering voices. The interface type exists solely because some of the base class methods are implemented differently for mastering voices. Having a separate type for these voices helps client code to distinguish the different voice types and to benefit from C++ type safety.

Members

The IXAudio2MasteringVoice interface inherits from IXAudio2Voice. IXAudio2MasteringVoice also has these types of members:

Methods

The IXAudio2MasteringVoice interface has these methods.

MethodDescription
GetChannelMask

Returns the channel mask for the mastering voice.

 

IXAudio2MasteringVoice

MethodDescription
DestroyVoice (inherited from IXAudio2Voice)

Destroys the voice. If necessary, stops it and removes it from the XAudio2 graph.

DisableEffect (inherited from IXAudio2Voice)

Disables the effect at a given position in the effect chain of the voice.

EnableEffect (inherited from IXAudio2Voice)

Enables the effect at a given position in the effect chain of the voice.

GetChannelMask

Returns the channel mask for the mastering voice.

GetChannelVolumes (inherited from IXAudio2Voice)

Returns the volume levels for the voice, per channel.

GetEffectParameters (inherited from IXAudio2Voice)

Returns the current effect-specific parameters of a given effect in the voice's effect chain.

GetEffectState (inherited from IXAudio2Voice)

Returns the running state of the effect at a specified position in the effect chain of the voice.

GetOutputMatrix (inherited from IXAudio2Voice)

Gets the volume level of each channel of the final output for the voice. These channels are mapped to the input channels of a specified destination voice.

GetVoiceDetails (inherited from IXAudio2Voice)

Gets information about the creation flags, input channels, and sample rate of the voice.

GetVolume (inherited from IXAudio2Voice)

Gets the current overall volume level of the voice.

SetChannelVolumes (inherited from IXAudio2Voice)

Sets the volume levels for the voice, per channel.

SetEffectChain (inherited from IXAudio2Voice)

Replaces the effect chain of the voice.

SetEffectParameters (inherited from IXAudio2Voice)

Sets an effect-specific block of parameters on a given effect in the voice's effect chain.

SetOutputMatrix (inherited from IXAudio2Voice)

Sets the volume level of each channel of the final output for the voice. These channels are mapped to the input channels of a specified destination voice.

SetOutputVoices (inherited from IXAudio2Voice)

Establishes a new set of submix or mastering voices to receive the output of the voice.

SetVolume (inherited from IXAudio2Voice)

Sets the overall volume level for the voice.

 

Remarks

Platform Requirements

Windows 10 (XAudio2.9); Windows 8, Windows Phone 8 (XAudio 2.8); DirectX SDK (XAudio 2.7)

Requirements

Header

Xaudio2.h

Library

Xaudio2.lib

See also

IXAudio2Voice
XAudio2 Interfaces

 

 

Show: