SharpDX.XAudio2

No documentation.

IXAudio2EngineCallback

The IXAudio2EngineCallback interface contains methods that notify the client when certain events happen in the engine. This interface should be implemented by the XAudio2 client. XAudio2 calls these methods via an interface pointer provided by the client, using either the {{XAudio2Create}} or method. Methods in this interface return void, rather than an HRESULT.

IXAudio2EngineCallback

Called by XAudio2 just before an audio processing pass begins.

void IXAudio2EngineCallback::OnProcessingPassStart()

Called by XAudio2 just after an audio processing pass ends.

void IXAudio2EngineCallback::OnProcessingPassEnd()

Called if a critical system error occurs that requires XAudio2 to be closed down and restarted.

Error code returned by XAudio2. void IXAudio2EngineCallback::OnCriticalError([None] HRESULT Error)

No documentation.

IXAudio2MasteringVoice

No documentation.

IXAudio2Voice

Initializes a new instance of the class.

The native pointer.

No documentation.

No documentation. void IXAudio2Voice::GetVoiceDetails([Out] XAUDIO2_VOICE_DETAILS* pVoiceDetails)

No documentation.

No documentation. No documentation. HRESULT IXAudio2Voice::SetOutputVoices([In, Optional] const XAUDIO2_VOICE_SENDS* pSendList)

No documentation.

No documentation. No documentation. HRESULT IXAudio2Voice::SetEffectChain([In, Optional] const XAUDIO2_EFFECT_CHAIN* pEffectChain)

No documentation.

No documentation. No documentation. No documentation. HRESULT IXAudio2Voice::EnableEffect([In] unsigned int EffectIndex,[In] unsigned int OperationSet)

No documentation.

No documentation. No documentation. No documentation. HRESULT IXAudio2Voice::DisableEffect([In] unsigned int EffectIndex,[In] unsigned int OperationSet)

No documentation.

No documentation. void IXAudio2Voice::GetEffectState([In] unsigned int EffectIndex,[Out] BOOL* pEnabled)

No documentation.

No documentation. No documentation. No documentation. No documentation. No documentation. HRESULT IXAudio2Voice::SetEffectParameters([In] unsigned int EffectIndex,[In, Buffer] const void* pParameters,[In] unsigned int ParametersByteSize,[In] unsigned int OperationSet)

No documentation.

No documentation. No documentation. No documentation. No documentation. HRESULT IXAudio2Voice::GetEffectParameters([In] unsigned int EffectIndex,[Out, Buffer] void* pParameters,[In] unsigned int ParametersByteSize)

No documentation.

No documentation. No documentation. No documentation. HRESULT IXAudio2Voice::SetFilterParameters([In] const XAUDIO2_FILTER_PARAMETERS* pParameters,[In] unsigned int OperationSet)

No documentation.

No documentation. void IXAudio2Voice::GetFilterParameters([Out] XAUDIO2_FILTER_PARAMETERS* pParameters)

No documentation.

No documentation. No documentation. No documentation. No documentation. HRESULT IXAudio2Voice::SetOutputFilterParameters([In, Optional] IXAudio2Voice* pDestinationVoice,[In] const XAUDIO2_FILTER_PARAMETERS* pParameters,[In] unsigned int OperationSet)

No documentation.

No documentation. No documentation. void IXAudio2Voice::GetOutputFilterParameters([In, Optional] IXAudio2Voice* pDestinationVoice,[Out] XAUDIO2_FILTER_PARAMETERS* pParameters)

No documentation.

No documentation. No documentation. No documentation. HRESULT IXAudio2Voice::SetVolume([In] float Volume,[In] unsigned int OperationSet)

No documentation.

No documentation. void IXAudio2Voice::GetVolume([Out] float* pVolume)

No documentation.

No documentation. No documentation. No documentation. No documentation. HRESULT IXAudio2Voice::SetChannelVolumes([In] unsigned int Channels,[In, Buffer] const float* pVolumes,[In] unsigned int OperationSet)

No documentation.

No documentation. No documentation. void IXAudio2Voice::GetChannelVolumes([In] unsigned int Channels,[Out, Buffer] float* pVolumes)

No documentation.

No documentation. No documentation. No documentation. No documentation. No documentation. No documentation. HRESULT IXAudio2Voice::SetOutputMatrix([In, Optional] IXAudio2Voice* pDestinationVoice,[In] unsigned int SourceChannels,[In] unsigned int DestinationChannels,[In, Buffer] const float* pLevelMatrix,[In] unsigned int OperationSet)

No documentation.

No documentation. No documentation. No documentation. No documentation. void IXAudio2Voice::GetOutputMatrix([In, Optional] IXAudio2Voice* pDestinationVoice,[In] unsigned int SourceChannels,[In] unsigned int DestinationChannels,[Out, Buffer] float* pLevelMatrix)

No documentation.

void IXAudio2Voice::DestroyVoice()

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

[in] Zero-based index of an effect in the effect chain of the voice. No documentation. HRESULT IXAudio2Voice::EnableEffect([None] UINT32 EffectIndex,[None] UINT32 OperationSet)

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

[in] Zero-based index of an effect in the effect chain of the voice. No documentation. HRESULT IXAudio2Voice::DisableEffect([None] UINT32 EffectIndex,[None] UINT32 OperationSet)

Sets parameters for a given effect in the voice's effect chain.

[in] Zero-based index of an effect within the voice's effect chain. Returns the current values of the effect-specific parameters. HRESULT IXAudio2Voice::SetEffectParameters([None] UINT32 EffectIndex,[In, Buffer] const void* pParameters,[None] UINT32 ParametersByteSize,[None] UINT32 OperationSet)

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

[in] Zero-based index of an effect within the voice's effect chain. [out] Returns the current values of the effect-specific parameters. No documentation. HRESULT IXAudio2Voice::GetEffectParameters([None] UINT32 EffectIndex,[Out, Buffer] void* pParameters,[None] UINT32 ParametersByteSize)

Sets parameters for a given effect in the voice's effect chain.

