創建直播錄制任務
更新時間 2024-06-24 15:42:39
最近更新時間: 2024-06-24 15:42:39
分享文章
接口功能介紹
支持創建直播錄制。
使用說明
使用直播錄制功能前，需先開通媒體存儲。
如果需要使用該接口，則不能開啟 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個字符，例如：//XOS.ctcdn.com。 |
| Params.RecordNotifyUrl | string | 錄制文件回調通知URL | 否 | 長度限制為1至255個字符 |
響應參數
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | int | 狀態碼，成功時為100000 |
| message | string | 描述信息，成功時為success |
| TaskID | string | 任務id |
示例
請求路徑：//cdnapi-global.ctapi.daliqc.cn/live/record/create-record
請求示例
{
"App":"test",
"DomainName":"daliqc.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含義
