點播API的ApsaraVideo for Media Processing參數說明 -

本文為您介紹點播API的ApsaraVideo for Media Processing參數。

HLS標準加密配置EncryptConfig

欄位名稱	類型	必填項	描述
CipherText	String	是	密文密鑰，用來擷取清除金鑰。
DecryptKeyUri	String	是	根據密文密鑰擷取解密密鑰地址，例如：`http://example.aliyundoc.com?CipherText=ZjJmZGViNzUtZWY1Mi00Y2RlLTk****`。
KeyServiceType	String	是	密鑰服務類型，預設值：KMS（阿里雲Key Management Service）。

EncryptConfig參數樣本

{
  "CipherText":"ZjJmZGViNzUtZWY1Mi00Y2RlLTk****",
  "DecryptKeyUri":"http://example.aliyundoc.com?CipherText=ZjJmZGViNzUtZWY1Mi00Y2RlLTk****",
  "KeyServiceType":"KMS"
}

轉碼作業參數替換配置 OverrideParams

欄位名稱	類型	必填項	描述
Watermarks	Watermark[]	否	浮水印替換必傳。
SubtitleSetting	SubtitleSetting	否	字幕替換必傳。說明使用到的轉碼模板必須先配置字幕參數，否則不做字幕參數覆蓋，詳細字幕配置請參見SubtitleConfig。覆蓋的字幕檔案地址必須是HTTP（非HTTPS）的OSS地址，不支援CDN加速網域名稱地址，例如：`http://out-dda****.cn-shanghai.aliyuncs.com/subtitle/subtitle.ass`
PackageSubtitleSetting	PackageSubtitleSetting[]	否	多碼率自適應打包中的字幕地址覆蓋時，該參數必傳。
TranscodeTemplateList	TranscodeTemplate[]	否	模板參數替換必傳支援轉碼模板中 Video、Audio、Clip、Rotate、TranscodeFileRegular參數覆蓋。原畫模板不支援參數覆蓋。參數覆蓋時 TranscodeTemplateId必傳。

說明

浮水印資訊暫只支援對浮水印的圖片檔案、文字的內容替換。

TranscodeTemplateList樣本

        [
                {
                  "TranscodeTemplateId":"9580424e49b28c952a46544e3e8f****",
                  "Video":{
                          "Width":720,
                          "Height":480,
                          "Bitrate":"600"
                  },
                  "Audio":{
                          "Bitrate":128
                  }，
                  "Clip":{
                          "TimeSpan":{
                                "Seek":"1"
                                "Duration":"5"
                        },
                  "Rotate":"270",
                  "TranscodeFileRegular":"{MediaId}/{JobId}/{PlayDefinition}"
                  }
                }
        ]

浮水印參數替換配置 Watermark

欄位名稱	類型	必填項	描述
WatermarkId	String	是	轉碼模板關聯浮水印ID，ApsaraVideo for VOD控制台可查。更多資訊，請參見浮水印管理。
FileUrl	String	否	浮水印檔案OSS地址。圖片浮水印必傳，檔案OSS地址擷取詳細參見CreateUploadAttachedMedia。
Content	String	否	文字浮水印內容，文字浮水印必傳。

重要

FileUrl必須與視頻源片所在儲存來源站點保持一致。

字幕參數替換配置 SubtitleSetting

欄位名稱	類型	必填項	描述
SubtitleList	Subtitle	是	替換的字幕列表。

字幕配置 Subtitle

欄位名稱

類型

必填項

描述

SubtitleUrl

String

是

字幕檔案的OSS地址（不支援HTTPS地址）。

CharEncode

String

是

字幕內容的編碼格式，取值：

auto（自動檢測）
UTF-8
GBK
BIG5

說明：CharEncode建議設定正確的編碼格式，使用auto（自動檢測）可能存在誤檢情況。

打包字幕替換參數 PackageSubtitleSetting

欄位名稱	類型	必填項	描述
PackageSubtitleList	PackageSubtitle[]	是	字幕替換必傳。

打包字幕替換參數 PackageSubtitle

欄位名稱	類型	必填項	描述
SubtitlePackageTemplateId	String	是	字幕打包模板ID。
Language	String	是	語言類型，請參考RFC5646，例如：en-US。說明 Language參數僅用於檢索需要替換的字幕檔案，而Language本身不會被替換。
SubtitleUrl	String	是	字幕地址，僅支援HTTP的OSS地址，不支援HTTP CDN地址和HTTPS地址。說明目前僅支援一個HTTP地址。字幕檔案僅支援儲存在點播分配的系統Bucket中。

說明

SubtitlePackageTemplateId和Language用於檢索對應需要替換的字幕地址，語言類型本身無法替換。

OverrideParams參數樣本

