TogetherModeVideoStream interface

Package:

@azure/communication-calling

Note

This API is in Beta and provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents a together mode bot video stream.

Extends

RemoteVideoStreamCommon

Inherited Properties

id	Id of the remote stream.
isReceiving	Whether video packets are being received. This flag can become false in cases such as remote video freezes, low network bandwidth, etc. It is recommended to display a loading spinner over the video, if isReceiving is false and isAvailable is true.
mediaStreamType	Get this remote media stream type.
size	The stream size. The higher the stream size, the better the video quality.

Methods

off("isReceivingChanged", PropertyChangedEvent)	Unsubscribe function for isReceivingChanged event.
off("sizeChanged", PropertyChangedEvent)	Unsubscribe function for sizeChanged event.
on("isReceivingChanged", PropertyChangedEvent)	Subscribe function for isReceivingChanged event.
on("sizeChanged", PropertyChangedEvent)	Subscribe function for sizeChanged event.

Inherited Property Details

id

Id of the remote stream.

id: number

Property Value

number

Inherited From RemoteVideoStreamCommon.id

isReceiving

Whether video packets are being received. This flag can become false in cases such as remote video freezes, low network bandwidth, etc. It is recommended to display a loading spinner over the video, if isReceiving is false and isAvailable is true.

isReceiving: boolean

Property Value

boolean

Inherited From RemoteVideoStreamCommon.isReceiving

mediaStreamType

Get this remote media stream type.

mediaStreamType: MediaStreamType

Property Value

MediaStreamType

Inherited From RemoteVideoStreamCommon.mediaStreamType

size

The stream size. The higher the stream size, the better the video quality.

size: StreamSize

Property Value

StreamSize

Inherited From RemoteVideoStreamCommon.size

Method Details

off("isReceivingChanged", PropertyChangedEvent)

Unsubscribe function for isReceivingChanged event.

function off(event: "isReceivingChanged", listener: PropertyChangedEvent)

Parameters

event

"isReceivingChanged"

event name.

listener

PropertyChangedEvent

callback fn that was used to subscribe to this event.

off("sizeChanged", PropertyChangedEvent)

Unsubscribe function for sizeChanged event.

function off(event: "sizeChanged", listener: PropertyChangedEvent)

Parameters

event

"sizeChanged"

event name.

listener

PropertyChangedEvent

callback fn that was used to subscribe to this event.

on("isReceivingChanged", PropertyChangedEvent)

Subscribe function for isReceivingChanged event.

function on(event: "isReceivingChanged", listener: PropertyChangedEvent)

Parameters

event

"isReceivingChanged"

event name.

listener

PropertyChangedEvent

callback fn that will be called when value of this property will change.

on("sizeChanged", PropertyChangedEvent)

Subscribe function for sizeChanged event.

function on(event: "sizeChanged", listener: PropertyChangedEvent)

Parameters

event

"sizeChanged"

event name.

listener

PropertyChangedEvent

callback fn that will be called when value of this property will change.