更新媒體處理模板
更新時間 2024-03-21 17:53:48
最近更新時間: 2024-03-21 17:53:48
分享文章
接口功能介紹
支持直播轉碼、直播錄制、直播截圖和直播審核等媒體處理模板參數更新。
使用說明
(1)注意事項:本接口為 全量更新接口 ,即入參不止是變更參數值,未變更的也需要入參。
(2)可通過查詢域名媒體處理配置查詢域名已綁定的模板配置,以判斷是否對其中模板ID進行參數變更。
(3)可通過查詢媒體處理模板列表查詢已新增的媒體處理模板信息,以判斷是否對其中模板ID進行參數變更。
接口詳情
請求方式:POST
請求路徑:/live/media-template/update-media-template
請求JSON參數
| 參數名 | 類型 | 名稱 | 是否必填 | 說明 |
|---|---|---|---|---|
| TemplateType | string | 模板類型 | 是 | live-tran:直播轉碼 live-record:直播錄制 live-snapshot:直播截圖 live-identify:直播審核 |
| TemplateID | string | 模板ID | 是 | 已創建成功的媒體處理模板ID |
| Params | dict | 模板參數 | 是 | 參數值的修改為全量更新 若只變更部分參數值,可先查詢模板ID下各參數值,將變更后的全集作為入參值。 參數列表詳見下文說明 |
轉碼參數Params
| 參數名 | 類型 | 名稱 | 是否必填 | 說明 |
|---|---|---|---|---|
| Output | list | 參數集 | 是 | 輸出文件的相關參數,目前只支持配置一個 |
| Video | dict | 視頻參數集 | 否 | 視頻設置補充參數集 |
Output結構
| 參數名 | 類型 | 名稱 | 是否必填 | 說明 |
|---|---|---|---|---|
| Format | dict | 參數格式 | 是 | 轉碼輸出流關鍵參數集 |
Format結構
| 參數名 | 類型 | 名稱 | 是否必填 | 說明 |
|---|---|---|---|---|
| Vcodec | string | 編碼方式 | 是 | 1:H264 2:H265 |
| OutputFormat | string | 推薦模板 | 否 | ld:流暢 sd:標清 hd:高清 ud:超清 設置此參數值后,使用默認值,無須再設置具體值。 亦可以選擇不設置此參數,進行下面幾個參數(即下方的Vbr~SeiContent)的自定義配置。 |
| Vbr | string | 視頻碼率 | 否 | 若未配置OutputFormat參數,則Vbr參數為必填。 取值范圍為100k~8000k |
| Width | string | 視頻分辨率寬度 | 否 | 若未配置OutputFormat參數,則Width參數為必填。 取值范圍為100~8000,必須為2的倍數 |
| Height | string | 視頻分辨率高度 | 否 | 若未配置OutputFormat參數,則Height參數為必填。 取值范圍為100~8000,必須為2的倍數 |
| Fr | string | 視頻幀率 | 否 | 取值范圍為5~60 |
| Abr | string | 音頻碼率 | 否 | 取值范圍為10k~500k |
| Asr | int | 音頻采樣率 | 否 | 取值范圍>0 |
| Acodec | string | 音頻編碼 | 否 | 1:AAC 2:PCM |
| Gop | int | Gop | 否 | 取值范圍為1~20 |
| SeiType | int | SEI類型 | 否 | 取值范圍:5、-1,默認-1(即不新增sei) |
| SeiPattern | string | SEI模式 | 否 | 取值范圍:keyframe |
| SeiContent | string | SEI內容 | 否 | 長度限制為4000字節,SEI值不為-1時,SeiContent不能為空 |
推薦模板參數值:
| Vcodec | OutputFormat | Acodec | Width | Height | Fr | Vbr(bps) | Asr(Hz) | Abr(bps) |
|---|---|---|---|---|---|---|---|---|
| H264 | ld | AAC | 480 | 360 | 18 | 500k | 22050 | 48k |
| H264 | sd | AAC | 1280 | 720 | 25 | 1100k | 44100 | 96k |
| H264 | hd | AAC | 1920 | 1080 | 30 | 2000k | 44100 | 128k |
| H264 | ud | AAC | 2560 | 1440 | 30 | 3000k | 44100 | 128k |
| H265 | ld | AAC | 480 | 360 | 18 | 400K | 22050 | 48k |
| H265 | sd | AAC | 1280 | 720 | 25 | 800K | 44100 | 96k |
| H265 | hd | AAC | 1920 | 1080 | 30 | 1400K | 44100 | 128k |
| H265 | ud | AAC | 2560 | 1440 | 30 | 2000k | 44100 | 128k |
Video結構
| 參數名 | 類型 | 名稱 | 是否必填 | 說明 |
|---|---|---|---|---|
| Logo | list | Logo | 否 | 輸出文件的相關參數,目前只支持配置一個 |
Logo結構
| 參數名 | 類型 | 名稱 | 是否必填 | 說明 |
|---|---|---|---|---|
| Pic | string | 水印圖片地址 | 否 | 水印圖片地址 水印相關參數Pic、OptimalW、OptimalH、OffsetX和OffsetY要么都傳,要么都不傳。 |
| OptimalW | int | 水印寬度 | 否 | 水印寬度,占直播原始畫面寬度百分比,建議高寬只設置一項,另外一項會自適應縮放,避免變形。 默認原始寬度。最大30% |
| OptimalH | int | 水印高度 | 否 | 水印高度,占直播原始畫面高度百分比,建議高寬只設置一項,另外一項會自適應縮放,避免變形。 默認原始高度。最大50% |
| OffsetX | int | OffsetX | 否 | 顯示位置,X軸偏移,單位是百分比,默認0。 |
| OffsetY | int | OffsetY | 否 | 顯示位置,Y軸偏移,單位是百分比,默認0。 |
錄制參數Params
| 參數名 | 類型 | 名稱 | 是否必填 | 說明 |
|---|---|---|---|---|
| Output | list | 參數集 | 是 | 輸出文件的相關參數,目前只支持配置一個 |
| Output[].Format | string | 輸出文件的封裝格式 | 是 | hls、flv、mp4、aac四種格式,格式名統一小寫 |
| Output[]. SegmentTime | string | 錄制文件分段時長 | 否 | 取值范圍:5~86400(單位秒) 1.當format為hls時,該字段代表ts文件的切片時長 2.當format為hls時,默認切片時長為10秒,為其它格式時默認分段為6小時 |
| Output[].OssFilePath | string | 文件存儲路徑 | 否 | 設置錄制文件在媒體存儲的存放路徑,可配置固定值及變量,變量包含: app_name:頻道名 stream_name:流名 task_start_time:任務開始UTC時間戳 默認: record/{app_name}/{stream_name} |
| Output[]. OssFileName | string | 文件命名規則 | 否 | 設置錄制文件的命名規則,可配置固定值及變量,變量包含: app_name:頻道名 stream_name:流名 file_start_time:錄制文件開始UTC時間戳 file_end_time:錄制文件結束UTC時間戳 默認:{file_start_time}_{file_end__time} |
| OssRegion | string | OSS的Region名稱 | 是 | OSS的Region名稱 |
| OssBucket | string | OSS的Bucket名稱 | 是 | OSS的Bucket名稱 |
| OssEndpoint | string | OSS的服務地址 | 是 | OSS的服務地址 |
| OssExpiration | int | OSS的生命周期 | 是 | OSS的生命周期,單位為天,取值范圍1~3650 即在對象在創建多少天后將其刪除 |
截圖參數Params
| 參數名 | 類型 | 名稱 | 是否必填 | 說明 |
|---|---|---|---|---|
| Output | list | 參數集 | 是 | 輸出文件的相關參數,目前只支持配置一個 |
| Output.Format | string | 圖片格式 | 是 | jpg png |
| Output.Interval | string | 截圖間隔時長 | 否 | 截圖間隔時長,單位 秒,默認10秒 |
| Output. SamplingSnapshot | int | 是否截關鍵幀 | 否 | 0:是; 1:否 |
| Output.OssFilePath | string | 截圖存儲路徑 | 否 | 截圖路徑, 可配置固定值及變量,變量包含: app_name:頻道名 stream_name:流名 task_start_time:任務開始UTC時間戳 默認: snapshot/{app_name}/{stream_name} |
| Output.OssFileName | string | 截圖文件命名規則 | 否 | 截圖命名,可配置固定值及變量,變量包含: app_name:頻道名; stream_name:流名; file_start_time:截圖文件開始時間 默認: $ {file_start_time} |
| OssRegion | string | OSS存儲的Region名稱 | 是 | 1至255個字符 |
| OssBucket | string | OSS存儲的Bucket名稱 | 是 | 1至255個字符 |
| OssEndpoint | string | OSS存儲的Endpoint名稱 | 是 | 1至255個字符 |
| OssExpiration | int | 存儲時長 | 是 | 1-3650,單位為天,即在對象創建多少天后將其刪除 |
審核參數Params
| 參數名 | 類型 | 名稱 | 是否必填 | 說明 |
|---|---|---|---|---|
| IdentifyType | int | 審核類型 | 是 | 取值范圍: 1:反色情 |
| Output | object array | 直播審核參數 | 否 | 只支持配置一個 |
| Output.Format | string | 截圖格式 | 是 | 支持jpg、png格式名統一小寫,默認jpg |
| Output.Interval | string | 截圖間隔 | 否 | 5至86400(單位秒)審核的采樣間隔時長,單位秒,默認10秒 |
| OssBucket | string | OSS存儲的Bucket名稱 | 是 | 1至255個字符 |
| OssRegion | string | OSS存儲的Region名稱 | 是 | 1至255個字符 |
| OssEndpoint | string | OSS存儲的Endpoint名稱 | 是 | 1至255個字符 |
響應JSON參數
| 參數名 | 類型 | 名稱 |
|---|---|---|
| code | int | 狀態碼 |
| message | string | 描述信息 |
| TemplateID | string | 模板id |
示例
請求路徑://cdnapi-global.ctapi.daliqc.cn/live/media-template/update-media-template
請求JSON示例
{
"TemplateName": "tes111t11",
"TemplateType": "live-tran",
"TemplateID": "82hshhdh88sj7",
"Params":{
"Output":[{"Format":{"Vcodec": "1", "Vbr":"500k","Width":"480","Height":"360"}}]
}
}
正常返回JSON示例
{
"code": 100000,
"message": "success",
"TemplateID": "65shhklue975easaa457"
}