{
  "Watermarks":[
    {
      "WatermarkId":"watermark1",
      "FileUrl":"http://****.bucket.aliyuncs.com/image/replace.png"
    },
    {
      "WatermarkId":"watermark2",
      "Content":"浮水印測試"
    }
  ],
  "SubtitleSetting":{
          "SubtitleList":[
                {
                "SubtitleUrl":"http://outin-****.oss-cn-shanghai.aliyuncs.com/subtitles/7b850b-724c-4011-b885-dd16c****.ass",
                "CharEncode":"UTF-8"
                },
                {
                "SubtitleUrl":"http://outin-****.oss-cn-shanghai.aliyuncs.com/subtitles/7b86db-724c-4011-b885-dd161d****.srt",
                "CharEncode":"auto"
                }
        ]
  },
  "PackageSubtitleSetting": {
    "PackageSubtitleList": [
      {
        "Language": "en-US",
        "SubtitlePackageTemplateId": "32d665807c08d25d4a5d513395****", 
        "SubtitleUrl": "http://outin-****.oss-cn-shanghai.aliyuncs.com/789679188D1F36A00AEB****.vtt" 
      },
      {
        "Language": "ja",  
        "SubtitlePackageTemplateId": "32d665807c08d25d4a5d513395ad****",
        "SubtitleUrl": "http://outin-****.oss-cn-shanghai.aliyuncs.com/F43FD90FF4B936A00AEB****.vtt"
      }
    ]
  }
}

浮水印配置 WatermarkConfig

如果浮水印類型為Image

參數名稱	參數類型	必填項	描述
Dx	String	是	水平位移，兩種取值形式。像素值：[8,4096] 畫面佔比值：(0,1)，其中取值為0表示畫面佔比0%，取值為1表示畫面佔比100%，取值為0.5則表示畫面佔比50%，其他取值含義以此類推。
Dy	String	是	垂直位移，兩種取值形式。像素值：[8,4096] 畫面佔比值：(0,1)，其中取值為0表示畫面佔比0%，取值為1表示畫面佔比100%，取值為0.5則表示畫面佔比50%，其他取值含義以此類推。
Width	String	是	浮水印寬，兩種取值形式。像素值：[8,4096] 畫面佔比值：(0,1)，其中取值為0表示畫面佔比0%，取值為1表示畫面佔比100%，取值為0.5則表示畫面佔比50%，其他取值含義以此類推。
Height	String	是	浮水印高，兩種取值形式。像素值：[8,4096] 畫面佔比值：(0,1)，其中取值為0表示畫面佔比0%，取值為1表示畫面佔比100%，取值為0.5則表示畫面佔比50%，其他取值含義以此類推。
ReferPos	String	是	浮水印位置： BottomRight（右下） BottomLeft（左下） TopRight（右上） TopLeft（左上）
Timeline	Timeline	否	浮水印時間軸，浮水印效果的開始展現及結束展現時間（JSON字串）。

重要

Timeline只對圖片浮水印生效。

如果浮水印類型為Text

參數名稱	參數類型	必填項	描述
Content	String	是	文字浮水印內容，例如：“文字浮水印”。
FontName	String	否	字型名稱
FontColor	String	否	字型顏色
FontAlpha	String	否	字型透明度。取值範圍：(0, 1]，預設值：1.0。
BorderColor	String	否	描邊顏色
Top	Integer	否	文本上邊距，只支援整型數值。預設值：0。取值範圍：[0,4096]。
Left	Integer	否	文本左邊距，只支援整型數值。預設值：0。取值範圍：[0,4096]。
FontSize	Integer	否	字型大小，只支援整型數值。預設值：16。取值範圍：(4, 120)。
BorderWidth	Integer	否	描邊寬度，只支援整型數值。預設值：0。取值範圍：(0,4096]。

浮水印時間軸 Timeline

參數名稱	參數類型	必填項	描述
Start	String	是	浮水印開始出現時間。單位：秒，取值範圍：數字，預設值：0。
Duration	String	是	浮水印期間。單位：秒，取值範圍：[數字，ToEND]，預設值：ToEND（整個視頻結束）。

重要

Timeline暫只對圖片浮水印生效。

字型名稱 Fontname

字型名稱	描述
SimSun	宋體
WenQuanYi Zen Hei	文泉驛正黑
WenQuanYi Zen Hei Mono	文泉驛等寬正黑
WenQuanYi Zen Hei Sharp	文泉驛點陣正黑
Yuanti SC	圓體-簡，常規體

視頻截圖

截圖模板配置

SnapshotTemplateConfig

名稱

類型

是否必填

描述

SnapshotType

String

是

截圖類型。取值：

NormalSnapshot：普通截圖。
SpriteSnapshot：雪碧圖。
WebVttSnapshot：WebVtt截圖。

SnapshotConfig

JSON

是

截圖模板配置資訊，不同的SnapshotType對應不同的模板配置內容。詳細資料，請參見下文SnapshotConfig。

SnapshotConfig

說明

雪碧圖是先截取普通截圖，然後將普通截圖拼成雪碧圖，所以無論是普通截圖或是雪碧截圖，SnapshotConfig參數都必傳。

