文档首页> 视频直播 Live> API参考> 录制管理> 提交录制控制命令
更新时间:2022-04-11 GMT+08:00
分享

提交录制控制命令

功能介绍

对单条流的实时录制控制接口。

接口约束

在录制规则类型为COMMAND_RECORD的时候有效。 -

调试

您可以在API Explorer中调试该接口。

URI

POST /v1/{project_id}/record/control

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参考获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

action

String

操作行为。 取值如下:

  • START:对指定流开始录制,必须在直播流已经推送情况下才能正常启动,使用此命令启动录制的直播流如果发生了断流且超出断流时长,就会停止录制,并且重新推流后不会自动启动录制。

  • STOP:对指定流停止录制。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token,使用Token鉴权方式时必选。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表4 请求Body参数

参数

是否必选

参数类型

描述

publish_domain

String

直播推流域名

app

String

应用名

stream

String

待启动或停止录制的流名

响应参数

状态码: 200

表5 响应Header参数

参数

参数类型

描述

X-request-id

String

此字段携带请求ID号,以便任务跟踪。格式为:request_id-timestamp-hostname(request_id在服务器端生成UUID,timestamp为当前时间戳,hostname为处理当前接口的服务器名称)

状态码: 400

表6 响应Header参数

参数

参数类型

描述

X-request-id

String

此字段携带请求ID号,以便任务跟踪。格式为:request_id-timestamp-hostname(request_id在服务器端生成UUID,timestamp为当前时间戳,hostname为处理当前接口的服务器名称)

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

POST https://{endpoint}/v1/{project_id}/record/control?action=START

{
  "publish_domain" : "publish.xxx.com",
  "app" : "live",
  "stream" : "mystream"
}

响应示例

状态码: 400

操作失败

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Request Illegal"
}

状态码

状态码

描述

200

操作成功

400

操作失败

错误码

请参见错误码

分享:

    相关文档

    相关产品

close