RemoteVideoStream interface
リモート参加者のビデオまたは画面共有を表します。
- Extends
プロパティ
is |
ストリームが UI でのレンダリングに使用できるかどうかを示します。 このフラグが true になると、リモート参加者のビデオがオンになります。このリモート ビデオ ストリームを UI に表示するビューを作成できます。 |
継承されたプロパティ
id | リモート ストリームの ID。 |
is |
ビデオ パケットを受信しているかどうか。 このフラグは、リモート ビデオのフリーズ、ネットワーク帯域幅の低下などの場合に false になる可能性があります。isReceiving が false で isAvailable が true の場合は、ビデオの上に読み込みスピナーを表示することをお勧めします。 |
media |
このリモート メディア ストリームの種類を取得します。 |
size | ストリーム サイズ。 ストリーム サイズが大きいほど、ビデオの品質が向上します。 |
メソッド
get |
リモート生ビデオ ストリームを取得する |
off("is |
isAvailableChanged イベントの Unsubscribe 関数。 |
off("is |
isRenderingChanged イベントの Unsubscribe 関数。 |
off("size |
sizeChanged イベントの Unsubscribe 関数。 |
on("is |
isAvailableChanged イベントのサブスクライブ関数。 |
on("is |
isRenderingChanged イベントのサブスクライブ関数。 |
on("size |
sizeChanged イベントのサブスクライブ関数。 |
プロパティの詳細
isAvailable
ストリームが UI でのレンダリングに使用できるかどうかを示します。 このフラグが true になると、リモート参加者のビデオがオンになります。このリモート ビデオ ストリームを UI に表示するビューを作成できます。
isAvailable: boolean
プロパティ値
boolean
継承されたプロパティの詳細
id
リモート ストリームの ID。
id: number
プロパティ値
number
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 イベントの Unsubscribe 関数。
function off(event: "isAvailableChanged", listener: PropertyChangedEvent)
パラメーター
- event
-
"isAvailableChanged"
イベント名。
- listener
- PropertyChangedEvent
このイベントのサブスクライブに使用されたコールバック fn。
off("isReceivingChanged", PropertyChangedEvent)
isRenderingChanged イベントの Unsubscribe 関数。
function off(event: "isReceivingChanged", listener: PropertyChangedEvent)
パラメーター
- event
-
"isReceivingChanged"
イベント名。
- listener
- PropertyChangedEvent
このイベントのサブスクライブに使用されたコールバック fn。
off("sizeChanged", PropertyChangedEvent)
sizeChanged イベントの Unsubscribe 関数。
function off(event: "sizeChanged", listener: PropertyChangedEvent)
パラメーター
- event
-
"sizeChanged"
イベント名。
- listener
- PropertyChangedEvent
このイベントのサブスクライブに使用されたコールバック fn。
on("isAvailableChanged", PropertyChangedEvent)
isAvailableChanged イベントのサブスクライブ関数。
function on(event: "isAvailableChanged", listener: PropertyChangedEvent)
パラメーター
- event
-
"isAvailableChanged"
イベント名。
- listener
- PropertyChangedEvent
このプロパティの値が変更されたときに呼び出されるコールバック fn。
on("isReceivingChanged", PropertyChangedEvent)
isRenderingChanged イベントのサブスクライブ関数。
function on(event: "isReceivingChanged", listener: PropertyChangedEvent)
パラメーター
- event
-
"isReceivingChanged"
イベント名。
- listener
- PropertyChangedEvent
このプロパティの値が変更されたときに呼び出されるコールバック fn。
on("sizeChanged", PropertyChangedEvent)
sizeChanged イベントのサブスクライブ関数。
function on(event: "sizeChanged", listener: PropertyChangedEvent)
パラメーター
- event
-
"sizeChanged"
イベント名。
- listener
- PropertyChangedEvent
このプロパティの値が変更されたときに呼び出されるコールバック fn。