Version
menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2024.1.1.8691 ). 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 2024.1.1
ak.soundengine.setSwitch

Sets the State of a Switch Group. See AK::SoundEngine::SetSwitch.

Arguments

Name Type Description
switchGroup * any of: Either the ID (GUID), name, or short ID of the Switch Group.
string The name of the object.
string An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
integer The Short ID of a Wwise Object.
Unsigned Integer 32-bit. Range: [0,4294967295]
switchState * any of: Either the ID (GUID), name, or Short ID of the Switch State.
string The name of the object.
string An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
integer The Short ID of a Wwise Object.
Unsigned Integer 32-bit. Range: [0,4294967295]
gameObject integer Associated game object ID. Its default value is the transport game object.
A game object ID, unsigned integer 64-bit. Range: [0,18446744073709551615]

(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