TogetherModeVideoStream interface

注意

此 API 以 Beta 版本预览形式提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

表示一起模式机器人视频流。

扩展

继承属性

id

远程流的 ID。

isReceiving

是否接收视频数据包。 在远程视频冻结、低网络带宽等情况下,此标志可能会变为 false。如果 isReceiving 为 false 且 isAvailable 为 true,则建议在视频上显示加载微调器。

mediaStreamType

获取此远程媒体流类型。

size

流大小。 流大小越高,视频质量就越好。

方法

off("isReceivingChanged", PropertyChangedEvent)

取消订阅 isReceivingChanged 事件的函数。

off("sizeChanged", PropertyChangedEvent)

取消订阅 sizeChanged 事件的函数。

on("isReceivingChanged", PropertyChangedEvent)

isReceivingChanged 事件的 Subscribe 函数。

on("sizeChanged", PropertyChangedEvent)

SizeChanged 事件的 Subscribe 函数。

继承属性详细信息

id

远程流的 ID。

id: number

属性值

number

继承自RemoteVideoStreamCommon.id

isReceiving

是否接收视频数据包。 在远程视频冻结、低网络带宽等情况下,此标志可能会变为 false。如果 isReceiving 为 false 且 isAvailable 为 true,则建议在视频上显示加载微调器。

isReceiving: boolean

属性值

boolean

继承自remoteVideoStreamCommon.isReceiving

mediaStreamType

获取此远程媒体流类型。

mediaStreamType: MediaStreamType

属性值

继承自remoteVideoStreamCommon.mediaStreamType

size

流大小。 流大小越高,视频质量就越好。

size: StreamSize

属性值

继承自 remoteVideoStreamCommon.size

方法详细信息

off("isReceivingChanged", PropertyChangedEvent)

取消订阅 isReceivingChanged 事件的函数。

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

参数

event

"isReceivingChanged"

事件名称。

listener
PropertyChangedEvent

用于订阅此事件的回调 fn。

off("sizeChanged", PropertyChangedEvent)

取消订阅 sizeChanged 事件的函数。

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

参数

event

"sizeChanged"

事件名称。

listener
PropertyChangedEvent

用于订阅此事件的回调 fn。

on("isReceivingChanged", PropertyChangedEvent)

isReceivingChanged 事件的 Subscribe 函数。

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

参数

event

"isReceivingChanged"

事件名称。

listener
PropertyChangedEvent

回调 fn,将在此属性的值发生更改时调用。

on("sizeChanged", PropertyChangedEvent)

SizeChanged 事件的 Subscribe 函数。

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

参数

event

"sizeChanged"

事件名称。

listener
PropertyChangedEvent

回调 fn,将在此属性的值发生更改时调用。