通过

RemoteVideoStream interface

  • 参考
包:
@azure/communication-calling

表示远程参与者的视频或屏幕共享。

扩展
RemoteVideoStreamCommon

属性

isAvailable

流是否可用于在 UI 中呈现。 当此标志变为 true 时，远程参与者已打开其视频。我们可以创建一个视图，以在 UI 上显示此远程视频流。

继承属性

id

远程流的 ID。
isReceiving

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

获取此远程媒体流类型。
size

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

方法

getMediaStream()

获取远程原始视频流
off("isAvailableChanged", PropertyChangedEvent)

取消订阅 isAvailableChanged 事件的函数。
off("isReceivingChanged", PropertyChangedEvent)

取消订阅 isRenderingChanged 事件的订阅函数。
off("sizeChanged", PropertyChangedEvent)

取消订阅 sizeChanged 事件的函数。
on("isAvailableChanged", PropertyChangedEvent)

isAvailableChanged 事件的 Subscribe 函数。
on("isReceivingChanged", PropertyChangedEvent)

isRenderingChanged 事件的 Subscribe 函数。
on("sizeChanged", PropertyChangedEvent)

SizeChanged 事件的 Subscribe 函数。

属性详细信息

isAvailable

流是否可用于在 UI 中呈现。 当此标志变为 true 时，远程参与者已打开其视频。我们可以创建一个视图，以在 UI 上显示此远程视频流。

isAvailable: boolean

属性值

boolean

继承属性详细信息

id

远程流的 ID。

id: number

属性值

number

继承自RemoteVideoStreamCommon.id 的

isReceiving

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

isReceiving: boolean

属性值

boolean

继承自remoteVideoStreamCommon.isReceiving

mediaStreamType

获取此远程媒体流类型。

mediaStreamType: MediaStreamType

属性值

MediaStreamType

继承自remoteVideoStreamCommon.mediaStreamType

size

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

size: StreamSize

属性值

StreamSize

继承自 remoteVideoStreamCommon.size

方法详细信息

getMediaStream()

获取远程原始视频流

function getMediaStream(): Promise<MediaStream>

返回

Promise<MediaStream>

MediaStream 或未定义。

off("isAvailableChanged", PropertyChangedEvent)

取消订阅 isAvailableChanged 事件的函数。

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

参数

event

"isAvailableChanged"

事件名称。

listener
PropertyChangedEvent

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

off("isReceivingChanged", PropertyChangedEvent)

取消订阅 isRenderingChanged 事件的订阅函数。

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("isAvailableChanged", PropertyChangedEvent)

isAvailableChanged 事件的 Subscribe 函数。

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

参数

event

"isAvailableChanged"

事件名称。

listener
PropertyChangedEvent

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

on("isReceivingChanged", PropertyChangedEvent)

isRenderingChanged 事件的 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，将在此属性的值发生更改时调用。