創建直播截圖任務
更新時間 2024-06-24 15:42:32
最近更新時間: 2024-06-24 15:42:32
分享文章
接口功能介紹
支持創建截圖任務。
使用說明
使用直播截圖功能前，需先開通媒體存儲。
如果需要使用該接口，則不能開啟 http強制跳轉https功能。
接口詳情
請求方式：POST
請求路徑：/live/snapshot/create-snapshot
請求參數
| 參數名 | 類型 | 名稱 | 是否必填 | 說明 |
|---|---|---|---|---|
| DomainName | string | 域名 | 是 | 拉流域名 |
| App | string | 頻道名 | 是 | - |
| Stream | string | 流名 | 是 | - |
| Params | object | 截圖參數配置 | 是 | - |
| Params.Output | object array | 輸出參數 | 是 | 目前只支持配置一個 |
| Params.Output[*].Format | string | 輸出圖片的封裝格式 | 是 | 支持jpg、png，格式名統一小寫 |
| Params.Output[*].Interval | string | 截圖間隔時長，單位秒 | 否 | 取值范圍為5至86400，默認10秒 |
| 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存儲的服務地址，例如：//XOS.ctcdn.com。 備注：完整的上傳地址url由worker依據上傳接口拼接合成 |
是 | 長度限制為1至255個字符 |
| Params.SnapshotNotifyUrl | string | 截圖文件回調通知URL | 否 | 長度限制為1至255個字符 |
響應參數
| 參數名 | 類型 | 名稱 |
|---|---|---|
| code | int | 狀態碼，成功時為100000 |
| message | string | 描述信息，成功時為success |
| TaskID | string | 任務id |
示例
請求路徑：//cdnapi-global.ctapi.daliqc.cn/live/snapshot/create-snapshot
請求示例
{
"App":"app-1",
"DomainName":"daliqc.cn",
"Params":{
"XOSBucket":"bucket",
"XOSSecretKey":"test",
"XOSRegion":"region",
"Output":[
{
"Format":"jpg",
"Interval":"10"
}
],
"SnapshotNotifyUrl":"//aaa.daliqc.cn/notify",
"XOSAccessKey":"akey"
},
"Stream":"stream-1"
}
正確響應示例
{
"code":100000,
"message":"success",
"taskID":"123"
}
錯誤碼請參考: 參數code和message含義
