stingray.WwiseWorld object reference

Description

This object provides access to functions for controlling sound events for a particular game World.

Constructors and accessors

stingray.Wwise.wwise_world()

Related sample code

Character template: /player.lua

Other related reference items

	stingray.Wwise.wwise_world()
	Wwise Sound

Related help topics

	Working with Audio > Wwise audio basics > About audio sources > Configure an audio source
	Working with Audio > Wwise authoring tool
	Working with Audio > Wwise Lua functions

Listeners

add_default_listeners ( self, listener_id ) Adds the given listener to the list of default listeners.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
listener_id :	integer	The Id of the listener to set as a default. Use Wwise.LISTENER_0 through Wwise.LISTENER_7.

Returns

This function does not return any values.

When a new source is created, it is added to the default listeners. By default, the only default listener is Wwise.LISTENER_0.

remove_default_listeners ( self, listener_id ) Removes the given listener from the default listeners list.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
listener_id :	integer	The id of the listener to remove from the list of default listeners. Use Wwise.LISTENER_0 through Wwise.LISTENER_7.

Returns

This function does not return any values.

set_listener ( self, listener_id, transform ) Sets the listener to the specified position.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
listener_id :	integer	The index of the listener to set. Use Wwise.LISTENER_0 through Wwise.LISTENER_7.
transform :	stingray.Matrix4x4	The new position and rotation for the specified listener.

Returns

This function does not return any values.

8 listeners are supported.

Related sample code

Appkit: /camera_wrapper.lua Oculus VR template: /project.lua

Sources

add_soundscape_listener ( self, listener_id ) Adds the specified listener to the WwiseWorld's soundscape.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
listener_id :	integer	The numeric ID of the listener to assign. Use Wwise.LISTENER_0 through Wwise.LISTENER_7.

Returns

This function does not return any values.

When a new source is created, its initial listener mask is set up with the list of default listeners. This function allows you to assign additional listeners to selected sources.

add_source_listeners ( self, source_id, listener_id ) Adds the specified listener to the specified source.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
source_id :	integer	The numeric ID of the source.
listener_id :	integer	The numeric ID of the listener to assign. Use Wwise.LISTENER_0 through Wwise.LISTENER_7.

Returns

This function does not return any values.

When a new source is created, its initial listener mask is set up with the list of default listeners. This function allows you to assign additional listeners to selected sources.

has_source ( self, source_id ) : boolean Indicates whether or not the given source exists (i.e. has a playing event).

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
source_id :	integer	The numeric ID of the source to look for.

Returns

boolean

true if a source exists with the specified ID, or false otherwise.

remove_soundscape_listener ( self, listener_id ) Removes the specified listener from the WwiseWorld's soundscape.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
listener_id :	integer	The numeric ID of the listener to remove from the source. Use Wwise.LISTENER_0 through Wwise.LISTENER_7.

Returns

This function does not return any values.

remove_source_listeners ( self, source_id, listener_id ) Removes the specified listener from the specified source.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
source_id :	integer	The numeric ID of the source.
listener_id :	integer	The numeric ID of the listener to remove from the source. Use Wwise.LISTENER_0 through Wwise.LISTENER_7.

Returns

This function does not return any values.

set_source_pose ( self, source_id, transform ) Moves the specified source to the specified position and rotation.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
source_id :	integer	The numeric ID of the source you want to move.
transform :	stingray.Matrix4x4	The new position and rotation for the specified source.

Returns

This function does not return any values.

set_source_position ( self, source_id, position ) Moves the specified source to the specified position.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
source_id :	integer	The numeric ID of the source you want to move.
position :	stingray.Vector3	The new position for the specified source.

Returns

This function does not return any values.

Events

destroy_manual_source ( self, source_id ) Destroys the given source.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
source_id :	integer	The numeric ID of an existing source.

Returns

This function does not return any values.

Destroying the source is required for sources which are created via make_manual_source() and configured for manual deletion. Any sounds currently playing on the source will become orphaned and continue to play until finished. For example if an event is playing on a unit source and that source is manually destroyed via destroy_manual_source(), the sound will continue to play at its last position. There is no way to re-attach the playing sound to another source. This function does not destroy sources which are set to be automatically destroyed when they have no active events.

Related sample code

Vehicle template: /vehicle_unit_controller.lua

get_playing_elapsed ( self, playing_id ) : number Returns time, in milliseconds, since the given event began playing.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
playing_id :	integer	The numeric ID of the playing event to obtain the position.

Returns

number

Time in milliseconds since start of event play.

Returns 0 if the given id does not correspond to a playing sound.

is_playing ( self, event_id ) : boolean Indicates whether or not the given playing event is active.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
event_id :	integer	The numeric ID of the active event.

Returns

boolean

