SDK 주요 메서드

Method

Web 버전의 카카오 i 커넥트 라이브 SDK 2.0에서 제공하는 기본 메서드는 다음과 같습니다.

signIn()_커넥트 라이브 내부 인증

카카오 i 커넥트 라이브 2.0 SDK의 내부 인증 방식으로 인증을 수행합니다. 인증 처리 후 결과는 Callback 형태로 전달합니다. 인증 및 키(Key) 처리에 대한 자세한 설명은 인증 및 키 처리 문서를 참고하시기 바랍니다.

코드예제signIn()_커넥트 라이브 내부 인증 Syntax

await ConnectLive.signIn({
	serviceId: '{서비스아이디}',
	serviceSecret: '{서비스시크릿}'
});

signIn()_서비스 자체 인증

커넥트 라이브 내부 인증 인증 방식이 아닌 서비스 자체의 인증 방식을 사용할 수 있습니다. 인증 및 키(Key) 처리에 대한 자세한 설명은 인증 및 키 처리 문서를 참고하시기 바랍니다.

코드예제signIn()_서비스 자체 인증 Syntax

await ConnectLive.signIn({
	serviceId: '{서비스 ID}',
	token: '{서비스에서 발급한 토큰}'
});

signOut()

SDK의 인증을 해제하고, 인증 관련 리소스를 정리합니다.

코드예제signOut() Syntax

ConnectLive.signOut();

createRoom()

Room 객체를 생성합니다. Room은 서비스에 따라 채팅방, 화상회의실 등 참여자들이 서비스를 이용하기 위해 입장하는 공간입니다.

코드예제createRoom() Syntax

const room = ConnectLive.createRoom({
	//옵션 기술
});

//or

const room = ConnectLive.createRoom();

createLocalMedia()

Local Participant(로컬 참여자)가 생성하는 로컬 오디오와 로컬 비디오의 처리를 위해 LocalMedia 객체를 생성합니다. constraints 파라미터는 audio(오디오)와 video(비디오) 객체를 가지고 있으며, 서비스에 맞게 객체를 설정할 수 있습니다. 자세한 설명은 getUserMedia() 메서드를 참고하시기 바랍니다.

코드예제createLocalMedia() Syntax

const localMedia = await ConnectLive.createLocalMedia({
	audio: true,
	video: true
});

createLocalScreen()

Local Participant(로컬 참여자)의 화면을 공유하기 위한 LocalScreen 객체를 생성합니다. constraints 파라미터는 LocalMedia와 동일하게 적용됩니다. video는 Local Participant(로컬 참여자)의 화면을 뜻하며, audio는 화면에서 나오는 오디오를 뜻합니다. 자세한 설명은 getDisplayMedia() 메서드를 참고하시기 바랍니다.

코드예제createLocalScreen() Syntax

const localScreen = await ConnectLive.createLocalScreen({
	audio: true,
	video: true
});

Event

Web 버전의 카카오 i 커넥트 라이브 SDK에서 발생하는 주요 Event는 다음과 같습니다.

tokenRefreshWarning

signIn() 메서드를 호출한 후, 토큰 갱신 시간이 다가오면 주기적으로 토큰을 갱신합니다. 이때 토큰 갱신에 실패하면 호출됩니다. 토큰 갱신 시간은 24시간입니다.

코드예제tokenRefreshWarning Syntax

room.on('tokenRefreshWarning', (err)=>{
	
});

tokenRefreshError

signIn() 메서드를 호출한 후, 토큰 갱신 시간이 다가오면 주기적으로 토큰을 갱신하며 이에 실패 시 tokenRefreshWarning 이벤트가 호출됩니다. 만약, 최종 정해진 시간을 넘어 토큰 갱신에 실패한 경우 tokenRefreshError 이벤트가 호출됩니다.

코드예제tokenRefreshError Syntax

room.on('tokenRefreshError', (err)=>{
	
});