使用SearchTemplate API搜尋自訂轉碼模板-ApsaraVideo for Media Processing-阿里雲

搜尋指定狀態的自訂模板。

介面說明

本介面通過搜尋轉碼模板狀態搜尋自訂模板。

QPS 限制

本介面的單使用者 QPS 限制為 100 次/秒。超過限制，API 呼叫會被限流，這可能會影響您的業務，請合理調用。更多資訊，請參見 QPS 限制。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

mts:SearchTemplate

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
PageSize	integer	否	結果分頁查詢時設定的每頁大小。上限值：100。預設值：10。	10
PageNumber	integer	否	當前頁號。預設值：1。	1
State	string	否	需要搜尋的轉碼模板狀態。 All 表示所有。 Normal 表示正常。 Deleted 表示已刪除。預設值：All。	Normal
NamePrefix	string	否	按模板名稱首碼搜尋時填入的首碼。	S00000001

返回參數

名稱	類型	描述	樣本值
	object	返回參數。
TotalCount	integer	搜尋結果總條數。	1
TemplateList	object
Template	array<object>	轉碼模板列表。
	array<object>	轉碼模板。
Video	object	視頻編解碼配置。
Bufsize	string	緩衝區大小。單位：Kb。預設值：6000。	6000
LongShortMode	string	是否開啟橫豎屏自適應（即：長短邊模式）。轉碼輸出的寬對應輸入片源的長邊（豎屏為片源的高），高對應輸入視頻的短邊（豎屏為片源的寬）。 true 表示開啟。 false 表示關閉。預設值：false。	false
Degrain	string	視頻品質控制度。	10
BitrateBnd	object	視頻平均碼率範圍。
Max	string	總碼率上限。單位：Kbps。	500
Min	string	總碼率下限。單位：Kbps。	100
PixFmt	string	視頻顏色格式。範圍：yuv420p，yuvj420p 等標準顏色格式。	yuv420p
Pad	string	視頻貼黑邊。參數格式：width:height:left:top。樣本：1280:800:0:140。	1280:800:0:140
Codec	string	編解碼格式。可選值 H.264、H.265。預設值：H.264。	H.264
Height	string	視頻高。單位：px。預設值：視頻原始高度。	800
Qscale	string	獨立去噪演算法強度。	1
Crop	string	視頻畫面裁切。自動檢測黑邊並裁切：設定為“border”。自訂裁切：自訂參數並裁剪。參數格式：width:height:left:top。樣本：1280:800:0:140。	border
Bitrate	string	視頻平均碼率。單位：Kbps。	200
Maxrate	string	視頻碼率峰值。單位：Kbps。	500
NarrowBand	object	窄帶高清設定參數。
Abrmax	number	動態碼率上限，設定後平均碼率範圍 (0, 1000000]。	3000
MaxAbrRatio	number	碼率上限最大倍率，設定後 Abrmax 值不會超過視頻源碼率的 x 倍。範圍 (0, 1.0]。	1.0
Version	string	窄帶高清版本，可選值：1.0 。	1.0
MaxFps	string	最大幀率。	60
Profile	string	編碼層級。 baseline：針對行動裝置。 main：針對標準解析度裝置。 high：針對高解析度裝置。預設值：high。	high
Crf	string	碼率-品質控制因子。預設值：編碼格式為 H264，預設值為 23。編碼格式為 H265，預設值為 26。如果設定了 Crf，則 Bitrate 的設定失效。	15
Remove	string	是否刪除視頻流。 true 表示刪除。 false 表示保留。預設值：false。	false
Gop	string	主要畫面格間最大幀數。預設值：250。	10
Width	string	視頻寬。取值範圍：[128,4096]。單位：px。預設值：視頻原始寬度。	256
Fps	string	幀率。當輸入檔案幀率超過 60 時取 60。預設值：取輸入檔案幀率。	25
Preset	string	視頻演算法器預置。預設值：medium。可選值： veryfast：超快。 fast：快。 medium：中等。 slow：慢。 slower：超慢。	medium
ScanMode	string	掃描模式。可選值： interlaced：交叉掃描。 progressive：順序掃描。	interlaced
ResoPriority	string	解析度調整優先順序。	1
Hdr2sdr	string	是否開啟 hdr2sdr 功能。啟用時會把 hdr 的視頻轉成 sdr。	true
TransConfig	object	轉碼通用配置。
IsCheckAudioBitrate	string	是否檢查音頻碼率。當輸出音頻碼率大於媒體源音頻碼率時，則視為輸出音頻碼率等於媒體源音頻碼率，即設定的音頻碼率參數不會生效。此值優先順序小於 IsCheckAudioBitrateFail。 true 表示檢查。 false 表示不檢查。預設值：參數為空白，並且 codec 和輸入源不一樣：false。參數為空白，並且 codec 和輸入源一樣：true。	false
TransMode	string	轉碼模式。預設值：onepass。可選值： onepass twopass CBR	onepass
IsCheckReso	string	是否檢查解析度。如果輸出解析度大於輸入解析度（判斷條件是寬或高），則輸出解析度等於輸入解析度。 true 表示檢查。 false 表示不檢查。預設值：false。	false
IsCheckVideoBitrateFail	string	是否允許視頻碼率檢查錯誤。此值優先順序大於 IsCheckVideoBitrate。 true 表示檢查出錯時不進行轉碼。 false 表示不檢查。預設值：false。	false
AdjDarMethod	string	解析度改寫方式。預設值：none。可選值： rescale：範圍展開。 crop：批量裁剪。 none：不改變。	none
IsCheckVideoBitrate	string	是否檢查視頻碼率。如果視頻輸出碼率大於視頻輸入碼率，則視頻輸出碼率等於視頻輸入碼率。 true 表示檢查。 false 表示不檢查。預設值：false。	false
IsCheckResoFail	string	是否檢查解析度。如果輸出解析度大於輸入解析度（判斷條件是寬或高），則返迴轉碼失敗。 true 表示檢查。 false 表示不檢查。預設值：false。	false
IsCheckAudioBitrateFail	string	是否允許音頻碼率檢查錯誤。此值優先順序大於 IsCheckAudioBitrate。 true 表示檢查出錯時不進行轉碼。 false 表示不檢查。預設值：false。	false
State	string	模板的狀態。 Normal：正常。 Deleted：已刪除。	Normal
MuxConfig	object	轉碼封包配置。
Gif	object	Gif 對應的封包配置。
FinalDelay	string	終幀暫停時間，單位厘秒（cs）。	0
DitherMode	string	調色盤顏色抖動方式。可選的抖動演算法為 sierra 演算法和 bayer 演算法。	sierra
Loop	string	迴圈次數。	0
IsCustomPalette	string	自訂調色盤功能。	false
Segment	object	切片配置。
Duration	string	分區時間長度。單位：秒。	10
Name	string	模板名稱。	MPS-example
Audio	object	音頻編解碼配置。
Profile	string	音頻編碼預置。當 Codec 為 aac 時可選值： aac_low aac_he aac_he_v2 aac_ld aac_eld	aac_low
Remove	string	是否刪除音頻流。 true 表示刪除。 false 表示保留。預設值：false。	false
Codec	string	音頻編解碼格式。預設值：aac。可選值： aac mp3 vorbis flac	aac
Samplerate	string	採樣率。單位：Hz。預設值：44100。	44100
Qscale	string	獨立去噪演算法強度。取值：[1,9]。	1
Channels	string	聲道數。預設值：2。	2
Bitrate	string	輸出檔案的音頻碼率。單位：Kbps。預設值：128。	500
Id	string	轉碼模板 ID。	16f01ad6175e4230ac42bb5182cd****
Container	object	容器。
Format	string	容器格式。可選值： flv mp4 ts m3u8 gif mp3 ogg flac	mp4
CreationTime	string	模板建立時間。	2021-03-04T06:44:43Z
PageSize	integer	分頁查詢時設定的每頁大小。	10
RequestId	string	請求 ID。	BC860F04-778A-472F-AB39-E1BF329C****
PageNumber	integer	當前頁碼。	1

