IDirectSoundBuffer::GetCurrentPosition
[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.]
This method retrieves the current position of the play and write cursors in the sound buffer.
Syntax
HRESULT GetCurrentPosition( LPDWORD lpdwCurrentPlayCursor, LPDWORD lpdwCurrentWriteCursor );
Parameters
- lpdwCurrentPlayCursor
Address of a variable to contain the current play position in the DirectSoundBuffer object. This position is an offset within the sound buffer and is specified in bytes. This parameter can be NULL if the current play position is not wanted. - lpdwCurrentWriteCursor
Address of a variable to contain the current write position in the DirectSoundBuffer object. This position is an offset within the sound buffer and is specified in bytes. This parameter can be NULL if the current write position is not wanted.
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:
| DSERR_INVALIDPARAM |
| DSERR_PRIOLEVELNEEDED |
Remarks
The write cursor indicates the position at which it is safe to write new data to the buffer. The write cursor always leads the play cursor, typically by about 15 milliseconds' worth of audio data.
It is always safe to change data that is behind the position indicated by the lpdwCurrentPlayCursor parameter.
Requirements
Header: Declared in DSound.h.
Library: Use Dsound.lib.