Version

menu_open
Wwise SDK 2023.1.4
ak.wwise.core.sound.setActiveSource

Sets which version of the source is being used for the specified sound. Use ak.wwise.core.object.get with the 'activeSource' return option to get the active source of a sound.

Arguments

Name Type Description
sound * any of: Sound ID (GUID), name, or path.
string The name of the object qualified by its type or Short ID in the form of type:name or Global:shortId. Only object types that have globally-unique names or Short Ids are supported. Ex: Event:Play_Sound_01, Global:245489792
string An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
string A project path to a Wwise object, including the category and the work-unit. For example: \Actor-Mixer Hierarchy\Default Work Unit\New Sound SFX.
source * any of: Source ID (GUID), name, or path. The source must be a child of the sound.
string The name of the object qualified by its type or Short ID in the form of type:name or Global:shortId. Only object types that have globally-unique names or Short Ids are supported. Ex: Event:Play_Sound_01, Global:245489792
string An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
string A project path to a Wwise object, including the category and the work-unit. For example: \Actor-Mixer Hierarchy\Default Work Unit\New Sound SFX.
platform any of: Platform ID (GUID) or name. This is an optional argument. When not specified, the current platform is used.
string The name of the object.
string An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.

(Required *)

Arguments Schema

See Also

Examples

Refer to Using the Wwise Authoring API (WAAPI) for more information about Wwise Authoring API.


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