Class: AudioPlayer

Defined in: src/sound/AudioPlayer.ts:13

Extends

• Script

Constructors

Constructor

new AudioPlayer(options): AudioPlayer

Defined in: src/sound/AudioPlayer.ts:24

Parameters

options

AudioPlayerOptions = {}

Returns

AudioPlayer

Overrides

Script.constructor

Properties

isXRScript

isXRScript: boolean = true

Defined in: src/core/Script.ts:54

Inherited from

Script.isXRScript

---

scheduleAheadTime

scheduleAheadTime: number = DEFAULT_SCHEDULE_AHEAD_TIME

Defined in: src/sound/AudioPlayer.ts:22

---

ux

ux: UX

Defined in: src/core/Script.ts:53

Inherited from

Script.ux

Methods

base64ToArrayBuffer()

base64ToArrayBuffer(base64): ArrayBuffer

Defined in: src/sound/AudioPlayer.ts:142

Parameters

base64

string

Returns

ArrayBuffer

---

clearQueue()

clearQueue(): void

Defined in: src/sound/AudioPlayer.ts:130

Returns

void

---

dispose()

dispose(): void

Defined in: src/sound/AudioPlayer.ts:165

Called when the script is removed from the scene. Opposite of init.

Returns

void

Overrides

Script.dispose

---

getIsPlaying()

getIsPlaying(): boolean

Defined in: src/sound/AudioPlayer.ts:134

Returns

boolean

---

getQueueLength()

getQueueLength(): number

Defined in: src/sound/AudioPlayer.ts:138

Returns

number

---

init()

init(_?): void | Promise<void>

Defined in: src/core/Script.ts:63

