Class Webcam

Class to setup the webcam.

Hierarchy (View Summary)

EventEmitter
- Webcam

Index

Constructors

Properties

eventHandlers video

Methods

dispose emit getVideoDimensions off on

Constructors

constructor

new Webcam(
constraints?: { video: { facingMode: string } },
videoElementSelector?: string,
): Webcam
Create a Webcam.
Parameters
- constraints: { video: { facingMode: string } } = ...
  {Object} - options to use for initialising the camera. This is the same constraints object as used by standard MediaDevices API.
- OptionalvideoElementSelector: string
  selector to obtain the HTML video element to render the webcam feed. If a falsy value (e.g. null or undefined), a video element will be created.
Returns Webcam
Overrides EventEmitter.constructor
- Defined in lib/three/webcam.ts:22

Properties

eventHandlers

eventHandlers: Record<string, ((...args: any[]) => void)[]>

video

video: HTMLVideoElement | null

The raw HTMLVideoElement.

Methods

dispose

dispose(): void
Free up the resources associated with the Webcam.

Returns void
- Defined in lib/three/webcam.ts:94

emit

emit(eventName: string, ...params: any[]): void
Emit an event.
Parameters
- eventName: string
  the event to emit.
- ...params: any[]
Returns void
Inherited from EventEmitter.emit
- Defined in lib/three/event-emitter.ts:26

getVideoDimensions

getVideoDimensions(): string
Returns string
- Defined in lib/three/webcam.ts:87

off

off(eventName: string, eventHandler: (...args: any[]) => void): void
Remove an event handler.
Parameters
- eventName: string
  the event to remove a handler from.
- eventHandler: (...args: any[]) => void
  the event handler function to remove.
Returns void
Inherited from EventEmitter.off
- Defined in lib/three/event-emitter.ts:37

on

on(eventName: string, eventHandler: (...args: any[]) => void): void
Add an event handler.
Parameters
- eventName: string
  the event to handle.
- eventHandler: (...args: any[]) => void
  the event handler function.
Returns void
Inherited from EventEmitter.on
- Defined in lib/three/event-emitter.ts:14