IXACTSoundBank::Stop

Stops a cue.

HRESULT Stop(
  XACTINDEX nCueIndex,
  DWORD dwFlags
);

Parameters

nCueIndex

[in] Index of the cue to be stopped.

Note    All instances of the cue specified by nCueIndex will be stopped.

dwFlags

[in] Flags affecting how the cue will be stopped. By default, the sound will complete whatever release phase the content has set up.

Value	Description
XACT_FLAG_SOUNDBANK_STOP_IMMEDIATE	Cue should stop immediately, ignoring any release phase or transition specified in the content.

Return Values

Returns S_OK if successful, an error code otherwise.

Requirements

Header: Declared in Xact.h.

See Also

IXACTSoundBank