Initializes an instance with XR controllers, grips, hands, raycaster, and default options. We allow all scripts to quickly access its user (e.g., user.isSelecting(), user.hands), world (e.g., physical depth mesh, lighting estimation, and recognized objects), and scene (the root of three.js's scene graph). If this returns a promise, we will wait for it.

Parameters

_?

object

Returns

void | Promise<void>

Inherited from

Script.init

---

initializeAudioContext()

initializeAudioContext(): Promise<void>

Defined in: src/sound/AudioPlayer.ts:65

Returns

Promise<void>

---

initPhysics()

initPhysics(_physics): void | Promise<void>

Defined in: src/core/Script.ts:73

Enables depth-aware interactions with physics. See /demos/ballpit

Parameters

_physics

Physics

Returns

void | Promise<void>

Inherited from

Script.initPhysics

---

onHoverEnter()

onHoverEnter(_controller): void

Defined in: src/core/Script.ts:158

Called when the controller starts hovering over this object with reticle.

Parameters

_controller

Object3D

An XR controller.

Returns

void

Inherited from

Script.onHoverEnter

---

onHoverExit()

onHoverExit(_controller): void

Defined in: src/core/Script.ts:163

Called when the controller hovers over this object with reticle.

Parameters

_controller

Object3D

An XR controller.

Returns

void

Inherited from

Script.onHoverExit

---

onHovering()

onHovering(_controller): void

Defined in: src/core/Script.ts:168

Called when the controller hovers over this object with reticle.

Parameters

_controller

Object3D

An XR controller.

Returns

void

Inherited from

Script.onHovering

---

onKeyDown()

onKeyDown(_event): void

Defined in: src/core/Script.ts:110

Called on keyboard keypress.

Parameters

_event

KeyEvent

Event containing .code to read the keyboard key.

Returns

void

Inherited from

Script.onKeyDown

---

onKeyUp()

onKeyUp(_event): void

Defined in: src/core/Script.ts:111

Parameters

_event

KeyEvent

Returns

void

Inherited from

Script.onKeyUp

---

onObjectGrabbing()

onObjectGrabbing(_event): void

Defined in: src/core/Script.ts:188

Called every frame a hand is grabbing this object.

Parameters

_event

ObjectGrabEvent

Returns

void

Inherited from

Script.onObjectGrabbing

---

onObjectGrabEnd()

onObjectGrabEnd(_event): void

Defined in: src/core/Script.ts:192

Called when a hand stops grabbing this object.

Parameters

_event

ObjectGrabEvent

Returns

void

Inherited from

Script.onObjectGrabEnd

---

onObjectGrabStart()

onObjectGrabStart(_event): void

Defined in: src/core/Script.ts:184

Called when a hand starts grabbing this object (touching + pinching).

Parameters

_event

ObjectGrabEvent

Returns

void

Inherited from

Script.onObjectGrabStart

---

onObjectSelectEnd()

onObjectSelectEnd(_event): boolean

Defined in: src/core/Script.ts:151

Called when the controller stops selecting this object the script represents, e.g. View, ModelView.

Parameters

_event

SelectEvent

event.target holds its controller.

Returns

boolean

Whether the event was handled

Inherited from

Script.onObjectSelectEnd

---

onObjectSelectStart()

onObjectSelectStart(_event): boolean

Defined in: src/core/Script.ts:142

Called when the controller starts selecting this object the script represents, e.g. View, ModelView.

Parameters

_event

SelectEvent

event.target holds its controller.

Returns

boolean

Whether the event was handled

Inherited from

Script.onObjectSelectStart

---

onObjectTouchEnd()

onObjectTouchEnd(_event): void

Defined in: src/core/Script.ts:180

Called when a hand's index finger stops touching this object.

Parameters

_event

ObjectTouchEvent

Returns

void

Inherited from

Script.onObjectTouchEnd

---

onObjectTouching()

onObjectTouching(_event): void

Defined in: src/core/Script.ts:176

Called every frame that a hand's index finger is touching this object.

Parameters

_event

ObjectTouchEvent

Returns

void

Inherited from

Script.onObjectTouching

---

onObjectTouchStart()

onObjectTouchStart(_event): void

Defined in: src/core/Script.ts:172

Called when a hand's index finger starts touching this object.

Parameters

_event

ObjectTouchEvent

Returns

void

Inherited from

Script.onObjectTouchStart

---

onSelect()

onSelect(_event): void

Defined in: src/core/Script.ts:99

Called whenever pinch / mouse click successfully completes, globally.

Parameters

_event

SelectEvent

event.target holds its controller.

Returns

void

Inherited from

Script.onSelect

---

onSelectEnd()

onSelectEnd(_event): void

Defined in: src/core/Script.ts:93

Called whenever pinch / mouse click discontinues, globally.

Parameters

_event

SelectEvent

event.target holds its controller

Returns

void

Inherited from

Script.onSelectEnd

---

onSelecting()

onSelecting(_event): void

Defined in: src/core/Script.ts:104

Called whenever pinch / mouse click is happening, globally.

Parameters

_event

SelectEvent

Returns

void

Inherited from

Script.onSelecting

---

onSelectStart()

onSelectStart(_event): void

Defined in: src/core/Script.ts:87

Called whenever pinch / mouse click starts, globally.

Parameters

_event

SelectEvent

event.target holds its controller

Returns

void

Inherited from

Script.onSelectStart

---

onSimulatorStarted()

onSimulatorStarted(): void

Defined in: src/core/Script.ts:79

Returns

void

Inherited from

Script.onSimulatorStarted

---

onSqueeze()

onSqueeze(_event): void

Defined in: src/core/Script.ts:133

Called whenever gamepad trigger successfully completes, globally.

Parameters

_event

SelectEvent

event.target holds its controller.

Returns

void

Inherited from

Script.onSqueeze

---

onSqueezeEnd()

onSqueezeEnd(_event): void

Defined in: src/core/Script.ts:122

Called whenever gamepad trigger stops, globally.

Parameters

_event

SelectEvent

event.target holds its controller.

Returns

void

Inherited from

Script.onSqueezeEnd

---

onSqueezeStart()

onSqueezeStart(_event): void

Defined in: src/core/Script.ts:117

Called whenever gamepad trigger starts, globally.

Parameters

_event

SelectEvent

event.target holds its controller.

Returns

void

Inherited from

Script.onSqueezeStart

---

onSqueezing()

onSqueezing(_event): void

Defined in: src/core/Script.ts:127

Called whenever gamepad is being triggered, globally.

Parameters

_event

SelectEvent

Returns

void

Inherited from

Script.onSqueezing

---

onXRSessionEnded()

onXRSessionEnded(): void

Defined in: src/core/Script.ts:77

Returns

void

Inherited from

Script.onXRSessionEnded

---

onXRSessionStarted()

onXRSessionStarted(_session?): void

Defined in: src/core/Script.ts:76

Parameters

_session?

XRSession

Returns

void

Inherited from

Script.onXRSessionStarted

---

physicsStep()

physicsStep(): void

Defined in: src/core/Script.ts:74

Returns

void

Inherited from

Script.physicsStep

---

playAudioChunk()

playAudioChunk(base64AudioData): Promise<void>

Defined in: src/sound/AudioPlayer.ts:84

Parameters

base64AudioData

string

Returns

Promise<void>

---

setCategoryVolumes()

setCategoryVolumes(categoryVolumes): void

Defined in: src/sound/AudioPlayer.ts:36

Sets the CategoryVolumes instance for this player to respect master/category volumes

Parameters

categoryVolumes

CategoryVolumes

Returns

void

---

setVolume()

setVolume(level): void

Defined in: src/sound/AudioPlayer.ts:44

Sets the specific volume for this player (0.0 to 1.0)

Parameters

level

number

Returns

void

---

stop()

stop(): void

Defined in: src/sound/AudioPlayer.ts:151

Returns

void

---

update()

update(_time?, _frame?): void

Defined in: src/core/Script.ts:68

Runs per frame.

Parameters

_time?

number

_frame?

XRFrame

Returns

void

Inherited from

Script.update

---

updateGainNodeVolume()

updateGainNodeVolume(): void

Defined in: src/sound/AudioPlayer.ts:53

Updates the gain node volume based on category volumes Public so CoreSound can update it when master volume changes

Returns

void

---

isSupported()

static isSupported(): boolean

Defined in: src/sound/AudioPlayer.ts:161

Returns

boolean