[in] Zero-based index of an effect within the voice's effect chain. [in] Returns the current values of the effect-specific parameters. No documentation. HRESULT IXAudio2Voice::SetEffectParameters([None] UINT32 EffectIndex,[In, Buffer] const void* pParameters,[None] UINT32 ParametersByteSize,[None] UINT32 OperationSet)

Sets parameters for a given effect in the voice's effect chain.

[in] Zero-based index of an effect within the voice's effect chain. [in] Returns the current values of the effect-specific parameters. [in] Identifies this call as part of a deferred batch. See the {{XAudio2 Operation Sets}} overview for more information. No documentation. HRESULT IXAudio2Voice::SetEffectParameters([None] UINT32 EffectIndex,[In, Buffer] const void* pParameters,[None] UINT32 ParametersByteSize,[None] UINT32 OperationSet)

Sets parameters for a given effect in the voice's effect chain.

Replaces the effect chain of the voice.

[in, optional] an array of structure that describes the new effect chain to use. If NULL is passed, the current effect chain is removed. If array is non null, its length must be at least of 1. No documentation. HRESULT IXAudio2Voice::SetEffectChain([In, Optional] const XAUDIO2_EFFECT_CHAIN* pEffectChain)

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

[in] Array of structure pointers to destination voices. If outputVoices is NULL, the voice will send its output to the current mastering voice. To set the voice to not send its output anywhere set an array of lenvth 0. All of the voices in a send list must have the same input sample rate, see {{XAudio2 Sample Rate Conversions}} for additional information. No documentation. HRESULT IXAudio2Voice::SetOutputVoices([In, Optional] const XAUDIO2_VOICE_SENDS* pSendList)

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.

[in] Confirms the output channel count of the voice. This is the number of channels that are produced by the last effect in the chain. [in] Confirms the input channel count of the destination voice. [in] Array of [SourceChannels ? DestinationChannels] volume levels sent to the destination voice. The level sent from source channel S to destination channel D is specified in the form pLevelMatrix[SourceChannels ? D + S]. For example, when rendering two-channel stereo input into 5.1 output that is weighted toward the front channels?but is absent from the center and low-frequency channels?the matrix might have the values shown in the following table. OutputLeft InputRight Input Left1.00.0 Right0.01.0 Front Center0.00.0 LFE0.00.0 Rear Left0.80.0 Rear Right0.00.8 Note that the left and right input are fully mapped to the output left and right channels; 80 percent of the left and right input is mapped to the rear left and right channels. See Remarks for more information on volume levels. No documentation. HRESULT IXAudio2Voice::SetOutputMatrix([In, Optional] IXAudio2Voice* pDestinationVoice,[None] UINT32 SourceChannels,[None] UINT32 DestinationChannels,[In, Buffer] const float* pLevelMatrix,[None] UINT32 OperationSet)

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.

[in] Pointer to a destination for which to set volume levels. Note If the voice sends to a single target voice then specifying NULL will cause SetOutputMatrix to operate on that target voice. [in] Confirms the output channel count of the voice. This is the number of channels that are produced by the last effect in the chain. [in] Confirms the input channel count of the destination voice. [in] Array of [SourceChannels ? DestinationChannels] volume levels sent to the destination voice. The level sent from source channel S to destination channel D is specified in the form pLevelMatrix[SourceChannels ? D + S]. For example, when rendering two-channel stereo input into 5.1 output that is weighted toward the front channels?but is absent from the center and low-frequency channels?the matrix might have the values shown in the following table. OutputLeft InputRight Input Left1.00.0 Right0.01.0 Front Center0.00.0 LFE0.00.0 Rear Left0.80.0 Rear Right0.00.8 Note that the left and right input are fully mapped to the output left and right channels; 80 percent of the left and right input is mapped to the rear left and right channels. See Remarks for more information on volume levels. No documentation. HRESULT IXAudio2Voice::SetOutputMatrix([In, Optional] IXAudio2Voice* pDestinationVoice,[None] UINT32 SourceChannels,[None] UINT32 DestinationChannels,[In, Buffer] const float* pLevelMatrix,[None] UINT32 OperationSet)

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.

[in] Confirms the output channel count of the voice. This is the number of channels that are produced by the last effect in the chain. [in] Confirms the input channel count of the destination voice. [in] Array of [SourceChannels ? DestinationChannels] volume levels sent to the destination voice. The level sent from source channel S to destination channel D is specified in the form pLevelMatrix[SourceChannels ? D + S]. For example, when rendering two-channel stereo input into 5.1 output that is weighted toward the front channels?but is absent from the center and low-frequency channels?the matrix might have the values shown in the following table. OutputLeft InputRight Input Left1.00.0 Right0.01.0 Front Center0.00.0 LFE0.00.0 Rear Left0.80.0 Rear Right0.00.8 Note that the left and right input are fully mapped to the output left and right channels; 80 percent of the left and right input is mapped to the rear left and right channels. See Remarks for more information on volume levels. [in] Identifies this call as part of a deferred batch. See the {{XAudio2 Operation Sets}} overview for more information. No documentation. HRESULT IXAudio2Voice::SetOutputMatrix([In, Optional] IXAudio2Voice* pDestinationVoice,[None] UINT32 SourceChannels,[None] UINT32 DestinationChannels,[In, Buffer] const float* pLevelMatrix,[None] UINT32 OperationSet)

No documentation.

GetVoiceDetails void IXAudio2Voice::GetVoiceDetails([Out] XAUDIO2_VOICE_DETAILS* pVoiceDetails)

No documentation.

SetOutputVoices HRESULT IXAudio2Voice::SetOutputVoices([In, Optional] const XAUDIO2_VOICE_SENDS* pSendList)

No documentation.

GetFilterParameters void IXAudio2Voice::GetFilterParameters([Out] XAUDIO2_FILTER_PARAMETERS* pParameters)

No documentation.

GetVolume void IXAudio2Voice::GetVolume([Out] float* pVolume)

Initializes a new instance of the class.

The native pointer.

