SpotlightCallFeature interface
추천 통화 기능입니다.
- Extends
속성
max |
추천할 수 있는 최대 참가자 수를 반환합니다. |
상속된 속성
name | 기능 이름입니다. |
메서드
get |
|
off("spotlight |
SpotlightUpdated 이벤트에 대한 구독 함수 |
on("spotlight |
SpotlightUpdated 이벤트에 대한 구독 함수 |
start |
|
stop |
모든 참가자에 대한 추천을 중지합니다. |
stop |
상속된 메서드
dispose() |
속성 세부 정보
maxParticipantsToSpotlight
추천할 수 있는 최대 참가자 수를 반환합니다.
maxParticipantsToSpotlight: number
속성 값
number
상속된 속성 세부 정보
name
기능 이름입니다.
name: string
속성 값
string
메서드 세부 정보
getSpotlightedParticipants()
function getSpotlightedParticipants(): SpotlightedParticipant[]
반환
현재 추천된 모든 참가자의 목록을 반환합니다.
off("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)
SpotlightUpdated 이벤트에 대한 구독 함수
function off(event: "spotlightChanged", listener: CollectionUpdatedEvent<SpotlightedParticipant>)
매개 변수
- event
-
"spotlightChanged"
이벤트 이름
- listener
이 이벤트를 구독하는 데 사용된 콜백 함수
on("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)
SpotlightUpdated 이벤트에 대한 구독 함수
function on(event: "spotlightChanged", listener: CollectionUpdatedEvent<SpotlightedParticipant>)
매개 변수
- event
-
"spotlightChanged"
이벤트 이름
- listener
이 이벤트를 구독하는 데 사용된 콜백 함수
startSpotlight(CommunicationIdentifier[])
function startSpotlight(participants?: CommunicationIdentifier[]): Promise<void>
매개 변수
- participants
참가자 배열이 전달되지 않은 경우 로컬 및 원격 참가자에 대한 스포트라이트를 시작하고 로컬 참가자에 대해 작업을 수행합니다.
반환
Promise<void>
startParticipantSpotlight 작업의 완료를 나타내는 Promise입니다. startParticipantSpotlight가 성공적으로 시작되면 'SpotlightUpdated' 이벤트가 내보내질 것입니다.
stopAllSpotlight()
모든 참가자에 대한 추천을 중지합니다.
function stopAllSpotlight(): Promise<void>
반환
Promise<void>
stopAllSpotlight 작업의 완료를 나타내는 Promise입니다. stopAllSpotlight가 성공적으로 중지되면 'SpotlightUpdated' 이벤트가 내보내질 것입니다.
stopSpotlight(CommunicationIdentifier[])
function stopSpotlight(participants?: CommunicationIdentifier[]): Promise<void>
매개 변수
- participants
는 참가자 배열이 전달되지 않은 경우 로컬 및 원격 참가자에 대한 스포트라이트를 중지하고, 로컬 참가자에 대해 작업을 수행합니다.
반환
Promise<void>
stopParticipantSpotlight 작업의 완료를 나타내는 Promise입니다. stopParticipantSpotlight가 성공적으로 중지되면 'SpotlightUpdated' 이벤트가 내보내질 것입니다.
상속된 메서드 세부 정보
dispose()
function dispose()