共用方式為


RemoteVideoStream interface

代表遠程參與者的視訊或屏幕共用。

Extends

屬性

isAvailable

數據流是否可以在UI中轉譯。 當此旗標變成 true 時,遠端參與者已開啟其視訊。我們可以建立檢視,在UI上顯示此遠端視訊串流。

繼承的屬性

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: 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

方法詳細資料

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,會在此屬性的值變更時呼叫。