Streaming Start
Event Name
WhiteboardPushStarted
Event Description
Notify the App background when the whiteboard streaming service is ready and starts streaming.
EventData Structure Definition
Parameter Name | Type | Description |
TaskId | String | TaskId of the started whiteboard streaming |
RoomId | Integer | Whiteboard Room ID |
PushUserId | String | Current task's user ID for whiteboard streaming service entry |
PushStartTime | Integer | Actual start streaming time, Unix timestamp, in seconds |
Example
{"EventData": {"PushStartTime": 1610545438,"PushUserId": "tic_push_user_1253_01","RoomId": 1253,"TaskId": "bj0mt2l23osdj300hl30"}"EventType": "WhiteboardPushStarted","ExpireTime": 1590046391,"SdkAppId": 1400000001,"Sign": "a2dabb362a9b811c0e26953a6276a41c","Timestamp": 1575545412}
Stop stream push
Event Name
WhiteboardPushStopped
Event Description
Notify the app background when the user actively calls the stop streaming interface or the streaming stops automatically for other reasons.
EventData Structure Definition
Parameter Name | Type | Description |
TaskId | String | Whiteboard streaming task ID when streaming ends |
RoomId | Integer | Room ID |
GroupId | String | Whiteboard Group ID |
PushUserId | String | Streaming User ID |
FinishReason | String | Reason for streaming termination AUTO: Automatic stream termination due to no audio/video uplink or whiteboard operation in the room for a long time USER_CALL: Proactive invocation of the stop streaming interface EXCEPTION: Abnormal stream termination |
PushStartTime | Integer | Actual start streaming time, Unix timestamp, in seconds |
PushStopTime | Integer | Actual stop streaming time, Unix timestamp, in seconds |
IMSyncTime | Integer | IM timestamp corresponding to the first frame of the whiteboard stream, used for synchronization time alignment of IM chat messages with whiteboard stream video during recorded replay |
ExceptionCnt | Integer | Number of exceptions occurred during streaming |
Error.Code | String | If there is an error in the whiteboard stream, this field will be present, with an error code of FailedOperation.Record |
Error.Message | String | Specific error description if whiteboard streaming encounters an error |
Example
{"EventData": {"TaskId": "ghucnligqtgtvk2624mb","RoomId": 880528,"GroupId": "880528","PushUserId": "tic_push_user_880528_test-01","FinishReason": "USER_CALL","PushStartTime": 1568949369,"PushStopTime": 1568949392,"IMSyncTime": 1568949369,"ExceptionCnt": 0}"EventType": "WhiteboardPushStopped","ExpireTime": 1590046391,"SdkAppId": 1400000001,"Sign": "a2dabb362a9b811c0e26953a6276a41c","Timestamp": 1575545412}