云端录制

云端录制API，主要用于服务器云端录制开启，结束，更新。

开启录制

请求：

POST /recording/start
Host: api.pano.video
Content-Type: application/json
Authorization: PanoSign <PanoSign>
Tracking-Id: ef9b2acc8e1f4d598090eb6d9cbe8596

{
  "channelId":"Hello Pano",   // string, 必填, 频道ID
  "streamList": [
    {
      "streamId": 1,          // int,    必填，录制流ID
      "type": 1,              // int,    必填，录制模式
      "userId": "1",          // string, 可选，用户ID
      "flag": 15,             // int,    必填，媒体类型
      "layout": {...},        // object, 可选，布局参数
      "fps": 15,              // int,    可选，帧率
      "format": 2,            // int,    可选，文件格式
      "watermarks": [...]     // array,  可选, 水印
    },
    {
      "streamId": 2,
      "type": 2,
      "flag": 15,
      "userId": "2",
      "layout": {...},
      "fps": 15,
      "format": 2,
      "watermarks": [...]
    }
  ]
}

参数说明：

  • streamId - 录制流ID，由开发者指定，用以标识和区分同一channelId内的不同录制流，后续可以使用streamId来更新、结束录制。
    开发者可以对同一个channelId录制多个流，每个流有不同的配置。
    如果一个channelId只有一个录制流，则streamList可以只包含一个元素。
  • type - 录制模式
    • "type": 1，混录模式，频道内所有用户的音视频混合录制为一个文件
    • "type": 2，单录模式，单个用户的音视频混合录制成一个文件(单录时必须指定userId)
  • userId - 用户ID
    • 单录时表示需要录制的用户的userId(type为2时，userId是必填项)
    • 混录时表示主讲人ID，混录时如果不指定userId则第一个入会的用户作为主讲人
  • flag - 媒体类型，表示录制哪些媒体，1: 录音频、2: 录视频、4: 录桌面共享、8: 录白板，多个值相加表示同时录制多种媒体，值15表示录制所有媒体(15=1+2+4+8)
  • layout - 布局参数，用于设置视频合流布局，格式请参考布局参数说明
  • fps - 设置录制的帧率，支持30帧(默认值)和15帧
  • format - 设置录制文件格式，1: FLV(默认值)，2: MP4
  • watermarks - 水印，格式请参考水印

响应：

状态码说明
200请求成功处理
400请求格式错误
401认证错误
404频道不存在。该错误可能是在第一个用户开启频道之前发起录制时发生，可尝试重试该请求。
500服务器内部错误

更新录制

请求：

PUT /recording/update
Host: api.pano.video
Content-Type: application/json
Authorization: PanoSign <PanoSign>
Tracking-Id: ef9b2acc8e1f4d598090eb6d9cbe8596

{
  "channelId":"Hello Pano",  // string, 必填, 频道ID
  "streamList": [
    {
      "streamId": 1,         // int,    必填, 录制流ID
      "userId": "1",         // string, 可选, 用户ID
      "layout": {...},       // object, 可选, 布局参数
      "fps": 15,             // int,    可选, 帧率
      "watermarks": [...]    // array,  可选, 水印, 数组为空时表示删除水印
    },
    {
      "streamId": 2,
      "layout": {...},
      "fps": 15
    }
  ]
}

通过更新接口可以更新stream的布局、混录时的主讲人Id等。

注意：type和flag不可以更新。如果是单录，userId也不可以更新。

响应：

状态码说明
200请求成功处理
400请求格式错误
401认证错误
404频道不存在
500服务器内部错误

结束录制

请求：

POST /recording/stop
Host: api.pano.video
Content-Type: application/json
Authorization: PanoSign <PanoSign>
Tracking-Id: ef9b2acc8e1f4d598090eb6d9cbe8596

{
  "channelId": "Hello Pano",   // string, 必填, 频道ID
  "streamId": 1                // int,    可选, 当为空时, 结束频道下所有录制, 当不为空时, 仅结束此streamId对应录制
}

响应：

状态码说明
200请求成功处理
400请求格式错误
401认证错误
404频道不存在，或者录制任务未开启，可能有以下几种原因：
1. 频道结束后发送请求
2. 没有开启过录制
3. 多次结束同一个录制
500服务器内部错误

获取录制文件URL

请求：

POST /recording/url
Host: api.pano.video
Content-Type: application/json
Authorization: PanoSign <PanoSign>
Tracking-Id: ef9b2acc8e1f4d598090eb6d9cbe8596

{
  "channelKey": "57489728467",                  // channelKey与fileKeyList有一个必填
  "fileKeyList": ["68532189794","68532189795"], // channelKey与fileKeyList有一个必填
  "duration": 86400                             // int, 可选, url有效时长(seconds)
}

参数说明:

  • channelKey - channelKey与fileKeyList必须有一个为必填，只有channelKey参数时表示获取此通话下的所有录制文件URL，只有fileKeyList参数时表示获取这些fileKey的录制文件URL，如果2个参数都有值，则表示此channelKey下的此fileKey对应的录制文件
  • fileKeyList - fileKey在查询通话详情里获得，或者在webhook里获得。单次最多可以获取50个录制文件的URL
  • duration - 生成的URL有一个有效期，默认为24小时，最长为7天

注意事项：

  • 在频道结束后开始生成录制文件，此过程耗时通常约等于频道时长。可以申请开通 Webhook 回调来接收"录制文件生成"的通知。
  • 如果单个 streamId 录制时长超过2小时，会按照每2小时对录制文件进行切片。例如，2小时30分钟的录制，会生成一个2小时的录制文件和一个30分钟的录制文件，fileKeyList 中包含两个元素。
  • 录制文件默认永久存储，免费保存90天，超过后将产生存储费用，具体资费请咨询商务；如需调整存储期限，请咨询技术支持。
  • 播放或下载录制文件，会产生费用(该费用不包含在免费时长中)，具体资费请咨询商务。

响应：

状态码说明
200请求成功处理
400请求格式错误
401认证错误
404录制文件不存在
500服务器内部错误

响应示例

200 OK
[
  {
    "channelKey": "57489728467",
    "streamId": 1,
    "fileKey": "68532189794",
    "url": "https://abc1.flv",
    "duration": 3315,            // 录制文件时长，int(seconds)
    "size": "12345"              // 录制文件大小，string(Byte) 
  },
  ... // 更多数据
]

删除录制或者录制合并文件

请求：

DELETE /recording/item
Host: api.pano.video
Content-Type: application/json
Authorization: PanoSign <PanoSign>
Tracking-Id: ef9b2acc8e1f4d598090eb6d9cbe8596

{
  "type": 1,                                           // int, 必选，1: 表示删除录制文件 2: 表示删除录制合并文件
  "channelKeyList": ["57489728467"],                   // 当type=1的时候，该字段和fileKeyList字段至少有一个存在，如果channelKeyList存在则表示按频道级别删除录制文件；如果fileKeyList存在则表示按文件级别删除录制文件
  "fileKeyList": ["68532189794","68532189795"],        // 当type=2的时候，该字段不允许为空
}

响应：

状态码说明
200请求成功处理
400请求格式错误
401认证错误
404录制文件不存在
500服务器端内部错误
Last updated on 10/22/2021
← 频道管理CDN推流 →