調用此接口并提供音視頻ID即可獲取播放地址,隨后可使用阿里云播放器或第三方播放器(如系統(tǒng)原生、開源或自研播放器)播放音視頻內(nèi)容。
接口說明
-
請確保在使用該接口前,已充分了解視頻點播產(chǎn)品的收費方式和價格。從點播的播放地址直接下載或播放視頻將產(chǎn)生下行流量費用,未配置加速域名時請參見存儲流出流量計費;已配置加速域名時請參見加速服務計費。如果您已開通了存儲傳輸加速,則從點播的播放地址直接下載或播放視頻還將涉及下載加速費用,計費詳情請參見存儲傳輸加速計費。
-
只有狀態(tài)為正常(Status 字段值為 Normal)的視頻才能正常播放。關于播放地址的播放說明及使用限制等更多信息,請參見音視頻播放。
-
當視頻播放異常時,您可以調用 GetMezzanineInfo 接口查詢視頻源文件信息是否正確。
-
如需調用本接口生成 m3u8 溯源水印視頻流,請先提交工單,申請開通,如何提交工單,請參見聯(lián)系我們。更多溯源水印詳細信息,請參見數(shù)字水印。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀?。≧ead)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產(chǎn)品自身定義的條件關鍵字。
- 關聯(lián)操作:是指成功執(zhí)行操作所需要的其他權限。操作者必須同時具備關聯(lián)操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯(lián)操作 |
---|---|---|---|---|
vod:GetPlayInfo | get | *全部資源 * |
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
VideoId | string | 是 | 音/視頻 ID,僅支持傳入單個音/視頻 ID。可通過以下方式獲?。?/p>
| 93ab850b4f654b6e91d24d81d44**** |
Formats | string | 否 | 媒體流格式。多個格式之間使用半角逗號(,)分隔。取值:
說明
dash 封裝格式時才會輸出。更多詳情,請參見Container:封裝格式。 | mp4,m3u8 |
AuthTimeout | long | 否 | 設置播放地址的有效時間。單位:秒。
| 1800 |
OutputType | string | 否 | 輸出地址類型。取值:
| cdn |
StreamType | string | 否 | 媒體流類型。多個類型之間用半角逗號(,)分隔。支持類型:
默認獲取所有類型的流。 | video |
ReAuthInfo | string | 否 | CDN 二次鑒權參數(shù),為 JSON 字符串。當開啟了 URL 鑒權的 A 方式鑒權功能時,可通過該參數(shù)設置鑒權 URL 的 | {"uid":"12345","rand":"abckljd"} |
Definition | string | 否 | 視頻流清晰度。多個清晰度之間用半角逗號(,)分隔。取值:
說明
| LD |
ResultType | string | 否 | 返回數(shù)據(jù)類型。取值:
| Single |
PlayConfig | string | 否 | 播放自定義設置。為 JSON 字符串,支持指定域名播放設置。參數(shù)構造詳情,請參見 PlayConfig 。 說明
PlayDomain 不設置時,接口默認使用點播配置的默認域名;如果沒有設置默認域名,則會根據(jù)域名的修改時間倒序查詢,使用最新修改過的域名作為播放域名。為防止返回的不是想要的域名,建議設置默認播放域名(可登錄視頻點播控制臺,選擇配置管理 > 媒資管理配置 > 存儲管理 > 管理 > 回源到此存儲地址的域名設置默認播放域名)。EncryptType 參數(shù)設置為AliyunVoDEncryption 時,為了保障您的視頻安全,默認不返回私有加密流播放地址,若需要返回私有加密流播放地址,需要同時設置ResultType 參數(shù)為Multiple 。 | {"PlayDomain":"vod.test_domain","XForwardedFor":"yqCD7Fp1uqChoVj/sl/p5Q==","PreviewTime":"20","MtsHlsUriToken":"yqCD7Fp1uqChoVjslp5Q"} |
AdditionType | string | 否 | 獲取彈幕蒙版數(shù)據(jù) URL 地址,取值:danmu。 說明
僅當 outputType 取值為cdn 時才會生效。
| danmu |
Trace | string | 否 | 用戶自定義的數(shù)字水印信息。
| test mark |
DigitalWatermarkType | string | 否 | 數(shù)字水印類型。取值:
| TraceMark |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"RequestId": "F552E596-967D-5500-842F-17E6364****",
"VideoBase": {
"CreationTime": "2017-06-26T06:38:48Z",
"Status": "Normal",
"VideoId": "93ab850b4f654b6e91d24d81d44****",
"CoverURL": "http://example.aliyundoc.com/sample.jpg?auth_key=2333232-atb****",
"Duration": "3.1667",
"Title": "阿里云VOD",
"MediaType": "video",
"DanMuURL": "http://example.aliyundoc.com/****?auth_key=abdf2123-6783232****",
"StorageClass": "Standard"
},
"PlayInfoList": {
"PlayInfo": [
{
"CreationTime": "2022-04-18T07:37:15Z",
"Status": "Normal",
"Specification": "H264.LD",
"NarrowBandType": "0",
"Height": 640,
"Bitrate": "450.878",
"ModificationTime": "2022-04-20T06:32:19Z",
"WatermarkId": "dgfn26457856****",
"Encrypt": 1,
"Definition": "LD",
"EncryptType": "AliyunVoDEncryption",
"EncryptMode": "License",
"StreamType": "video",
"JobId": "80e9c6580e754a798c3c19c59b16****",
"Size": 418112,
"Width": 360,
"Fps": "25",
"Duration": "9.0464",
"PlayURL": "https://example.aliyundoc.com/d52ee123f331466aabf6ab32a93d****/a777f9e24e6e47a2a942467d5c38ea37-8ee8e04293c6657fdda282bc422704****.m3u8",
"Format": "m3u8",
"HDRType": "HLG",
"BitDepth": 8,
"JobType": 2,
"JobExt": "CopyrightMarkTest",
"CodecName": ""
}
]
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-12-09 | OpenAPI 返回結構發(fā)生變更 | 查看變更詳情 |
2024-10-11 | OpenAPI 返回結構發(fā)生變更 | 查看變更詳情 |
2023-10-18 | OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2023-09-05 | OpenAPI 返回結構發(fā)生變更 | 查看變更詳情 |
2021-12-23 | OpenAPI 返回結構發(fā)生變更 | 查看變更詳情 |
2021-11-16 | OpenAPI 返回結構發(fā)生變更 | 查看變更詳情 |
接口錯誤碼
下表列舉了本接口特有的錯誤碼。
錯誤代碼 | 錯誤信息 | HTTP 狀態(tài)碼 | 說明 |
---|---|---|---|
Forbidden.IllegalStatus | Status of the video is illegal. Current Status is %s. | 403 | 視頻狀態(tài)無效,當前狀態(tài)為%s。只有 Normal 狀態(tài)的視頻才能播放。 |
InvalidVideo.NotFound | The video does not exist. | 404 | 視頻不存在。 |
InvalidVideo.NoneStream | The video has no stream to play for the request parameter ‘Formats : mp4, Definition : LD, StreamType : video’. | 404 | 根據(jù)您的篩選條件找不到可以播放的轉碼輸出流,請檢查您的轉碼配置與篩選條件是否匹配。 |
Forbidden.AliyunVoDEncryption | Currently only the AliyunVoDEncryption stream exists, you must use the Aliyun player to play or set the value of ResultType to Multiple. | 403 | 當前僅存在阿里云視頻加密的轉碼輸出流,必須使用阿里云播放器進行播放或者設置請求參數(shù) ResultType 值為 Multiple。 |