Dapatkan URL pemutaran audio dan video dengan GetPlayInfo - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Mengambil URL pemutaran untuk aset media berdasarkan ID-nya. Anda kemudian dapat menggunakan URL ini untuk memutar konten audio/video dengan Pemutar Video Apsara atau pemutar pihak ketiga mana pun, seperti pemutar sistem bawaan, pemutar sumber terbuka, atau pemutar yang dikembangkan sendiri.

Deskripsi operasi

Before using this API, ensure you fully understand the pricing and billing methods for the ApsaraVideo VOD service. Playing or downloading content from a VOD playback URL will incur outbound traffic fees. If an accelerated domain is not configured, refer to Outbound traffic. If an accelerated domain is configured, refer to Acceleration. If you have enabled cross-region transfer acceleration, additional fees will apply. For details, see Transfer acceleration.
Only videos with a Status of Normal can be played. For more information on playback URL usage and limitations, see .
If a media asset is not in the Standard storage class, set the StorageClass field of the PlayConfig parameter accordingly. For more information, see PlayConfig.
If you encounter playback issues, call the API to verify the source file information.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

vod:GetPlayInfo

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
VideoId	string	No	ID aset media. Hanya satu ID yang didukung per permintaan. Anda dapat memperoleh ID dengan salah satu cara berikut: Masuk ke konsol ApsaraVideo VOD. Di panel navigasi, pilih Media Files > Audio/Video. Lihat ID-nya. `VideoId` dikembalikan di tanggapan panggilan . Panggil operasi SearchMedia untuk mengkueri ID (VideoId).	93ab850b4f654b6e91d24d81d44****
Formats	string	No	Daftar format aliran media yang dipisahkan koma untuk diambil. Nilai valid: mp4 m3u8 mp3 flv mpd Catatan Secara default, aliran dalam semua format dikembalikan. Format mpd hanya tersedia jika Pengemasan DASH dikonfigurasi di template transkoding. Untuk informasi lebih lanjut, lihat Kontainer.	mp4,m3u8
AuthTimeout	integer	No	Periode validitas URL pemutaran, dalam detik. Jika OutputType diatur ke cdn: URL kedaluwarsa hanya jika Penandatanganan URL diaktifkan. Jika tidak, URL berlaku secara permanen. Untuk informasi lebih lanjut tentang Penandatanganan URL, lihat . Nilai minimum: 1. Nilai maksimum: Tidak ada batas. Nilai default: Periode validitas yang dikonfigurasi di pengaturan Penandatanganan URL Anda. Jika OutputType diatur ke oss: URL kedaluwarsa hanya jika izin akses penyimpanan diatur ke privat. Jika tidak, URL berlaku secara permanen. Nilai minimum: 1. Nilai maksimum: Untuk mengurangi risiko keamanan, nilai maksimum adalah 604800 (7 hari) untuk bucket VOD dan 129600 (36 jam) untuk bucket OSS Anda sendiri. Jika Anda memerlukan periode validitas yang lebih lama, atur OutputType ke cdn dan gunakan Penandatanganan URL. Nilai default: 3600.	1800
OutputType	string	No	Tipe URL pemutaran yang dikembalikan. Nilai valid: oss: URL OSS (origin sumber). cdn (default): URL terakselerasi.	cdn
StreamType	string	No	Daftar tipe aliran media yang dipisahkan koma untuk diambil. Nilai valid: video audio Jika tidak ditentukan, semua tipe aliran yang tersedia dikembalikan.	video
ReAuthInfo	string	No	String JSON yang berisi parameter untuk otentikasi CDN sekunder. Gunakan parameter ini untuk mengatur bidang `uid` dan `rand` untuk Penandatanganan URL Tipe A. Untuk informasi lebih lanjut, lihat .	{"uid":"12345","rand":"abckljd"}
Definition	string	No	Definisi aliran video. Pisahkan beberapa definisi dengan koma (,). Nilai valid: FD: Definisi rendah. LD: Definisi standar. SD: Definisi tinggi. HD: Definisi ultra tinggi. OD: Kualitas asli. 2K: 2K. 4K: 4K. SQ: Kualitas standar. HQ: Kualitas tinggi. AUTO: Bitrate adaptif. Catatan Secara default, aliran dari semua definisi dikembalikan. Parameter ini diperlukan saat menghasilkan video dengan Jejak watermark. Nilainya harus sesuai dengan resolusi yang diatur untuk transkoding. Format AUTO hanya tersedia jika streaming bitrate adaptif dikonfigurasi di template transkoding. Untuk informasi lebih lanjut, lihat PackageSetting.	LD
ResultType	string	No	Tipe data yang dikembalikan untuk setiap format dan definisi. Nilai valid: Single (default): Hanya mengembalikan aliran yang paling baru dikodekan ulang untuk setiap pasangan format/definisi. Multiple: Mengembalikan semua aliran yang telah dikodekan ulang untuk setiap pasangan format/definisi.	Single
PlayConfig	string	No	String JSON untuk pengaturan pemutaran kustom, seperti menentukan domain pemutaran. Untuk informasi lebih lanjut tentang struktur parameter, lihat PlayConfig. Catatan Jika `PlayConfig` atau bidang `PlayDomain`-nya tidak diatur, API menggunakan domain default yang dikonfigurasi di VOD. Jika tidak ada domain default yang diatur, API menggunakan domain yang paling baru diubah. Kami menyarankan untuk mengatur domain default di konsol ApsaraVideo VOD (Pilih Configuration Management > Media Management > Storage > Manage > Origin Domain Name) Ketika `EncryptType` di `PlayConfig` diatur ke `AliyunVoDEncryption`, aliran terenkripsi privat tidak dikembalikan secara default demi keamanan. Untuk mengambilnya, Anda juga harus mengatur `ResultType` ke `Multiple`.	{"PlayDomain":"vod.test_domain","XForwardedFor":"yqCD7Fp1uqChoVj/sl/p5Q==","PreviewTime":"20","MtsHlsUriToken":"yqCD7Fp1uqChoVjslp5Q"}
AdditionType	string	No	Atur ke danmu untuk mengambil URL data overlay komentar langsung (danmaku). Catatan Parameter ini hanya berlaku ketika `OutputType` adalah `cdn`.	danmu
Trace	string	No	Informasi yang ditentukan pengguna untuk watermark digital. Jika Anda mengatur `DigitalWatermarkType` ke `TraceMark`, nilai parameter ini disematkan sebagai informasi Jejak watermark. API mengembalikan URL aliran video yang berisi watermark ini. Nilai mendukung huruf Inggris, angka, dan karakter Cina, hingga 1024 karakter. Jika Anda mengatur `DigitalWatermarkType` ke `CopyrightMark`, nilainya harus sesuai dengan teks watermark yang ditentukan di template watermark. API mengembalikan aliran video dengan Watermark hak cipta yang ditentukan.	test mark
DigitalWatermarkType	string	No	Tipe watermark digital. Nilai valid: TraceMark: Jejak watermark. CopyrightMark: Watermark hak cipta.	TraceMark
ReferenceId	string	No		123-123
ReferenceId	string	No	自定义 ID，仅支持小写字母、大写字母、数字、横线、下划线，长度 6-64 位。用户维度唯一。	123-123

