Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
IXAudio2Voice represents the base interface from which IXAudio2SourceVoice, IXAudio2SubmixVoice and IXAudio2MasteringVoice are derived. The methods listed below are common to all voice subclasses.
| Method | Description |
|---|---|
| DestroyVoice | Destroys the voice. If necessary, stops the voice and removes it from the XAudio2 graph. |
| DisableEffect | Disables the effect at a given position in the effect chain of the voice. |
| EnableEffect | Enables the effect at a given position in the effect chain of the voice. |
| GetChannelVolumes | Returns the volume levels for the voice, per channel. |
| GetEffectParameters | Returns the current effect-specific parameters of a given effect in the voice's effect chain. |
| GetEffectState | Returns the running state of the effect at a specified position in the effect chain of the voice. |
| GetFilterParameters | Gets the voice's filter parameters. |
| GetOutputFilterParameters | Returns the filter parameters from one of this voice's sends. |
| GetOutputMatrix | 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 | Returns information about the creation flags, input channels, and sample rate of a voice. |
| GetVolume | Gets the current overall volume level of the voice. |
| SetChannelVolumes | Sets the volume levels for the voice, per channel. |
| SetEffectChain | Replaces the effect chain of the voice. |
| SetEffectParameters | Sets parameters for a given effect in the voice's effect chain. |
| SetFilterParameters | Sets the voice's filter parameters. |
| SetOutputFilterParameters | Sets the filter parameters on one of this voice's sends. |
| SetOutputMatrix | 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 | Designates a new set of submix or mastering voices to receive the output of the voice. |
| SetVolume | Sets the overall volume level for the voice. |
Methods
The IXAudio2Voice interface has these methods.
| IXAudio2Voice::DestroyVoice Destroys the voice. If necessary, stops the voice and removes it from the XAudio2 graph. |
| IXAudio2Voice::DisableEffect Disables the effect at a given position in the effect chain of the voice. |
| IXAudio2Voice::EnableEffect Enables the effect at a given position in the effect chain of the voice. |
| IXAudio2Voice::GetChannelVolumes Returns the volume levels for the voice, per channel. |
| IXAudio2Voice::GetEffectParameters Returns the current effect-specific parameters of a given effect in the voice's effect chain. |
| IXAudio2Voice::GetEffectState Returns the running state of the effect at a specified position in the effect chain of the voice. |
| IXAudio2Voice::GetFilterParameters Gets the voice's filter parameters. |
| IXAudio2Voice::GetOutputFilterParameters Returns the filter parameters from one of this voice's sends. |
| IXAudio2Voice::GetOutputMatrix 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. |
| IXAudio2Voice::GetVoiceDetails Returns information about the creation flags, input channels, and sample rate of a voice. |
| IXAudio2Voice::GetVolume Gets the current overall volume level of the voice. |
| IXAudio2Voice::SetChannelVolumes Sets the volume levels for the voice, per channel. |
| IXAudio2Voice::SetEffectChain Replaces the effect chain of the voice. |
| IXAudio2Voice::SetEffectParameters Sets parameters for a given effect in the voice's effect chain. |
| IXAudio2Voice::SetFilterParameters Sets the voice's filter parameters. |
| IXAudio2Voice::SetOutputFilterParameters Sets the filter parameters on one of this voice's sends. |
| IXAudio2Voice::SetOutputMatrix 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. |
| IXAudio2Voice::SetOutputVoices Designates a new set of submix or mastering voices to receive the output of the voice. |
| IXAudio2Voice::SetVolume 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
| Requirement | Value |
|---|---|
| Target Platform | Windows |
| Header | xaudio2.h |