樣本

正常返回樣本

JSON格式

{
  "TotalCount": 1,
  "TemplateList": {
    "Template": [
      {
        "Video": {
          "Bufsize": "6000",
          "LongShortMode": "false",
          "Degrain": "10",
          "BitrateBnd": {
            "Max": "500",
            "Min": "100"
          },
          "PixFmt": "yuv420p",
          "Pad": "1280:800:0:140",
          "Codec": "H.264",
          "Height": "800",
          "Qscale": "1",
          "Crop": "border",
          "Bitrate": "200",
          "Maxrate": "500",
          "NarrowBand": {
            "Abrmax": 3000,
            "MaxAbrRatio": 1,
            "Version": "1.0"
          },
          "MaxFps": "60",
          "Profile": "high",
          "Crf": "15",
          "Remove": "false",
          "Gop": "10",
          "Width": "256",
          "Fps": "25",
          "Preset": "medium",
          "ScanMode": "interlaced",
          "ResoPriority": "1",
          "Hdr2sdr": "true"
        },
        "TransConfig": {
          "IsCheckAudioBitrate": "false",
          "TransMode": "onepass",
          "IsCheckReso": "false",
          "IsCheckVideoBitrateFail": "false",
          "AdjDarMethod": "none",
          "IsCheckVideoBitrate": "false",
          "IsCheckResoFail": "false",
          "IsCheckAudioBitrateFail": "false"
        },
        "State": "Normal",
        "MuxConfig": {
          "Gif": {
            "FinalDelay": "0",
            "DitherMode": "sierra",
            "Loop": "0",
            "IsCustomPalette": "false"
          },
          "Segment": {
            "Duration": "10"
          }
        },
        "Name": "MPS-example",
        "Audio": {
          "Profile": "aac_low",
          "Remove": "false",
          "Codec": "aac",
          "Samplerate": "44100",
          "Qscale": "1",
          "Channels": "2",
          "Bitrate": "500"
        },
        "Id": "16f01ad6175e4230ac42bb5182cd****",
        "Container": {
          "Format": "mp4"
        },
        "CreationTime": "2021-03-04T06:44:43Z"
      }
    ]
  },
  "PageSize": 10,
  "RequestId": "BC860F04-778A-472F-AB39-E1BF329C****",
  "PageNumber": 1
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。