Quick Start

Omnitalk SDK를 어떻게 활용할 수 있는지에 대한 간단한 예시입니다. (음성,영상)

1. 객체 및 세션 생성

발급된 Service ID로 Omnitalk 객체와 세션을 생성하는 초기화 과정을 수행합니다. 세션이 정상적으로 생성되면 방 리스트를 조회하거나 방 생성, 방송 개시 및 시청이 가능합니다.

Omnitalk.sdkInit("YN3F-GE3M-4CW2-FDLZ");
const sdk = Omnitalk.getInstance();
const session = await sdk.createSession();

Function	Description	Parameter	Value	Return
sdkInit( )	sdk 객체 초기화	service_id	"YN3F-GE3M-4CW2-FDLZ"
getInstance()	sdk 객체 생성	-	-	Object
createSession( )	옴니톡 세션 생성	-	-	Object

2. 방 생성

생성된 세션을 바탕으로 방을 만들 수 있습니다. 음성은 "audioroom" 영상은 "videoroom"을 parameter에 전달합니다. 방의 정보가 담긴 JSON Object를 리턴합니다.

const roomId = await sdk.createRoom(room_type);

Function	Description	Parameter	Value	Return
createRoom( )	방송 생성	room_type	"audioroom", "videoroom"	JSON Object

3. 방 목록 조회 및 참여

방 목록을 조회하거나 참여할 수 있습니다. 참여할 방의 room_id는 방 목록을 조회하여 알 수 있습니다.

const roomList = await sdk.roomList(room_type);
const joinResult = await sdk.joinRoom(room_id);

Function	Description	Parameter	Value	Return
roomList( )	방송 조회	room_type	"audioroom", "videoroom"	JSON Array
joinRoom( )	방송 참여	room_id	"b45de3c0167"	JSON Object

4. 방송 개시

로컬의 음성이나 영상을 송출하기 위해서 필요한 과정입니다. call_type에 송출하고 싶은 종류의 값을 전달 합니다. publish를 수행한 결과를 JSON Object로 리턴합니다.

const publishResult = await sdk.publish(call_type);

Function	Description	Parameter	Value	Return
publish( )	방송 조회	call_type	"videocall", "audiocall"	JSON Object

5. 방송 중인 참여자 조회 및 시청

방에 참여하면 방송 중인 참여자의 목록을 조회하고 시청할 수 있습니다. Subscribe는 영상을 시청할 경우에만 필요하며 특정 사용자의 publish_idx는 참여자 목록을 조회하면 알 수 있습니다.

const publishList = await sdk.publishList(room_id);
const subscribeResult = await sdk.subscribe(publish_idx);

Function	Description	Parameter	Value	Return
publishList( )	방송중인 참여자 조회	room_id	"b45de3c0167"	JSON Array
subscribe( )	방송 중인 특정 사용자의 영상 시청	publish_idx	27	JSON Object

6. 시청 종료 및 세션 종료

특정 사용자의 영상 시청을 종료하거나 방을 나갈 수 있습니다. leave의 parameter로 특정 사용자의 session_id를 전달하면 방 안에서 특정 사용자의 영상 시청이 종료됩니다. leave의 parameter에 아무것도 전달하지 않으면 로컬의 세션 연결이 종료됩니다.

await sdk.leave(session_id);

Function	Description	Parameter	Value	Return
leave( )	특정 사용자의 영상 시청 종료 혹은 로컬의 세션 연결 종료	session_id	"YjQ1ZGUzYzA3M"	-