Meeting recording and live streaming

Get recording settings

POST /server/v1/mcu/record-config Authentication: required (see Overview) Global default recording settings Request parameters None Response parameters

string

App ID

string

Layout type: auto, full, grids_2, grids_4, …

integer

Watermark type. 1: none, 2: single row, 3: multiple rows

string

Window label position, a letter or combination: L left, R right, T top, B bottom; empty disables labels

integer

Settings creation time (timestamp)

integer

Settings update time (timestamp)

Response example:

{
  "code": 0,
  "data": {
    "app_id": "",
    "created_at": 0,
    "layout": "",
    "updated_at": 0,
    "watermark_type": 0,
    "window_tag_type": ""
  }
}

Save recording settings

POST /server/v1/mcu/save-record-config Authentication: required (see Overview) Update the global default recording settings Request parameters

string

Layout type: auto, full, grids_2, grids_4, …

integer

Watermark type. 1: none, 2: single row, 3: multiple rows

string

Window label position, a letter or combination: L left, R right, T top, B bottom; empty disables labels

Request example:

{
  "layout": "",
  "watermark_type": 0,
  "window_tag_type": ""
}

Response parameters data is null Response example:

{
  "code": 0,
  "data": null
}

List recording tasks

POST /server/v1/mcu/list-task Authentication: required (see Overview) List recording tasks. One recording = one task, and a task may contain multiple recording files (a new segment starts when the segment duration is exceeded, and also when recording resumes after an interruption). To get playable files, use “Get recording task details” (includes all files and URLs inline) or “List recording files”. Request parameters

string

Room number; empty means any

string

Meeting ID; empty means any

integer

Task status; omit for any. 0: pending, 1: in progress, 2: stopping, 3: ended abnormally, 4: ended normally

string

Recording title, fuzzy match; empty means any (max length 100)

string

Tag, fuzzy match; empty means any (max length 50)

integer

Start time

integer

End time

integer

Page number, starting from 1 Example: 1

integer

Items per page Example: 10

Request example:

{
  "begin_at": 0,
  "end_at": 0,
  "meeting_id": "",
  "page": 1,
  "per-page": 10,
  "room_no": "",
  "tag": "",
  "task_status": 0,
  "title": ""
}

Response parameters

string

Task ID

string

Task initiator ID

string

Task initiator name

string

Channel

string

Channel title

string

External room number

integer

Task type, a bit mask: 1 video recording, 2 stream mixing, 4 audio recording, 8 live stream

integer

0: pending, 1: in progress, 2: stopping, 3: ended abnormally, 4: ended normally

string

Error description

integer

Recording start time (timestamp); 0 means the underlying task has not started running yet

integer

Recording end time (timestamp); 0 means not ended

integer

Number of recording files; a recording produces extra files when it exceeds the segment duration or resumes after an interruption

integer

Total duration of all recording files (seconds)

integer

Total size of all recording files (bytes)

string

Recording tags, comma-separated

array<object>

Recording file list; returned only in task details

Show Element fields

string

Recording file ID, used to get the playback URL

string

ID of the recording task it belongs to

string

Channel

integer

Segment number, starting from 1; sorting by it gives the playback order

integer

Recording size (bytes)

integer

Segment duration (seconds)

integer

Segment start time (timestamp)

integer

Segment end time (timestamp)

integer

Offset from the task start (ms), used for the progress bar in multi-segment playback

integer

Segment reason. 0: unknown, 1: split by duration, 2: resumed after an interruption (gap after the previous segment)

string

Presigned playback URL; returned only in task details

integer

Record creation time (timestamp)

integer

Task creation time (timestamp)

integer

Task update time (timestamp)

integer

Current time, used to calculate the recording duration when the frontend’s local clock is inaccurate

Response example:

{
  "_meta": {
    "currentPage": 1,
    "pageCount": 5,
    "perPage": 20,
    "totalCount": 100
  },
  "code": 0,
  "data": [
    {
      "began_at": 0,
      "channel": "",
      "created_at": 0,
      "ended_at": 0,
      "err_desc": "",
      "now": 0,
      "op_name": "",
      "op_uid": "",
      "record_count": 0,
      "records": [
        {
          "addr": "",
          "began_at": 0,
          "channel": "",
          "created_at": 0,
          "duration": 0,
          "ended_at": 0,
          "offset_ms": 0,
          "reason": 0,
          "record_id": "",
          "seq": 0,
          "task_id": "",
          "vod_size": 0
        }
      ],
      "room_no": "",
      "tags": "",
      "task_id": "",
      "task_status": 0,
      "task_type": 0,
      "title": "",
      "total_duration": 0,
      "total_size": 0,
      "updated_at": 0
    }
  ]
}

Get recording task details

