RemoteVideoStream interface

Пакет:

@azure/communication-calling

Представляет видео или общий доступ к экрану удаленного участника.

Extends

RemoteVideoStreamCommon

Свойства

isAvailable

Доступен ли поток для отрисовки в пользовательском интерфейсе. Когда этот флаг становится истинным, удаленный участник включил видео. и мы можем создать представление для отображения этого удаленного видеопотока в пользовательском интерфейсе.

Унаследованные свойства

id	Идентификатор удаленного потока.
isReceiving	Будут ли получены видеопакеты. Этот флаг может стать ложным в таких случаях, как зависание удаленного видео, низкая пропускная способность сети и т. д. Рекомендуется отобразить спиннер загрузки по видео, если isReceiving имеет значение false и isAvailable имеет значение true.
mediaStreamType	Получите этот тип удаленного потока мультимедиа.
size	Размер потока. Чем выше размер потока, тем лучше качество видео.

Методы

getMediaStream()	Получение удаленного необработанного видеопотока
off("isAvailableChanged", PropertyChangedEvent)	Отмена подписки для события IsAvailableChanged.
off("isReceivingChanged", PropertyChangedEvent)	Отмена подписки для события isRenderingChanged.
off("sizeChanged", PropertyChangedEvent)	Отмена подписки для события sizeChanged.
on("isAvailableChanged", PropertyChangedEvent)	Функция подписки для события IsAvailableChanged.
on("isReceivingChanged", PropertyChangedEvent)	Функция подписки для события isRenderingChanged.
on("sizeChanged", PropertyChangedEvent)	Функция подписки для события sizeChanged.

Сведения о свойстве

isAvailable

Доступен ли поток для отрисовки в пользовательском интерфейсе. Когда этот флаг становится истинным, удаленный участник включил видео. и мы можем создать представление для отображения этого удаленного видеопотока в пользовательском интерфейсе.

isAvailable: boolean

Значение свойства

boolean

Сведения об унаследованном свойстве

id

Идентификатор удаленного потока.

id: number

Значение свойства

number

унаследован отRemoteVideoStreamCommon.id

isReceiving

Будут ли получены видеопакеты. Этот флаг может стать ложным в таких случаях, как зависание удаленного видео, низкая пропускная способность сети и т. д. Рекомендуется отобразить спиннер загрузки по видео, если 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.

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, который будет вызываться при изменении значения этого свойства.