Class: XRDeviceCamera

Defined in: src/camera/XRDeviceCamera.ts:32

Handles video capture from a device camera, manages the device list, and reports its state using VideoStream's event model.

Extends

• VideoStream<XRDeviceCameraDetails>

Constructors

Constructor

new XRDeviceCamera(options): XRDeviceCamera

Defined in: src/camera/XRDeviceCamera.ts:50

Parameters

options

DeviceCameraOptions

The configuration options.

Returns

XRDeviceCamera

Overrides

VideoStream.constructor

Properties

aspectRatio?

optional aspectRatio: number

Defined in: src/video/VideoStream.ts:86

Inherited from

VideoStream.aspectRatio

---

height?

optional height: number

Defined in: src/video/VideoStream.ts:85

Inherited from

VideoStream.height

---

isXRScript

isXRScript: boolean = true

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

Inherited from

VideoStream.isXRScript

---

loaded

loaded: boolean = false

Defined in: src/video/VideoStream.ts:83

Inherited from

VideoStream.loaded

---

rgbToDepthParams

rgbToDepthParams: RgbToDepthParams

Defined in: src/camera/XRDeviceCamera.ts:36

---

simulatorCamera?

optional simulatorCamera: SimulatorCamera

Defined in: src/camera/XRDeviceCamera.ts:35

---

state

state: StreamState = StreamState.IDLE

Defined in: src/video/VideoStream.ts:88

Inherited from

VideoStream.state

---

stream_

protected stream_: null | MediaStream = null

Defined in: src/video/VideoStream.ts:90

Inherited from

VideoStream.stream_

---

texture

texture: Texture

Defined in: src/video/VideoStream.ts:87

Inherited from

VideoStream.texture

---

ux

ux: UX

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

Inherited from

VideoStream.ux

---

video_

protected video_: HTMLVideoElement

Defined in: src/video/VideoStream.ts:91

Inherited from

VideoStream.video_

---

videoConstraints_

protected videoConstraints_: MediaTrackConstraints

Defined in: src/camera/XRDeviceCamera.ts:37

---

width?

optional width: number

Defined in: src/video/VideoStream.ts:84

Inherited from

VideoStream.width

Accessors

isUsingXRCameraAccess

Get Signature

get isUsingXRCameraAccess(): boolean

Defined in: src/camera/XRDeviceCamera.ts:302

Whether the camera is using the WebXR Raw Camera Access API fallback.

Returns

boolean

---

video

Get Signature

get video(): HTMLVideoElement

Defined in: src/video/VideoStream.ts:92

Returns

HTMLVideoElement

Inherited from

VideoStream.video

Methods

dispose()

dispose(): void

Defined in: src/video/VideoStream.ts:284

Disposes of all resources used by this stream.

Returns

void

Inherited from

VideoStream.dispose

---

getAvailableDevices()

getAvailableDevices(): MediaOrSimulatorMediaDeviceInfo[]

Defined in: src/camera/XRDeviceCamera.ts:271

Gets the list of enumerated video devices.

Returns

MediaOrSimulatorMediaDeviceInfo[]

---

getAvailableVideoDevices()

getAvailableVideoDevices(): Promise<MediaOrSimulatorMediaDeviceInfo[]>

Defined in: src/camera/XRDeviceCamera.ts:64

Retrieves the list of available video input devices.

Returns

Promise<MediaOrSimulatorMediaDeviceInfo[]>

A promise that resolves with an array of video devices.

---

getCurrentDevice()

getCurrentDevice(): undefined | MediaOrSimulatorMediaDeviceInfo

Defined in: src/camera/XRDeviceCamera.ts:278

Gets the currently active device info, if available.

Returns

undefined | MediaOrSimulatorMediaDeviceInfo

---

getCurrentDeviceIndex()

getCurrentDeviceIndex(): number

Defined in: src/camera/XRDeviceCamera.ts:295

Gets the index of the currently active device.

Returns

number

---

getCurrentTrackSettings()

getCurrentTrackSettings(): undefined | MediaTrackSettings

