IDirectSoundBuffer8::SetCurrentPosition Method
[The feature associated with this page, DirectSound, is a legacy feature. It has been superseded by WASAPI and Audio Graphs. Media Casting have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use Media Casting instead of DirectSound, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
The SetCurrentPosition method sets the position of the play cursor, which is the point at which the next byte of data is read from the buffer.
Syntax
HRESULT SetCurrentPosition(
DWORD dwNewPosition
)
Parameters
- dwNewPosition
Offset of the play cursor, in bytes, from the beginning of the buffer.
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_INVALIDCALL |
| DSERR_INVALIDPARAM |
| DSERR_PRIOLEVELNEEDED |
Remarks
This method cannot be called on the primary buffer.
If the buffer is playing, the cursor immediately moves to the new position and play continues from that point. If it is not playing, playback will begin from the new position the next time the Play method is called.
Requirements
Header: Declared in DSound.h.
Library: Use Dsound3d.dll.