Elemen respons

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	F552E596-967D-5500-842F-17E6364****
VideoBase	object	The basic information about the audio or video file.
CreationTime	string	The time when the audio or video file was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format in UTC.	2017-06-26T06:38:48Z
Status	string	The status of the audio or video file. For more information about the valid values and descriptions, see Status: Audio and video statuses.	Normal
VideoId	string	The ID of the audio or video file.	93ab850b4f654b6e91d24d81d44****
CoverURL	string	The URL of the thumbnail. Catatan To obtain the thumbnail URL in real time after uploading a video, configure ApsaraVideo VOD callbacks. For more information, see HTTP callback and Thumbnail capture complete.	http://example.aliyundoc.com/sample.jpg?auth_key=2333232-atb****
Duration	string	The duration of the audio or video file. Unit: seconds.	3.1667
Title	string	The title of the audio or video file.	阿里云VOD
MediaType	string	The type of the media file. Valid values: video: video. audio: audio-only.	video
DanMuURL	string	The URL of the live comment overlay data.	http://example.aliyundoc.com/**?auth_key=abdf2123-6783232**
StorageClass	string	The storage class of the media asset. Valid values: Standard: Standard. IA: Infrequent Access (IA). Archive: Archive. ColdArchive: Cold Archive. SourceIA: Source IA. SourceArchive: Source Archive. SourceColdArchive: Source Cold Archive. Changing: The storage class is being changed. SourceChanging: The storage class of the source file is being changed.	Standard
PlayInfoList	object
PlayInfo	array<object>	The playback information of the audio or video stream.
	object	The details of the audio or video file.
