TKRoomSDK Constants Explanation
TKRoomSDK Constants Explanation
Room Roles
| Name | Type | Description |
|---|---|---|
| TK.ROOM_ROLE.TEACHER | Number | Teacher (Lecturer) |
| TK.ROOM_ROLE.ASSISTANT | Number | Teaching Assistant |
| TK.ROOM_ROLE.STUDENT | Number | Number |
| TK.ROOM_ROLE.AUDIT | Number | Audience (Veteran) |
| TK.ROOM_ROLE.PATROL | Number | Classroom Monitor (Inspector) |
| Classroom Monitor (Inspector) | Number | Class Teacher |
| TK.ROOM_ROLE.AUDIT_STUDENT | Number | Auditing Student |
| TK.ROOM_ROLE.SYSTEM_ADMIN | Number | System Administrator |
| TK.ROOM_ROLE.ENTERPRISE_ADMIN | Number | Enterprise Administrator |
| TK.ROOM_ROLE.ADMIN | Number | Administrator |
| TK.ROOM_ROLE.GUARDIAN | Number | Parent (Guardian) |
| TK.ROOM_ROLE.TALK_CLOUD | Number | Talk Cloud Administrator |
| TK.ROOM_ROLE.WORK_ORDER | Number | Ticket Administrator |
| TK.ROOM_ROLE.PLAYBACK | Number | Replayer |
| TK.ROOM_ROLE.RECORD | Number | Recording Perspective |
| TK.ROOM_ROLE.AUDITOR | Number | Live Audience |
Message Sending Roles
| Name | Type | Description |
|---|---|---|
| TK.MSG_TO_ALLUSER | String | TK.MSG_TO_ALLSUPERUSERS |
| TK.MSG_TO_ALLEXCEPTSENDER | String | Send a message to everyone in the room except the sender |
| TK.MSG_TO_ALLEXCEPTAUDITOR | String | Send a message to everyone in the room except the live audience |
| TK.MSG_TO_ALLEXCEPTAUDITOR_AND_SENDER | String | Send a message to everyone in the room except the live audience and the sender |
| TK.MSG_TO_ALLSUPERUSERS | String | Send a message to superusers in the room (such as teachers, teaching assistants, etc.) |
| TK.MSG_TO_NONEUSER | String | Send the message to the server only, without sending it to anyone |
Audio and Video Publishing Status
| Name | Type | Description |
|---|---|---|
| TK.PUBLISH_STATE_NONE | Number | It has not been published |
| TK.PUBLISH_STATE_AUDIOONLY | Number | Only the audio has been released |
| TK.PUBLISH_STATE_VIDEOONLY | Number | Only the video has been released |
| TK.PUBLISH_STATE_BOTH | Number | The audio and video have been released |
| TK.PUBLISH_STATE_MUTEALL | Number | The user is in a publishing state, but both audio and video are turned off |
Screen Sharing Publishing Status
| Name | Type | Description |
|---|---|---|
| TK.SCREENSTATE_ON | Number | Screen sharing is published |
| TK.SCREENSTATE_OFF | Number | Screen sharing is unpublished |
Media File Publishing Status
| Name | Type | Description |
|---|---|---|
| TK.MEDIAFILESTATE_ON | Number | Media file published |
| TK.MEDIAFILESTATE_OFF | Number | Media file unpublished |
Video Display Mode
| Name | Type | Description |
|---|---|---|
| TK_VIDEO_MODE.ASPECT_RATIO_CONTAIN | Number | Display in the container proportionally (the video may have black bars) |
| TK_VIDEO_MODE.ASPECT_RATIO_COVER | Number | Scale to fill the container proportionally (the video may be cropped) |
Media Type
| Name | Type | Description |
|---|---|---|
| TK.MEDIA_TYPE.DEVICE_AV | String | Audio and video device types |
| TK.MEDIA_TYPE.MEDIA | String | Media file type |
| TK.MEDIA_TYPE.FILE | String | Local media file type |
| TK.MEDIA_TYPE.SCREEN | String | Screen sharing type |
Media Stream Type
| Name | Type | Description |
|---|---|---|
| TK.STREAM_VIDEO | String | Type of audio and video devices |
| TK.STREAM_MEDIA | String | Media file type |
| TK.STREAM_FILE | String | Type of local media file |
| TK.STREAM_SCREEN | String | Screen sharing type |
Room Mode
| Name | Type | Description |
|---|---|---|
| TK.ROOM_MODE.NORMAL_ROOM | String | Regular room mode |
| TK.ROOM_MODE.BIG_ROOM | String | Large room (massive room) mode |
Device Change
| Name | Type | Description |
|---|---|---|
| TK.DEVICE_STATE.DEVICE_ADD | Number | Device added |
| TK.DEVICE_STATE.DEVICE_REMOVE | Number | Device added |
Network Status Quality
| Name | Type | Description |
|---|---|---|
| TK.NET_QUALITY.TK_NET_QUALITY_EXCELLENT | Number | Good (packet loss rate < 1 or delay < 80), value is 1 |
| TK.NET_QUALITY.TK_NET_QUALITY_GOOD | Number | Fair (1 ≤ packet loss rate < 5 or 80 ≤ delay < 150), value is 2 |
| TK.NET_QUALITY.TK_NET_QUALITY_ACCEPTED | Number | Medium (5 ≤ packet loss rate < 10 or 150 ≤ delay < 300), value is 3 |
| TK.NET_QUALITY.TK_NET_QUALITY_BAD | Number | Poor (10 ≤ packet loss rate < 20 or 300 ≤ delay < 500), value is 4 |
| TK.NET_QUALITY.TK_NET_QUALITY_VERYBAD | Number | Very Poor (packet loss rate ≥ 20 or delay ≥ 500), value is 5 |
Server Recording Type
| Name | Type | Description |
|---|---|---|
| TK.REC_TYPE_VIDEOLIST | String | Record the audio and video of all publishers in the room. Each publisher’s audio and video will generate a separate recording file (containing only their own audio) |
| TK.REC_TYPE_MP3 | String | Record only the audio of the publishers in the room. The recorded file will be in MP3 format |
| TK.REC_TYPE_MIXVIDEO | String | Record the audio and video of all publishers in the room, and mix the videos according to a certain arrangement rule in the recorded file. This type of recording will generate both MP3 and MP4 files. The MP4 file contains the mixed and arranged video as well as the audio of all publishers. The MP3 file contains the audio of all publishers |
Server Recording Status
| Name | Type | Description |
|---|---|---|
| TK.Constant.SERVER_RECORD_STATE.STOPED | Number | Server recording has been stopped |
| TK.Constant.SERVER_RECORD_STATE.STARTED | Number | Server recording has started |
| TK.Constant.SERVER_RECORD_STATE.PAUSED | Number | Server recording has been paused |
Print Log
| Name | Type | Description |
|---|---|---|
| TK.LOG_DEBUG | Number | Debug-level logs |
| TK.LOG_TRACE | Number | Trace-level logs |
| TK.LOG_INFO | Number | Info-level logs |
| TK.LOG_WARNING | Number | Warning-level logs |
| TK.LOG_ERROR | Number | Error-level logs |
| TK. LOG_NONE | Number | Do not print logs |
