接口功能介绍
支持创建直播录制。
使用说明
使用直播录制功能前,需先开通媒体存储。
如果需要使用该接口,则不能开启 http强制跳转https功能。
接口详情
请求方式:POST
请求路径:/live/record/create-record
请求参数
参数 | 类型 | 名称 | 是否必填 | 说明 |
---|---|---|---|---|
DomainName | string | 域名 | 是 | 拉流域名。 |
App | string | 频道名 | 是 | - |
Stream | string | 流名 | 是 | - |
Params | object | 录制参数配置 | 是 | - |
Params.Output | object array | 输出参数 | 是 | 最多支持配置4个 |
Params.Output[*].Format | string | 输出文件的封装格式 | 是 | hls、flv、mp4、aac四种格式,格式名统一小写 |
Params.Output[*].SegmentTime | string | 录制文件分段时长,按固定文件时长输出,单位秒 | 否 | 取值范围为5至86400 当format为hls时,该字段代表ts文件的切片时长 当format为hls时,默认切片时长为10秒,为其它格式时默认分段为6小时 |
Params.Output[*].ResetTimestamps | int | 录制起始时间戳,仅仅针对mp4,flv,aac有效 | 否 | 录制起始时间戳,分段默认从零开始,仅仅针对输出文件的封装格式为mp4、flv、aac有效。取值范围为0和1,默认为1,分别表示: 0:分段文件起始时间戳不重置为0 1:分段文件起始时间戳重置为0 |
Params.OutTimeLink | string | 续录的超时时长,单位秒 | 否 | 取值范围是0至600。hls、flv、mp4、aac四种格式文件录制支持超时续录,默认为0秒 |
Params.XOSAccessKey | string | XOS存储的访问密钥 | 是 | 长度限制为1至255个字符 |
Params.XOSSecretKey | string | XOS存储的访问密钥 | 是 | 长度限制为1至255个字符 |
Params.XOSBucket | string | XOS存储的Bucket名称 | 是 | 长度限制为1至255个字符 |
Params.XOSRegion | string | XOS存储的Region名称 | 是 | 长度限制为1至255个字符 |
Params.XOSEndpoint | string | XOS存储的服务地址 | 是 | 长度限制为1至255个字符,例如:http://XOS.ctcdn.com。 |
Params.RecordNotifyUrl | string | 录制文件回调通知URL | 否 | 长度限制为1至255个字符 |
响应参数
参数名 | 类型 | 说明 |
---|---|---|
code | int | 状态码,成功时为100000 |
message | string | 描述信息,成功时为success |
TaskID | string | 任务id |
示例
请求路径:https://cdnapi-global.ctapi.ctyun.cn/live/record/create-record
请求示例
{
"App":"test",
"DomainName":"ctyun.cn1",
"Params":{
"XOSBucket":"test",
"RecordNotifyUrl":"test",
"XOSSecretKey":"test",
"XOSRegion":"test",
"Output":[
{
"Format":"hls",
"ResetTimestamps":0,
"SegmentTime":"10"
}
],
"XOSEndpoint":"test",
"XOSAccessKey":"test",
"OutTimeLink":"100"
},
"Stream":"test"
}
正确响应示例
{
"code":100000,
"message":"success",
"taskID":"123"
}
错误码请参考: 参数code和message含义