| Microsoft DirectX 9.0 SDK Update (Summer 2004) |
IDirectMusicPerformance8::GetSegmentState
The GetSegmentState method retrieves the currently playing primary segment state or the primary segment state that is playing at a given time.
Syntax
HRESULT GetSegmentState(
IDirectMusicSegmentState ** ppSegmentState,
MUSIC_TIME mtTime
);
Parameters
ppSegmentState
Address of a variable that receives a pointer to the segment state. The caller is responsible for calling Release on this pointer.
mtTime
Time for which the segment state is to be retrieved.
Return Values
If the method succeeds, the return value is S_OK.
If it fails, the method can return one of the error values shown in the following table.
| Return code |
| DMUS_E_NOT_FOUND |
| E_POINTER |
Remarks
To get the currently playing segment state, pass the time returned by the IDirectMusicPerformance8::GetTime method. Because of latency, the currently playing segment state is not necessarily the one being heard.
Requirements
Header: Declared in dmusici.h.
See Also
© 2004 Microsoft Corporation. All rights reserved.