RemoteParticipant interface
통화의 원격 참가자를 나타냅니다.
- Extends
속성
call |
참가자가 통화를 떠난 이유, 코드/하위 코드/메시지가 포함되어 있습니다. |
is |
이 원격 참가자가 음소거되었는지 여부입니다. |
is |
이 원격 참가자가 말하는지 여부입니다. |
role | 이 원격 참가자의 역할을 가져옵니다. |
state | 이 원격 참가자의 상태를 가져옵니다. |
video |
이 참가자가 가지고 있는 비디오 스트림의 컬렉션입니다. |
상속된 속성
display |
선택적 표시 이름(해당 원격 참가자의 엔드포인트에 의해 설정된 경우)입니다. |
endpoint |
이 원격 참가자에 대한 모든 엔드포인트의 세부 정보 가져오기 |
identifier | 이 원격 참가자의 식별자를 가져옵니다. |
메서드
속성 세부 정보
callEndReason
isMuted
이 원격 참가자가 음소거되었는지 여부입니다.
isMuted: boolean
속성 값
boolean
isSpeaking
이 원격 참가자가 말하는지 여부입니다.
isSpeaking: boolean
속성 값
boolean
role
state
videoStreams
이 참가자가 가지고 있는 비디오 스트림의 컬렉션입니다.
videoStreams: readonly RemoteVideoStream[]
속성 값
readonly RemoteVideoStream[]
상속된 속성 세부 정보
displayName
선택적 표시 이름(해당 원격 참가자의 엔드포인트에 의해 설정된 경우)입니다.
displayName?: string
속성 값
string
endpointDetails
이 원격 참가자에 대한 모든 엔드포인트의 세부 정보 가져오기
endpointDetails: EndpointDetails[]
속성 값
identifier
이 원격 참가자의 식별자를 가져옵니다.
identifier: CommunicationIdentifierKind
속성 값
메서드 세부 정보
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 이벤트에 대한 Subscribe 함수입니다.
function on(event: "displayNameChanged", listener: PropertyChangedEvent)
매개 변수
- event
-
"displayNameChanged"
이벤트 이름입니다.
- listener
- PropertyChangedEvent
이 속성의 값이 변경될 때 호출되는 콜백 fn입니다.
on("isMutedChanged", PropertyChangedEvent)
isMutedChanged 이벤트에 대한 Subscribe 함수입니다.
function on(event: "isMutedChanged", listener: PropertyChangedEvent)
매개 변수
- event
-
"isMutedChanged"
이벤트 이름입니다.
- listener
- PropertyChangedEvent
이 속성의 값이 변경될 때 호출되는 콜백 fn입니다.
on("isSpeakingChanged", PropertyChangedEvent)
isSpeakingChanged 이벤트에 대한 Subscribe 함수입니다.
function on(event: "isSpeakingChanged", listener: PropertyChangedEvent)
매개 변수
- event
-
"isSpeakingChanged"
이벤트 이름입니다.
- listener
- PropertyChangedEvent
이 속성의 값이 변경될 때 호출되는 콜백 fn입니다.
on("roleChanged", PropertyChangedEvent)
roleChanged 이벤트에 대한 Subscribe 함수입니다.
function on(event: "roleChanged", listener: PropertyChangedEvent)
매개 변수
- event
-
"roleChanged"
이벤트 이름입니다.
- listener
- PropertyChangedEvent
이 속성의 값이 변경될 때 호출되는 콜백 fn입니다.
on("stateChanged", PropertyChangedEvent)
stateChanged 이벤트에 대한 Subscribe 함수입니다.
function on(event: "stateChanged", listener: PropertyChangedEvent)
매개 변수
- event
-
"stateChanged"
이벤트 이름입니다.
- listener
- PropertyChangedEvent
이 속성의 값이 변경될 때 호출되는 콜백 fn입니다.
on("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)
videoStreamsUpdated 이벤트에 대한 Subscribe 함수입니다.
function on(event: "videoStreamsUpdated", listener: CollectionUpdatedEvent<RemoteVideoStream>)
매개 변수
- event
-
"videoStreamsUpdated"
이벤트 이름입니다.
- listener
이 컬렉션이 변경될 때 호출되는 콜백 fn은 추가 및 제거된 요소의 배열을 전달합니다.