CreationTime	string	The time when the stream was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format in UTC.	2022-04-18T07:37:15Z
Status	string	The status of the media stream. Valid values: Normal: The stream is in the normal state. This status is assigned to the latest transcoded stream for each definition and format. Invisible: The stream is in the invisible state. If multiple streams are generated for the same definition and format, the latest stream is marked as Normal and the others are marked as Invisible.	Normal
Specification	string	The specifications of the transcoded output. For more information about the valid values and descriptions, see Specification: Output specifications.	H264.LD
NarrowBandType	string	The transcoding type. Valid values: 0: Normal transcoding. 1.0: Narrowband HD 1.0. 2.0: Narrowband HD 2.0.	0
Height	integer	The height of the media stream. Unit: px.	640
Bitrate	string	The bitrate of the media stream. Unit: Kbps. Catatan Due to the dynamic sharding feature of M3U8, the calculated bitrate may have a drift.	450.878
ModificationTime	string	The time when the stream was last updated. The time is in the yyyy-MM-ddTHH:mm:ssZ format in UTC.	2022-04-20T06:32:19Z
WatermarkId	string	The ID of the watermark template associated with the current media stream.	dgfn26457856****
Encrypt	integer	Indicates whether the media stream is encrypted. Valid values: 0: No. 1: Yes.	1
Definition	string	The definition of the video stream. Valid values: FD: Low definition. LD: Standard definition. SD: High definition. HD: Ultra high definition. OD: Original quality. 2K: 2K. 4K: 4K. SQ: Standard quality. HQ: High quality. AUTO: Adaptive bitrate.	LD
EncryptType	string	The encryption type of the media stream. Valid values: AliyunVoDEncryption: Alibaba Cloud proprietary cryptography. HLSEncryption: HLS standard encryption. Catatan If the encryption type is `AliyunVoDEncryption`, you can play the stream only using ApsaraVideo Player SDK.	AliyunVoDEncryption
EncryptMode	string	The encryption mode of the media stream. Valid values: License: Local decryption mode. Catatan If the encryption mode is License, you can play the stream only using ApsaraVideo Player SDK.	License
StreamType	string	The type of the media stream. The value is video for a video stream or audio for an audio-only stream.	video
JobId	string	The ID of the transcoding job for the media stream. This ID serves as the unique identifier for the media stream.	80e9c6580e754a798c3c19c59b16****
Size	integer	The size of the media stream. Unit: byte. Catatan Due to the dynamic sharding feature of M3U8, the calculated stream size may have a drift.	418112
Width	integer	The width of the media stream. Unit: px.	360
Fps	string	The frame rate of the media stream. Unit: frames per second.	25
Duration	string	The duration of the media stream. Unit: seconds.	9.0464
PlayURL	string	The playback URL of the video stream.	https://example.aliyundoc.com/d52ee123f331466aabf6ab32a93d**/a777f9e24e6e47a2a942467d5c38ea37-8ee8e04293c6657fdda282bc422704**.m3u8
Format	string	The format of the media stream. The value is mp4 or m3u8 for a video file. The value is mp3 for an audio-only file.	m3u8
HDRType	string	The High Dynamic Range (HDR) type of the media stream. Valid values: HDR HDR10 HLG DolbyVision HDRVivid SDR+	HLG
BitDepth	integer	The color depth. The value is an integer.	8
JobType	integer	The type of the digital watermark. Valid values: 1: Tracing watermark. 2: Copyright watermark.	2
JobExt	string	The custom watermark information for the copyright watermark. This field is returned only when `JobType` is `2`.	CopyrightMarkTest
CodecName	string	The encoding type. Valid values: H264 H265	H264

Contoh

Respons sukses

JSONformat

{
  "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"
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.