參數名稱	類型	是否必填	描述
FrameType	String	是	截圖的框架類型，取值： intra：主要畫面格。 normal：普通幀。
Count	Long	是	需要截取的圖片數量，單位：張。
Interval	Long	是	截圖的間隔時間，必須大於等於0，單位：秒。其中，Interval為0表示按照Count數根據視頻時間長度平均截圖。
SpecifiedOffsetTime	Long	是	截圖指定時間的起始點，單位：毫秒。
Width	Integer	否	截圖寬，取值範圍：[8,4096]，預設原片寬，單位：px。
Height	Integer	否	截圖高，取值範圍：[8,4096]，預設原片高，單位：px。
SpriteSnapshotConfig	JSON	否	雪碧圖配置，截圖類型為雪碧圖（SnapshotType取值為SpriteSnapshot）時，本參數必傳。詳細資料，請參見下文SpriteSnapshotConfig。
Format	String	否	輸出的截圖檔案格式，取值：vtt （僅WebVttSnapshot類型支援該參數）。
SubOut	JSON	否	WebVttSnapshot截圖方式下，控制截圖的展示方式（僅WebVttSnapshot類型支援該參數）。詳細資料，請參見下文SubOut。

SpriteSnapshotConfig

參數名稱	類型	是否必填	描述
CellWidth	String	否	雪碧圖中小圖的寬，預設為普通截圖的寬，單位：px。
CellHeight	String	否	雪碧圖中小圖的高，預設為普通截圖的高，單位：px。
Padding	String	是	小圖內邊距大小，單位：px。
Margin	String	是	小圖外邊距大小，單位：px。
Color	String	是	雪碧圖背景顏色，更多資訊，請參見顏色設定。說明 Color暫不支援RGB值設定。
Columns	String	是	小圖列數，取值範圍：[1,10000]。
Lines	String	是	小圖行數，取值範圍：[1,10000]。
KeepCellPic	String	是	是否保留小圖，取值： keep：保留。 delete：刪除。

SubOut

參數名稱

類型

是否必填

描述

IsSptFrag

String

是

取值：

false：截圖單張分開儲存。
true：截圖先拼成類似雪碧圖的大圖統一儲存。

截圖模板樣本

{
  "SnapshotConfig": {
    "Count": 10,
    "SpecifiedOffsetTime": 0,
    "Interval": 1
  },
  "SnapshotType": "NormalSnapshot"
}

視頻動圖

動圖模板配置

DynamicImageTemplateConfig

參數名稱	類型	是否必填	描述
Name	String	是	動圖模板名稱。
Video	JSON	是	動圖畫面參數配置。詳細資料，請參見下文Video。
Container	JSON	是	動圖輸出格式配置。詳細資料，請參見下文Container。
Clip	JSON	是	動圖裁剪參數配置。詳細資料，請參見下文Clip。
SetDefaultCover	String	是	截取的動圖是否預設設定成視頻封面。取值： true：預設設定成視頻封面。 false：不設定成視頻封面。

Video

說明

若Width（寬）和Height（高）都不設定，則輸出的動圖的尺寸和原片保持一致。
若僅設定Width（寬），則輸出的動圖的Height（高）會按照原片等比例進行縮放。
若僅設定Height（高），則輸出的動圖的Width（寬）會按照原片等比例進行縮放。

參數名稱	類型	是否必填	描述
Width	String	否	輸出動圖的寬，取值範圍：[128,4096]。
Height	String	否	輸出動圖的高，取值範圍：[128,4096]。
Fps	String	是	幀率，取值範圍：(0,60]。

Container

參數名稱

類型

是否必填

描述

Format

String

是

動圖輸出格式。取值：

webp
gif

Clip

參數名稱	類型	是否必填	描述
TimeSpan	JSON	是	動圖截取時間軸配置。詳細資料，請參見下文TimeSpan。

TimeSpan

說明

如需按持續時間長度的方式截取動圖，則需同時傳入Seek和Duration參數；如需按去首尾的方式截取動圖，則需同時傳入Seek和End參數。
如果同時傳入了Seek、Duration和End參數，將按照Seek和End參數來生效。

參數名稱	類型	是否必填	描述
Seek	String	是	視頻動圖截取的開始時間點。格式一：sssss[.SSS]，取值範圍：[0.000，86399.999]。樣本：0 格式二：hh:mm:ss[.SSS]，取值範圍：[00:00:00.000,23:59:59.999]。樣本：00:00:05.003
Duration	String	否	視頻裁剪的持續時間長度。格式一：sssss[.SSS]，取值範圍：[0.000，86399.999]。樣本：15 格式二：hh:mm:ss[.SSS]，取值範圍：[00:00:00.000,23:59:59.999]。樣本：00:00:10.003
End	String	否	視頻裁剪需要丟棄的尾部時間長度。傳入此參數時，傳入的Duration參數失效。格式一：sssss[.SSS]，取值範圍：[0.000，86399.999]。樣本：12000.55 格式二：hh:mm:ss[.SSS]，取值範圍：[00:00:00.000,23:59:59.999]。樣本：00:00:15.003

動圖模板樣本

{
  "Video": {
    "Fps": 5,
    "Width": 1024
  },
  "Clip": {
    "TimeSpan": {
      "Seek": 0,
      "Duration": 15
    }
  },
  "Container": {
    "Format": "gif"
  },
  "SetDefaultCover": "false"
}