Class AudioSceneComponent
Hierarchy
- AudioSceneComponent
Implements
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Creates a new instance of the component for the given scene
Parameters
Returns AudioSceneComponent
Properties
audio
Gets or Sets a custom listener position for all sounds in the scene By default, this is the position of the first active camera
audio
Gets or Sets a custom listener rotation for all sounds in the scene By default, this is the rotation of the first active camera
audio
Gets or sets a refresh rate when using 3D audio positioning
Readonly nameSearch playground for name
The component name helpful to identify the component in the list of scene components.
sceneSearch playground for scene
The scene the component belongs to.
Accessors
audio
Gets whether audio is enabled or not. Please use related enable/disable method to switch state.
Returns boolean
headphone
Gets whether audio is outputting to headphone or not. Please use the according Switch methods to change output.
Returns boolean
Methods
add
Adds all the elements from the container to the scene
Parameters
container: AbstractScene
the container holding the elements
Returns void
disable
Disables audio in the associated scene.
Returns void
disposeSearch playground for dispose
Disposes the component and the associated resources.
Returns void
enable
Enables audio in the associated scene.
Returns void
rebuildSearch playground for rebuild
Rebuilds the elements related to this component in case of context lost for instance.
Returns void
registerSearch playground for register
Registers the component in a given scene
Returns void
remove
Removes all the elements in the container from the scene
Parameters
container: AbstractScene
contains the elements to remove
Optional dispose: boolean
if the removed element should be disposed (default: false)
Returns void
serializeSearch playground for serialize
Serializes the component data to the specified json object
Parameters
serializationObject: any
The object to serialize to
Returns void
switch
Switch audio to headphone output.
Returns void
switch
Switch audio to normal speakers.
Returns void
Defines the sound scene component responsible to manage any sounds in a given scene.