> For the complete documentation index, see [llms.txt](https://docs.omnitalk.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.omnitalk.io/commons/event-message.md). # Event Message 옴니톡 SDK에서 제공하는 이벤트는 다음과 같으며 필요에 따라 자유롭게 활용하시면 됩니다. 해당 페이지에서는 Event Message 이름과 각각의 예시를 보여 줍니다. 플랫폼별 이벤트 메시지 수신 방법은 각 API Reference 본문을 참조 바랍니다. ## 플랫폼별 API Reference 링크 * [Javascript API](/javascript/api-reference.md) * [Typescript API](https://docs.omnitalk.io/typescript/api-reference) * [React-Native API](/react-native/api-reference.md) * [Flutter API](/flutter/api-reference.md) * [iOS API](/ios/api-reference.md)
Event NameDescription
RINGBACK_EVENTofferCall() 호출 성공 시
RINGING_EVENTofferCall( ) 수신 시
BROADCASTING_EVENT영상 회의 publish() 성공 시
CONNECTED_EVENT

통화 - 상대방과 연결 성공 시

회의 - 새로운 참가자 입장 시

MUTE_EVENT음소거 / 로컬 비디오 화면 송출 off 시
UNMUTE_EVENT음소거 해제 / 로컬 비디오 화면 송출 on 시
SCREEN_SHARE_EVENTscreenShare() 호출 성공 시
SCREEN_UNSHARE_EVENTscreenUnshare() 호출 시
MESSAGE_EVENT채팅 메시지 이벤트 수신 시
LEAVE_EVENT참가자 퇴장 시
KICKOUT_EVENT참가자 강제 퇴장 시
### RINGBACK\_EVENT * caller(발신자)가 offerCall() 호출에 성공 했을 때, **발신자 본인에게 발생**하는 이벤트 메세지 ```jsx { "cmd" : "RINGBACK_EVENT", "session":"YjQ1ZGUzYzA3MmJhMTY4NjcxMD", "caller": "alice", "callee": "bob", "call_type": "audiocall" } ``` ### RINGING\_EVENT * caller(발신자)가 offerCall() 호출에 성공 했을 때, **callee(수신자)에게 발생**하는 이벤트 메세지 ```jsx { "cmd" : "RINGBACK_EVENT", "session":"YjQ1ZGUzYzA3MmJhMTY4NjcxMD", "user_id":"gOEEdpqGJP", "caller": "alice", "callee": "bob", "room_type": "audiocall", "call_type": "audiocall", } ``` ### BROADCASTING\_EVENT * 영상 회의(videoroom) 에서만 발생하는 이벤트 메세지. * 특정 **참가자가 방송을 송출** 했을 때, **다른 참가자들에게 발생**하는 이벤트 메세지 ```jsx { "cmd" : "BROADCASTING_EVENT", "session": "YzMyYWE1YTA3MmJhMTY4NjE0MDAwNTcyNi01MzM=", "user_id" : "gOEEdpqGJP", "room_type": "audiocall", "call_type": "audiocall", } ``` ### CONNECTED\_EVENT * (음성, 영상) **통화일 경우**는 상대방과 연결이 성공 했을 때, **caller와 callee 모두에게 발생**하는 이벤트 메세지 * (음성, 영상) **회의일 경우**는 새로운 참가자가 입장 했을 때, **기존 참가자들에게 발생**하는 이벤트 메세지 ```jsx { "cmd" : "CONNECTED_EVENT", "session": "YjQ1ZGUzYzA3MmJhMTY4NjE0MzU0NjI1My01MDM=", "user_id": "AaalBCeHdL", "room_type": "videoroom", "call_type": "audiocall", } ``` ### MUTE\_EVENT * 특정 참가자가 **음성 또는 영상을 mute** 했을 때, **다른 참가자들에게 발생**하는 이벤트 메세지 ```javascript { "cmd" : "MUTE_EVENT", "session": "YjQ1ZGUzYzA3MmJhMTY4Njgy", "track":"audio" } ``` ### UNMUTE\_EVENT * 특정 참가자가 **음성 또는 영상을 unmute** 했을 때, **다른 참가자들에게 발생**하는 이벤트 메세지 ```javascript { "cmd" : "UNMUTE_EVENT", "session": "YjQ1ZGUzYzA3MmJhMTY4Njgy", "track":"audio" } ``` ### SCREEN\_SHARE\_EVENT * 특정 참가자가 **화면 공유**를 했을 때, **다른 참가자들에게 발생**하는 이벤트 메세지 ```javascript { "cmd" : "SCREEN_SHARE_EVENT", "session": "YjQ1ZGUzYzA3MmJhMTY4Njgy", "user_id": "gOEEdpqGJP", "room_type": "videoroom", "call_type": "videocall" } ``` ### SCREEN\_UNSHARE\_EVENT * 특정 참가자가 **화면 공유를 취소** 했을 때, **다른 참가자들에게 발생**하는 이벤트 메세지 ```javascript { "cmd" : "SCREEN_UNSHARE_EVENT", "session": "YjQ1ZGUzYzA3MmJhMTY4Njgy", "user_id": "gOEEdpqGJP", "room_type": "videoroom", "call_type": "videocall" } ``` ### MESSAGE\_EVENT * message action은 4가지로 구분됩니다. * send: 특정 참가자가 **채팅 메세지를 전송** 했을 때, **다른 참가자들에게 발생**하는 이벤트 메세지 * whisper: 특정 참가자가 다른 참가자에게 **귓속말을 전송** 했을때, **귓속말 대상자에게 발생**하는 이벤트 메세지 * join: 새로운 **참가자가 입장** 했을 때, **다른 참가자들에게 발생**하는 이벤트 메세지 * leave: **참가자가 퇴장** 했을 때, **다른 참가자들에게 발생**하는 이벤트 메세지 ```javascript { "cmd" : "MESSAGE_EVENT", "action": "join", "session": "aGZTTUpDVG1JSDE2ODg4OTE4MDMtNA==", "timestamp": 1688891816, "user_id": "11", "user_name": "mXPkkkEOgQ" } ``` ### LEAVE\_EVENT * 특정 참가자가 **퇴장** 했을 때, **다른 참가자들에게 발생**하는 이벤트 메세지 ```jsx { "cmd" : "LEAVE_EVENT", "session": "YzMyYWE1YTA3MmJhMTY4NjE0MzUzOTMxNS01Mzg=", } ``` ### KICKOUT\_EVENT * 특정 참가자를 강제 **퇴장**시켰을 때, **다른 참가자들에게 발생**하는 이벤트 메세지 ```jsx { "cmd" : "KICKOUT_EVENT", "session": "YjQ1ZGUzYzA3MmJhMTY4Njgy", "room_type" : "videoroom" } ``` ###