true if a the id corresponds to a currently playing event, false otherwise.

make_auto_source ( self, pose ) : integer Creates a new Wwise object source for the given game source and returns the ID of the source.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
pose :	stingray.Matrix4x4	A Matrix4x4 used to create a new Wwise source.

Returns

integer

The ID of the source.

If invalid source input or other errors occur during source creation then WwiseWorldInterface::NO_SOURCE_ID will be returned. A Source created via make_auto_source is automatically cleaned up if it has no actively playing events.

make_auto_source ( self, unit, object ) : integer If the given unit matches an existing unit game source, the existing source id will be returned and the unit source lifetime will be set to be deleted when it has no active playing events.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
unit :	stingray.Unit	A Unit that will be used to create a new source or to find an existing source matching the given unit.
object :	integer?	This parameter can contain the numeric ID of an object within that unit. The ? notation indicates that this type is optional: there may be zero or one instances of it.

Returns

integer

The ID of the source.

If no existing matching unit source is found, then a new unit source will be created and its ID will be returned. If invalid source input or other errors occur during source creation then WwiseWorldInterface::NO_SOURCE_ID will be returned. A Source created via make_auto_source is automatically cleaned up if it has no actively playing events.

make_auto_source ( self, position, rotation ) : integer Creates a new Wwise object source for the given game source and returns the ID of the source.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
position :	stingray.Vector3	A Vector3 used to create a new Wwise source.
rotation :	stingray.Quaternion?	This parameter can be a Quaternion that indicates the source rotation. The ? notation indicates that this type is optional: there may be zero or one instances of it.

Returns

integer

The ID of the source.

If invalid source input or other errors occur during source creation then WwiseWorldInterface::NO_SOURCE_ID will be returned. A Source created via make_auto_source is automatically cleaned up if it has no actively playing events.

make_manual_source ( self, unit, object ) : integer If the given unit matches an existing unit game source, the existing source id will be returned and the unit source lifetime will be set to for manual deletion.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
unit :	stingray.Unit	A Unit that will be used to create a new source or to find an existing source matching the given unit.
object :	integer?	This parameter can contain the numeric ID of an object within that unit. The ? notation indicates that this type is optional: there may be zero or one instances of it.

Returns

integer

The ID of the source.

If no existing matching unit source is found, then a new unit manual delete source will be created and its ID will be returned. If invalid source input or other errors occur during source creation then WwiseWorldInterface::NO_SOURCE_ID will be returned. A Source created via make_manual_source() requires destroy_manual_source() to be called in order to cleanup the source.

make_manual_source ( self, position, rotation ) : integer Creates a new Wwise object source for the given game source, and returns the ID of the source.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
position :	stingray.Vector3	A new Vector3 source.
rotation :	stingray.Quaternion?	This parameter can be a Quaternion that indicates the source rotation. The ? notation indicates that this type is optional: there may be zero or one instances of it.

Returns

integer

The ID of the source.

If invalid source input or other errors occur during source creation then WwiseWorldInterface::NO_SOURCE_ID will be returned. A Source created via make_manual_source() requires destroy_manual_source() to be called in order to cleanup the source.

make_manual_source ( self, pose ) : integer Creates a new Wwise object source for the given game source, and returns the ID of the source.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
pose :	stingray.Matrix4x4	A new Matrix4x4 source.

Returns

integer

The ID of the source.

If invalid source input or other errors occur during source creation then WwiseWorldInterface::NO_SOURCE_ID will be returned. A Source created via make_manual_source() requires destroy_manual_source() to be called in order to cleanup the source.

Related sample code

Vehicle template: /vehicle_unit_controller.lua

pause_all ( self ) Pauses all currently playing events in the Wwise world.

Parameters

self :

stingray.WwiseWorld

Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

This function does not return any values.

Other related reference items

stingray.WwiseWorld.resume_all() stingray.WwiseWorld.resume_event()

pause_event ( self, playing_id ) Temporarily pauses a currently playing event whose numeric ID matches the specified ID.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
playing_id :	integer	The numeric ID of the event to be paused.

Returns

This function does not return any values.

You can resume the event with a call to resume_event() or resume_all().

Other related reference items

stingray.WwiseWorld.resume_all() stingray.WwiseWorld.resume_event()

resume_all ( self ) Resumes playing all events in the Wwise world that were previously paused by a call to pause_event() or pause_all().

Parameters

self :

stingray.WwiseWorld

Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

This function does not return any values.

Other related reference items

stingray.WwiseWorld.pause_event()

resume_event ( self, playing_id ) Resumes playing an event previously paused by a call to pause_event() or pause_all().

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
playing_id :	integer	The numeric ID of the event to be resumed.

Returns

This function does not return any values.

Other related reference items

stingray.WwiseWorld.pause_event()

