按需完成手动录制。例如动态启动录制、动态停止录制。
接口说明
-
请确保在使用该接口前,已充分了解直播录制的收费方式和价格。计费详情,请参见直播录制费用。
-
该接口前只能控制录制配置生效的直播流,需要先完成添加录制配置。
-
调用前须保证目标流(DomainName/AppName/StreamName)处于活跃推流状态。
-
如果某条直播流正在录制(自动录制或手动录制启动),您可以调用此接口停止该直播流的录制;但如果在启动时调用该接口尝试启动录制,则会返回 TaskAlreadyStarted 错误,表示任务已启动。
-
手动启动录制的直播流如果发生断流,即会停止录制。如果没有配置自动录制,重新推流后不会自动启动录制。
QPS 限制
本接口的单用户 QPS 限制为 50 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
live:RealTimeRecordCommand |
none |
*Domain
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
否 |
地域 ID。 |
cn-shanghai |
| Command |
string |
是 |
操作行为。取值:
|
start |
| DomainName |
string |
是 |
主播流域名。 |
example.com |
| AppName |
string |
是 |
播流所属应用名称。您可在流管理页面查看 AppName。 |
liveApp**** |
| StreamName |
string |
是 |
播流名称。请确保 StreamName 正确,您可在流管理页面查看 StreamName。 说明
该接口仅支持单条流操作,不支持通配符。 |
liveStream**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
16A96B9A-F203-4EC5-8E43-CB92E68F4CD8 |
示例
正常返回示例
JSON格式
{
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | MalformedParam | %s, please check and try again later. | 存在无效参数,请检查后重试。 |
| 400 | MissingParam | %s, please check and try again later. | 参数缺失,请检查后重试。 |
| 400 | CodeConfigNotFound | %s, please check and try again later. | 配置不存在,请检查后重试。 |
| 500 | InternalError | %s. | 直播 liveapi 服务端错误。 |
| 409 | StreamNotFound | %s, please check and try again later. | 流不存在,请检查后重试。 |
| 409 | TaskAlreadyStarted | %s, please do not start again. | 任务已启动,请勿重复启动。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。