Interface VideoTransformDevice

A device that applies processing to another device.

interface VideoTransformDevice {
    outputMediaStream: MediaStream;
    intrinsicDevice(): Promise<Device>;
    onOutputStreamDisconnect(): void;
    stop(): Promise<void>;
    transformStream(mediaStream?: MediaStream): Promise<MediaStream>;
}

Implemented by

DefaultVideoTransformDevice

Index

Properties

outputMediaStream

Methods

intrinsicDevice onOutputStreamDisconnect stop transformStream

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>
Returns the inner Device that the device controller should select as active video device.

Returns Promise<Device>
- Defined in src/devicecontroller/VideoTransformDevice.ts:19

onOutputStreamDisconnect

onOutputStreamDisconnect(): void
onOutputStreamDisconnect is called when device controller disconnects the transformed video stream.

Returns void
- Defined in src/devicecontroller/VideoTransformDevice.ts:29

stop

stop(): Promise<void>
stop should be called to free any resources associated with the device. It must be called if transformStream is ever called.

Returns Promise<void>
- Defined in src/devicecontroller/VideoTransformDevice.ts:14

transformStream

transformStream(mediaStream?: MediaStream): Promise<MediaStream>
Starts processing the input MediaStream and returns the output MediaStream.
Parameters
- OptionalmediaStream: MediaStream
Returns Promise<MediaStream>
- Defined in src/devicecontroller/VideoTransformDevice.ts:24