Microsoft DirectX 8.0 (C++) |
Stops playback of a segment or segment state.
This method has been superseded by IDirectMusicPerformance8::StopEx, which can stop playback of a segment, segment state, or audiopath.
HRESULT Stop( IDirectMusicSegment* pSegment, IDirectMusicSegmentState* pSegmentState, MUSIC_TIME mtTime, DWORD dwFlags );
If the method succeeds, the return value is S_OK.
If it fails, the method can return E_POINTER.
If pSegment and pSegmentState are both NULL, all music stops, and all currently cued segments are released. If either pSegment or pSegmentState is not NULL, only the requested segment states are removed from the performance. If both are non-NULL and DMUS_SEGF_DEFAULT is used, the default resolution from the pSegment is used.
If you set all parameters to NULL or 0, everything stops immediately, and controller reset messages and note-off messages are sent to all mapped performance channels.
Header: Declared in dmusici.h.
IDirectMusicPerformance8::PlaySegment, IDirectMusicPerformance8::PlaySegmentEx, IDirectMusicPerformance8::StopEx, DMUS_SEGF_FLAGS