Skip to main content

Camera

wemap-sdk-js

Class: Camera

Extends​

  • EventEmitter

Constructors​

Constructor​

new Camera(container, options?): Camera

Parameters​

container​

HTMLElement

options?​

CameraOptions

Returns​

Camera

Properties​

fov​

fov: { horizontal: number; vertical: number; } | null

notifyContainerSizeChanged()​

notifyContainerSizeChanged: () => void

Returns​

void

videoContainer​

videoContainer: HTMLElement

videoElement​

videoElement: HTMLVideoElement

videoStream​

videoStream: MediaStream | null

DEFAULT_OPTIONS​

static DEFAULT_OPTIONS: object

height​

height: number

resizeOnWindowChange​

resizeOnWindowChange: boolean

width​

width: number

GENERIC_HARDWARE_VERTICAL_FOV​

static GENERIC_HARDWARE_VERTICAL_FOV: number

Accessors​

currentImage​

Get Signature​

get currentImage(): Promise\<null> | Promise\<HTMLCanvasElement>

Returns​

Promise\<null> | Promise\<HTMLCanvasElement>

hardwareVerticalFov​

Get Signature​

get hardwareVerticalFov(): number

Returns​

number

Set Signature​

set hardwareVerticalFov(hardwareVerticalFov): void

Parameters​
hardwareVerticalFov​

number

Returns​

void

state​

Get Signature​

get state(): CameraState

Returns​

CameraState

Methods​

off()​

Call Signature​

off(event, listener): this

Parameters​
event​

"starting"

listener​

() => void

Returns​

this

Call Signature​

off(event, listener): this

Parameters​
event​

"started"

listener​

(obj) => void

Returns​

this

Call Signature​

off(event, listener): this

Parameters​
event​

"stopping"

listener​

() => void

Returns​

this

Call Signature​

off(event, listener): this

Parameters​
event​

"stopped"

listener​

() => void

Returns​

this

Call Signature​

off(event, listener): this

Parameters​
event​

"fov.changed"

listener​

(obj) => void

Returns​

this

on()​

Call Signature​

on(event, listener): this

Parameters​
event​

"starting"

listener​

() => void

Returns​

this

Call Signature​

on(event, listener): this

Parameters​
event​

"started"

listener​

(obj) => void

Returns​

this

Call Signature​

on(event, listener): this

Parameters​
event​

"stopping"

listener​

() => void

Returns​

this

Call Signature​

on(event, listener): this

Parameters​
event​

"stopped"

listener​

() => void

Returns​

this

Call Signature​

on(event, listener): this

Parameters​
event​

"fov.changed"

listener​

(obj) => void

Returns​

this

release()​

release(): void

Returns​

void

start()​

start(videoMediaConstraints?): Promise\<{ stream: MediaStream; videoElement: HTMLVideoElement; }>

Parameters​

videoMediaConstraints?​

MediaTrackConstraints

Returns​

Promise\<{ stream: MediaStream; videoElement: HTMLVideoElement; }>

stop()​

stop(): Promise\<void>

Returns​

Promise\<void>

checkAvailability()​

static checkAvailability(testUserMedia?): Promise\<void>

Parameters​

testUserMedia?​

boolean

Returns​

Promise\<void>