Wwise SDK 2021.1.14

Creates a transport object for the given Wwise object. The return transport object can be used to play, stop, pause and resume the Wwise object via the other transport functions.

Arguments

Name	Type	Description
object *	any of:	The ID (GUID), name, or path of the object to control via the transport object.
	string	The name of the object qualified by its type in the form of type:name. Only object types that have globally-unique names are supported. Ex: Event:Play_Sound_01
	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.
gameObject	integer	The game object to use for playback. A game object ID, unsigned integer 64-bit. Range: [0,18446744073709551615]

(Required *)

Arguments Schema

Result

Name	Type	Description
transport	integer	Transport object ID to be used with all other ak.wwise.core.transport functions. Unsigned Integer 32-bit. Range: [0,4294967295]

Result Schema

Examples

Creating a transport object

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.

Get started with Wwise