IXAudio2SourceVoice::GetFrequencyRatio Method

Returns the frequency adjustment ratio of the voice.

Syntax

public:
void GetFrequencyRatio(
         float *pRatio
)  

Parameters

pRatio
Type: float *

[out] Returns the current frequency adjustment ratio if successful.

Return value

None.

Remarks

GetFrequencyRatio always returns the voice’s actual current frequency ratio. However, this may not match the ratio set by the most recent IXAudio2SourceVoice::SetFrequencyRatio call: the actual ratio is only changed the next time the audio engine runs after the IXAudio2SourceVoice::SetFrequencyRatio call (or after the corresponding IXAudio2::CommitChanges call, if IXAudio2SourceVoice::SetFrequencyRatio was called with a deferred operation ID).

For information on frequency ratios, see IXAudio2SourceVoice::SetFrequencyRatio.

Requirements

Header: Declared in xaudio2.h.

Library: Use xaudio2.lib.

See also

IXAudio2SourceVoice

IXAudio2SourceVoice Members