IDirectSoundBuffer8::GetFrequency Method

The GetFrequency method retrieves the frequency, in samples per second, at which the buffer is playing.

Syntax

HRESULT GetFrequency(
         LPDWORD pdwFrequency
)

Parameters

  • pdwFrequency
    Address of a variable that receives the frequency at which the audio buffer is being played, in hertz.

Return Value

If the method succeeds, the return value is DS_OK. If the method fails, the return value may be one of the following error values:

Return code
DSERR_CONTROLUNAVAIL
DSERR_INVALIDPARAM
DSERR_PRIOLEVELNEEDED

Remarks

The frequency value for software buffers is in the range of DSBFREQUENCY_MIN to DSBFREQUENCY_MAX, defined in Dsound.h. Hardware buffers can return other values.

Requirements

Header: Declared in DSound.h.

Library: Use Dsound3d.dll.

See Also

IDirectSoundBuffer8