新增轉碼模板
更新時間 2023-09-28 10:51:54
最近更新時間: 2023-09-28 10:51:54
分享文章
通過本接口可添加轉碼配置信息，創建新的轉碼模板。
接口功能介紹
通過本接口可添加轉碼配置信息，創建新的轉碼模板。
接口約束
本接口的單用戶QPS限制為20次/秒。超過限制，API調用會被限流，這可能會影響您的業務，請合理調用。
URI
POST /template/transcode/create
請求體 body 參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| name | 是 | String | 模板名稱，必填，支持大小寫字母數字以及漢字以及下劃線及折線，長度最長為20個字符，并且同一個用戶名稱唯一。 | transcodeTemplate | |
| favorite | 否 | Boolean | 是否為選定模板，默認為否。 | true | |
| format | 是 | String | 轉碼目標文件格式，可選為 MP4/FLV/HLS。 | MP4 | |
| encrytion | 否 | Boolean | 表示是否加密目標視頻，僅當 transcode.format == "HLS" 時有效。 | true | |
| video | 否 | Object | 視頻的轉碼參數，video不傳且audio有值表示新建音頻轉碼模板，video和audio至少一個有值。 | -- | video |
| audio | 否 | Object | 音頻的轉碼參數，不傳時表示去除音頻。 | -- | audio |
| remark | 否 | String | 轉碼模板備注 | 模板備注 |
表 video
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| codec | 是 | String | 視頻編碼，支持 H264 和 H265。如果目標文件格式為 FLV，這一項只能為 H264。 | H264 | |
| bitRate | 否 | String | 可選參數，但建議填寫，視頻的碼率，默認為自動。請注意，該值需要自帶單位，例如 512K。 | 512K | |
| frameRate | 否 | Integer | 視頻的幀率，默認為 24。 | 24 | |
| height | 否 | Integer | 目標視頻的高度，如果高度和寬度都不指定，則為原視頻的高寬。如果指定了其中一個，另一個不指定，不指定的會按比例縮放。 | 1024 | |
| width | 否 | Integer | 目標視頻的寬度，如果高度和寬度都不指定，則為原視頻的高寬。如果指定了其中一個，另一個不指定，不指定的會按比例縮放。 | 768 | |
| autoRotate | 否 | Boolean | 表示當前模板支持自動旋轉，即如當前模板的分辨率為 1024x768，但如果用戶傳入了 高 > 寬的情況，則該模板將自動適配為 768x1024 | true |
表 audio
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| codec | 是 | String | 音頻的編碼，可選為 AAC 和 MP3。 | AAC | |
| bitRate | 否 | String | 音頻的碼率，建議從以下值選擇輸入 64K/96K/128K/192K/256K/320K，不填入為自動 | 128k | |
| sampleRate | 是 | Integer | 音頻的頻率，可選為 44100/48000，默認為 44100 | 44100 |
響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| code | 是 | Integer | 本次請求的結果碼。 | 0 | |
| message | 是 | String | 錯誤文本信息，創建成功時，為空字符串。 | "" | |
| data | 是 | Object | 返回數據。 | data |
表 data
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| templateId | 是 | Long | 模板id。 | 100000000003 |
請求示例
請求體body
{
"name": "",
"favorite": "true",
"format": "MP4",
"encrytion": "true",
"remark": "模板備注",
"video": {
"codec": "H264",
"bitRate": "512K",
"frameRate": 24,
"height": 1024,
"width": 768,
"autoRotate": "true"
},
"audio": {
"codec": "AAC",
"bitRate": "128k",
"sampleRate": 44100
}
}
響應示例
{
"code": 0,
"message": "",
"data" : {
"templateId" : "100000000003"
}
}
狀態碼
| Http 狀態碼 | 狀態碼信息 | 狀態碼描述 |
|---|---|---|
| 0 | 表示業務成功 | 表示業務成功 |
| 400 | 請求參數有誤 | 請求參數有誤 |
| 403 | 用戶鑒權失敗，用戶無操作權限 | 用戶鑒權失敗，用戶無操作權限 |
| 404 | 請求的資源不存在，輸入錯誤的URL | 請求的資源不存在，輸入錯誤的URL |
| 500 | 業務執行異常 | 業務執行異常 |
錯誤碼
OpenAPI錯誤碼請參考 錯誤碼說明。
