| Microsoft DirectX 9.0 |
The GetStatus method retrieves the status of the sound buffer.
Syntax
HRESULT GetStatus(
LPDWORD pdwStatus
);
Parameters
pdwStatus
Address of a variable that receives the status of the sound buffer. The status can be a combination of the following flags:
| Value | 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. This value is returned only in combination with DSBSTATUS_PLAYING. |
| DSBSTATUS_PLAYING | The buffer is playing. If this value is not set, the buffer is stopped. |
| DSBSTATUS_LOCSOFTWARE | The buffer is playing in software. Set only for buffers created with the DSBCAPS_LOCDEFER flag. |
| DSBSTATUS_LOCHARDWARE | The buffer is playing in hardware. Set only for buffers created with the DSBCAPS_LOCDEFER flag. |
| DSBSTATUS_TERMINATED | The buffer was prematurely terminated by the voice manager and is not playing. Set only for buffers created with the DSBCAPS_LOCDEFER flag. |
Remarks
DSBSTATUS_PLAYING is set if the buffer is being heard. Because of latency, a call to IDirectSoundBuffer8::Play or IDirectSoundBuffer8::Stop might not immediately change the status.
Return Values
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.
See Also