云录制与直播

获取默认录制配置

POST /server/v1/mcu/record-config 鉴权：需要（见概览）查询应用当前的默认录制配置（布局、水印、成员名标签位置）。无请求参数，配置是应用维度的，由鉴权得到的应用身份决定。启动任务时不传 layout_data 就用这套配置 —— 把统一的水印、标签、布局策略配在这里，就不必每次启动任务都重复传。 请求参数 无 响应参数

string

应用ID

string

布局类型 auto,full,grids_2,grids_4,…

integer

水印类型 0默认,1无,2单排,3多排

string

窗口标签位置字母或组合:L左,R右,T上,B下,空表示不启用标签

integer

配置创建时间，秒级时间戳示例：1718194666

integer

配置最后变更时间，秒级时间戳示例：1718194705

响应示例：

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

更新默认录制配置

POST /server/v1/mcu/save-record-config 鉴权：需要（见概览）更新应用的默认录制配置。三个字段都可选，只传要改的。改动只影响之后启动的新任务，进行中的任务不受影响。 请求参数

string

布局类型: auto自动 full全屏 right_4右侧小窗 top_4顶部小窗 br_7下L型 tl_7上L型 tb_8左右布局, 以及等分宫格 grids_N (N 取 2,3,4,5,6,8,9,12,16,20,25) 示例：auto

integer

水印类型 0默认,1无,2单排,3多排示例：1

string

每个画面上成员名标签的位置，字母或组合:L左,R右,T上,B下（如 LB 左下）；空表示不显示标签（最大长度 2）示例：L

请求示例：

{
  "layout": "auto",
  "watermark_type": 1,
  "window_tag_type": "L"
}

响应参数 data 为 null 响应示例：

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

录像列表

POST /server/v1/mcu/list-record 鉴权：需要（见概览）分页查询录像列表。只有已完成的任务才有可播放的录像文件，用响应里的 task_status 区分进行中与已结束。 请求参数

integer

起始时间，秒级时间戳，按任务创建时间过滤；0 表示不限示例：1718194666

integer

终止时间，秒级时间戳；0 表示不限示例：1718799878

array<string>

通用搜索

string

排序（可排序字段：created_at）

integer

页数，从1开始示例：1

integer

每页数据量示例：10

请求示例：

{
  "begin_at": 1718194666,
  "end_at": 1718799878,
  "page": 1,
  "per-page": 10,
  "search": [
    ""
  ],
  "sort": ""
}

响应参数

string

任务ID

string

任务发起人ID

string

任务发起人名

string

频道

string

频道标题

string

外部会议号

integer

0待开始 1进行中 2待结束 3异常结束 4正常结束

string

错误描述

string

录像文件key

integer

录像大小(字节)

integer

MCU开始时间

integer

Mcu时长(秒)

string

录像标签逗号隔开

integer

任务创建时间，秒级时间戳示例：1718194666

integer

任务最后变更时间，秒级时间戳示例：1718194705

响应示例：

{
  "_meta": {
    "currentPage": 1,
    "pageCount": 5,
    "perPage": 20,
    "totalCount": 100
  },
  "code": 0,
  "data": [
    {
      "channel": "",
      "created_at": 1718194666,
      "err_desc": "",
      "mcu_at": 0,
      "mcu_dur": 0,
      "op_name": "",
      "op_uid": "",
      "room_no": "",
      "tags": "",
      "task_id": "",
      "task_status": 0,
      "title": "",
      "updated_at": 1718194705,
      "vod_key": "",
      "vod_size": 0
    }
  ]
}

获取录像播放地址

POST /server/v1/mcu/vod-url 鉴权：需要（见概览）获取录像回放地址。任务必须已停止且转码完成，进行中的任务取不到地址。地址有有效期，不要长期缓存或存进业务库，每次播放前重新获取。 请求参数

string

任务ID 示例：sxjgwy

string

频道(无TaskId时必填)；只传频道则取该频道最近一次的录像示例：fire

boolean

是否返回内网地址，适合纯内网部署或专线接入；默认返回外网地址

请求示例：

{
  "channel": "fire",
  "is_lan": false,
  "task_id": "sxjgwy"
}

响应参数

string

录像地址

integer

录像大小(字节)

integer

MCU开始时间

integer

Mcu时长(秒)

响应示例：

