IXACTEngine::Stop

  • Article

IXACTEngine::Stop

Stops a sound category.

[Content-driven]

  HRESULT 
  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 is stopped. By default, the sounds complete whatever release phase the content has set up.

Return Values

Returns S_OK if successful. Otherwise, an error code.

Requirements

Header: Declared in Xact.h.

Library: Use Xact.lib.

See Also

IXACTEngine | IXACTEngine::GetCategory