Skip to main content

Class: WorldOptions

Defined in: src/world/WorldOptions.ts:9

Constructors​

Constructor​

new WorldOptions(options?): WorldOptions

Defined in: src/world/WorldOptions.ts:18

Parameters​

options?​
debugging?​

boolean = false

enabled?​

boolean = false

enableMeshDetection?​

() => WorldOptions

enableObjectDetection?​

() => WorldOptions

enablePlaneDetection?​

() => WorldOptions

enableSoundDetection?​

() => WorldOptions

initiateRoomCapture?​

boolean = false

meshes?​

{ enable?: () => MeshDetectionOptions; enabled?: boolean; showDebugVisualizations?: boolean; } = ...

meshes.enable?​

() => MeshDetectionOptions

meshes.enabled?​

boolean = false

meshes.showDebugVisualizations?​

boolean = false

objects?​

{ backendConfig?: { activeBackend?: "gemini" | "mediapipe"; gemini?: { responseSchema?: { items?: ... | ...; type?: ... | ...; }; systemInstruction?: string; }; mediapipe?: { modelAssetPath?: string; scoreThreshold?: number; wasmFilesUrl?: string; }; }; debugging?: boolean; enable?: () => ObjectsOptions; enabled?: boolean; objectImageMargin?: number; showDebugVisualizations?: boolean; } = ...

objects.backendConfig?​

{ activeBackend?: "gemini" | "mediapipe"; gemini?: { responseSchema?: { items?: ... | ...; type?: ... | ...; }; systemInstruction?: string; }; mediapipe?: { modelAssetPath?: string; scoreThreshold?: number; wasmFilesUrl?: string; }; } = ...

Configuration for the detection backends.

objects.backendConfig.activeBackend?​

"gemini" | "mediapipe" = ...

The active backend to use for detection.

objects.backendConfig.gemini?​

{ responseSchema?: { items?: ... | ...; type?: ... | ...; }; systemInstruction?: string; } = ...

objects.backendConfig.gemini.responseSchema?​

{ items?: ... | ...; type?: ... | ...; } = ...

objects.backendConfig.gemini.responseSchema.items?​

... | ... = ...

objects.backendConfig.gemini.responseSchema.type?​

... | ... = 'ARRAY'

objects.backendConfig.gemini.systemInstruction?​

string = ...

objects.backendConfig.mediapipe?​

{ modelAssetPath?: string; scoreThreshold?: number; wasmFilesUrl?: string; } = ...

Configuration for MediaPipe backend.

objects.backendConfig.mediapipe.modelAssetPath?​

string = 'https://storage.googleapis.com/mediapipe-models/object_detector/efficientdet_lite2/int8/latest/efficientdet_lite2.tflite'

objects.backendConfig.mediapipe.scoreThreshold?​

number = 0.5

objects.backendConfig.mediapipe.wasmFilesUrl?​

string = 'https://cdn.jsdelivr.net/npm/@mediapipe/tasks-vision@0.10.34/wasm'

objects.debugging?​

boolean = false

objects.enable?​

() => ObjectsOptions

objects.enabled?​

boolean = false

objects.objectImageMargin?​

number = 0.05

Margin to add when cropping the object image, as a percentage of image size.

objects.showDebugVisualizations?​

boolean = false

planes?​

{ debugging?: boolean; enable?: () => PlanesOptions; enabled?: boolean; showDebugVisualizations?: boolean; } = ...

planes.debugging?​

boolean = false

planes.enable?​

() => PlanesOptions

planes.enabled?​

boolean = false

planes.showDebugVisualizations?​

boolean = false

sounds?​

{ backendConfig?: { activeBackend?: string; mediapipe?: { chunkSamples?: number; modelAssetPath?: string; wasmFilesUrl?: string; }; }; enable?: () => SoundsOptions; enabled?: boolean; showDebugInfo?: boolean; } = ...

sounds.backendConfig?​

{ activeBackend?: string; mediapipe?: { chunkSamples?: number; modelAssetPath?: string; wasmFilesUrl?: string; }; } = ...

sounds.backendConfig.activeBackend?​

string = 'mediapipe'

sounds.backendConfig.mediapipe?​

{ chunkSamples?: number; modelAssetPath?: string; wasmFilesUrl?: string; } = ...

sounds.backendConfig.mediapipe.chunkSamples?​

number = 16000

sounds.backendConfig.mediapipe.modelAssetPath?​

string = 'https://tfhub.dev/google/lite-model/yamnet/classification/tflite/1?lite-format=tflite'

sounds.backendConfig.mediapipe.wasmFilesUrl?​

string = 'https://cdn.jsdelivr.net/npm/@mediapipe/tasks-audio@0.10.35/wasm'

sounds.enable?​

() => SoundsOptions

sounds.enabled?​

boolean = false

sounds.showDebugInfo?​

boolean = false

Returns​

WorldOptions

Properties​

debugging​

debugging: boolean = false

Defined in: src/world/WorldOptions.ts:10

enabled​

enabled: boolean = false

Defined in: src/world/WorldOptions.ts:11

initiateRoomCapture​

initiateRoomCapture: boolean = false

Defined in: src/world/WorldOptions.ts:12

meshes​

meshes: MeshDetectionOptions

Defined in: src/world/WorldOptions.ts:15

objects​

objects: ObjectsOptions

Defined in: src/world/WorldOptions.ts:14

planes​

planes: PlanesOptions

Defined in: src/world/WorldOptions.ts:13

sounds​

sounds: SoundsOptions

Defined in: src/world/WorldOptions.ts:16

Methods​

enableMeshDetection()​

enableMeshDetection(): WorldOptions

Defined in: src/world/WorldOptions.ts:45

Enables mesh detection.

Returns​

WorldOptions

enableObjectDetection()​

enableObjectDetection(): WorldOptions

Defined in: src/world/WorldOptions.ts:36

Enables object detection.

Returns​

WorldOptions

enablePlaneDetection()​

enablePlaneDetection(): WorldOptions

Defined in: src/world/WorldOptions.ts:27

Enables plane detection.

Returns​

WorldOptions

enableSoundDetection()​

enableSoundDetection(): WorldOptions

Defined in: src/world/WorldOptions.ts:54

Enables sound detection.

Returns​

WorldOptions