stop_all ( self ) Stops all currently playing events in the Wwise world.

Parameters

self :

stingray.WwiseWorld

Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

This function does not return any values.

Related sample code

Appkit: /simple_project.lua

stop_audio_input_sound ( self, playing_id ) Stops an Audio Input Plugin sound that was created via trigger_audio_input_sound.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
playing_id :	integer	The playing sound that was created via trigger_audio_input_sound.

Returns

This function does not return any values.

This is required to stop infinitely looping sounds. Sounds created via the trigger_audio_input_event interface can be stopped via the normal event methods.

stop_event ( self, playing_id ) Stops a currently playing event whose numeric ID matches the specified ID.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
playing_id :	integer	The numeric ID of the event to be stopped.

Returns

This function does not return any values.

trigger_audio_input_event ( self, event_name, source_id, stream_source ) : integer Uses the Wwise Audio Input Plugin to play an event using audio data fed from a buffer.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
source_id :	integer	The game object to play the sound on.
event_name :	string	The name of the event.
stream_source :	stingray.SoundStreamSource	The audio stream data to use to play the sound.

Returns

integer

The numeric ID of the new playing event or nil if playing failed.

trigger_audio_input_sound ( self, source_id, stream_source ) : integer Uses the Wwise Audio Input Plugin to play a sound without using events, using audio data fed from a buffer.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
source_id :	integer	The game object to play the sound on.
stream_source :	stingray.SoundStreamSource	The audio stream data to use to play the sound.

Returns

integer

The numeric ID of the new playing event or nil if playing failed.

If looping, the sound must be stopped via stop_audio_input_sound.

trigger_event ( self, event_name ) : integer, integer Triggers a new event and returns the ID of the global unpositioned source for the given WwiseWorld.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
event_name :	string	The name of the event.

Returns

integer	The numeric ID of the new playing event.
integer	The ID of the source playing the new event.

This source is used to play 2D sounds.

Related sample code

Basic template: /player.lua Vehicle template: /vehicle_unit_controller.lua Oculus VR template: /player.lua

trigger_event ( self, event_name, source_id ) : integer, integer Triggers a new event and returns the ID of the global unpositioned source for the given WwiseWorld.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
event_name :	string	The name of the event.
source_id :	integer	A preexisting SourceId to trigger the event on.

Returns

integer	The numeric ID of the new playing event.
integer	The ID of the source playing the new event.

This source is used to play 2D sounds.

trigger_event ( self, event_name, pose ) : integer, integer Triggers a new event for the specified source, and returns the ID of the playing event and the ID of the source which the event is playing on.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
event_name :	string	The name of the event.
pose :	stingray.Matrix4x4	A Matrix4x4 used to create a new Wwise source.

Returns

integer	The numeric ID of the new playing event.
integer	The ID of the source playing the new event.

The newly created source will be destroyed when it has no active playing events.

trigger_event ( self, event_name, position, rotation ) : integer, integer Triggers a new event for the specified source, and returns the ID of the playing event and the ID of the source which the event is playing on.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
event_name :	string	The name of the event.
position :	stingray.Vector3	A Vector3 used to create a new Wwise source.
rotation :	stingray.Quaternion?	This parameter can be a Quaternion that indicates the source rotation. The ? notation indicates that this type is optional: there may be zero or one instances of it.

Returns

integer	The numeric ID of the new playing event.
integer	The ID of the source playing the new event.

The newly created source will be destroyed when it has no active playing events.

trigger_event ( self, event_name, unit, unit_object ) : integer, integer If the given unit matches an existing unit source, the existing source id will be returned.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
event_name :	string	The name of the event.
unit :	stingray.Unit	A Unit that will be used to create a new source or to find an existing source matching the given unit.
unit_object :	integer?	This parameter can contain the numeric index of an object within the given unit. The ? notation indicates that this type is optional: there may be zero or one instances of it.

Returns

integer	The numeric ID of the new playing event.
integer	The ID of the source playing the new event.

If no existing matching unit source is found, then a new unit source will be created and its ID will be returned. The newly created source will be destroyed when it has no active playing events.

Parameters

post_trigger ( self, source_id, name ) Triggers the given trigger for the given source.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
source_id :	integer	The source ID.
name :	string	The trigger name.

Returns

This function does not return any values.

set_global_parameter ( self, name, value ) Routes the given parameter name and value to the corresponding Wwise global parameter.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
name :	string	The name of the parameter to be routed.
value :	number	The numeric value for the parameter.

Returns

This function does not return any values.

set_source_parameter ( self, source_id, name, value ) Routes the given parameter name and value to the corresponding Wwise object parameter of the specified source.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
source_id :	integer	The numeric ID of the source.
name :	string	The name of the parameter to be routed.
value :	number	The numeric value for the parameter.

