Printer Friendly Version      Send     
Click to Rate and Give Feedback
MSDN
MSDN Library
DirectX
SDK Documentation
DirectX Audio
Reference
XAudio2
Interfaces
 IXAudio2SubmixVoice
IXAudio2SubmixVoice

IXAudio2SubmixVoice

A submix voice is used primarily for performance improvements and effects processing. Data buffers cannot be submitted directly to submix voices and will not be audible unless submitted to a mastering voice. A submix voice can be used to ensure that a particular set of voice data is converted to the same format and/or to have a particular effect chain processed on the collective result.

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

Method Description
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.

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.

GetFilterParameters (inherited from IXAudio2Voice

Gets the voice's filter parameters.

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.

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.

SetFilterParameters (inherited from IXAudio2Voice)

Sets the voice's filter parameters.

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.

Requirements

Header: Declared in XAudio2.h.

Library: Use XAudio2.lib.

See Also

XAudio2 Interfaces, How To: Use Submix Voices, XAPO Overview

© 2008 Microsoft Corporation. All rights reserved. Terms of Use  |  Trademarks  |  Privacy Statement
Page view tracker