LocalParticipant
LocalParticipant 클래스는 카카오 i 커넥트 라이브 SDK의 주요 클래스 중 하나로, 로컬 참여자(나 자신)를 의미합니다. LocalParticipant 클래스는 Property, Method로 구성됩니다.
표LocalParticipant 클래스 전체 목록클래스 | 구분 | 항목 | 설명 |
---|---|---|---|
LocalParticipant | Property | id | 로컬 참여자의 아이디 |
hasAudio | 로컬 참여자가 오디오를 공유했는지 여부 | ||
hasVideo | 로컬 참여자가 비디오를 공유했는지 여부 | ||
Method | getAudio() | audioId를 인자로 사용하여 LocalAudio 객체를 가져옴 | |
getVideo() | videoId를 인자로 사용하여 LocalVideo 객체를 가져옴 | ||
stop() | Local Participant(로컬 참여자)가 공유한 오디오와 비디오의 미디어 스트림 트랙 모두 중단 |
Property
LocalParticipant 클래스의 프로퍼티는 다음과 같습니다.
표LocalParticipant 프로퍼티 목록Property | 타입 | 설명 |
---|---|---|
id | String | 로컬 참여자의 아이디 |
hasAudio | Boolean | 로컬 참여자가 오디오를 공유했는지 여부 |
hasVideo | Boolean | 로컬 참여자가 비디오를 공유했는지 여부 |
Method
LocalParticipant 클래스의 메서드는 다음과 같습니다.
getAudio()
publish() 메서드를 호출하여 LocalAudio를 Room에 공유하면, 로컬 참여자가 사용 중인 오디오의 고유 audioId가 발급됩니다. 이 audioId를 인자로 사용하여 LocalAudio 객체를 가져올 수 있습니다.
코드예제getAudio() Syntax
const localAudio = localParticipant.getAudio('{audioId}');
파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
audioId | Number | 필수 |
고유한 오디오 아이디 - publish() 메서드 호출 이후 확인 가능 |
반환 | 타입 | 필수여부 | 설명 |
---|---|---|---|
LocalAudio | LocalAudio | 필수 |
LocalAudio 또는 null 을 반환 |
getVideo()
publish() 메서드를 호출하여 LocalVideo를 Room에 공유하면, 로컬 참여자가 사용 중인 비디오의 고유한 videoId가 발급됩니다. 이 videoId를 인자로 사용하여 LocalVideo 객체를 가져올 수 있습니다.
코드예제getVideo() Syntax
const localVideo = localParticipant.getVideo('{videoId}');
파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
videoId | Number | 필수 |
고유한 비디오 아이디 - publish() 메서드 호출 이후 확인 가능 |
반환 | 타입 | 필수여부 | 설명 |
---|---|---|---|
LocalVideo | LocalVideo | 필수 |
LocalVideo 또는 null 을 반환 |
stop()
Local Participant(로컬 참여자)가 공유한 오디오와 비디오의 미디어 스트림 트랙을 모두 중단합니다. 중단된 트랙은 더 이상 사용할 수 없습니다.
코드예제stop() Syntax
localParticipant.stop();