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

페이지 이동경로

RemoteAudio

RemoteAudio 클래스는 RemoteMedia의 오디오 속성에 해당되는 객체입니다. RemoteAudio클래스는 Property와 Method로 구성됩니다.

RemoteAudio 클래스 전체 목록
클래스 구분 항목 설명
RemoteAudio Property participantId Remote Participant(리모트 참여자)의 아이디
audioId 고유 아이디
isAlwaysOn alwaysOn 여부
active 활성화 상태
Method getParticipantId() participantId(리모트 참여자 아이디) 반환
getExtraValue() Remote Participant(리모트 참여자)가 오디오에 기록한 Extra Value 반환
getAudioId() 리모트 참여자의 오디오 아이디(audioId) 반환

Property

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

RemoteAudio 프로퍼티 목록
Property 타입 설명
participantId String Remote Participant(리모트 참여자)의 아이디
audioId Number 고유 아이디
isAlwaysOn Boolean alwaysOn 여부
- 리모트 참여자가 자신의 LocalAudio에서 설정 시 로컬 참여자는 RemoteAudio의 isAlwaysOn으로 확인 가능
active Boolean 활성화 상태

Method

getParticipantId()

participantId(리모트 참여자 아이디)를 반환합니다. participantId는 getRemoteParticipant() 메서드의 인자로 사용될 수 있습니다.

코드예제getParticipantId() Syntax

const participantId = remoteAudio.getParticipantId();

getParticipantId() Returns
반환 타입 설명
participantId String 리모트 참여자의 고유한 아이디
- getRemoteParticipant() 메서드의 인자로 사용

getExtraValue()

Remote Participant(리모트 참여자)가 오디오에 기록한 Extra Value를 반환합니다. Extra Value는 서비스에서 필요에 의해 별도로 설정한 값입니다.

코드예제getExtraValue() Syntax

const extraValue = remoteAudio.getExtraValue();

getExtraValue() Returns
반환 타입 설명
extra value String Extra Value 반환

getAudioId()

리모트 참여자의 오디오 아이디(audioId)를 반환합니다. audioId는 getRemoteAudio() 메서드를 호출할 때 인자로 사용될 수 있습니다.

코드예제getAudioId() Syntax

const audioId = remoteAudio.getAudioId();

getAudioId() Returns
반환 타입 설명
audioId String 리모트 참여자가 사용 중인 오디오 아이디
이 문서가 만족스러운 이유를 알려주세요.
이 문서에 아쉬운 점을 알려주세요.
평가해주셔서 감사합니다.

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