Defined in: src/camera/XRDeviceCamera.ts:288

Gets the settings of the currently active video track.

Returns

undefined | MediaTrackSettings

---

getDeviceIdFromLabel()

protected getDeviceIdFromLabel(label): null | string

Defined in: src/camera/XRDeviceCamera.ts:121

Parameters

label

string

Returns

null | string

---

getSnapshot()

Call Signature

getSnapshot(_): ImageData

Defined in: src/video/VideoStream.ts:187

Captures the current video frame.

Parameters

_

VideoStreamGetSnapshotImageDataOptions

Returns

ImageData

The captured data.

Inherited from

VideoStream.getSnapshot

Call Signature

getSnapshot(_): Promise<null | string>

Defined in: src/video/VideoStream.ts:188

Captures the current video frame.

Parameters

_

VideoStreamGetSnapshotBase64Options

Returns

Promise<null | string>

The captured data.

Inherited from

VideoStream.getSnapshot

Call Signature

getSnapshot(_): Texture

Defined in: src/video/VideoStream.ts:189

Captures the current video frame.

Parameters

_

VideoStreamGetSnapshotTextureOptions

Returns

Texture

The captured data.

Inherited from

VideoStream.getSnapshot

Call Signature

getSnapshot(_): Promise<null | Blob>

Defined in: src/video/VideoStream.ts:190

Captures the current video frame.

Parameters

_

VideoStreamGetSnapshotBlobOptions

Returns

Promise<null | Blob>

The captured data.

Inherited from

VideoStream.getSnapshot

---

handleVideoStreamLoadedMetadata()

protected handleVideoStreamLoadedMetadata(resolve, reject, allowRetry): void

Defined in: src/video/VideoStream.ts:153

Processes video metadata, sets dimensions, and resolves a promise.

Parameters

resolve

() => void

The resolve function of the wrapping Promise.

reject

(_) => void

The reject function of the wrapping Promise.

allowRetry

boolean = false

Whether to allow a retry attempt on failure.

Returns

void

Inherited from

VideoStream.handleVideoStreamLoadedMetadata

---

init()

init(): Promise<void>

Defined in: src/camera/XRDeviceCamera.ts:91

Initializes the camera based on the initial constraints.

Returns

Promise<void>

Overrides

VideoStream.init

---

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

VideoStream.initPhysics

---

initStream_()

protected initStream_(): Promise<void>

Defined in: src/camera/XRDeviceCamera.ts:132

Initializes the media stream from the user's camera. After the stream starts, it updates the current device index based on the stream's active track.

Returns

Promise<void>

---

onHoverEnter()

onHoverEnter(_controller): boolean | void

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

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

Parameters

_controller

Object3D

An XR controller.

Returns

boolean | void

Whether the event was handled. If true, the event will not bubble up.

Inherited from

VideoStream.onHoverEnter

---

onHoverExit()

onHoverExit(_controller): boolean | void

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

Called when the controller hovers over this object with reticle.

Parameters

_controller

Object3D

An XR controller.

Returns

boolean | void

Whether the event was handled. If true, the event will not bubble up.

Inherited from

VideoStream.onHoverExit

---

onHovering()

onHovering(_controller): boolean | void

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

Called when the controller hovers over this object with reticle.

Parameters

_controller

Object3D

An XR controller.

Returns

boolean | void

Whether the event was handled. If true, the event will not bubble up.

Inherited from

VideoStream.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

VideoStream.onKeyDown

---

onKeyUp()

onKeyUp(_event): void

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

Parameters

_event

KeyEvent

Returns

void

Inherited from

VideoStream.onKeyUp

---

onObjectGrabbing()

onObjectGrabbing(_event): void

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

Called every frame a hand is grabbing this object.

Parameters

_event

ObjectGrabEvent

Returns

void

Inherited from

VideoStream.onObjectGrabbing

---

onObjectGrabEnd()

onObjectGrabEnd(_event): void

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

Called when a hand stops grabbing this object.

Parameters

_event

ObjectGrabEvent

Returns

