Class AudioSource<TEventMap>

Type Parameters

TEventMap extends Object3DEventMap = Object3DEventMap

Hierarchy

Object3D<TEventMap>
- AudioSource

Index

Constructors

Accessors

loop rate volume

Methods

destroy pause play resume stop updateMatrixWorld updatePosition

Constructors

constructor

new AudioSource<TEventMap>(howl: Howl, options?: AudioOptions): AudioSource<TEventMap>
Type Parameters
- TEventMap extends Object3DEventMap = Object3DEventMap
Parameters
- howl: Howl
- options: AudioOptions = ...
Returns AudioSource<TEventMap>
Overrides Object3D<TEventMap>.constructor
- Defined in src/audio/AudioSource.ts:32

Accessors

loop

get loop(): boolean
Returns boolean
- Defined in src/audio/AudioSource.ts:128
set loop(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/audio/AudioSource.ts:121

rate

get rate(): number
Returns number
- Defined in src/audio/AudioSource.ts:117
set rate(value: number): void
Parameters
- value: number
Returns void
- Defined in src/audio/AudioSource.ts:110

volume

get volume(): number
Returns number
- Defined in src/audio/AudioSource.ts:106
set volume(value: number): void
Parameters
- value: number
Returns void
- Defined in src/audio/AudioSource.ts:99

Methods

destroy

destroy(): void
Returns void
- Defined in src/audio/AudioSource.ts:147

pause

pause(): void
Returns void
- Defined in src/audio/AudioSource.ts:87

play

play(stopCurrent?: boolean): void
Parameters
- stopCurrent: boolean = false
Returns void
- Defined in src/audio/AudioSource.ts:62

resume

resume(): void
Returns void
- Defined in src/audio/AudioSource.ts:93

stop

stop(): void
Returns void
- Defined in src/audio/AudioSource.ts:81

updateMatrixWorld

updateMatrixWorld(force?: boolean): void
Parameters
- Optional force: boolean
Returns void
Overrides Object3D.updateMatrixWorld
- Defined in src/audio/AudioSource.ts:143

updatePosition

updatePosition(playerHead: Object3D<Object3DEventMap>): void
Parameters
- playerHead: Object3D<Object3DEventMap>
Returns void
- Defined in src/audio/AudioSource.ts:132