Interface: WebcamElement

Public controls for a webcam.

Extends

• DOMElement

Properties

Property	Type	Description
background	string	-
deviceId	string | undefined	-
domElement	HTMLElement	-
enterDelay?	number	Delay in seconds before entering scene transition begins (defaults to 0).
enterDuration?	number	Duration in seconds for entering scene transition (defaults to stage defaultDuration if undefined).
exitDelay?	number	Delay in seconds before exiting scene transition begins (defaults to 0).
exitDuration?	number	Duration in seconds for exiting scene transition (defaults to stage defaultDuration if undefined).
fit	ImageFit	-
id	string	-
isActive	boolean	Whether the element is active (default: false).
isMounted	boolean	Whether the element is mounted (default: false).
kind	string	-
mirror	boolean	-

Accessors

align

Get Signature

get align(): Align | undefined

Returns

Align | undefined

Set Signature

set align(value: ReactiveProp<Align> | undefined): void

Parameters

Parameter	Type
value	ReactiveProp<Align> | undefined

Returns

void

Inherited from

DOMElement.align

---

blur

Get Signature

get blur(): number

Returns

number

Set Signature

set blur(value: ReactiveProp<number>): void

Parameters

Parameter	Type
value	ReactiveProp<number>

Returns

void

Inherited from

DOMElement.blur

---

brightness

Get Signature

get brightness(): number

Returns

number

Set Signature

set brightness(value: ReactiveProp<number>): void

Parameters

Parameter	Type
value	ReactiveProp<number>

Returns

void

Inherited from

DOMElement.brightness

---

color

Get Signature

get color(): string | undefined

Returns

string | undefined

Set Signature

set color(value: ReactiveProp<string> | undefined): void

Parameters

Parameter	Type
value	ReactiveProp<string> | undefined

Returns

void

Inherited from

DOMElement.color

---

height

Get Signature

get height(): Size | undefined

Returns

Size | undefined

Set Signature

set height(value: ReactiveProp<Size> | undefined): void

Parameters

Parameter	Type
value	ReactiveProp<Size> | undefined

Returns

void

Inherited from

DOMElement.height

---

opacity

Get Signature

get opacity(): number

Returns

number

Set Signature

set opacity(value: ReactiveProp<number>): void

Parameters

Parameter	Type
value	ReactiveProp<number>

Returns

void

Inherited from

DOMElement.opacity

---

origin

Get Signature

get origin(): ElementAnchor

Which point of the element sits on its coordinate (default: "top-left").

Returns

ElementAnchor

Set Signature

set origin(value: ReactiveProp<ElementAnchor> | undefined): void

Which point of the element sits on its coordinate (default: "top-left").

Parameters

Parameter	Type
value	ReactiveProp<ElementAnchor> | undefined

Returns

void

Which point of the element sits on its coordinate (default: "top-left").

Inherited from

DOMElement.origin

---

position

Get Signature

get position(): Position

Returns

Position

Set Signature

set position(value: PositionUpdater | ReactiveProp<Position> | undefined): void

Parameters

Parameter	Type
value	PositionUpdater | ReactiveProp<Position> | undefined

Returns

void

Inherited from

DOMElement.position

---

rotation

Get Signature

get rotation(): number

Returns

number

Set Signature

set rotation(value: ReactiveProp<number>): void

Parameters

Parameter	Type
value	ReactiveProp<number>

Returns

void

Inherited from

DOMElement.rotation

---

scale

Get Signature

get scale(): number

Returns

number

Set Signature

set scale(value: ReactiveProp<number>): void

Parameters

Parameter	Type
value	ReactiveProp<number>

Returns

void

Inherited from

DOMElement.scale

---

size

Get Signature

get size(): Size | undefined

Returns

Size | undefined

Set Signature

set size(value: ReactiveProp<Size> | undefined): void

Parameters

Parameter	Type
value	ReactiveProp<Size> | undefined

Returns

void

Inherited from

DOMElement.size

---

width

Get Signature

get width(): Size | undefined

Returns

Size | undefined

Set Signature

set width(value: ReactiveProp<Size> | undefined): void

Parameters

Parameter	Type
value	ReactiveProp<Size> | undefined

Returns

void

Inherited from

DOMElement.width

---

x

Get Signature

get x(): number

Returns

number

Set Signature

set x(value: CoordProp): void

Parameters

Parameter	Type
value	CoordProp

Returns

void

Inherited from

WebcamElement.x

---

y

Get Signature

get y(): number

Returns

number

Set Signature

set y(value: CoordProp): void

Parameters

Parameter	Type
value	CoordProp

Returns

void

Inherited from

DOMElement.y

---

zIndex

Get Signature

get zIndex(): string | number | undefined

Returns

string | number | undefined

Set Signature

set zIndex(value: ReactiveProp<string | number> | undefined): void

Parameters

Parameter	Type
value	ReactiveProp<string | number> | undefined

Returns

void

Inherited from

DOMElement.zIndex

Methods

cycleCamera()

cycleCamera(): Promise<void>

Returns

Promise<void>

---

decorate()

decorate(decorator: ElementDecorator): this

Applies an element decorator.

Parameters

Parameter	Type
decorator	ElementDecorator

Returns

this

Inherited from

DOMElement.decorate

---

onActivate()

onActivate(fn: () => void): () => void

Parameters

Parameter	Type
fn	() => void

Returns

() => void

Inherited from

DOMElement.onActivate

---

onClick()

onClick(handler: (event: MouseEvent) => unknown): this

Parameters

Parameter	Type
handler	(event: MouseEvent) => unknown

Returns

this

Inherited from

DOMElement.onClick

---

onDeactivate()

onDeactivate(fn: () => void): () => void

Parameters

Parameter	Type
fn	() => void

Returns

() => void

Inherited from

DOMElement.onDeactivate

---

onMount()

onMount(fn: () => void): () => void

Parameters

Parameter	Type
fn	() => void

Returns

() => void

Inherited from

DOMElement.onMount

---

onUnmount()

onUnmount(fn: () => void): () => void

Parameters

Parameter	Type
fn	() => void

Returns

() => void

Inherited from

DOMElement.onUnmount

---

onUpdate()

onUpdate(fn: (progress: number) => void): () => void

Parameters

Parameter	Type
fn	(progress: number) => void

Returns

() => void

Inherited from

DOMElement.onUpdate

---

start()

start(): Promise<void>

Returns

Promise<void>

---

stop()

stop(): void

Returns

void

---

to()

to(props: ElementTransitionProps<WebcamElement>): ElementTransition

Sets properties with one transition.

Parameters

Parameter	Type
props	ElementTransitionProps<WebcamElement>

Returns

ElementTransition

Inherited from

DOMElement.to