Class VideoCapture

General interface for any video capture subsystem, user-implementable.

Events:

data(VideoFrame): A video frame is available.

Hierarchy

EventEmitter
- VideoCapture
  - VideoCaptureTee
  - VideoCaptureCanvas

Index

Constructors

constructor

Properties

VideoFrame

Methods

Constructors

constructor

new VideoCapture(): VideoCapture

Overrides EventEmitter.constructor
- Defined in video-capture.ts:28
Returns VideoCapture

Properties

Optional VideoFrame

VideoFrame?: typeof VideoFrame

VideoFrame type to be used by captured frame, set by the user, but restricted by certain capture types.

Methods

Abstract close

close(): void

- Defined in video-capture.ts:36
Stop this video capture and remove any underlying data.

Returns void

emitEvent

emitEvent(ev: string, arg: any): void

Inherited from EventEmitter.emitEvent
- Defined in events.ts:70
Emit this event.

Parameters
- ev: string
  
  Event name to emit.
- arg: any
  
  Argument to the event handler(s).
Returns void

Abstract getFramerate

getFramerate(): number

- Defined in video-capture.ts:88
Get the framerate of this capture.

Returns number

Abstract getHeight

getHeight(): number

- Defined in video-capture.ts:83
Get the height of video frames from this capture.

Returns number

Abstract getWidth

getWidth(): number

- Defined in video-capture.ts:78
Get the width of video frames from this capture.

Returns number

off

off(ev: string, handler: EventHandler): void

Inherited from EventEmitter.off
- Defined in events.ts:55
Remove an event handler.

Parameters
- ev: string
  
  Event name.
- handler: EventHandler
  
  Handler to remove.
Returns void

on

on(ev: string, handler: EventHandler): void

Inherited from EventEmitter.on
- Defined in events.ts:33
Set an event handler.

Parameters
- ev: string
  
  Event name, or "*" for all events.
- handler: EventHandler
  
  Event handler for this event.
Returns void

once

once(ev: string, handler: EventHandler): void

Inherited from EventEmitter.once
- Defined in events.ts:44
Set a one-time event handler.

Parameters
- ev: string
  
  Event name, or "*" for all events.
- handler: EventHandler
  
  Event handler for this event.
Returns void

tee

tee(ct: number): VideoCapture[]

- Defined in video-capture.ts:42
"Tee" this capture into the number of receivers specified.

Parameters
- ct: number
  
  Number of duplicates to make.
Returns VideoCapture[]

Generated using TypeDoc