Class AudioSceneComponent
Hierarchy
- AudioSceneComponent
Implements
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
-
Creates a new instance of the component for the given scene
Parameters
-
scene: Scene
Defines the scene to register the component in
Returns AudioSceneComponent
-
Properties
audio Positioning Refresh RateSearch playground for audioPositioningRefreshRate
Gets or sets a refresh rate when using 3D audio positioning
Readonly nameSearch playground for name
The component name helpfull to identify the component in the list of scene components.
sceneSearch playground for scene
The scene the component belongs to.
Accessors
audio Enabled
-
Gets whether audio is enabled or not. Please use related enable/disable method to switch state.
Returns boolean
audio Listener Position Provider
headphone
-
Gets whether audio is outputing to headphone or not. Please use the according Switch methods to change output.
Returns boolean
Methods
add From ContainerSearch playground for addFromContainer
-
Adds all the elements from the container to the scene
Parameters
-
container: AbstractScene
the container holding the elements
Returns void
-
disable AudioSearch playground for disableAudio
-
Disables audio in the associated scene.
Returns void
disposeSearch playground for dispose
-
Disposes the component and the associated ressources.
Returns void
enable AudioSearch playground for enableAudio
-
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 From ContainerSearch playground for removeFromContainer
-
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 Audio Mode For HeadphonesSearch playground for switchAudioModeForHeadphones
-
Switch audio to headphone output.
Returns void
switch Audio Mode For Normal SpeakersSearch playground for switchAudioModeForNormalSpeakers
-
Switch audio to normal speakers.
Returns void
Defines the sound scene component responsible to manage any sounds in a given scene.