Class: VideoOutput
Constructors
new VideoOutput()
new VideoOutput(
_mediaData
,playback
,peer
,room
):VideoOutput
Parameters
• _mediaData
• _mediaData.id: number
• _mediaData.paused: boolean
• _mediaData.properties: object
| object
• playback: VideoPlayback
• peer: RemotePeer
• room: Room
Returns
Defined in
ari/lib/api/media/video-output.d.ts:13
Properties
kind
readonly
kind:"video-output"
="video-output"
Defined in
ari/lib/api/media/video-output.d.ts:9
peer
readonly
peer:RemotePeer
Defined in
ari/lib/api/media/video-output.d.ts:7
playback
readonly
playback:VideoPlayback
Defined in
ari/lib/api/media/video-output.d.ts:6
room
readonly
room:Room
Defined in
ari/lib/api/media/video-output.d.ts:8
Accessors
customType
get
customType():string
The custom type can be provided by the remote's VideoInput to help understanding its purpose.
Returns
string
The custom type value if available; otherwise, undefined.
Defined in
ari/lib/api/media/video-output.d.ts:53
isPaused
get
isPaused():boolean
Returns
boolean
Defined in
ari/lib/api/media/video-output.d.ts:27
isStarted
get
isStarted():boolean
Indicates whether the process has started.
Returns
boolean
True if the process has started, otherwise false.
Defined in
ari/lib/api/media/video-output.d.ts:19
mediaId
get
mediaId():number
Retrieves the media ID associated with this instance.
Returns
number
The unique identifier of the media.
Defined in
ari/lib/api/media/video-output.d.ts:41
mediaStream
get
mediaStream():MediaStream
GEt the current MediaStream associated with playback.
Returns
MediaStream
The current MediaStream if available, otherwise undefined.
Defined in
ari/lib/api/media/video-output.d.ts:47
uid
get
uid():string
Retrieves the unique identifier (UID) associated with the playback.
Returns
string
The UID of the playback.
Defined in
ari/lib/api/media/video-output.d.ts:35
Methods
pause()
pause():
Promise
<void
>