{
  "code": 0,
  "data": {
    "addr": "",
    "mcu_at": 0,
    "mcu_dur": 0,
    "size": 0
  }
}

删除录像

POST /server/v1/mcu/del-record 鉴权：需要（见概览）删除录像记录，删除后不再出现在录像列表与详情中。只传 channel 不传 task_id 时，该频道下所有含录像的任务会被一起删掉，要删指定的一次录制请传 task_id。 请求参数

string

任务ID 示例：sxjgwy

string

频道(无TaskId时必填) 示例：fire

请求示例：

{
  "channel": "fire",
  "task_id": "sxjgwy"
}

响应参数 data 为 null 响应示例：

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

启动录制/合流/直播任务

POST /server/v1/mcu/start 鉴权：需要（见概览）启动服务端的录制、合流或直播任务。同一频道对同一类型只有一个进行中的任务：重复调用不新建，而是按传入参数更新已有任务。 请求参数

integer

必填

任务类型，按位组合：1录像、2合流、4录音、8直播流；如 3 表示录像+合流，9 表示录像+直播示例：9

string

任务发起人ID 示例：1001

string

任务发起人名（最大长度 100）示例：张三

string

必填

频道（长度 64 字节以内，仅支持大小写字母、数字、下划线 _ 与连字符 -）示例：fire

string

必填

频道标题。会成为录像标题，也是水印的默认内容（watermark.text 留空时）示例：项目周会 2024-06-12

string

外部会议号。你自己业务的会议号，仅用于回查，RTC 侧不校验（最大长度 50）示例：818595664

string

录像标签，逗号分隔（注意：修改录像接口的 tags 是数组）示例：周会,研发

object

布局数据。不传时使用应用的默认录制配置（见获取默认录制配置）

显示字段

string

必填

布局类型: auto自动 full全屏 right_4右侧小窗 top_4顶部小窗 br_7下L型 tl_7上L型 tb_8左右布局, 以及等分宫格 grids_N (N 取 2,3,4,5,6,8,9,12,16,20,25) 示例：auto

object

水印

显示字段

integer

类型 0默认, 1无, 2单排, 3多排示例：1

string

指定内容, 空表示自动(会议标题)

integer

字体大小, 0表示默认值

string

字体颜色, 空表示默认值

string

轮廓颜色, 空表示默认值

integer

轮廓线宽, 0表示默认值

string

会中无人时显示的文本, 空表示无人时停止录制

object

默认标签

显示字段

string

类型, 字母或组合: L左, R右, T上, B下示例：L

string

指定内容, 空表示自动(会中名称)

integer

字体大小, 0表示默认

string

字体颜色, 空表示默认

string

背景颜色, 空表示默认

integer

轮询时长(秒) 0不轮询

array<object>

逻辑块列表

显示元素字段

array<object>

宫格列表, 空表示剩余格子共用此处的用户

array<string>

用户ID列表, 空表示大轮询在线剩余用户, 多个表示小轮询

object

用户名称表, 与McuDiv.Uids对应(不必需)

请求示例：

{
  "channel": "fire",
  "layout_data": {
    "div_list": [
      {
        "cells": [
          {
            "bind_share": false,
            "idx": 0,
            "tag": {
              "bg_color": "",
              "color": "",
              "size": 0,
              "text": "",
              "type": "L"
            }
          }
        ],
        "uids": [
          ""
        ]
      }
    ],
    "layout": "auto",
    "names": {},
    "nobody_text": "",
    "polling_dur": 0,
    "tag": {
      "bg_color": "",
      "color": "",
      "size": 0,
      "text": "",
      "type": "L"
    },
    "watermark": {
      "color": "",
      "ol_color": "",
      "ol_width": 0,
      "size": 0,
      "text": "",
      "type": 1
    }
  },
  "op_name": "张三",
  "op_uid": "1001",
  "room_no": "818595664",
  "tags": "周会,研发",
  "task_type": 9,
  "title": "项目周会 2024-06-12"
}

响应参数

string

本次任务的 ID，停止任务、查询详情、取播放地址都用它

响应示例：

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

停止录制/合流/直播任务

POST /server/v1/mcu/stop 鉴权：需要（见概览）停止进行中的录制/合流/直播任务。录像文件在任务停止后才完成转码，随后才能取到播放地址。频道销毁时进行中的任务会自动停止，不必先手动调用。 请求参数

