IDirectSoundBuffer::GetFrequency

Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

The IDirectSoundBuffer::GetFrequencymethod retrieves the frequency, in samples per second, at which the buffer is playing.

HRESULT GetFrequency(
LPDWORD
lpdwFrequency
);

Parameters

lpdwFrequency

Address of the variable that represents the frequency at which the audio buffer is being played.

Return Values

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:

DSERR_CONTROLUNAVAIL

DSERR_INVALIDPARAM

DSERR_PRIOLEVELNEEDED

Remarks

The frequency value will be in the range of DSBFREQUENCY_MIN to DSBFREQUENCY_MAX. These values are currently defined in Dsound.h as 100 and 100,000 respectively.

Requirements

Runs On	Versions	Defined in	Include	Link to
Windows CE OS	2.12 or later. Version 2.12 requires DXPAK 1.0 or later.	dsound.h		dsound.lib

Note This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.