POST /server/v1/mcu/detail Authentication: required (see Overview) Recording task details: task status, start and end times, total duration, and all recording files of this recording (the records array, with each file’s playback URL, duration, start and end times, and segment number). Request parameters

string

Task ID

string

Meeting ID (required if task_id is not set)

boolean

Whether to return internal network playback URLs

Request example:

{
  "is_lan": false,
  "meeting_id": "",
  "task_id": ""
}

Response parameters

string

Task ID

string

Task initiator ID

string

Task initiator name

string

Channel

string

Channel title

string

External room number

integer

Task type, a bit mask: 1 video recording, 2 stream mixing, 4 audio recording, 8 live stream

integer

0: pending, 1: in progress, 2: stopping, 3: ended abnormally, 4: ended normally

string

Error description

integer

Recording start time (timestamp); 0 means the underlying task has not started running yet

integer

Recording end time (timestamp); 0 means not ended

integer

Number of recording files; a recording produces extra files when it exceeds the segment duration or resumes after an interruption

integer

Total duration of all recording files (seconds)

integer

Total size of all recording files (bytes)

string

Recording tags, comma-separated

array<object>

Recording file list; returned only in task details

Show Element fields

string

Recording file ID, used to get the playback URL

string

ID of the recording task it belongs to

string

Channel

integer

Segment number, starting from 1; sorting by it gives the playback order

integer

Recording size (bytes)

integer

Segment duration (seconds)

integer

Segment start time (timestamp)

integer

Segment end time (timestamp)

integer

Offset from the task start (ms), used for the progress bar in multi-segment playback

integer

Segment reason. 0: unknown, 1: split by duration, 2: resumed after an interruption (gap after the previous segment)

string

Presigned playback URL; returned only in task details

integer

Record creation time (timestamp)

integer

Task creation time (timestamp)

integer

Task update time (timestamp)

integer

Current time, used to calculate the recording duration when the frontend’s local clock is inaccurate

Response example:

{
  "code": 0,
  "data": {
    "began_at": 0,
    "channel": "",
    "created_at": 0,
    "ended_at": 0,
    "err_desc": "",
    "now": 0,
    "op_name": "",
    "op_uid": "",
    "record_count": 0,
    "records": [
      {
        "addr": "",
        "began_at": 0,
        "channel": "",
        "created_at": 0,
        "duration": 0,
        "ended_at": 0,
        "offset_ms": 0,
        "reason": 0,
        "record_id": "",
        "seq": 0,
        "task_id": "",
        "vod_size": 0
      }
    ],
    "room_no": "",
    "tags": "",
    "task_id": "",
    "task_status": 0,
    "task_type": 0,
    "title": "",
    "total_duration": 0,
    "total_size": 0,
    "updated_at": 0
  }
}

List recording files

POST /server/v1/mcu/list-record Authentication: required (see Overview) List recording files. Each entry is one file (segment) produced by a recording. Ascending seq is the playback order; offset_ms is the offset from the task start, used for the progress bar in multi-segment playback; reason=2 means there is a time gap between this segment and the previous one (recording was interrupted and then resumed). Request parameters

string

Recording task ID; set it to see only the files of one recording. Empty means any

string

Meeting ID; empty means any

integer

Page number, starting from 1 Example: 1

integer

Items per page Example: 10

Request example:

{
  "meeting_id": "",
  "page": 1,
  "per-page": 10,
  "task_id": ""
}

Response parameters

string

Recording file ID, used to get the playback URL

string

ID of the recording task it belongs to

string

Channel

integer

Segment number, starting from 1; sorting by it gives the playback order

integer

Recording size (bytes)

integer

Segment duration (seconds)

integer

Segment start time (timestamp)

integer

Segment end time (timestamp)

integer

Offset from the task start (ms), used for the progress bar in multi-segment playback

integer

Segment reason. 0: unknown, 1: split by duration, 2: resumed after an interruption (gap after the previous segment)

string

Presigned playback URL; returned only in task details

integer

Record creation time (timestamp)

Response example:

{
  "_meta": {
    "currentPage": 1,
    "pageCount": 5,
    "perPage": 20,
    "totalCount": 100
  },
  "code": 0,
  "data": [
    {
      "addr": "",
      "began_at": 0,
      "channel": "",
      "created_at": 0,
      "duration": 0,
      "ended_at": 0,
      "offset_ms": 0,
      "reason": 0,
      "record_id": "",
      "seq": 0,
      "task_id": "",
      "vod_size": 0
    }
  ]
}

Get the playback URL of a recording file

POST /server/v1/mcu/vod-url Authentication: required (see Overview) Get the playback URL of a single recording file. The URL expires (after 2 hours), so do not cache it long-term Request parameters

string

required

Recording file ID, taken from the task details or the recording file list