Creates and configures a mastering voice.

an instance of [in] Number of channels the mastering voice expects in its input audio. InputChannels must be less than or equal to XAUDIO2_MAX_AUDIO_CHANNELS. InputChannels can be set to XAUDIO2_DEFAULT_CHANNELS, with the default being determined by the current platform. Windows Attempts to detect the system speaker configuration setup. Xbox 360 Defaults to 5.1 surround. [in] Sample rate of the input audio data of the mastering voice. This rate must be a multiple of XAUDIO2_QUANTUM_DENOMINATOR. InputSampleRate must be between XAUDIO2_MIN_SAMPLE_RATE and XAUDIO2_MAX_SAMPLE_RATE. InputSampleRate can be set to XAUDIO2_DEFAULT_SAMPLERATE, with the default being determined by the current platform. Windows Windows XP defaults to 44100. Windows Vista and Windows 7 default to the setting specified in the Sound Control Panel. The default for this setting is 44100 (or 48000 if required by the driver). Xbox 360 Defaults to 48000. [in] Index of the output device that will be sent input by the mastering voice. Specifying the default value of 0 causes XAudio2 to select the global default audio device. HRESULT IXAudio2::CreateMasteringVoice([Out] IXAudio2MasteringVoice** ppMasteringVoice,[None] UINT32 InputChannels,[None] UINT32 InputSampleRate,[None] UINT32 Flags,[None] UINT32 DeviceIndex,[In, Optional] const XAUDIO2_EFFECT_CHAIN* pEffectChain)

No documentation.

IXAudio2SourceVoice

Initializes a new instance of the class.

The native pointer.

No documentation.

No documentation. No documentation. No documentation. HRESULT IXAudio2SourceVoice::Start([In] unsigned int Flags,[In] unsigned int OperationSet)

No documentation.

No documentation. No documentation. No documentation. HRESULT IXAudio2SourceVoice::Stop([In] XAUDIO2_PLAY_FLAGS Flags,[In] unsigned int OperationSet)

No documentation.

No documentation. No documentation. No documentation. HRESULT IXAudio2SourceVoice::SubmitSourceBuffer([In] const XAUDIO2_BUFFER* pBuffer,[In] const void* pBufferWMA)

No documentation.

No documentation. HRESULT IXAudio2SourceVoice::FlushSourceBuffers()

No documentation.

No documentation. HRESULT IXAudio2SourceVoice::Discontinuity()

No documentation.

No documentation. No documentation. HRESULT IXAudio2SourceVoice::ExitLoop([In] unsigned int OperationSet)

No documentation.

No documentation. void IXAudio2SourceVoice::GetState([Out] XAUDIO2_VOICE_STATE* pVoiceState)

No documentation.

No documentation. No documentation. No documentation. HRESULT IXAudio2SourceVoice::SetFrequencyRatio([In] float Ratio,[In] unsigned int OperationSet)

No documentation.

No documentation. void IXAudio2SourceVoice::GetFrequencyRatio([Out] float* pRatio)

No documentation.

No documentation. No documentation. HRESULT IXAudio2SourceVoice::SetSourceSampleRate([In] unsigned int NewSourceSampleRate)

Creates and configures a source voice.

an instance of [in] Pointer to a structure. This structure contains the expected format for all audio buffers submitted to the source voice. XAudio2 supports voice types of PCM, xWMA, ADPCM (Windows only), and XMA (Xbox 360 only). XAudio2 supports the following PCM formats. 8-bit (unsigned) integer PCM 16-bit integer PCM (Optimal format for XAudio2) 20-bit integer PCM (either in 24 or 32 bit containers) 24-bit integer PCM (either in 24 or 32 bit containers) 32-bit integer PCM 32-bit float PCM (Preferred format after 16-bit integer) The number of channels in a source voice must be less than or equal to XAUDIO2_MAX_AUDIO_CHANNELS. The sample rate of a source voice must be between XAUDIO2_MIN_SAMPLE_RATE and XAUDIO2_MAX_SAMPLE_RATE. Note Data formats such as XMA, {{ADPCM}}, and {{xWMA}} that require more information than provided by have a structure as the first member in their format structure. When creating a source voice with one of those formats cast the format's structure as a structure and use it as the value for pSourceFormat. [in] Flags that specify the behavior of the source voice. A flag can be 0 or a combination of one or more of the following: ValueDescriptionXAUDIO2_VOICE_NOPITCHNo pitch control is available on the voice.?XAUDIO2_VOICE_NOSRCNo sample rate conversion is available on the voice, the voice's outputs must have the same sample rate.Note The XAUDIO2_VOICE_NOSRC flag causes the voice to behave as though the XAUDIO2_VOICE_NOPITCH flag also is specified. ?XAUDIO2_VOICE_USEFILTERThe filter effect should be available on this voice.?XAUDIO2_VOICE_MUSICThe voice is used to play background music. The system automatically can replace the voice with music selected by the user.? [in] Highest allowable frequency ratio that can be set on this voice. The value for this argument must be between XAUDIO2_MIN_FREQ_RATIO and XAUDIO2_MAX_FREQ_RATIO. Subsequent calls to are clamped between XAUDIO2_MIN_FREQ_RATIO and MaxFrequencyRatio. The maximum value for this argument is defined as XAUDIO2_MAX_FREQ_RATIO, which allows pitch to be raised by up to 10 octaves. If MaxFrequencyRatio is less than 1.0, the voice will use that ratio immediately after being created (rather than the default of 1.0). Xbox 360 For XMA voices there is an additional restriction on the MaxFrequencyRatio argument and the voice's sample rate. The product of these two numbers cannot exceed XAUDIO2_MAX_RATIO_TIMES_RATE_XMA_MONO for one-channel voices or XAUDIO2_MAX_RATIO_TIMES_RATE_XMA_MULTICHANNEL for voices with any other number of channels. If the value specified for MaxFrequencyRatio is too high for the specified format, the call to CreateSourceVoice fails and produces a debug message. Note XAudio2's memory usage can be reduced by using the lowest possible MaxFrequencyRatio value. No documentation. HRESULT IXAudio2::CreateSourceVoice([Out] IXAudio2SourceVoice** ppSourceVoice,[In] const WAVEFORMATEX* pSourceFormat,[None] UINT32 Flags,[None] float MaxFrequencyRatio,[In, Optional] IXAudio2VoiceCallback* pCallback,[In, Optional] const XAUDIO2_VOICE_SENDS* pSendList,[In, Optional] const XAUDIO2_EFFECT_CHAIN* pEffectChain)

Creates and configures a source voice.

an instance of [in] Pointer to a structure. This structure contains the expected format for all audio buffers submitted to the source voice. XAudio2 supports voice types of PCM, xWMA, ADPCM (Windows only), and XMA (Xbox 360 only). XAudio2 supports the following PCM formats. 8-bit (unsigned) integer PCM 16-bit integer PCM (Optimal format for XAudio2) 20-bit integer PCM (either in 24 or 32 bit containers) 24-bit integer PCM (either in 24 or 32 bit containers) 32-bit integer PCM 32-bit float PCM (Preferred format after 16-bit integer) The number of channels in a source voice must be less than or equal to XAUDIO2_MAX_AUDIO_CHANNELS. The sample rate of a source voice must be between XAUDIO2_MIN_SAMPLE_RATE and XAUDIO2_MAX_SAMPLE_RATE. Note Data formats such as XMA, {{ADPCM}}, and {{xWMA}} that require more information than provided by have a structure as the first member in their format structure. When creating a source voice with one of those formats cast the format's structure as a structure and use it as the value for pSourceFormat. [in] Flags that specify the behavior of the source voice. A flag can be 0 or a combination of one or more of the following: ValueDescriptionXAUDIO2_VOICE_NOPITCHNo pitch control is available on the voice.?XAUDIO2_VOICE_NOSRCNo sample rate conversion is available on the voice, the voice's outputs must have the same sample rate.Note The XAUDIO2_VOICE_NOSRC flag causes the voice to behave as though the XAUDIO2_VOICE_NOPITCH flag also is specified. ?XAUDIO2_VOICE_USEFILTERThe filter effect should be available on this voice.?XAUDIO2_VOICE_MUSICThe voice is used to play background music. The system automatically can replace the voice with music selected by the user.? [in] Highest allowable frequency ratio that can be set on this voice. The value for this argument must be between XAUDIO2_MIN_FREQ_RATIO and XAUDIO2_MAX_FREQ_RATIO. Subsequent calls to are clamped between XAUDIO2_MIN_FREQ_RATIO and MaxFrequencyRatio. The maximum value for this argument is defined as XAUDIO2_MAX_FREQ_RATIO, which allows pitch to be raised by up to 10 octaves. If MaxFrequencyRatio is less than 1.0, the voice will use that ratio immediately after being created (rather than the default of 1.0). Xbox 360 For XMA voices there is an additional restriction on the MaxFrequencyRatio argument and the voice's sample rate. The product of these two numbers cannot exceed XAUDIO2_MAX_RATIO_TIMES_RATE_XMA_MONO for one-channel voices or XAUDIO2_MAX_RATIO_TIMES_RATE_XMA_MULTICHANNEL for voices with any other number of channels. If the value specified for MaxFrequencyRatio is too high for the specified format, the call to CreateSourceVoice fails and produces a debug message. Note XAudio2's memory usage can be reduced by using the lowest possible MaxFrequencyRatio value. [in, optional] Pointer to a client-provided callback interface, . No documentation. HRESULT IXAudio2::CreateSourceVoice([Out] IXAudio2SourceVoice** ppSourceVoice,[In] const WAVEFORMATEX* pSourceFormat,[None] UINT32 Flags,[None] float MaxFrequencyRatio,[In, Optional] IXAudio2VoiceCallback* pCallback,[In, Optional] const XAUDIO2_VOICE_SENDS* pSendList,[In, Optional] const XAUDIO2_EFFECT_CHAIN* pEffectChain)

Creates and configures a source voice with callback through delegates.

an instance of [in] Pointer to a structure. This structure contains the expected format for all audio buffers submitted to the source voice. XAudio2 supports voice types of PCM, xWMA, ADPCM (Windows only), and XMA (Xbox 360 only). XAudio2 supports the following PCM formats. 8-bit (unsigned) integer PCM 16-bit integer PCM (Optimal format for XAudio2) 20-bit integer PCM (either in 24 or 32 bit containers) 24-bit integer PCM (either in 24 or 32 bit containers) 32-bit integer PCM 32-bit float PCM (Preferred format after 16-bit integer) The number of channels in a source voice must be less than or equal to XAUDIO2_MAX_AUDIO_CHANNELS. The sample rate of a source voice must be between XAUDIO2_MIN_SAMPLE_RATE and XAUDIO2_MAX_SAMPLE_RATE. Note Data formats such as XMA, {{ADPCM}}, and {{xWMA}} that require more information than provided by have a structure as the first member in their format structure. When creating a source voice with one of those formats cast the format's structure as a structure and use it as the value for pSourceFormat. [in] Flags that specify the behavior of the source voice. A flag can be 0 or a combination of one or more of the following: ValueDescriptionXAUDIO2_VOICE_NOPITCHNo pitch control is available on the voice.?XAUDIO2_VOICE_NOSRCNo sample rate conversion is available on the voice, the voice's outputs must have the same sample rate.Note The XAUDIO2_VOICE_NOSRC flag causes the voice to behave as though the XAUDIO2_VOICE_NOPITCH flag also is specified. ?XAUDIO2_VOICE_USEFILTERThe filter effect should be available on this voice.?XAUDIO2_VOICE_MUSICThe voice is used to play background music. The system automatically can replace the voice with music selected by the user.? [in] Highest allowable frequency ratio that can be set on this voice. The value for this argument must be between XAUDIO2_MIN_FREQ_RATIO and XAUDIO2_MAX_FREQ_RATIO. Subsequent calls to are clamped between XAUDIO2_MIN_FREQ_RATIO and MaxFrequencyRatio. The maximum value for this argument is defined as XAUDIO2_MAX_FREQ_RATIO, which allows pitch to be raised by up to 10 octaves. If MaxFrequencyRatio is less than 1.0, the voice will use that ratio immediately after being created (rather than the default of 1.0). Xbox 360 For XMA voices there is an additional restriction on the MaxFrequencyRatio argument and the voice's sample rate. The product of these two numbers cannot exceed XAUDIO2_MAX_RATIO_TIMES_RATE_XMA_MONO for one-channel voices or XAUDIO2_MAX_RATIO_TIMES_RATE_XMA_MULTICHANNEL for voices with any other number of channels. If the value specified for MaxFrequencyRatio is too high for the specified format, the call to CreateSourceVoice fails and produces a debug message. Note XAudio2's memory usage can be reduced by using the lowest possible MaxFrequencyRatio value. True to enable delegate callbacks on this instance. Default is false No enableCallbackEvents. HRESULT IXAudio2::CreateSourceVoice([Out] IXAudio2SourceVoice** ppSourceVoice,[In] const WAVEFORMATEX* pSourceFormat,[None] UINT32 Flags,[None] float MaxFrequencyRatio,[In, Optional] IXAudio2VoiceCallback* pCallback,[In, Optional] const XAUDIO2_VOICE_SENDS* pSendList,[In, Optional] const XAUDIO2_EFFECT_CHAIN* pEffectChain)

