Version
menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2022.1.17.8543 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.
Wwise SDK 2022.1.17

◆ UnsetMedia()

AKSOUNDENGINE_API AKRESULT AK::SoundEngine::UnsetMedia ( AkSourceSettings *  in_pSourceSettings,
AkUInt32  in_uNumSourceSettings 
)

Removes the specified source from the list of loaded media, even if this media is already in use. The sources are identified by their ID (refer to General Information for a discussion on using strings and IDs).

Note: This function is unsafe and deprecated. Use TryUnsetMedia() in its place. Media that is still in use by the sound engine should not be unset by this function. If the media is still in use, this function will attempt to forcibly kill all sounds and effects referencing this media, and then return AK_ResourceInUse. The client should NOT presume that the memory can be safely released at this point. The moment at which the memory can be safely released is unknown, and the only safe course of action is to keep the memory alive until the sound engine is terminated.
Returns
  • AK_Success: Operation was successful, and the memory can be released on the client side.
  • AK_ResourceInUse: Specified media is still in use by the sound engine, the client should not release the memory.
  • AK_InvalidParameter: in_pSourceSettings is invalid
Parameters
in_pSourceSettingsArray of Source Settings
in_uNumSourceSettingsNumber of Source Settings in the array

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise