Skip to main content

Class: VideoInput

Represents a video input media for use in applications that involve video communication or playback. The VideoInput class encapsulates a video capture source and provides access to its related MediaStream and custom type.

Constructors​

new VideoInput()​

new VideoInput(capture): VideoInput

Parameters​

• capture: VideoCapture

Returns​

VideoInput

Defined in​

ari/lib/api/media/video-input.d.ts:11

Properties​

capture​

readonly capture: VideoCapture

Defined in​

ari/lib/api/media/video-input.d.ts:9

kind​

readonly kind: "video-input" = "video-input"

Defined in​

ari/lib/api/media/video-input.d.ts:10

Accessors​

customType​

get customType(): string

The custom type helps to identify the purpose of the VideoInput. When adding the VideoInput to a room, the customType can be used by remote peers to understand the purpose of the stream.

Returns​

string

The custom type value if available; otherwise, undefined.

Defined in​

ari/lib/api/media/video-input.d.ts:27

mediaStream​

get mediaStream(): MediaStream

The MediaStream of the VideoInput that is sent to remote peers for video playback.

Throws​

Throws an error if the MediaStream is not available.

Returns​

MediaStream

The MediaStream object if playback has been started.

Defined in​

ari/lib/api/media/video-input.d.ts:19