RemoteParticipant interface
Представляет удаленного участника в вызове.
- Extends
Свойства
| call |
Причина того, почему участник покинул вызов, содержит код/ вложенный код/сообщение. |
| is |
Независимо от того, отключен ли этот удаленный участник. |
| is |
Независимо от того, говорит ли этот удаленный участник. |
| role | Получите роль этого удаленного участника. |
| state | Получение состояния этого удаленного участника. |
| video |
Коллекция видеопотоков, которые участники имеют. |
Унаследованные свойства
| display |
Необязательное отображаемое имя, если оно было задано конечной точкой этого удаленного участника. |
| endpoint |
Получение сведений обо всех конечных точках для этого удаленного участника |
| identifier | Получите идентификатор для этого удаленного участника. |
Методы
| mute() | Отключение микрофона этого удаленного участника. |
| off("display |
Отмена подписки для события displayNameChanged. |
| off("is |
Отмена подписки для события IsMutedChanged. |
| off("is |
Отмена подписки для события isSpeakingChanged. |
| off("role |
Отмена подписки для события roleChanged. |
| off("state |
Отмена подписки для события stateChanged. |
| off("video |
Отмена подписки для события videoStreamsUpdated. |
| on("display |
Функция подписки для события displayNameChanged. |
| on("is |
Функция подписки для события IsMutedChanged. |
| on("is |
Функция подписки для события isSpeakingChanged. |
| on("role |
Функция подписки для события roleChanged. |
| on("state |
Функция подписки для события stateChanged. |
| on("video |
Функция подписки для события videoStreamsUpdated. |
Сведения о свойстве
callEndReason
Причина того, почему участник покинул вызов, содержит код/ вложенный код/сообщение.
callEndReason?: CallEndReasonЗначение свойства
isMuted
Независимо от того, отключен ли этот удаленный участник.
isMuted: booleanЗначение свойства
boolean
isSpeaking
Независимо от того, говорит ли этот удаленный участник.
isSpeaking: booleanЗначение свойства
boolean
role
state
Получение состояния этого удаленного участника.
state: RemoteParticipantStateЗначение свойства
videoStreams
Коллекция видеопотоков, которые участники имеют.
videoStreams: readonly RemoteVideoStream[]Значение свойства
readonly RemoteVideoStream[]
Сведения об унаследованном свойстве
displayName
Необязательное отображаемое имя, если оно было задано конечной точкой этого удаленного участника.
displayName?: stringЗначение свойства
string
наследуется отParticipantInfo.displayName
endpointDetails
Получение сведений обо всех конечных точках для этого удаленного участника
endpointDetails: EndpointDetails[]Значение свойства
наследуется отParticipantInfo.endpointDetails
identifier
Получите идентификатор для этого удаленного участника.
identifier: CommunicationIdentifierKindЗначение свойства
Наследуется отParticipantInfo.identifier
Сведения о методе
mute()
Отключение микрофона этого удаленного участника.
function mute(): Promise<void>Возвращаемое значение
Promise<void>
off("displayNameChanged", PropertyChangedEvent)
Отмена подписки для события displayNameChanged.
function off(event: "displayNameChanged", listener: PropertyChangedEvent)Параметры
- event
-
"displayNameChanged"
имя события.
- listener
- PropertyChangedEvent
обратный вызов fn, который использовался для подписки на это событие.
off("isMutedChanged", PropertyChangedEvent)
Отмена подписки для события IsMutedChanged.
function off(event: "isMutedChanged", listener: PropertyChangedEvent)Параметры
- event
-
"isMutedChanged"
имя события.
- listener
- PropertyChangedEvent
обратный вызов fn, который использовался для подписки на это событие.
off("isSpeakingChanged", PropertyChangedEvent)
Отмена подписки для события isSpeakingChanged.
function off(event: "isSpeakingChanged", listener: PropertyChangedEvent)Параметры
- event
-
"isSpeakingChanged"
имя события.
- listener
- PropertyChangedEvent
обратный вызов fn, который использовался для подписки на это событие.
off("roleChanged", PropertyChangedEvent)
Отмена подписки для события roleChanged.
function off(event: "roleChanged", listener: PropertyChangedEvent)Параметры
- event
-
"roleChanged"
имя события.
- listener
- PropertyChangedEvent
обратный вызов fn, который использовался для подписки на это событие.
off("stateChanged", PropertyChangedEvent)
Отмена подписки для события stateChanged.
function off(event: "stateChanged", listener: PropertyChangedEvent)Параметры
- event
-
"stateChanged"
имя события.
- listener
- PropertyChangedEvent
обратный вызов fn, который использовался для подписки на это событие.
off("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)
Отмена подписки для события videoStreamsUpdated.
function off(event: "videoStreamsUpdated", listener: CollectionUpdatedEvent<RemoteVideoStream>)Параметры
- event
-
"videoStreamsUpdated"
имя события.
- listener
обратный вызов fn, который использовался для подписки на это событие.
on("displayNameChanged", PropertyChangedEvent)
Функция подписки для события displayNameChanged.
function on(event: "displayNameChanged", listener: PropertyChangedEvent)Параметры
- event
-
"displayNameChanged"
имя события.
- listener
- PropertyChangedEvent
обратный вызов fn, который будет вызываться при изменении значения этого свойства.
on("isMutedChanged", PropertyChangedEvent)
Функция подписки для события IsMutedChanged.
function on(event: "isMutedChanged", listener: PropertyChangedEvent)Параметры
- event
-
"isMutedChanged"
имя события.
- listener
- PropertyChangedEvent
обратный вызов fn, который будет вызываться при изменении значения этого свойства.
on("isSpeakingChanged", PropertyChangedEvent)
Функция подписки для события isSpeakingChanged.
function on(event: "isSpeakingChanged", listener: PropertyChangedEvent)Параметры
- event
-
"isSpeakingChanged"
имя события.
- listener
- PropertyChangedEvent
обратный вызов fn, который будет вызываться при изменении значения этого свойства.
on("roleChanged", PropertyChangedEvent)
Функция подписки для события roleChanged.
function on(event: "roleChanged", listener: PropertyChangedEvent)Параметры
- event
-
"roleChanged"
имя события.
- listener
- PropertyChangedEvent
обратный вызов fn, который будет вызываться при изменении значения этого свойства.
on("stateChanged", PropertyChangedEvent)
Функция подписки для события stateChanged.
function on(event: "stateChanged", listener: PropertyChangedEvent)Параметры
- event
-
"stateChanged"
имя события.
- listener
- PropertyChangedEvent
обратный вызов fn, который будет вызываться при изменении значения этого свойства.
on("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)
Функция подписки для события videoStreamsUpdated.
function on(event: "videoStreamsUpdated", listener: CollectionUpdatedEvent<RemoteVideoStream>)Параметры
- event
-
"videoStreamsUpdated"
имя события.
- listener
обратный вызов fn, который будет вызываться при изменении этой коллекции, он будет передавать массивы добавленных и удаленных элементов.