Skip to main content

Class: GenericCamera

Defined in: drivers/generic_camera/index.ts:12

Generic Camera driver for video tools, extends the CamFeed class

Extends

Constructors

Constructor

new GenericCamera(log, options): GenericCamera;

Defined in: drivers/generic_camera/index.ts:19

Parameters

ParameterType
logany
optionsIKeyValue

Returns

GenericCamera

Overrides

CamFeed.constructor

Properties

PropertyModifierTypeDefault valueDescriptionInherited fromDefined in
mediaStreampublicMediaStreamundefinedMedia stream with track from videoSourceCamFeed.mediaStreamdrivers/CamFeed.ts:65
toolNamestaticstring'generic_camera'Generic camera's tool name-drivers/generic_camera/index.ts:17
userClassstaticstring'GenericCamera-v1'Device type of the Generic Camera-drivers/generic_camera/index.ts:14

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)

Inherited from

CamFeed.blocking


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>

Inherited from

CamFeed.start


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

Inherited from

CamFeed.stop