點播API的請求參數說明和配置樣本 -

本文為您介紹點播API關於請求參數PlayConfig、ReAuthInfo、UserData、SpriteSnapshotConfig、EncryptConfig的參數說明和配置樣本。

媒體播放自訂設定 PlayConfig

參數說明

媒體播放時的自訂設定欄位，為JSON字串，目前支援指定網域名稱播放的設定。支援如下欄位：

欄位名稱	類型	必填	描述
PlayDomain	String	否	播放網域名稱名稱。當配置多個回源網域名稱時，可指定其中一個網域名稱播放當前視頻。當指定網域名稱不存在時，播放地址返回當前視頻儲存對應的預設播放網域名稱。取值樣本：`"vod.test_domain"`。
XForwardedFor	String	否	用戶端請求的真實IP。可用於驗證審核安全IP等情境。可解決經過多層代理後，點播服務無法擷取到原始用戶端IP的問題。為了保障資料安全性，該IP值為加密後的值，加密方式為`AES/ECB/PKCS5Padding`，加密使用的密鑰請提交工單，由點播幕後處理。取值樣本：yqCD7Fp1uqChoVj/sl/p5Q==
PreviewTime	String	否	ApsaraVideo for VOD試看時間長度，單位為秒。最小值1，最大值為視頻總時間長度，未指定時表示觀看完整視頻，開啟試看功能請參見試看視頻。
MtsHlsUriToken	String	否	業務方令牌服務產生的MtsHlsUriToken，適用於HLS標準加密的視頻播放，實現對業務方解密密鑰的保護，防止密鑰被竊取。詳細內容請參見HLS標準加密。
EncryptType	String	否	加密類型，可用於篩選非加密或加密流進行播放。取值： Unencrypted：非加密。 AliyunVoDEncryption：阿里雲私人加密。 HLSEncryption：HLS標準加密。說明有關加密流地址的使用說明及限制，請參見擷取播放地址。
StorageClass	String	否	媒資儲存類型，可用於篩選返回指定儲存類型的播放流，取值：空值：預設值，不進行篩選。如果音視頻為標準儲存類型，則正常返回播放流；如果音視頻為媒資範圍的非標準儲存，則介面不返回播放流；如果音視頻為源檔案範圍的非標準儲存，則介面只返迴轉碼流，不返回原畫流。 All：所有類型。 Standard：標準。 IA：媒資低頻。 Archive：媒資歸檔。 ColdArchive：媒資冷歸檔。 SourceIA：源檔案低頻。 SourceArchive：源檔案歸檔。 SourceColdArchive：源檔案冷歸檔。 Changing：媒資變更中。 SourceChanging：源檔案變更中。

配置樣本

PlayConfig={
  "PlayDomain": "vod.test_domain",
  "XForwardedFor": "yqCD7Fp1uqChoVj/sl/p5Q==",
  "PreviewTime": "20",
  "MtsHlsUriToken": "yqCD7Fp1uqChoVjslp5Q",
  "StorageClass": "Standard"
}

CDN二次鑒權設定 ReAuthInfo

參數說明

媒體播放時設定的CDN二次鑒權參數，為JSON字串。當開啟了CDN二次鑒權功能時，可通過該參數設定鑒權URL的uid和rand。支援如下欄位：

欄位名稱	類型	必填	描述
uid	String	否	附加參數，一般為0，可自訂。
rand	String	否	隨機數，一般為0，如要確保每次產生的URL不同則可使用UUID等做隨機數。

配置樣本

ReAuthInfo={
  "uid": "12345",
  "rand": "abckljd"
}

媒體上傳自訂設定 UserData

參數說明

媒體上傳時的自訂設定欄位，為JSON字串，支援訊息回調等設定。

支援如下欄位：

欄位名稱	類型	必填	描述
MessageCallback	String	否	訊息回調設定，資料類型為JSON Object，指定時以此處設定的事件通知為準，否則以全域設定的事件通知為準。更多資訊，請參見設定多地址回調。參數說明： CallbackType：回調方式，取值為`http`或`mns`。 CallbackURL：HTTP回調的回調地址，當`CallbackType`取值為`http`時，本參數必傳。 MNSQueueName：MNS隊列的名稱，當`CallbackType`取值為`mns`時，本參數必傳。 MNSEndpoint：MNS隊列的Endpoint地址，當`CallbackType`取值為`mns`時，本參數必傳。取值樣本： HTTP回調：`{"CallbackType":"http", "CallbackURL":"http://callback-host/addr"}` MNS回調：`{"CallbackType":"mns","MNSQueueName":"vod-callback-bj","MNSEndpoint":"http://174809843091****.mns.cn-beijing.aliyuncs.com"}`
Extend	String	否	使用者自訂的擴充欄位，用於回調時透傳返回，最大長度512位元組。資料類型為JSON Object。說明擴充欄位中盡量避免使用貨幣符號（$）、正斜線（/）、反斜線（\ ）等特殊字元，若不可避免，建議對欄位參數值進行Base64 Encode，取用時Base64 Decode。
AccelerateConfig	String	否	上傳加速設定。資料類型為JSON Object，取值樣本：{"Type":"oss","Domain":"https://oss-accelerate.aliyuncs.com"}。其中Type為加速方式（僅支援oss），Domain為加速網域名稱（對應OSS的訪問網域名稱和資料中心，預設為https）。說明上傳加速功能需要先申請開通後才能使用，有關上傳加速的開通方式及計費說明請參見上傳加速。

配置樣本

UserData={
  "MessageCallback": {
    "MNSEndpoint":"http://174809843091****.mns.cn-beijing.aliyuncs.com",
    "MNSQueueName":"vod-callback-bj",
    "CallbackType": "mns"
  },
  "Extend": {
    "localId": "xxx",
    "test": "www"
  },
  "AccelerateConfig": {
    "Type": "oss",
    "Domain": "https://oss-accelerate.aliyuncs.com"
  }
}

加密配置 EncryptConfig

標準加密配置。

欄位名稱	類型	必填	描述
CipherText	String	是	密文密鑰，用來擷取清除金鑰。本參數填寫為調用GenerateKMSDataKey - 建立KMS資料密鑰介面返回的`CiphertextBlob`值。
DecryptKeyUri	String	是	根據密文密鑰擷取解密的密鑰URI地址，密鑰URI地址由解密服務地址及`Ciphertext`值拼接而成。解密服務由您自行搭建，例如您搭建的解密服務地址為`http://demo.aliyundoc.com`，則本參數填寫格如下： `http://demo.aliyundoc.com?CipherText=ZjJmZGViNzUtZWY1Mi00Y2RlLTk3MTMt****`
KeyServiceType	String	是	密鑰服務類型，預設值：KMS（阿里雲Key Management Service）。

截雪碧圖配置 SpriteSnapshotConfig

欄位名稱	類型	必填	描述
CellWidth	String	否	雪碧圖中小圖的寬，預設為截圖輸出的寬，單位：px。
CellHeight	String	否	雪碧圖中小圖的高，預設為截圖輸出的高，單位：px。
Padding	String	否	小圖內邊距大小，預設為0，單位：px。
Margin	String	否	小圖外邊距大小，預設為0，單位：px。
Color	String	否	雪碧圖背景顏色，預設為Black。
Columns	String	否	小圖列數，取值範圍：[1,10000]，預設取值：10。
Lines	String	否	小圖行數，取值範圍：[1,10000]，預設取值：10。
KeepCellPic	String	否	是否保留小圖，取值： keep：保留。 delete：刪除。預設值為keep。

說明

當SpriteSnapshotConfig需要全部採用預設值，傳入JSON空串：{}。