Skip to main content

Class: CamFeed

Defined in: drivers/CamFeed.ts:54

The generic driver for a camera tool

Extended by​

Constructors​

Constructor​

new CamFeed(log, options): CamFeed;

Defined in: drivers/CamFeed.ts:88

Parameters​

ParameterType
logany
optionsIKeyValue

Returns​

CamFeed

Properties​

PropertyTypeDescriptionDefined in
mediaStreamMediaStreamMedia stream with track from videoSourcedrivers/CamFeed.ts:65

Methods​

blocking()​

blocking(): Promise<unknown>;

Defined in: drivers/CamFeed.ts:389

Checks if camera feed is running, if so it will set up an event emitter for stage_terminating

Returns​

Promise<unknown>

A promise (either rejecting or explaining reason for the termination of the camera driver)


start()​

start(): Promise<null>;

Defined in: drivers/CamFeed.ts:343

Starts the camera feed process by determining if multiple cameras are plugged in and adjusting the camera settings/configurations.

Returns​

Promise<null>


stop()​

stop(reason): void;

Defined in: drivers/CamFeed.ts:367

Stops the camera stream and terminates connections

Parameters​

ParameterTypeDescription
reasonstringReason for stopping the camera feed

Returns​

void

Nothing