tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Interactive Whiteboard
    Documentation

    Real-Time Recording Event

    Last updated: 2023-12-21 11:25:39

      Recording Start

      Event Name
      OnlineRecordStarted
      Event Description
      The application background will receive a notification when real-time recording service is prepared and recording starts.
      EventData Data Structure Definition
      Parameter Name
      Type
      Description
      TaskId
      String
      Task ID of the initiated real-time recording
      RoomId
      Integer
      Room ID of a room for real-time recording
      RecordUserId
      String
      User ID for the user who enters the room through real-time recording service in the current task
      Example
      {
          "EventData": {
              "RecordUserId": "tic_record_user_1253_01",
              "RoomId": 1253,
              "TaskId": "bj0mt2l23osdj300hl30"
          },
          "EventType": "OnlineRecordStarted",
          "ExpireTime": 1590046391,
          "SdkAppId": 1400000001,
          "Sign": "a2dabb362a9b811c0e26953a6276a41c",
          "Timestamp": 1575545412
      }

      Recording Stop

      Event Name
      OnlineRecordStopped
      Event Description
      The application background will receive a notification when a user actively calls the stop recording interface or the recording is automatically stopped due to other reasons.
      EventData Data Structure Definition
      Parameter Name
      Type
      Description
      TaskId
      String
      Task ID of the stopped real-time recording
      RoomId
      Integer
      Room ID of a room for real-time recording
      RecordUserId
      String
      User ID for the user who enters the room through real-time recording service in the current task
      Example
      {
          "EventData": {
              "RecordUserId": "tic_record_user_1253_01",
              "RoomId": 1253,
              "TaskId": "bj0mt2l23osdj300hl30"
          },
          "EventType": "OnlineRecordStopped",
          "ExpireTime": 1590046391,
          "SdkAppId": 1400000001,
          "Sign": "a2dabb362a9b811c0e26953a6276a41c",
          "Timestamp": 1575545412
      }

      Recording Result Callback

      Event Name
      OnlineRecordFinished
      Event Description
      The application background will receive a notification when real-time recording completes.
      EventData Data Structure Definition
      Parameter Name
      Type
      Description
      TaskId
      String
      Task ID of the real-time recording task finishes
      RoomId
      Integer
      Room ID
      GroupId
      String
      Group ID of the whiteboard
      RecordUserId
      String
      Record user ID
      FinishReason
      String
      Reasons for recording termination
      AUTO: recording automatically stopped when there were no audio and video data flow and whiteboard operations in a room for a long time
      USER_CALL: the stop recording interface was actively called
      EXCEPTION: recording terminated unexpectedly
      RecordStartTime
      Integer
      Actual recording start time (a Unix timestamp in seconds)
      RecordStopTime
      Integer
      Actual recording stop time (a Unix timestamp in seconds)
      TotalTime
      Integer
      Total length of the replay video (a Unix timestamp in seconds)
      ExceptionCnt
      Integer
      Number of anomalies in recording process
      OmittedDurations
      Array of OmittedDuration
      The parameter of omitted durations in concatenated videos is valid only when video concatenation is open.
      VideoInfos
      Array of VideoInfo
      Video recording list
      Error.Code
      String
      This field will exist if errors occur in real-time recording. For specific error code descriptions, please refer to the interface document Query Real-time Recording Task.
      Error.Message
      String
      Specific error descriptions if errors occur in real-time recording
      Example
      Example 1 Successful Real-Time Recording Callback
      {
        "EventData": {
          "TaskId": "ghucnligqtgtvk2624mb",
          "RoomId": 880528,
          "GroupId": "880528",
          "RecordUserId": "tic_record_user_880528_test-01",
          "FinishReason": "USER_CALL",
          "RecordStartTime": 1568949369,
          "RecordStopTime": 1568949392,
          "TotalTime": 18317,
          "ExceptionCnt": 0,
          "OmittedDurations": [],
          "VideoInfos": [
            {
              "UserId": "Mac_trtc_04",
              "VideoDuration": 17969,
              "VideoFormat": "mp4",
              "VideoId": "dace3518e865e76a9e36712c629822ba",
              "VideoPlayTime": 0,
              "VideoSize": 593418,
              "VideoType": 0,
              "VideoUrl": "http://online-recording-1259648581.file.myqcloud.com/00sp43mantgtv4r842mb/d124f518e865e76a9e36712c629822ba.mp4"
            },
            {
              "UserId": "tic_mixstream_880528_101",
              "VideoDuration": 18205,
              "VideoFormat": "mp4",
              "VideoId": "763d1f6b8679c3f17fb118bd37d05c85",
              "VideoPlayTime": 3,
              "VideoSize": 765545,
              "VideoType": 3,
              "VideoUrl": "http://online-recording-1259648581.file.myqcloud.com/00sp43mantgtv4r842mb/763d1f6b86724f51fb118bd37d05c85.mp4"
            },
            {
              "UserId": "tic_mixstream_880528_3",
              "VideoDuration": 18222,
              "VideoFormat": "mp4",
              "VideoId": "1b9623df0516dc7318df89f6e7fffc1e",
              "VideoPlayTime": 95,
              "VideoSize": 402038,
              "VideoType": 3,
              "VideoUrl": "http://online-recording-1259648581.file.myqcloud.com/00sp43mantgtv4r842mb/1b9623df05124f51318df89f6e7fffc1e.mp4"
            },
            {
              "UserId": "",
              "VideoDuration": 17605,
              "VideoFormat": "mp4",
              "VideoId": "a8152f8faa2cfe621dc965a066a5813c",
              "VideoPlayTime": 623,
              "VideoSize": 226337,
              "VideoType": 2,
              "VideoUrl": "http://online-recording-1259648581.file.myqcloud.com/00sp43mantgtv4r842mb/a815224f512cfe621dc965a066a5813c.mp4"
            }
          ]
        },
        "EventType": "OnlineRecordFinished",
        "ExpireTime": 1590046391,
        "SdkAppId": 1400000001,
        "Sign": "a2dabb362a9b811c0e26953a6276a41c",
        "Timestamp": 1575545412
      }
      Example 2 Failed Real-Time Recording Callback
      {
          "EventData": {
              "Error": {
                  "Code": "FailedOperation.Record",
                  "Message": "code: 40001, msg: 2020-05-21 15:20:06, invalid userid\\n"
              },
              "ExceptionCnt": 0,
              "FinishReason": "EXCEPTION",
              "GroupId": "880528",
              "OmittedDurations": [],
              "RecordStartTime": 0,
              "RecordStopTime": 1590045606,
              "RecordUserId": "tic_record_user_880528_test-01",
              "RoomId": 880528,
              "TaskId": "ghucnligqtgtvk2624mb",
              "TotalTime": 0,
              "VideoInfos": []
          },
          "EventType": "OnlineRecordFinished",
          "ExpireTime": 1590046391,
          "SdkAppId": 1400000001,
          "Sign": "a2dabb362a9b811c0e26953a6276a41c",
          "Timestamp": 1575545412
      }

      Long Pause Alarm

      Event Name
      OnlineRecordLongPauseWarning
      Event Description
      A real-time recording will automatically stop if it pauses for more than 30 minutes. The application background will receive a notification when the pause reaches 20 minutes.
      EventData Data Structure Definition
      Parameter Name
      Type
      Description
      TaskId
      String
      Task ID of the initiated real-time recording
      RoomId
      Integer
      Room ID of a room for real-time recording
      RecordUserId
      String
      User ID for the user who enters the room through real-time recording service in the current task
      PauseTime
      Integer
      Pause time (a Unix timestamp in seconds)
      EstimateStopTime
      Integer
      Estimated time of automatic stop recording (a Unix timestamp in seconds)
      Example
      {
        "EventData": {
          "TaskId": "bj0mt2l23osdj300hl30",
          "RoomId": 1253,
          "RecordUserId": "tic_record_user_1253_01",
          "PauseTime": 1575545412,
          "EstimateStopTime": 1575546412
        },
        "EventType": "OnlineRecordLongPauseWarning",
        "ExpireTime": 1590046391,
        "SdkAppId": 1400000001,
        "Sign": "a2dabb362a9b811c0e26953a6276a41c",
        "Timestamp": 1575545412
      }

      Long Pause Forces Automatic Termination

      Event Name
      OnlineRecordLongPauseForceStopped
      Event Description
      A real-time recording will automatically stop when it pauses for more than 30 minutes. The App background will recieve a notification that the current task has automatically stopped.
      EventData Data Structure Definition
      Parameter Name
      Type
      Description
      TaskId
      String
      Task ID of the initiated real-time recording
      RoomId
      Integer
      Room ID of a room for real-time recording
      RecordUserId
      String
      User ID for the user who enters the room through real-time recording service in the current task
      PauseTime
      Integer
      Pause time (a Unix timestamp in seconds)
      StopTime
      Integer
      Automatic stop time (a Unix timestamp in seconds)
      Example
      {
        "EventData": {
          "TaskId": "bj0mt2l23osdj300hl30",
          "RoomId": 1253,
          "RecordUserId": "tic_record_user_1253_01",
          "PauseTime": 1575545412,
          "StopTime": 1575546412
        },
        "EventType": "OnlineRecordLongPauseForceStopped",
        "ExpireTime": 1590046391,
        "SdkAppId": 1400000001,
        "Sign": "a2dabb362a9b811c0e26953a6276a41c",
        "Timestamp": 1575545412
      }
      
      
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy