IDirectSoundBuffer::GetStatus

  • Article

[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 status of the sound buffer.

Syntax

HRESULT GetStatus( LPDWORD lpdwStatus );

Parameters

  • lpdwStatus
    Address of a variable to contain the status of the sound buffer. The status can be a combination of the following flags.
    Flag Description
    DSBSTATUS_BUFFERLOST The buffer is lost and must be restored before it can be played or locked.
    DSBSTATUS_LOOPING The buffer is being looped. If this value is not set, the buffer will stop when it reaches the end of the sound data. Note that if this value is set, the buffer must also be playing.
    DSBSTATUS_PLAYING The buffer is playing. If this value is not set, the buffer is stopped.

Return Value

If the method succeeds, the return value is DS_OK.

If the method fails, the return value may be DSERR_INVALIDPARAM.

Requirements

Header: Declared in DSound.h.

Library: Use Dsound.lib.

See Also

IDirectSoundBuffer