TogetherModeVideoStream interface
Represents a together mode bot video stream.
- Extends
Properties
| is |
Inherited Properties
| id | Id of the remote stream. |
| is |
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. |
| media |
Get this remote media stream type. |
| size | The stream size. The higher the stream size, the better the video quality. |
Methods
| off("is |
Subscribe function for isAvailable event. |
| off("is |
Unsubscribe function for isReceivingChanged event. |
| off("size |
Unsubscribe function for sizeChanged event. |
| on("is |
Subscribe function for isAvailable event. |
| on("is |
Subscribe function for isReceivingChanged event. |
| on("size |
Subscribe function for sizeChanged event. |
Property Details
isAvailable
isAvailable: booleanProperty Value
boolean
Inherited Property Details
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: booleanProperty Value
boolean
Inherited From RemoteVideoStreamCommon.isReceiving
mediaStreamType
Get this remote media stream type.
mediaStreamType: MediaStreamTypeProperty Value
Inherited From RemoteVideoStreamCommon.mediaStreamType
size
The stream size. The higher the stream size, the better the video quality.
size: StreamSizeProperty Value
Inherited From RemoteVideoStreamCommon.size
Method Details
off("isAvailableChanged", PropertyChangedEvent)
Subscribe function for isAvailable event.
function off(event: "isAvailableChanged", listener: PropertyChangedEvent)Parameters
- event
-
"isAvailableChanged"
event name.
- listener
- PropertyChangedEvent
callback fn that will be called when value of this property will change.
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("isAvailableChanged", PropertyChangedEvent)
Subscribe function for isAvailable event.
function on(event: "isAvailableChanged", listener: PropertyChangedEvent)Parameters
- event
-
"isAvailableChanged"
event name.
- listener
- PropertyChangedEvent
callback fn that will be called when value of this property will change.
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.