IDirectSoundBuffer::SetCurrentPosition

Article
06/03/2016

[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 moves the current play position for secondary sound buffers.

Syntax

HRESULT SetCurrentPosition( DWORD dwNewPosition );

Parameters

dwNewPosition
New position, in bytes, from the beginning of the buffer that will be used when the sound buffer is played.

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_INVALIDCALL

DSERR_INVALIDPARAM

DSERR_PRIOLEVELNEEDED

Remarks

This method cannot be called on primary sound buffers.

If the buffer is playing, it will immediately move to the new position and continue. If it is not playing, it will begin from the new position the next time the IDirectSoundBuffer::Play method is called.

Requirements

Header: Declared in DSound.h.

Library: Use Dsound.lib.