Kakao i Connect Live::Kakao i Connect Live 2.0::API 레퍼런스::Web::RemoteParticipant

페이지 이동경로

RemoteParticipant

RemoteParticipant 클래스는 카카오 i 커넥트 라이브 SDK의 주요 클래스 중 하나입니다. 카카오 커넥트 라이브에서 Remote Participant는 다른 참여자를 의미합니다. RemoteParticipant 클래스는 Property와 Method로 구성됩니다.

RemoteParticipant 클래스 전체 목록
클래스 구분 항목 설명
RemoteParticipant Property id 리모트 참여자의 아이디
hasAudio 리모트 참여자가 오디오를 공유했는지 여부
hasVideo 리모트 참여자가 비디오를 공유했는지 여부
audios 리모트 참여자가 공유한 오디오 배열
videos 리모트 참여자가 공유한 비디오 배열
isEnabledAudio 리모트 참여자가 공유한 오디오 중 하나라도 활성화되어 있으면 true 반환
isEnabledVideo 리모트 참여자가 공유한 비디오 중 하나라도 활성화되어 있으면 true 반환
Method getSubscribedVideos() 리모트 참여자가 공유하고 있는 비디오 중에서 구독 중인 비디오 배열 반환
getUnsubscribedVideos() 리모트 참여자가 공유한 비디오 중에서 현재 구독 중이 아닌 비디오 배열 반환
getAudio() audioId를 인자로 사용하여 리모트 참여자가 공유 중인 RemoteAudio 객체 반환
getVideo() videoId를 인자로 사용하여 리모트 참여자가 공유 중인 RemoteVideo 객체 가져옴

Property

RemoteParticipant 클래스의 프로퍼티는 다음과 같습니다.

RemoteParticipant 프로퍼티 목록
Property 타입 설명
id String 리모트 참여자 아이디
hasAudio Boolean 리모트 참여자가 오디오를 공유했는지 여부
hasVideo Boolean 리모트 참여자가 비디오를 공유했는지 여부
audios RemoteAudio[] 리모트 참여자가 공유한 오디오 배열
videos RemoteVideo[] 리모트 참여자가 공유한 비디오 배열
isEnabledAudio Boolean 리모트 참여자가 공유한 오디오 중 하나라도 활성화되어 있으면 true 반환
isEnabledVideo Boolean 리모트 참여자가 공유한 비디오 중 하나라도 활성화되어 있으면 true 반환

Method

RemoteParticipant 클래스의 메서드는 다음과 같습니다.

getSubscribedVideos()

리모트 참여자가 공유하고 있는 비디오 중에서 구독 중인 비디오 배열을 반환합니다.

코드예제getSubscribedVideos() Syntax

const remoteVideos = participant.getSubscribedVideos();

getSubscribedVideos() Returns
반환 타입 설명
RemoteVideo RemoteVideo[] 현재 구독 중인 RemoteVideo 배열 반환

getUnsubscribedVideos()

리모트 참여자가 공유한 비디오 중에서 현재 구독 중이지 않은 비디오 배열을 반환합니다.

코드예제getUnsubscribedVideos() Syntax

const remoteVideos = participant.getUnsubscribedVideos();

getUnsubscribedVideos() Returns
반환 타입 설명
RemoteVideo RemoteVideo[] 구독 중이 아닌 RemoteVideo 배열을 반환

getAudio()

audioId를 인자로 사용하여 리모트 참여자가 공유 중인 RemoteAudio 객체를 반환합니다. 리모트 참여자의 audioId는 getAuidoId() 메서드를 통해 확인할 수 있습니다.

코드예제getAudio() Syntax

const remoteAudio = participant.getAudio('{audioId}');

getAudio() Parameters
파라미터 타입 필수 여부 설명
audioId number 필수 고유한 오디오 아이디
getAudio() Returns
반환 타입 설명
RemoteAudio RemoteAudio RemoteAudio 또는 null 반환

getVideo()

videoId를 인자로 사용하여 리모트 참여자가 공유 중인 RemoteVideo 객체를 가져올 수 있습니다. 리모트 참여자의 videoId는 getVideoId() 메서드를 통해 확인할 수 있습니다.

코드예제getVideo() Syntax

const remoteVideo = participant.getVideo('{videoId}');

getVideo() Parameters
파라미터 타입 필수 여부 설명
videoId Number 필수 리모트 참여자의 고유한 비디오 아이디
getVideo() Returns
반환 타입 설명
RemoteVideo RemoteVideo Remotevideo 또는 null을 반환
이 문서가 만족스러운 이유를 알려주세요.
이 문서에 아쉬운 점을 알려주세요.
평가해주셔서 감사합니다.

더 자세한 의견은 documentation@kakaoenterprise.com 으로 제보해주세요.