Scaleform Studio Lua API Reference: scaleform.FMODSound object reference
scaleform.FMODSound object reference
Description
A Sound object for audio.
The FMODSounds is only available if Scaleform Studio is was compiled with support for FMOD (by default this is disabled).
Inheritance 
Functions
Parameters
Returns
self : |
The sound object. | |
file_name : | string |
The sound file to play. |
boolean |
Returns true if the sound file is played and false otherwise. |
Use play() to play it. Used with FMOD implementation.
Parameters
Returns
self : |
The sound object. | |
file_name : | string |
The sound file to play. |
start_time : | integer |
The start time of the file. |
loops : | integer |
The number of loops. |
| This function does not return any values. |
Used with FMOD implementation.
Other related reference items
Parameters
Returns
self : |
The sound object. |
boolean |
Returns true if the playback is stopped and false otherwise. |
Used with FMOD implementation.
scaleform.EventDispatcherThe base object for managing event listeners and dispatching events to the listeners.
scaleform.FMODSound.load (self, file_name) : booleanPre-loads sound file.
self : scaleform.SoundThe sound object.
file_name : stringThe sound file to play.
boolean 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). A string of characters.true or false.
scaleform.FMODSound.play (self, file_name, start_time, loops) Plays the specified sound file.
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.A strictly integral numeric value, with no decimal component.
scaleform.FMODSound.stop (self) : booleanStops playback of all sound channels of this object.
self : scaleform.SoundThe sound object.
boolean scaleform.FMODSound.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.ActorGeneric objects located in a scene. 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.