Class Webcam

Player input from webcam video

Hierarchy

Webcam

Implements

Input

Index

Constructors

constructor

Methods

Constructors

constructor

new Webcam(videoConstraints?: MediaTrackConstraints): Webcam

Parameters
- Optional videoConstraints: MediaTrackConstraints
  
  constraints to be merged with defaultVideoConstraints and to be passed to navigator.mediaDevices.getUserMedia()
Returns Webcam

Methods

[Symbol.asyncIterator]

[Symbol.asyncIterator](__namedParameters?: InputOptions): AsyncGenerator<ImageData, void, unknown>

Implementation of Input.[Symbol.asyncIterator]

Yields webcam video as sequence of ImageData frames

Parameters
- __namedParameters: InputOptions = {}
Returns AsyncGenerator<ImageData, void, unknown>

start

start(): Promise<Webcam>

Manually starts webcam

Ordinary webcam is lazily started during async iteration over it.
But sometimes you may want to manually pre-start webcam e.g during parallel creation of a Player instance:
```
const [webcam, player] = await Promise.all([
 new Webcam().start(),
 Player.create({ clientToken: "xxx-xxx-xxx" }),
])

player.use(webcam)
```
Returns Promise<Webcam>

stop

stop(): void

Turns off webcam

Returns void