請求參數(shù)說明
本文為您介紹點播API關于請求參數(shù)PlayConfig、ReAuthInfo、UserData、SpriteSnapshotConfig、EncryptConfig的參數(shù)說明和配置示例。
媒體播放自定義設置 PlayConfig
參數(shù)說明
媒體播放時的自定義設置字段,為JSON字符串,目前支持指定域名播放的設置。支持如下字段:
字段名稱 | 類型 | 必填 | 描述 |
PlayDomain | String | 否 | 播放域名名稱。當配置多個回源域名時,可指定其中一個域名播放當前視頻。當指定域名不存在時,播放地址返回當前視頻存儲對應的默認播放域名。取值示例: |
XForwardedFor | String | 否 | 客戶端請求的真實IP。可用于驗證審核安全IP等場景。可解決經(jīng)過多層代理后,點播服務無法獲取到原始客戶端IP的問題。為了保障數(shù)據(jù)安全性,該IP值為加密后的值,加密方式為 取值示例:yqCD7Fp1uqChoVj/sl/p5Q== |
PreviewTime | String | 否 | 視頻點播試看時長,單位為秒。最小值1,最大值為視頻總時長,未指定時表示觀看完整視頻,開啟試看功能請參見試看視頻。 |
MtsHlsUriToken | String | 否 | 業(yè)務方令牌服務生成的MtsHlsUriToken,適用于HLS標準加密的視頻播放,實現(xiàn)對業(yè)務方解密密鑰的保護,防止密鑰被竊取。詳細內(nèi)容請參見HLS標準加密。 |
EncryptType | String | 否 | 加密類型,可用于篩選非加密或加密流進行播放。取值:
說明 有關加密流地址的使用說明及限制,請參見獲取播放地址。 |
StorageClass | String | 否 | 媒資存儲類型,可用于篩選返回指定存儲類型的播放流,取值:
|
配置示例
PlayConfig={
"PlayDomain": "vod.test_domain",
"XForwardedFor": "yqCD7Fp1uqChoVj/sl/p5Q==",
"PreviewTime": "20",
"MtsHlsUriToken": "yqCD7Fp1uqChoVjslp5Q",
"StorageClass": "Standard"
}
CDN二次鑒權設置 ReAuthInfo
參數(shù)說明
媒體播放時設置的CDN二次鑒權參數(shù),為JSON字符串。當開啟了CDN二次鑒權功能時,可通過該參數(shù)設置鑒權URL的uid和rand。支持如下字段:
字段名稱 | 類型 | 必填 | 描述 |
uid | String | 否 | 附加參數(shù),一般為0,可自定義。 |
rand | String | 否 | 隨機數(shù),一般為0,如要確保每次生成的URL不同則可使用UUID等做隨機數(shù)。 |
配置示例
ReAuthInfo={
"uid": "12345",
"rand": "abckljd"
}
媒體上傳自定義設置 UserData
參數(shù)說明
媒體上傳時的自定義設置字段,為JSON字符串,支持消息回調(diào)等設置。
支持如下字段:
字段名稱 | 類型 | 必填 | 描述 |
MessageCallback | String | 否 | 消息回調(diào)設置,數(shù)據(jù)類型為JSON Object,指定時以此處設置的事件通知為準,否則以全局設置的事件通知為準。更多信息,請參見設置多地址回調(diào)。 參數(shù)說明:
取值示例:
|
Extend | String | 否 | 用戶自定義的擴展字段,用于回調(diào)時透傳返回,最大長度512字節(jié)。數(shù)據(jù)類型為JSON Object。 說明 擴展字段中盡量避免使用美元符號($)、正斜線(/)、反斜線(\ )等特殊字符,若不可避免,建議對字段參數(shù)值進行Base64 Encode,取用時Base64 Decode。 |
AccelerateConfig | String | 否 | 上傳加速設置。數(shù)據(jù)類型為JSON Object,取值示例:{"Type":"oss","Domain":"https://oss-accelerate.aliyuncs.com"}。其中Type為加速方式(僅支持oss),Domain為加速域名(對應OSS的訪問域名和數(shù)據(jù)中心,默認為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 | 是 | 密文密鑰,用來獲取明文密鑰。本參數(shù)填寫為調(diào)用GenerateKMSDataKey - 創(chuàng)建KMS數(shù)據(jù)密鑰接口返回的 |
DecryptKeyUri | String | 是 | 根據(jù)密文密鑰獲取解密的密鑰URI地址,密鑰URI地址由解密服務地址及 解密服務由您自行搭建,例如您搭建的解密服務地址為
|
KeyServiceType | String | 是 | 密鑰服務類型,默認值:KMS(阿里云密鑰管理服務KMS)。 |
截雪碧圖配置 SpriteSnapshotConfig
字段名稱 | 類型 | 必填 | 描述 |
CellWidth | String | 否 | 雪碧圖中小圖的寬,默認為截圖輸出的寬,單位:px。 |
CellHeight | String | 否 | 雪碧圖中小圖的高,默認為截圖輸出的高,單位:px。 |
Padding | String | 否 | 小圖內(nèi)邊距大小,默認為0,單位:px。 |
Margin | String | 否 | 小圖外邊距大小,默認為0,單位:px。 |
Color | String | 否 | 雪碧圖背景顏色,默認為Black。 |
Columns | String | 否 | 小圖列數(shù),取值范圍:[1,10000],默認取值:10。 |
Lines | String | 否 | 小圖行數(shù),取值范圍:[1,10000],默認取值:10。 |
KeepCellPic | String | 否 | 是否保留小圖,取值:
默認值為keep。 |
當SpriteSnapshotConfig需要全部采用默認值,傳入JSON空串:{}。