boolean

Whether to return LAN (internal network) URLs

Request example:

{
  "is_lan": false,
  "record_id": ""
}

Response parameters

string

Recording URL

integer

Recording size (bytes)

integer

Segment start time (compatibility field, same as began_at)

integer

Segment duration (seconds) (compatibility field, same as duration)

string

Recording file ID, used to get the URL of or delete a single file

string

ID of the recording task it belongs to

integer

Segment number, starting from 1; sorting by it gives the playback order

integer

Segment start time (timestamp)

integer

Segment end time (timestamp)

integer

Segment duration (seconds)

integer

Offset from the task start (ms), used for the progress bar in multi-segment playback

integer

Segment reason. 0: unknown, 1: split by duration, 2: resumed after an interruption (gap after the previous segment)

Response example:

{
  "code": 0,
  "data": {
    "began_at": 0,
    "duration": 0,
    "ended_at": 0,
    "mcu_at": 0,
    "mcu_dur": 0,
    "offset_ms": 0,
    "reason": 0,
    "record_id": "",
    "seq": 0,
    "size": 0,
    "task_id": "",
    "url": ""
  }
}

Get playback URLs of multiple recording files

POST /server/v1/mcu/vod-url/batch Authentication: required (see Overview) Get playback URLs of recording files in batch, up to 50 at a time; useful for fetching everything at once for continuous playback of a whole meeting Request parameters

array<string>

required

Recording file ID list, up to 50 per request (max length 50)

boolean

Whether to return LAN (internal network) URLs

Request example:

{
  "is_lan": false,
  "record_ids": [
    ""
  ]
}

Response parameters

string

Recording URL

integer

Recording size (bytes)

integer

Segment start time (compatibility field, same as began_at)

integer

Segment duration (seconds) (compatibility field, same as duration)

string

Recording file ID, used to get the URL of or delete a single file

string

ID of the recording task it belongs to

integer

Segment number, starting from 1; sorting by it gives the playback order

integer

Segment start time (timestamp)

integer

Segment end time (timestamp)

integer

Segment duration (seconds)

integer

Offset from the task start (ms), used for the progress bar in multi-segment playback

integer

Segment reason. 0: unknown, 1: split by duration, 2: resumed after an interruption (gap after the previous segment)

Response example:

{
  "code": 0,
  "data": [
    {
      "began_at": 0,
      "duration": 0,
      "ended_at": 0,
      "mcu_at": 0,
      "mcu_dur": 0,
      "offset_ms": 0,
      "reason": 0,
      "record_id": "",
      "seq": 0,
      "size": 0,
      "task_id": "",
      "url": ""
    }
  ]
}

Get playback URLs of all recordings in a meeting

POST /server/v1/mcu/vods-url Authentication: required (see Overview) Playback URLs of all recordings in a meeting. When a recording produces multiple files, all of them are returned, sorted by segment number. url/size/mcu_at/mcu_dur are legacy fields with unchanged meaning (mcu_at is the segment start time, mcu_dur is the segment duration); new fields such as record_id / seq / offset_ms are for locating a file precisely and for multi-segment playback. Request parameters

string

Meeting ID (required if room_no is not set)

string

Room number

boolean

Whether to return LAN (internal network) URLs

Request example:

{
  "is_lan": false,
  "meeting_id": "",
  "room_no": ""
}

Response parameters

string

Recording URL

integer

Recording size (bytes)

integer

Segment start time (compatibility field, same as began_at)

integer

Segment duration (seconds) (compatibility field, same as duration)

string

Recording file ID, used to get the URL of or delete a single file

string

ID of the recording task it belongs to

integer

Segment number, starting from 1; sorting by it gives the playback order

integer

Segment start time (timestamp)

integer

Segment end time (timestamp)

integer

Segment duration (seconds)

integer

Offset from the task start (ms), used for the progress bar in multi-segment playback

integer

Segment reason. 0: unknown, 1: split by duration, 2: resumed after an interruption (gap after the previous segment)

Response example:

{
  "code": 0,
  "data": [
    {
      "began_at": 0,
      "duration": 0,
      "ended_at": 0,
      "mcu_at": 0,
      "mcu_dur": 0,
      "offset_ms": 0,
      "reason": 0,
      "record_id": "",
      "seq": 0,
      "size": 0,
      "task_id": "",
      "url": ""
    }
  ]
}

Get live stream URLs

POST /server/v1/mcu/live-url Authentication: required (see Overview) Get live stream URLs Request parameters

string

Room number

string

Meeting ID

Request example:

{
  "meeting_id": "",
  "room_no": ""
}

Response parameters

string

RTMP playback URL

string

HTTP-FLV playback URL

string

HLS playback URL

Response example:

{
  "code": 0,
  "data": {
    "flv": "",
    "hls": "",
    "rtmp": ""
  }
}

Delete a recording task

POST /server/v1/mcu/del-task Authentication: required (see Overview) Delete a recording task together with all of its recording files Request parameters

string

Task ID

string

Meeting ID (required if task_id is not set)

boolean

Whether to return internal network playback URLs

Request example:

{
  "is_lan": false,
  "meeting_id": "",
  "task_id": ""
}

Response parameters data is null Response example:

{
  "code": 0,
  "data": null
}

Delete a recording file

POST /server/v1/mcu/del-record Authentication: required (see Overview) Delete a single recording file; other files from the same recording are not affected Request parameters

string

required

Recording file ID

Request example:

{
  "record_id": ""
}

Response parameters data is null Response example:

{
  "code": 0,
  "data": null
}

Start or update a recording task

POST /server/v1/mcu/start Authentication: required (see Overview) Start a recording task Request parameters

string

Room number

string

Meeting ID

integer

required

Task type, a bit mask: 1 video recording, 2 stream mixing, 4 audio recording, 8 live stream; e.g. 3 = video recording + stream mixing, 9 = video recording + live stream Example: 9

string

Recording task title

string

Task initiator ID

string

Task initiator name

string

Recording tags, comma-separated

object

required

Layout data

Show Fields

string

required

Layout type

object

Watermark

Show Fields

integer

Type. 0: default, 1: none, 2: single row, 3: multiple rows

string

Custom text; empty means automatic (meeting title)

integer

Font size; 0 means the default

string

Font color; empty means the default

string

Outline color; empty means the default

integer

Outline width; 0 means the default

string

Text shown when no one is in the meeting; empty means recording stops when no one is present

object

Default name label

Show Fields

string

Type, a letter or combination: L left, R right, T top, B bottom

string

Custom text; empty means automatic (in-meeting display name)

integer

Font size; 0 means default

string

Font color; empty means default

string

Background color; empty means default

integer

Rotation interval (seconds); 0 disables rotation

array<object>

Logical block list

Show Element fields

array<object>

Grid cell list; empty means the remaining cells share the users here

array<string>

User ID list. Empty: rotate through all remaining online users; multiple IDs: rotate among these users only

Request example:

{
  "layout_data": {
    "div_list": [
      {
        "cells": [
          {
            "bind_share": false,
            "idx": 0,
            "tag": {
              "bg_color": "",
              "color": "",
              "size": 0,
              "text": "",
              "type": ""
            }
          }
        ],
        "uids": [
          ""
        ]
      }
    ],
    "layout": "",
    "nobody_text": "",
    "polling_dur": 0,
    "tag": {
      "bg_color": "",
      "color": "",
      "size": 0,
      "text": "",
      "type": ""
    },
    "watermark": {
      "color": "",
      "ol_color": "",
      "ol_width": 0,
      "size": 0,
      "text": "",
      "type": 0
    }
  },
  "meeting_id": "",
  "op_name": "",
  "op_uid": "",
  "room_no": "",
  "tags": "",
  "task_type": 9,
  "title": ""
}

Response parameters

string

Keys are dynamic; see the description above

Response example:

{
  "code": 0,
  "data": {}
}

Stop a recording task

POST /server/v1/mcu/stop Authentication: required (see Overview) Request parameters

string

Room number

string

Meeting ID

integer

Task type (optional). If omitted, tasks of all types in the meeting are stopped; if set, only the given types are stopped. Values are the same as for the start endpoint Example: 1

Request example:

{
  "meeting_id": "",
  "room_no": "",
  "task_type": 1
}

Response parameters data is null Response example:

{
  "code": 0,
  "data": null
}

Overview

Web SDK

Android SDK

Swift SDK (iOS/macOS)

Server API

Meeting recording and live streaming

Get recording settings

Save recording settings

List recording tasks

Get recording task details

List recording files

Get the playback URL of a recording file

Get playback URLs of multiple recording files

Get playback URLs of all recordings in a meeting

Get live stream URLs

Delete a recording task

Delete a recording file

Start or update a recording task

Stop a recording task

​Get recording settings

​Save recording settings

​List recording tasks

​Get recording task details

​List recording files

​Get the playback URL of a recording file

​Get playback URLs of multiple recording files

​Get playback URLs of all recordings in a meeting

​Get live stream URLs

​Delete a recording task

​Delete a recording file

​Start or update a recording task

​Stop a recording task

Get recording settings

Save recording settings

List recording tasks

Get recording task details

List recording files

Get the playback URL of a recording file

Get playback URLs of multiple recording files

Get playback URLs of all recordings in a meeting

Get live stream URLs

Delete a recording task

Delete a recording file

Start or update a recording task

Stop a recording task