Starts consumption and processing of audio by the voice. Delivers the result to any connected submix or mastering voices, or to the output device, with CommitNow changes.

No documentation. HRESULT IXAudio2SourceVoice::Start([None] UINT32 Flags,[None] UINT32 OperationSet)

Sets the frequency ratio.

The ratio.

Starts consumption and processing of audio by the voice. Delivers the result to any connected submix or mastering voices, or to the output device.

[in] Identifies this call as part of a deferred batch. See the {{XAudio2 Operation Sets}} overview for more information. No documentation. HRESULT IXAudio2SourceVoice::Start([None] UINT32 Flags,[None] UINT32 OperationSet)

No documentation.

No documentation. No documentation. No documentation. HRESULT IXAudio2SourceVoice::SubmitSourceBuffer([In] const XAUDIO2_BUFFER* pBuffer,[In, Optional] const XAUDIO2_BUFFER_WMA* pBufferWMA)

No documentation.

GetState void IXAudio2SourceVoice::GetState([Out] XAUDIO2_VOICE_STATE* pVoiceState)

No documentation.

GetFrequencyRatio void IXAudio2SourceVoice::GetFrequencyRatio([Out] float* pRatio)

No documentation.

SetSourceSampleRate HRESULT IXAudio2SourceVoice::SetSourceSampleRate([In] unsigned int NewSourceSampleRate)

Occurs just before the processing pass for the voice begins.

In order to use this delegate, this instance must have been intialized with events delegate support.

Occurs just after the processing pass for the voice ends.

In order to use this delegate, this instance must have been intialized with events delegate support.

Occurs when the voice has just finished playing a contiguous audio stream.

In order to use this delegate, this instance must have been intialized with events delegate support.

Occurs when the voice is about to start processing a new audio buffer.

In order to use this delegate, this instance must have been intialized with events delegate support.

Occurs when the voice finishes processing a buffer.

In order to use this delegate, this instance must have been intialized with events delegate support.

Occurs when a critical error occurs during voice processing.

In order to use this delegate, this instance must have been intialized with events delegate support.

Occurs when [voice error].

In order to use this delegate, this instance must have been intialized with events delegate support.

No documentation.

IXAudio2VoiceCallback

Called during each processing pass for each voice, just before XAudio2 reads data from the voice's buffer queue.

The number of bytes that must be submitted immediately to avoid starvation. This allows the implementation of just-in-time streaming scenarios; the client can keep the absolute minimum data queued on the voice at all times, and pass it fresh data just before the data is required. This model provides the lowest possible latency attainable with XAudio2. For xWMA and XMA data BytesRequired will always be zero, since the concept of a frame of xWMA or XMA data is meaningless. Note In a situation where there is always plenty of data available on the source voice, BytesRequired should always report zero, because it doesn't need any samples immediately to avoid glitching. void IXAudio2VoiceCallback::OnVoiceProcessingPassStart([None] UINT32 BytesRequired)

Called just after the processing pass for the voice ends.

void IXAudio2VoiceCallback::OnVoiceProcessingPassEnd()

Called when the voice has just finished playing a contiguous audio stream.

void IXAudio2VoiceCallback::OnStreamEnd()

Called when the voice is about to start processing a new audio buffer.

Context pointer that was assigned to the pContext member of the structure when the buffer was submitted. void IXAudio2VoiceCallback::OnBufferStart([None] void* pBufferContext)

Called when the voice finishes processing a buffer.

Context pointer assigned to the pContext member of the structure when the buffer was submitted. void IXAudio2VoiceCallback::OnBufferEnd([None] void* pBufferContext)

Called when the voice reaches the end position of a loop.

Context pointer that was assigned to the pContext member of the structure when the buffer was submitted. void IXAudio2VoiceCallback::OnLoopEnd([None] void* pBufferContext)

Called when a critical error occurs during voice processing.

Context pointer that was assigned to the pContext member of the structure when the buffer was submitted. The HRESULT code of the error encountered. void IXAudio2VoiceCallback::OnVoiceError([None] void* pBufferContext,[None] HRESULT Error)

No documentation.

IXAudio2SubmixVoice

Initializes a new instance of the class.

The native pointer.

Creates and configures a mastering voice on the default audio device, with stereo channels at 44100Hz.

an instance of HRESULT IXAudio2::CreateSubmixVoice([Out] IXAudio2SubmixVoice** ppSubmixVoice,[None] UINT32 InputChannels,[None] UINT32 InputSampleRate,[None] UINT32 Flags,[None] UINT32 DeviceIndex,[In, Optional] const XAUDIO2_EFFECT_CHAIN* pEffectChain)

Creates and configures a mastering voice on the default audio device and 44100Hz.

Creates and configures a mastering voice on the default audio device.

an instance of [in] Number of channels the mastering voice expects in its input audio. InputChannels must be less than or equal to XAUDIO2_MAX_AUDIO_CHANNELS. InputChannels can be set to XAUDIO2_DEFAULT_CHANNELS, with the default being determined by the current platform. Windows Attempts to detect the system speaker configuration setup. Xbox 360 Defaults to 5.1 surround. [in] Sample rate of the input audio data of the mastering voice. This rate must be a multiple of XAUDIO2_QUANTUM_DENOMINATOR. InputSampleRate must be between XAUDIO2_MIN_SAMPLE_RATE and XAUDIO2_MAX_SAMPLE_RATE. InputSampleRate can be set to XAUDIO2_DEFAULT_SAMPLERATE, with the default being determined by the current platform. Windows Windows XP defaults to 44100. Windows Vista and Windows 7 default to the setting specified in the Sound Control Panel. The default for this setting is 44100 (or 48000 if required by the driver). Xbox 360 Defaults to 48000. HRESULT IXAudio2::CreateSubmixVoice([Out] IXAudio2SubmixVoice** ppSubmixVoice,[None] UINT32 InputChannels,[None] UINT32 InputSampleRate,[None] UINT32 Flags,[None] UINT32 DeviceIndex,[In, Optional] const XAUDIO2_EFFECT_CHAIN* pEffectChain)

Creates and configures a submix voice.

an instance of [in] Number of channels in the input audio data of the submix voice. InputChannels must be less than or equal to XAUDIO2_MAX_AUDIO_CHANNELS. [in] Sample rate of the input audio data of submix voice. This rate must be a multiple of XAUDIO2_QUANTUM_DENOMINATOR. InputSampleRate must be between XAUDIO2_MIN_SAMPLE_RATE and XAUDIO2_MAX_SAMPLE_RATE. [in] Flags that specify the behavior of the submix voice. Can be 0 or the following: ValueDescriptionXAUDIO2_VOICE_USEFILTERThe filter effect should be available on this voice.? [in] An arbitrary number that specifies when this voice is processed with respect to other submix voices, if the XAudio2 engine is running other submix voices. The voice is processed after all other voices that include a smaller ProcessingStage value, and before all other voices that include a larger ProcessingStage value. Voices that include the same ProcessingStage value are processed in any order. A submix voice cannot send to another submix voice with a lower or equal ProcessingStage value; this prevents audio being lost due to a submix cycle. No documentation. HRESULT IXAudio2::CreateSubmixVoice([Out] IXAudio2SubmixVoice** ppSubmixVoice,[None] UINT32 InputChannels,[None] UINT32 InputSampleRate,[None] UINT32 Flags,[None] UINT32 ProcessingStage,[In, Optional] const XAUDIO2_VOICE_SENDS* pSendList,[In, Optional] const XAUDIO2_EFFECT_CHAIN* pEffectChain)

No documentation.

IXAudio2

Initializes a new instance of the class.

The native pointer.

Constant CLSID_XAudio2.

CLSID_XAudio2

Constant CLSID_XAudio2_Debug.

CLSID_XAudio2_Debug

Constant IID_IXAudio2.

IID_IXAudio2

No documentation.

No documentation. No documentation. HRESULT IXAudio2::GetDeviceCount([Out] unsigned int* pCount)

No documentation.

No documentation. No documentation. No documentation. HRESULT IXAudio2::GetDeviceDetails([In] unsigned int Index,[Out] XAUDIO2_DEVICE_DETAILS* pDeviceDetails)

No documentation.

No documentation. No documentation. No documentation. HRESULT IXAudio2::Initialize([In] unsigned int Flags,[In] XAUDIO2_WINDOWS_PROCESSOR_SPECIFIER XAudio2Processor)

No documentation.

No documentation. No documentation. HRESULT IXAudio2::RegisterForCallbacks([In] IXAudio2EngineCallback* pCallback)

No documentation.

No documentation. void IXAudio2::UnregisterForCallbacks([In] IXAudio2EngineCallback* pCallback)

No documentation.

No documentation. No documentation. No documentation. No documentation. No documentation. No documentation. No documentation. No documentation. HRESULT IXAudio2::CreateSourceVoice([Out, Fast] IXAudio2SourceVoice** ppSourceVoice,[In] const WAVEFORMATEX* pSourceFormat,[In] XAUDIO2_VOICE_FLAGS Flags,[In] float MaxFrequencyRatio,[In, Optional] IXAudio2VoiceCallback* pCallback,[In, Optional] const XAUDIO2_VOICE_SENDS* pSendList,[In, Optional] const XAUDIO2_EFFECT_CHAIN* pEffectChain)

No documentation.

No documentation. No documentation. No documentation. No documentation. No documentation. No documentation. No documentation. No documentation. HRESULT IXAudio2::CreateSubmixVoice([Out, Fast] IXAudio2SubmixVoice** ppSubmixVoice,[In] unsigned int InputChannels,[In] unsigned int InputSampleRate,[In] XAUDIO2_VOICE_SEND_FLAGS Flags,[In] unsigned int ProcessingStage,[In, Optional] const XAUDIO2_VOICE_SENDS* pSendList,[In, Optional] const XAUDIO2_EFFECT_CHAIN* pEffectChain)

No documentation.

No documentation. No documentation. No documentation. No documentation. No documentation. No documentation. No documentation. HRESULT IXAudio2::CreateMasteringVoice([Out, Fast] IXAudio2MasteringVoice** ppMasteringVoice,[In] unsigned int InputChannels,[In] unsigned int InputSampleRate,[In] unsigned int Flags,[In] unsigned int DeviceIndex,[In, Optional] const XAUDIO2_EFFECT_CHAIN* pEffectChain)

No documentation.

No documentation. HRESULT IXAudio2::StartEngine()

