调用SubmitLiveRecordJob提交实时录制任务,对直播流进行录制。
接口说明
该接口目前支持阿里云直播或第三方 RTMP 直播流录制。建议先推流再调用本接口提交录制任务。如果直播流地址拉不到流,任务会尝试拉流 3 分钟。超时后录制服务将停止录制。
提交录制任务前,需准备好阿里云 OSS 或 VOD 存储空间。建议使用在智能媒体服务中配置的存储地址,便于对录制生成的文件进行管理和处理。
如果系统预置的录制模板不符合需求,可自行创建定制录制模板。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ice:SubmitLiveRecordJob | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
NotifyUrl | string | 否 | 回调地址 | https://example.com/imsnotify |
StreamInput | object | 是 | 直播流地址。 | |
Type | string | 是 | 直播流地址类型。目前支持 rtmp。 | rtmp |
Url | string | 否 | 直播流地址。 | rtmp://example.com/live/stream1 |
RecordOutput | object | 是 | 录制存储地址。 | |
Type | string | 是 | 存储地址类型。 | oss |
Bucket | string | 否 | 存储空间名称。 | imsbucket1 |
Endpoint | string | 否 | 存储服务地址。 | oss-cn-hangzhou.aliyuncs.com |
TemplateId | string | 是 | 录制模板 ID。 | 69e1f9fe-1e97-11ed-ba64-0c42a1b73d66 |
Name | string | 是 | 录制任务名称。 | live stream record 1 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "BEA98A0C-7870-15FE-B96F-8880BB600A2C",
"JobId": "ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66"
}
错误码
访问错误中心查看更多错误码。