調用此介面並提供音視頻ID即可擷取播放地址,隨後可使用阿里雲播放器或第三方播放器(如系統原生、開源或自研播放器)播放音視頻內容。
介面說明
請確保在使用該介面前,已充分瞭解ApsaraVideo for VOD產品的收費方式和價格。從點播的播放地址直接下載或播放視頻將產生下行流量費用,未配置加速網域名稱時請參見儲存流出流量計費;已配置加速網域名稱時請參見加速服務計費。如果您已開通了儲存傳輸加速,則從點播的播放地址直接下載或播放視頻還將涉及下載加速費用,計費詳情請參見儲存傳輸加速計費。
只有狀態為正常(Status 欄位值為 Normal)的視頻才能正常播放。關於播放地址的播放說明及使用限制等更多資訊,請參見音視頻播放。
當媒資儲存類型為非標準儲存時,需要對 PlayConfig 參數的 StorageClass 欄位進行相應設定,詳情請參見 PlayConfig 。
當視頻播放異常時,您可以調用 GetMezzanineInfo 介面查詢視頻源檔案資訊是否正確。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
vod:GetPlayInfo |
get |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| VideoId |
string |
否 |
音/視頻 ID,僅支援傳入單個音/視頻 ID。可通過以下方式擷取:
|
93ab850b4f654b6e91d24d81d44**** |
| Formats |
string |
否 |
媒體流格式。多個格式之間使用半形逗號(,)分隔。取值:
說明
|
mp4,m3u8 |
| AuthTimeout |
integer |
否 |
設定播放地址的有效時間。單位:秒。
|
1800 |
| OutputType |
string |
否 |
輸出地址類型。取值:
|
cdn |
| StreamType |
string |
否 |
媒體流類型。多個類型之間用半形逗號(,)分隔。支援類型:
預設擷取所有類型的流。 |
video |
| ReAuthInfo |
string |
否 |
CDN 二次鑒權參數,為 JSON 字串。當開啟了 URL 鑒權的 A 方式鑒權功能時,可通過該參數設定鑒權 URL 的 |
{"uid":"12345","rand":"abckljd"} |
| Definition |
string |
否 |
視頻流清晰度。多個清晰度之間用半形逗號(,)分隔。取值:
說明
|
LD |
| ResultType |
string |
否 |
返回資料類型。取值:
|
Single |
| PlayConfig |
string |
否 |
播放自訂設定。為 JSON 字串,支援指定網域名稱播放設定。參數構造詳情,請參見 PlayConfig 。 說明
|
{"PlayDomain":"vod.test_domain","XForwardedFor":"yqCD7Fp1uqChoVj/sl/p5Q==","PreviewTime":"20","MtsHlsUriToken":"yqCD7Fp1uqChoVjslp5Q"} |
| AdditionType |
string |
否 |
擷取彈幕蒙版資料 URL 地址,取值:danmu。 說明
僅當 |
danmu |
| Trace |
string |
否 |
使用者自訂的數字浮水印資訊。
|
test mark |
| DigitalWatermarkType |
string |
否 |
數字浮水印類型。取值:
|
TraceMark |
| ReferenceId |
string |
否 |
自訂 ID,僅支援小寫字母、大寫字母、數字、橫線、底線,長度 6-64 位元。使用者維度唯一。 |
123-123 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回結果。 |
||
| RequestId |
string |
請求 ID。 |
F552E596-967D-5500-842F-17E6364**** |
| VideoBase |
object |
音/視頻基本資料。 |
|
| CreationTime |
string |
音/視頻建立時間。格式為:yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。 |
2017-06-26T06:38:48Z |
| Status |
string |
音/視頻狀態。各取值及描述,請參見Status:音視頻狀態。 |
Normal |
| VideoId |
string |
音/視頻 ID。 |
93ab850b4f654b6e91d24d81d44**** |
| CoverURL |
string |
音/視頻封面地址。 |
http://example.aliyundoc.com/sample.jpg?auth_key=2333232-atb**** |
| Duration |
string |
音/視頻時間長度。單位:秒。 |
3.1667 |
| Title |
string |
音/視頻標題。 |
阿里雲VOD |
| MediaType |
string |
媒體檔案類型,取值:
|
video |
| DanMuURL |
string |
彈幕蒙版資料的地址。 |
http://example.aliyundoc.com/****?auth_key=abdf2123-6783232**** |
| StorageClass |
string |
媒資儲存類型。取值:
|
Standard |
| PlayInfoList |
object |
||
| PlayInfo |
array<object> |
音/視頻播放資訊(流資訊)。 |
|
|
object |
音/視頻詳細資料。 |
||
| CreationTime |
string |
建立時間。格式為:yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。 |
2022-04-18T07:37:15Z |
| Status |
string |
媒體流狀態,取值:
|
Normal |
| Specification |
string |
音視頻轉碼輸出規格。各取值及描述,請參見輸出規格:Specification。 |
H264.LD |
| NarrowBandType |
string |
轉碼類型。取值:
|
0 |
| Height |
integer |
媒體流高度。單位:px。 |
640 |
| Bitrate |
string |
媒體流碼率。單位:Kbps。 說明
受 M3U8 動態分區特性影響,其碼率計算可能存在偏差。 |
450.878 |
| ModificationTime |
string |
更新時間。格式為:yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。 |
2022-04-20T06:32:19Z |
| WatermarkId |
string |
當前媒體流關聯的浮水印模板 ID。 |
dgfn26457856**** |
| Encrypt |
integer |
媒體流是否加密流,取值:
|
1 |
| Definition |
string |
視頻流清晰度定義。取值:
|
LD |
| EncryptType |
string |
媒體流加密類型。取值:
說明
如果加密類型為 AliyunVoDEncryption,則只能使用阿里雲播放器 SDK 才能正常播放。 |
AliyunVoDEncryption |
| EncryptMode |
string |
媒體流加密模式。取值:
說明
如果加密模式為 License,則只能使用阿里雲播放器 SDK 才能正常播放。 |
License |
| StreamType |
string |
媒體流類型。 若媒體流為視頻則取值:video,若是純音頻則取值:audio。 |
video |
| JobId |
string |
媒體流轉碼的作業 ID。作為媒體流的唯一標識。 |
80e9c6580e754a798c3c19c59b16**** |
| Size |
integer |
媒體流大小。單位:Byte。 說明
受 M3U8 動態分區特性影響,其媒體流大小計算可能存在偏差。 |
418112 |
| Width |
integer |
媒體流寬度。單位:px。 |
360 |
| Fps |
string |
媒體流幀率。單位:幀/每秒。 |
25 |
| Duration |
string |
媒體流長度。單位:秒。 |
9.0464 |
| PlayURL |
string |
視頻流的播放地址。 |
https://example.aliyundoc.com/d52ee123f331466aabf6ab32a93d****/a777f9e24e6e47a2a942467d5c38ea37-8ee8e04293c6657fdda282bc422704****.m3u8 |
| Format |
string |
媒體流格式。
|
m3u8 |
| HDRType |
string |
媒體流 HDR 類型。取值:
|
HLG |
| BitDepth |
integer |
顏色位深。取值為整數。 |
8 |
| JobType |
integer |
數字浮水印類型。取值:
|
2 |
| JobExt |
string |
著作權浮水印的自訂浮水印資訊。僅當 |
CopyrightMarkTest |
| CodecName |
string |
編碼類別型。取值:
|
H264 |
樣本
正常返回樣本
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": "H264"
}
]
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。