 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::SetFrequencymethod sets the frequency at which the audio samples are played.
HRESULT SetFrequency( DWORD dwFrequency );
Parameters
- dwFrequency
- New frequency, in hertz (Hz), at which to play the audio
samples. The value must be in the range DSBFREQUENCY_MIN to
DSBFREQUENCY_MAX. These values are currently defined in Dsound.h as
100 and 100,000 respectively.
If the value is DSBFREQUENCY_ORIGINAL, the frequency is reset to the default value in the current buffer format. This format is specified in the IDirectSound::CreateSoundBuffermethod.
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:
Remarks
Increasing or decreasing the frequency changes the perceived pitch of the audio data. This method does not affect the format of the buffer.
This method is not valid for primary sound buffers.
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.
See Also
IDirectSoundBuffer, IDirectSound::CreateSoundBuffer, IDirectSoundBuffer::GetFrequency, IDirectSoundBuffer::Play, IDirectSoundBuffer::SetFormat