IXACTEngine::Stop

Stops a sound category.

STDAPI Stop(
  XACTCATEGORY nCategory,
  DWORD dwFlags
);

Parameters

nCategory

[in] Index of the category (XACTCATEGORY) to stop, as returned by IXACTEngine::GetCategory.

dwFlags

[in] Flag that specifies how the category will be stopped. By default, the sounds complete whatever release phase the content has set up.

Value	Description
XACT_FLAG_API_STOP_IMMEDIATE	Category 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

IXACTEngine | IXACTEngine::GetCategory