Interface VideoTransformDevice

A device that applies processing to another device.

Hierarchy

VideoTransformDevice

Implemented by

DefaultVideoTransformDevice

Index

Properties

outputMediaStream

Methods

Properties

Readonly outputMediaStream

outputMediaStream: MediaStream

outputMediaStream is generated after processors are applied. It will be auto-released after stop is called.

Methods

intrinsicDevice

intrinsicDevice(): Promise<Device>

- Defined in src/devicecontroller/VideoTransformDevice.ts:19
Returns the inner Device that the device controller should select as active video device.

Returns Promise<Device>

onOutputStreamDisconnect

onOutputStreamDisconnect(): void

- Defined in src/devicecontroller/VideoTransformDevice.ts:29
onOutputStreamDisconnect is called when device controller disconnects the transformed video stream.

Returns void

stop

stop(): Promise<void>

- Defined in src/devicecontroller/VideoTransformDevice.ts:14
stop should be called to free any resources associated with the device. It must be called if transformStream is ever called.

Returns Promise<void>

transformStream

transformStream(mediaStream?: MediaStream): Promise<MediaStream>

- Defined in src/devicecontroller/VideoTransformDevice.ts:24
Starts processing the input MediaStream and returns the output MediaStream.

Parameters
- Optional mediaStream: MediaStream
Returns Promise<MediaStream>

Generated using TypeDoc