点播API的请求参数说明和配置示例_视频点播(VOD)-阿里云帮助中心

本文为您介绍点播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	否	视频点播试看时长，单位为秒。最小值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字符串，支持消息回调等设置。

说明

暂时只支持HTTP方式的回调覆盖设置。

支持如下字段：

字段名称	类型	必填	描述
MessageCallback	String	否	消息回调设置，指定时以此为准，否则以全局设置的事件通知为准。数据类型为JSON Object，取值示例：{"CallbackType":"http", "CallbackURL":"http://callback-host/addr"}。其中CallbackType为回调方式，默认为http，CallbackURL为回调地址。
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": {
    "CallbackURL": "http://example.aliyundoc.com",
    "CallbackType": "http"
  },
  "Extend": {
    "localId": "xxx",
    "test": "www"
  },
  "AccelerateConfig": {
    "Type": "oss",
    "Domain": "https://oss-accelerate.aliyuncs.com"
  }
}

加密配置 EncryptConfig

标准加密配置。

字段名称	类型	必填	描述
CipherText	String	是	密文密钥，用来获取明文密钥。
DecryptKeyUri	String	是	根据密文密钥获取解密的密钥地址，例如：`http://demo.aliyundoc.com?CipherText=ZjJmZGViNzUtZWY1Mi00Y2RlLTk3MTMt`
KeyServiceType	String	是	密钥服务类型，默认值：KMS（阿里云密钥管理服务KMS）。

截雪碧图配置 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空串：{}。