No documentation.

void IXAudio2::StopEngine()

No documentation.

No documentation. No documentation. HRESULT IXAudio2::CommitChanges([In] unsigned int OperationSet)

No documentation.

No documentation. void IXAudio2::GetPerformanceData([Out] XAUDIO2_PERFORMANCE_DATA* pPerfData)

No documentation.

No documentation. No documentation. void IXAudio2::SetDebugConfiguration([In, Optional] const XAUDIO2_DEBUG_CONFIGURATION* pDebugConfiguration,[In, Optional] void* pReserved)

Initializes a new instance of the class.

Specify a Debug or Normal XAudio2 instance. The processor specifier.

Returns information about an audio output device.

[in] Index of the device to be queried. This value must be less than the count returned by . On success, pointer to an structure that is returned. HRESULT IXAudio2::GetDeviceDetails([None] UINT32 Index,[Out] XAUDIO2_DEVICE_DETAILS* pDeviceDetails)

Calculate a decibel from a volume.

The volume. a dB value

Calculate radians from a cutoffs frequency.

The cutoff frequency. The sample rate. radian

Calculate a cutoff frequency from a radian.

The radians. The sample rate. cutoff frequency

Calculate a volume from a decibel

a dB value an amplitude value

Calculate semitones from a Frequency ratio

The frequency ratio. semitones

Calculate frequency from semitones.

The semitones. the frequency

Atomically applies a set of operations for all pending operations.

HRESULT IXAudio2::CommitChanges([None] UINT32 OperationSet)

No documentation.

GetDeviceCount HRESULT IXAudio2::GetDeviceCount([Out] unsigned int* pCount)

No documentation.

GetPerformanceData void IXAudio2::GetPerformanceData([Out] XAUDIO2_PERFORMANCE_DATA* pPerfData)

Called by XAudio2 just before an audio processing pass begins.

Called by XAudio2 just after an audio processing pass ends.

Called if a critical system error occurs that requires XAudio2 to be closed down and restarted.

No documentation.

XAUDIO2_EFFECT_DESCRIPTOR

Initializes a new instance of the class with a Stereo Effect.

The effect.

Initializes a new instance of the class.

The effect. The output channel count.

No documentation.

IUnknown* pEffect

No documentation.

unsigned int OutputChannels

Gets or sets the AudioProcessor. The AudioProcessor cannot be set more than one.

The effect.

No documentation.

BOOL InitialState

A Reverb XAudio2 AudioProcessor.

Initializes a new instance of the class.

No documentation.

XAUDIO2FX_REVERB_I3DL2_PARAMETERS

No documentation.

float WetDryMix

No documentation.

int Room

No documentation.

int RoomHF

No documentation.

float RoomRolloffFactor

No documentation.

float DecayTime

No documentation.

float DecayHFRatio

No documentation.

int Reflections

No documentation.

float ReflectionsDelay

No documentation.

int Reverb

No documentation.

float ReverbDelay

No documentation.

float Diffusion

No documentation.

float Density

No documentation.

float HFReference

No documentation.

XAUDIO2FX_REVERB_PARAMETERS

No documentation.

float WetDryMix

No documentation.

unsigned int ReflectionsDelay

No documentation.

unsigned char ReverbDelay

No documentation.

unsigned char RearDelay

No documentation.

unsigned char PositionLeft

No documentation.

unsigned char PositionRight

No documentation.

unsigned char PositionMatrixLeft

No documentation.

unsigned char PositionMatrixRight

No documentation.

unsigned char EarlyDiffusion

No documentation.

unsigned char LateDiffusion

No documentation.

unsigned char LowEQGain

No documentation.

unsigned char LowEQCutoff

No documentation.

unsigned char HighEQGain

No documentation.

unsigned char HighEQCutoff

No documentation.

float RoomFilterFreq

No documentation.

float RoomFilterMain

No documentation.

float RoomFilterHF

No documentation.

float ReflectionsGain

No documentation.

float ReverbGain

No documentation.

float DecayTime

No documentation.

float Density

No documentation.

float RoomSize

No documentation.

XAUDIO2FX_VOLUMEMETER_LEVELS

No documentation.

float* pPeakLevels

No documentation.

float* pRMSLevels

No documentation.

unsigned int ChannelCount

No documentation.

XAUDIO2_BUFFER

Constant LoopInfinite.

XAUDIO2_LOOP_INFINITE

No documentation.

XAUDIO2_BUFFER_FLAGS Flags

No documentation.

unsigned int AudioBytes

No documentation.

const unsigned char* pAudioData

No documentation.

unsigned int PlayBegin

No documentation.

unsigned int PlayLength

No documentation.

unsigned int LoopBegin

No documentation.

unsigned int LoopLength

No documentation.

unsigned int LoopCount

No documentation.

void* pContext

Gets or sets the datastream associated to this audio buffer

The stream.

No documentation.

XAUDIO2_BUFFER_FLAGS

No documentation.

XAUDIO2_END_OF_STREAM

None.

None

No documentation.

XAUDIO2_DEVICE_ROLE

No documentation.

NotDefaultDevice

No documentation.

DefaultConsoleDevice

No documentation.

DefaultMultimediaDevice

No documentation.

DefaultCommunicationsDevice

No documentation.

DefaultGameDevice

No documentation.

GlobalDefaultDevice

No documentation.

InvalidDeviceRole

No documentation.

XAUDIO2_FILTER_TYPE

No documentation.

LowPassFilter

No documentation.

BandPassFilter

No documentation.

HighPassFilter

No documentation.

NotchFilter

No documentation.

XAUDIO2_LOG_TYPE

No documentation.

XAUDIO2_LOG_ERRORS

No documentation.

XAUDIO2_LOG_WARNINGS

No documentation.

XAUDIO2_LOG_INFO

No documentation.

XAUDIO2_LOG_DETAIL

No documentation.

XAUDIO2_LOG_API_CALLS

No documentation.

XAUDIO2_LOG_FUNC_CALLS

No documentation.