string

任务ID 示例：sxjgwy

string

频道(无TaskId时必填) 示例：fire

integer

任务类型(选填)。不传表示停掉该频道所有类型的任务；传了则只停指定类型，取值同启动接口示例：1

请求示例：

{
  "channel": "fire",
  "task_id": "sxjgwy",
  "task_type": 1
}

响应参数 data 为 null 响应示例：

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

录像详情

POST /server/v1/mcu/record-detail 鉴权：需要（见概览）查询一次录制任务的详情：任务类型、状态、起止时间、时长、录像文件信息。有 task_id 时按任务查；只传 channel 则取该频道最近一次的录像。用响应里的 task_status 判断任务跑到哪一步了（0 待开始 1 进行中 2 待结束 3 异常结束 4 正常结束）。 请求参数

string

任务ID 示例：sxjgwy

string

频道(无TaskId时必填) 示例：fire

请求示例：

{
  "channel": "fire",
  "task_id": "sxjgwy"
}

响应参数

string

任务ID

string

任务发起人ID

string

任务发起人名

string

频道

string

频道标题

string

外部会议号

integer

0待开始 1进行中 2待结束 3异常结束 4正常结束

string

错误描述

string

录像文件key

integer

录像大小(字节)

integer

MCU开始时间

integer

Mcu时长(秒)

string

录像标签逗号隔开

integer

任务创建时间，秒级时间戳示例：1718194666

integer

任务最后变更时间，秒级时间戳示例：1718194705

响应示例：

{
  "code": 0,
  "data": {
    "channel": "",
    "created_at": 1718194666,
    "err_desc": "",
    "mcu_at": 0,
    "mcu_dur": 0,
    "op_name": "",
    "op_uid": "",
    "room_no": "",
    "tags": "",
    "task_id": "",
    "task_status": 0,
    "title": "",
    "updated_at": 1718194705,
    "vod_key": "",
    "vod_size": 0
  }
}

修改录像标题与标签

POST /server/v1/mcu/update-record 鉴权：需要（见概览）修改录像的标题与标签，用于归档整理，不影响录像文件本身。标题与标签都可以用录像列表的 search 检索到。 请求参数

string

必填

任务ID 示例：sxjgwy

string

录像标题，不传表示不改（最大长度 100）示例：项目周会（已归档）

array<string>

标签，最多 10 个，整体替换而非追加 —— 要保留的标签需一并传入（最大长度 10）示例：["周会","研发"]

请求示例：

{
  "tags": [
    "周会",
    "研发"
  ],
  "task_id": "sxjgwy",
  "title": "项目周会（已归档）"
}

响应参数 data 为 null 响应示例：

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

获取直播拉流地址

POST /server/v1/mcu/live-url 鉴权：需要（见概览）获取直播拉流地址，一次返回 rtmp / flv / hls 三种协议，按你的播放端选用。与录像回放不同，直播地址在任务进行中就能取到 —— 前提是启动任务时 task_type 带了直播位（8）。地址有有效期，不要长期缓存。 请求参数

string

任务ID 示例：sxjgwy

string

频道(无TaskId时必填) 示例：fire

请求示例：

{
  "channel": "fire",
  "task_id": "sxjgwy"
}

响应参数

string

RTMP 拉流地址，延迟最低，适合需要低延迟的播放端

string

HTTP-FLV 拉流地址，Web 端常用

string

HLS(m3u8) 拉流地址，兼容性最好，延迟相对高

响应示例：

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

概览

iOS SDK

Swift SDK（iOS/macOS）

Android SDK

Windows SDK

Web SDK

微信小程序 SDK

服务端 API

全平台 C++ SDK

获取默认录制配置

更新默认录制配置

录像列表

获取录像播放地址

删除录像

启动录制/合流/直播任务

停止录制/合流/直播任务

录像详情

修改录像标题与标签

获取直播拉流地址

​获取默认录制配置

​更新默认录制配置

​录像列表

​获取录像播放地址

​删除录像

​启动录制/合流/直播任务

​停止录制/合流/直播任务

​录像详情

​修改录像标题与标签

​获取直播拉流地址

获取默认录制配置

更新默认录制配置

录像列表

获取录像播放地址

删除录像

启动录制/合流/直播任务

停止录制/合流/直播任务

录像详情

修改录像标题与标签

获取直播拉流地址