Returns

This function does not return any values.

Related sample code

Vehicle template: /vehicle_unit_controller.lua

set_switch ( self, group, state, source_id ) Sets the state of a switch group Wwise object.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
group :	string	The state group. Must match wwise project state setup.
state :	string	The current state. Must match wwise project state setup.
source_id :	integer	The associated source ID.

Returns

This function does not return any values.

Note this must be set before triggering events on a source for the switch value to apply to the event. Use make_source before trigger_event to obtain a new source id to set the switch on before triggering the event.

Environments

reset_aux_environment ( self ) Disables all aux environment buses by sending a 0 control output value for them.

Parameters

self :

stingray.WwiseWorld

Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

This function does not return any values.

Applies to all sources in the given world.

reset_environment_for_source ( self ) Disables all aux environment buses on the given source by sending a 0 control output value for them.

Parameters

self :

stingray.WwiseWorld

Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

This function does not return any values.

set_dry_environment ( self, value ) Sets the dry bus value for all sources in this world.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
value :	number	The bus value to send. 0 to 1.

Returns

This function does not return any values.

The dry value defaults to 1 (full).

set_dry_environment_for_source ( self, source, value ) Sets the given environment bus dry value for the given source.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
source :	integer	The source.
value :	number	The bus value to send. 0 to 1.

Returns

This function does not return any values.

The dry value for all sources defaults to 1 (full).

set_environment ( self, name, value ) Sets the given environment bus to the control output volume given for all sources in this world.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
name :	string	The auxiliary bus name.
value :	number	The bus value to send. 0 to 1.

Returns

This function does not return any values.

set_environment_for_source ( self, source, name, value ) Sets the given bus to the control output volume given for the given source.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
source :	integer	The source.
name :	string	The auxiliary bus name.
value :	number	The bus value to send. 0 to 1.

Returns

This function does not return any values.

Each source can have a maximum of MAX_ENVIRONMENTS_PER_OBJECT(4) unique active aux bus environments.

set_obstruction_and_occlusion ( self, listener, source, obstruction, occlusion ) Sets the obstruction and occlusion values for given source and listener.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
listener :	integer	The listener id. Use Wwise.LISTENER_0 through Wwise.LISTENER_7.
source :	integer	The source.
obstruction :	number	How much the source is blocked. 0 to 1.
occlusion :	number	How much the source is occluded. 0 to 1.

Returns

This function does not return any values.

Soundscape

add_soundscape_unit_source ( self, event_name, unit, unit_object, shape_type, shape_scale, positioning, min_distance, max_distance, trigger_range ) : integer Adds a Soundscape source to the world.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
event_name :	string	The Wwise event name to trigger when the source is active.
unit :	stingray.Unit	The unit to use for positioning. The unit's position, scale, and rotation are used to define the shape bounds.
unit_object :	integer	The unit object node index.
shape_type :	integer	Shape enum value for a Soundscape source. Supported values: Wwise.SHAPE_POINT, Wwise.SHAPE_SPHERE, Wwise.SHAPE_BOX.
shape_scale :	any(number, stingray.Vector3)	Vector3 extents for Wwise.SHAPE_BOX, float for Wwise.SHAPE_POINT and Wwise.SHAPE_SPHERE. Value is ignored for SHAPE_POINT. The any(...) notation indicates that this item may be an instance of any of the types shown in the parentheses.
positioning :	integer	Wwise source behavior within the shape. Supported values: Wwise.POSITIONING_CLOSEST_TO_LISTENER, Wwise.POSITIONING_RANDOM_IN_SHAPE, Wwise.POSITIONING_RANDOM_AROUND_LISTENER.
min_distance :	number	Minimum distance for Random Around Listener positioning.
max_distance :	number	Maximum distance for Random Around Listener positioning.
trigger_range :	number?	Optional range to use to trigger the event. By default the event's maximum attenuation distance is used. The ? notation indicates that this type is optional: there may be zero or one instances of it.

Returns

integer

The id of the Soundscape source. This id is not a wwise source id. It is specific to the Soundscape add/remove functionality.

remove_soundscape_source ( self, ss_source_id ) Removes a soundscape source from the the world.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
ss_source_id :	integer	The Soundscape source Id.

Returns

This function does not return any values.

set_obstruction_and_occlusion_for_soundscape_source ( self, ss_source, obstruction, occlusion ) Sets the obstruction and occlusion values for given soundscape source.

Parameters

self :	stingray.WwiseWorld	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
ss_source :	integer	The soundscape source id that was returned from add_soundscape_source.
obstruction :	number	How much the source is blocked. 0 to 1.
occlusion :	number	How much the source is occluded. 0 to 1.

Returns

This function does not return any values.

Soundscape source ids are returned from add_soundscape_unit_source.