Skip to main content

Class: DeviceCameraOptions

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

Configuration options for the device camera.

Constructors​

Constructor​

new DeviceCameraOptions(options?): DeviceCameraOptions

Defined in: src/camera/CameraOptions.ts:75

Parameters​

options?​
cameraLabel?​

string

enabled?​

boolean = false

rgbToDepthParams?​

{ k1?: number; k2?: number; k3?: number; p1?: number; p2?: number; scale?: number; scaleX?: number; scaleY?: number; translateU?: number; translateV?: number; xc?: number; yc?: number; } = ...

Parameters for RGB to depth UV mapping given different aspect ratios.

rgbToDepthParams.k1?​

number

rgbToDepthParams.k2?​

number

rgbToDepthParams.k3?​

number

rgbToDepthParams.p1?​

number

rgbToDepthParams.p2?​

number

rgbToDepthParams.scale?​

number

rgbToDepthParams.scaleX?​

number

rgbToDepthParams.scaleY?​

number

rgbToDepthParams.translateU?​

number

rgbToDepthParams.translateV?​

number

rgbToDepthParams.xc?​

number

rgbToDepthParams.yc?​

number

targetDevice?​

string

The DEVICE_CAMERA_PARAMETERS key (such as 'galaxyxr', 'aura' or 'quest3') whose intrinsics and pose describe the headset camera. When unset, the profile comes from the user agent, which cannot tell Aura from Galaxy XR. A valid ?camera=<profile> URL parameter overrides this. Read or switch the active profile at runtime with XRDeviceCamera.targetDevice.

videoConstraints?​

{ }

Constraints for getUserMedia. This will guide the initial camera selection.

willCaptureFrequently?​

boolean = false

Hint for performance optimization on frequent captures.

Returns​

DeviceCameraOptions

Properties​

cameraLabel?​

optional cameraLabel: string

Defined in: src/camera/CameraOptions.ts:65


enabled​

enabled: boolean = false

Defined in: src/camera/CameraOptions.ts:51


rgbToDepthParams​

rgbToDepthParams: RgbToDepthParams

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

Parameters for RGB to depth UV mapping given different aspect ratios.


targetDevice?​

optional targetDevice: string

Defined in: src/camera/CameraOptions.ts:73

The DEVICE_CAMERA_PARAMETERS key (such as 'galaxyxr', 'aura' or 'quest3') whose intrinsics and pose describe the headset camera. When unset, the profile comes from the user agent, which cannot tell Aura from Galaxy XR. A valid ?camera=<profile> URL parameter overrides this. Read or switch the active profile at runtime with XRDeviceCamera.targetDevice.


videoConstraints?​

optional videoConstraints: MediaTrackConstraints

Defined in: src/camera/CameraOptions.ts:56

Constraints for getUserMedia. This will guide the initial camera selection.


willCaptureFrequently​

willCaptureFrequently: boolean = false

Defined in: src/camera/CameraOptions.ts:60

Hint for performance optimization on frequent captures.