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
Defined in
ari/lib/api/media/video-input.d.ts:11
Properties
capture
readonlycapture:VideoCapture
Defined in
ari/lib/api/media/video-input.d.ts:9
kind
readonlykind:"video-input"="video-input"
Defined in
ari/lib/api/media/video-input.d.ts:10
Accessors
customType
getcustomType():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:28
mediaStream
getmediaStream():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:20
volume
getvolume():InputVolume
Returns
Defined in
ari/lib/api/media/video-input.d.ts:12
Methods
close()
close():
void
Returns
void
Defined in
ari/lib/api/media/video-input.d.ts:29