XAUDIO2_LOG_TIMING

No documentation.

XAUDIO2_LOG_LOCKS

No documentation.

XAUDIO2_LOG_MEMORY

No documentation.

XAUDIO2_LOG_STREAMING

No documentation.

XAUDIO2_PLAY_FLAGS

No documentation.

XAUDIO2_PLAY_TAILS

None.

None

No documentation.

XAUDIO2_WINDOWS_PROCESSOR_SPECIFIER

No documentation.

Processor1

No documentation.

Processor2

No documentation.

Processor3

No documentation.

Processor4

No documentation.

Processor5

No documentation.

Processor6

No documentation.

Processor7

No documentation.

Processor8

No documentation.

Processor9

No documentation.

Processor10

No documentation.

Processor11

No documentation.

Processor12

No documentation.

Processor13

No documentation.

Processor14

No documentation.

Processor15

No documentation.

Processor16

No documentation.

Processor17

No documentation.

Processor18

No documentation.

Processor19

No documentation.

Processor20

No documentation.

Processor21

No documentation.

Processor22

No documentation.

Processor23

No documentation.

Processor24

No documentation.

Processor25

No documentation.

Processor26

No documentation.

Processor27

No documentation.

Processor28

No documentation.

Processor29

No documentation.

Processor30

No documentation.

Processor31

No documentation.

Processor32

No documentation.

XAUDIO2_ANY_PROCESSOR

No documentation.

XAUDIO2_DEFAULT_PROCESSOR

No documentation.

XAUDIO2_VOICE_FLAGS

No documentation.

XAUDIO2_VOICE_NOPITCH

No documentation.

XAUDIO2_VOICE_NOSRC

No documentation.

XAUDIO2_VOICE_MUSIC

None.

None

No documentation.

XAUDIO2_VOICE_SEND_FLAGS

No documentation.

XAUDIO2_VOICE_USEFILTER

None.

None

No documentation.

XAUDIO2_FLAGS

No documentation.

XAUDIO2_DEBUG_ENGINE

None.

None

No documentation.

XAUDIO2_BUFFER_WMA

No documentation.

const unsigned int* pDecodedPacketCumulativeBytes

No documentation.

unsigned int PacketCount

No documentation.

XAUDIO2_DEBUG_CONFIGURATION

No documentation.

unsigned int TraceMask

No documentation.

unsigned int BreakMask

No documentation.

BOOL LogThreadID

No documentation.

BOOL LogFileline

No documentation.

BOOL LogFunctionName

No documentation.

BOOL LogTiming

No documentation.

XAUDIO2_DEVICE_DETAILS

No documentation.

wchar_t DeviceID[256]

No documentation.

wchar_t DisplayName[256]

No documentation.

XAUDIO2_DEVICE_ROLE Role

No documentation.

WAVEFORMATEXTENSIBLE OutputFormat

No documentation.

XAUDIO2_EFFECT_CHAIN

No documentation.

unsigned int EffectCount

No documentation.

XAUDIO2_EFFECT_DESCRIPTOR* pEffectDescriptors

No documentation.

XAUDIO2_FILTER_PARAMETERS

No documentation.

XAUDIO2_FILTER_TYPE Type

No documentation.

float Frequency

No documentation.

float OneOverQ

No documentation.

XAUDIO2_PERFORMANCE_DATA

No documentation.

unsigned longlong AudioCyclesSinceLastQuery

No documentation.

unsigned longlong TotalCyclesSinceLastQuery

No documentation.

unsigned int MinimumCyclesPerQuantum

No documentation.

unsigned int MaximumCyclesPerQuantum

No documentation.

unsigned int MemoryUsageInBytes

No documentation.

unsigned int CurrentLatencyInSamples

No documentation.

unsigned int GlitchesSinceEngineStarted

No documentation.

unsigned int ActiveSourceVoiceCount

No documentation.

unsigned int TotalSourceVoiceCount

No documentation.

unsigned int ActiveSubmixVoiceCount

No documentation.

unsigned int ActiveResamplerCount

No documentation.

unsigned int ActiveMatrixMixCount

No documentation.

unsigned int ActiveXmaSourceVoices

No documentation.

unsigned int ActiveXmaStreams

No documentation.

XAUDIO2_VOICE_DETAILS

No documentation.

unsigned int CreationFlags

No documentation.

unsigned int InputChannels

No documentation.

unsigned int InputSampleRate

No documentation.

XAUDIO2_SEND_DESCRIPTOR

No documentation.

XAUDIO2_VOICE_SEND_FLAGS Flags

No documentation.

IXAudio2Voice* pOutputVoice

Initializes a new instance of the struct.

The output voice.

Initializes a new instance of the struct.

The send flags. The output voice.

Gets or sets the output voice. This parameter cannot be null.

The output voice.

No documentation.

XAUDIO2_VOICE_SENDS

No documentation.

unsigned int SendCount

No documentation.

XAUDIO2_SEND_DESCRIPTOR* pSends

No documentation.

XAUDIO2_VOICE_STATE

No documentation.

void* pCurrentBufferContext

No documentation.

unsigned int BuffersQueued

No documentation.

unsigned longlong SamplesPlayed

EventArgs used by .

Initializes a new instance of the class.

The error code.

Gets or sets the error code.

The error code.

Functions

Internal VoiceCallback callback Impl

Return a pointer to the unamanged version of this callback.

The callback. A pointer to a shadow c++ callback

XAudio2FxContants Functions.

Constant None.

Internal EngineCallback Callback Impl

Return a pointer to the unamanged version of this callback.

The callback. A pointer to a shadow c++ callback

Called by XAudio2 just after an audio processing pass ends.

void IXAudio2EngineCallback::OnProcessingPassEnd()

Called if a critical system error occurs that requires XAudio2 to be closed down and restarted.

This pointer Error code returned by XAudio2. void IXAudio2EngineCallback::OnCriticalError([None] HRESULT Error)

A VolumeMeter XAudio2 AudioProcessor.

Initializes a new instance of the class.