AudioSceneComponent

Class AudioSceneComponent

Defines the sound scene component responsible to manage any sounds in a given scene.

Hierarchy

AudioSceneComponent

Implements

ISceneSerializableComponent

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new AudioSceneComponent(scene?: Nullable<Scene>): AudioSceneComponent

- Defined in .temp/docdirectory/doc.d.ts:4733
Creates a new instance of the component for the given scene

Parameters
- Optional scene: Nullable<Scene>
  
  Defines the scene to register the component in
Returns AudioSceneComponent

Properties

audioPositioningRefreshRateSearch playground for audioPositioningRefreshRate

audioPositioningRefreshRate: number

Gets or sets a refresh rate when using 3D audio positioning

Readonly nameSearch playground for name

name: "Audio" = "Audio"

The component name helpful to identify the component in the list of scene components.

sceneSearch playground for scene

scene: Scene

The scene the component belongs to.

Accessors

audioEnabled

get audioEnabled(): boolean

- Defined in .temp/docdirectory/doc.d.ts:4713
Gets whether audio is enabled or not. Please use related enable/disable method to switch state.

Returns boolean

audioListenerPositionProvider

get audioListenerPositionProvider(): Nullable<() => Vector3>
set audioListenerPositionProvider(value: Nullable<() => Vector3>): any

- Defined in .temp/docdirectory/doc.d.ts:4728
Gets the current audio listener position provider

Returns Nullable<() => Vector3>
- Defined in .temp/docdirectory/doc.d.ts:4733
Sets a custom listener position for all sounds in the scene By default, this is the position of the first active camera

Parameters
- value: Nullable<() => Vector3>
Returns any

headphone

get headphone(): boolean

- Defined in .temp/docdirectory/doc.d.ts:4719
Gets whether audio is outputting to headphone or not. Please use the according Switch methods to change output.

Returns boolean

Methods

addFromContainerSearch playground for addFromContainer

addFromContainer(container: AbstractScene): void

Implementation of ISceneSerializableComponent.addFromContainer
- Defined in .temp/docdirectory/doc.d.ts:4757
Adds all the elements from the container to the scene

Parameters
- container: AbstractScene
  
  the container holding the elements
Returns void

disableAudioSearch playground for disableAudio

disableAudio(): void

- Defined in .temp/docdirectory/doc.d.ts:4771
Disables audio in the associated scene.

Returns void

disposeSearch playground for dispose

dispose(): void

Implementation of ISceneSerializableComponent.dispose
- Defined in .temp/docdirectory/doc.d.ts:4767
Disposes the component and the associated resources.

Returns void

enableAudioSearch playground for enableAudio

enableAudio(): void

- Defined in .temp/docdirectory/doc.d.ts:4775
Enables audio in the associated scene.

Returns void

rebuildSearch playground for rebuild

rebuild(): void

Implementation of ISceneSerializableComponent.rebuild
- Defined in .temp/docdirectory/doc.d.ts:4747
Rebuilds the elements related to this component in case of context lost for instance.

Returns void

registerSearch playground for register

register(): void

Implementation of ISceneSerializableComponent.register
- Defined in .temp/docdirectory/doc.d.ts:4742
Registers the component in a given scene

Returns void

removeFromContainerSearch playground for removeFromContainer

removeFromContainer(container: AbstractScene, dispose?: boolean): void

Implementation of ISceneSerializableComponent.removeFromContainer
- Defined in .temp/docdirectory/doc.d.ts:4763
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

serialize(serializationObject: any): void

Implementation of ISceneSerializableComponent.serialize
- Defined in .temp/docdirectory/doc.d.ts:4752
Serializes the component data to the specified json object

Parameters
- serializationObject: any
  
  The object to serialize to
Returns void

switchAudioModeForHeadphonesSearch playground for switchAudioModeForHeadphones

switchAudioModeForHeadphones(): void

- Defined in .temp/docdirectory/doc.d.ts:4779
Switch audio to headphone output.

Returns void

switchAudioModeForNormalSpeakersSearch playground for switchAudioModeForNormalSpeakers

switchAudioModeForNormalSpeakers(): void

- Defined in .temp/docdirectory/doc.d.ts:4783
Switch audio to normal speakers.

Returns void