void

Inherited from

VideoStream.onObjectGrabEnd

---

onObjectGrabStart()

onObjectGrabStart(_event): void

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

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

Parameters

_event

ObjectGrabEvent

Returns

void

Inherited from

VideoStream.onObjectGrabStart

---

onObjectSelectEnd()

onObjectSelectEnd(_event): boolean | void

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

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 | void

Whether the event was handled. If true, the event will not bubble up.

Inherited from

VideoStream.onObjectSelectEnd

---

onObjectSelectStart()

onObjectSelectStart(_event): boolean | void

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 | void

Whether the event was handled. If true, the event will not bubble up.

Inherited from

VideoStream.onObjectSelectStart

---

onObjectTouchEnd()

onObjectTouchEnd(_event): void

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

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

Parameters

_event

ObjectTouchEvent

Returns

void

Inherited from

VideoStream.onObjectTouchEnd

---

onObjectTouching()

onObjectTouching(_event): void

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

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

Parameters

_event

ObjectTouchEvent

Returns

void

Inherited from

VideoStream.onObjectTouching

---

onObjectTouchStart()

onObjectTouchStart(_event): void

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

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

Parameters

_event

ObjectTouchEvent

Returns

void

Inherited from

VideoStream.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

VideoStream.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

VideoStream.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

VideoStream.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

VideoStream.onSelectStart

---

onSimulatorStarted()

onSimulatorStarted(): void

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

Returns

void

Inherited from

VideoStream.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

VideoStream.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

VideoStream.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

VideoStream.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

VideoStream.onSqueezing

---

onXRSessionEnded()

onXRSessionEnded(): void

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

Returns

void

Inherited from

VideoStream.onXRSessionEnded

---

onXRSessionStarted()

onXRSessionStarted(_session?): void

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

Parameters

_session?

XRSession

Returns

void

Inherited from

VideoStream.onXRSessionStarted

---

physicsStep()

physicsStep(): void

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

Returns

void

Inherited from

VideoStream.physicsStep

---

registerSimulatorCamera()

registerSimulatorCamera(simulatorCamera): void

Defined in: src/camera/XRDeviceCamera.ts:371

Parameters

simulatorCamera

SimulatorCamera

Returns

void

---

setDeviceId()

setDeviceId(deviceId): Promise<void>

Defined in: src/camera/XRDeviceCamera.ts:241

Sets the active camera by its device ID. Removes potentially conflicting constraints such as facingMode.

Parameters

deviceId

string

Device ID

Returns

Promise<void>

---

setFacingMode()

setFacingMode(facingMode): Promise<void>

Defined in: src/camera/XRDeviceCamera.ts:261

Sets the active camera by its facing mode ('user' or 'environment').

Parameters

facingMode

VideoFacingModeEnum

facing mode

Returns

Promise<void>

---

setRenderer()

setRenderer(renderer): void

Defined in: src/camera/XRDeviceCamera.ts:84

Sets the renderer reference, needed for WebXR camera access fallback.

Parameters

renderer

WebGLRenderer

Returns

void

---

setState_()

protected setState_(state, details): void

Defined in: src/video/VideoStream.ts:134

Sets the stream's state and dispatches a 'statechange' event.

Parameters

state

StreamState

The new state.

details

Additional data for the event payload.

VideoStreamDetails | XRDeviceCameraDetails

Returns

void

Inherited from

VideoStream.setState_

---

stop_()

protected stop_(): void

Defined in: src/video/VideoStream.ts:265

Stops the current video stream tracks.

Returns

void

Inherited from

VideoStream.stop_

---

update()

update(_time?, _frame?): void

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

Runs per frame.

Parameters

_time?

number

_frame?

XRFrame

Returns

void

Inherited from

VideoStream.update

---

updateXRCamera()

updateXRCamera(frame): void

Defined in: src/camera/XRDeviceCamera.ts:310

Updates the camera texture from the WebXR Raw Camera Access API. Must be called each frame from the render loop when in XR camera mode.

Parameters

frame

XRFrame

Returns

void