Scaleform Studio Lua API Reference: scaleform.Sound object reference
Description
A Sound object for playing audio through Wwise Wwise is only available if Scaleform Studio is compiled with it enabled (by default it is enabled).
Inheritance 
Constructors and accessors
Other related reference items
Related help topics
Functions
target : |
The actor to link the sound. |
|
The newly created Sound object. |
Used with Wwise implementation.
self : |
The sound object. | |
bank_name : | string |
The sound bank name. |
boolean |
Returns true if the sound bank is loaded and false otherwise. |
Used with Wwise implementation.
self : |
The sound object. | |
play_id : | integer |
The event playing ID. |
boolean |
Returns true if success and false otherwise. |
Used with Wwise implementation.
self : |
The sound object. | |
play_id : | integer |
The event playing ID. |
boolean |
Returns true if success and false otherwise. |
Used with Wwise implementation.
self : |
The sound object. | |
lang : | string |
The language. |
boolean |
Returns true if the language set successfully and false otherwise. |
Used with Wwise implementation.
self : |
The sound object. | |
param_name : | string |
Parameter name. |
param_value : | number |
Parameter value. |
global : | boolean? |
Specifies if parameter is global. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
boolean |
Returns true if success and false otherwise. |
Used with Wwise implementation.
self : |
The sound object. | |
play_id : | integer |
The event playing ID. |
boolean |
Returns true if success and false otherwise. |
Used with Wwise implementation.
self : |
The sound object currently considered. |
|
The actor linked with this Sound object. |
Used with Wwise implementation.
self : |
The sound object. | |
event_name : | string |
The event name. |
integer |
Returns playing event ID. |
Used with Wwise implementation.
scaleform.EventDispatcherThe base object for managing event listeners and dispatching events to the listeners.
scaleform.Sound.create (target) : scaleform.SoundCreates a Sound object.
scaleform.FMODSound.load (self, file_name) : booleanPre-loads sound file.
scaleform.FMODSound.play (self, file_name, start_time, loops) Plays the specified sound file.
scaleform.FMODSound.stop (self) : booleanStops playback of all sound channels of this object.
scaleform.FMODSound.target (self) : scaleform.ActorReturns the actor this sound object is linked to.
target : scaleform.ActorThe actor to link the sound.
scaleform.SoundThe newly created Sound object.
scaleform.ActorGeneric objects located in a scene.
scaleform.SoundA Sound object for playing audio through Wwise Wwise is only available if Scaleform Studio is compiled with it enabled (by default it is enabled).
scaleform.Sound.load_bank (self, bank_name) : booleanLoads the sound bank.
self : scaleform.SoundThe sound object.
bank_name : stringThe sound bank name.
booleanA string of characters.true or false. scaleform.Sound.pause_event (self, play_id) : booleanPauses playback of an active event.
self : scaleform.SoundThe sound object.
play_id : integerThe event playing ID.
booleanA strictly integral numeric value, with no decimal component. scaleform.Sound.resume_event (self, play_id) : booleanResumes playback of an active event.
self : scaleform.SoundThe sound object.
play_id : integerThe event playing ID.
boolean scaleform.Sound.set_language (self, lang) : booleanSets the current language.
self : scaleform.SoundThe sound object.
lang : stringThe language.
boolean scaleform.Sound.set_parameter (self, param_name, param_value, global) : booleanSets the value of a real-time parameter control.
self : scaleform.SoundThe sound object.
param_name : stringParameter name.
param_value : numberParameter value.
global : boolean?Specifies if parameter is global.
booleanA numeric value. scaleform.Sound.stop_event (self, play_id) : booleanStops playback of an active event.
self : scaleform.SoundThe sound object.
play_id : integerThe event playing ID.
boolean scaleform.Sound.target (self) : scaleform.ActorReturns the actor this sound object is linked to.
self : scaleform.SoundThe sound object currently considered.
scaleform.ActorThe actor linked with this Sound object.
scaleform.Sound.trigger_event (self, event_name) : integerAsynchronously trigger an event in the sound engine.
self : scaleform.SoundThe sound object.
event_name : stringThe event name.
integer scaleform.Sound.unload_bank (self, bank_name) : booleanUnloads the sound bank.
self : scaleform.SoundThe sound object.
bank_name : stringThe sound bank name.
boolean self : scaleform.SoundThe sound object.
file_name : stringThe sound file to play.
boolean self : scaleform.SoundThe sound object.
file_name : stringThe sound file to play.
start_time : integerThe start time of the file.
loops : integerThe number of loops.
self : scaleform.SoundThe sound object.
boolean self : scaleform.SoundThe sound object currently considered.
scaleform.ActorThe actor linked with this Sound object.Indicates a table.
This documentation uses the term table to mean an anonymous, temporary Lua table that contains named data values. You typically use these tables to pass data or settings to a function, or to hold data returned by a function.Indicates an object.
This documentation uses the term object to mean a named Lua table or userdata value that maintains a state. Some object types may have multiple instances existing at the same time, each with its own state; these objects typically have creation functions or accessors that you must call in order to get an instance. Some object types have only one instance, which you always access through the object's name.Indicates a named variable within a namespace, object or table; or an element within an enumeration.Indicates a code sample.Indicates an enumeration.
This documentation uses the term enumeration to mean a named Lua table that contains only a set of constant values. These values typically identify a predefined set of options for some setting or behavior. You might pass an enumeration value to a function, or test the value returned by a function against the items in the enumeration to see which option is currently set.Indicates a named variable within a namespace or object that has a pre-set constant value.Indicates a category: a semantic grouping of related API elements.Indicates a namespace.
This documentation uses the term namespace to mean a named Lua table that exists in only one single instance, intended as a container for an interface of related objects, functions and data variables.Indicates an output value returned by a function.Indicates a named function within a namespace or object.Indicates an input parameter for a function.