stingray.Wwise namespace reference

Description

The Wwise object is a singleton that provides Stingray game code with an interface to the Wwise engine APIs.

Related sample code

Appkit: /camera_wrapper.lua Appkit: /simple_project.lua Basic template: /player.lua Character template: /player.lua Vehicle template: /vehicle_unit_controller.lua Oculus VR template: /player.lua Oculus VR template: /project.lua

Other related reference items

Wwise Sound

Related help topics

	Working with Audio > Wwise audio basics > Load sound banks at runtime
	Working with Audio > Wwise authoring tool
	Working with Audio > Wwise Lua functions
	Managing Content and Resources > Localizing your game > Localizing audio

Functions

duration_type ( event_name ) : number Gets the duration type for the specified event.

Parameters

event_name :

string

The name of the event to lookup the value for.

Returns

number

The duration type for the event sound, matching one of the Wwise.WWISE_DURATION_* Lua variables.

Note that some Wwise event types (Wwise Silence, procedural SFX like Tone Generator) do not support duration inspection and will return WWISE_DURATION_UNSUPPORTED.

has_event ( event_name ) : boolean Indicates if the given event exists in any exported bank.

Parameters

event_name :

string

The name of the event.

Returns

boolean

true if the given event exists in any exported bank, false otherwise.

load_bank ( resource_name ) Loads the specified sound bank into the Wwise engine.

Parameters

resource_name :

string

The name of the sound bank resource to load.

Returns

This function does not return any values.

Related sample code

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

Other related reference items

stingray.Wwise.set_language()

max_attenuation ( event_name ) : number Gets the maximum attenuation distance for the specified event.

Parameters

event_name :

string

The name of the event to lookup the value for.

Returns

number

The maximum attenuation distance.

max_duration ( event_name ) : number Gets the maximum duration length for the specified event.

Parameters

event_name :

string

The name of the event to lookup the value for.

Returns

number

The maximum duration of the event sound, in seconds.

Note that some Wwise event types (Wwise Silence, procedural SFX like Tone Generator) do not support duration inspection.

min_duration ( event_name ) : number Gets the minimum duration length for the specified event.

Parameters

event_name :

string

The name of the event to lookup the value for.

Returns

number

The minimum duration of the event sound, in seconds.

Note that some Wwise event types (Wwise Silence, procedural SFX like Tone Generator) do not support duration inspection.

position_type ( event_name ) : number Gets the positioning type of the given event.

Parameters

event_name :

string

The name of the event to lookup the value for.

Returns

number

One of WWISE_3D_SOUND, WWISE_2D_SOUND, or WWISE_INVALID_SOUND.

set_language ( language_dir ) Sets the current Wwise engine language directory to the given language directory name.

Parameters

language_dir :

string

The language to use when loading new bank sounds.

Returns

This function does not return any values.

The name should match one of the language folder names in the Wwise exports folder. The language will only affect future calls to load_bank(). Currently loaded bank sounds will remain in the previously set language.

set_panning_rule ( rule, type, output_id ) Sends a message to set the panning rule to the given settings.

Parameters

rule :	integer	Panning rule, obtained via get_module_number with a PANNING_RULE_* parameter.
type :	integer	Audio output type, obtained via get_module_number with a OUTPUT_* parameter.
output_id :	integer?	Device-unique identifier. Defaults to 0 for main. The ? notation indicates that this type is optional: there may be zero or one instances of it.

Returns

This function does not return any values.

set_state ( group, state ) Sets the state of a switch group Wwise object.

Parameters

group :	string	The state group. Must match wwise project state setup.
state :	string	The current state. Must match wwise project state setup.

Returns

This function does not return any values.

unload_bank ( resource_name ) Unloads the specified sound bank from the Wwise engine.

Parameters

resource_name :

string

The name of the sound bank resource to unload.

Returns

This function does not return any values.

wwise_world ( world ) : stingray.WwiseWorld Returns a pointer to the WwiseWorld object that corresponds to the specified Stingray game World.

Parameters

world :

stingray.World

A Stingray game world whose Wwise interface you want to retrieve.

Returns

stingray.WwiseWorld

The WwiseWorld interface for the specified game World.

Related sample code

Appkit: /camera_wrapper.lua Appkit: /simple_project.lua Basic template: /player.lua Vehicle template: /vehicle_unit_controller.lua Oculus VR template: /player.lua Oculus VR template: /project.lua