Obtain audio and video playback URLs with GetPlayInfo - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Retrieves the playback URL of an audio or video file by providing the audio or video ID, which can then be played using ApsaraVideo Player or a third-party player such as a system-native, open-source, or custom-built player.

Operation description

Before using this operation, make sure you fully understand the billing methods and pricing of ApsaraVideo VOD. Directly downloading or playing videos from ApsaraVideo VOD playback URLs incurs outbound traffic fees. If no accelerated domain name is configured, refer to Storage outbound traffic billing. If an accelerated domain name is configured, refer to Acceleration service billing. If you have enabled storage transfer acceleration, directly downloading or playing videos from ApsaraVideo VOD playback URLs also incurs download acceleration fees. For billing details, refer to Storage transfer acceleration billing.
Only videos in the Normal state (the Status field value is Normal) can be played. For more information about playback URL descriptions and usage limits, refer to Audio and video playback.
When the media storage type is non-standard storage, set the StorageClass field of the PlayConfig parameter accordingly. For details, refer to PlayConfig.
If video playback is abnormal, call the GetMezzanineInfo operation to check whether the video source file information is correct.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vod:GetPlayInfo

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
VideoId	string	No	The audio or video ID. Only a single audio or video ID is supported. You can obtain the ID by using the following methods: For audio or video files uploaded through the console, log on to the ApsaraVideo VOD console and choose Media Files > Audio/Video to view the audio or video ID. When uploading audio or video files by calling the CreateUploadVideo operation, the audio or video ID is the value of the VideoId response parameter. After the audio or video file is uploaded, call the SearchMedia operation to query the audio or video ID, which is the value of the VideoId response parameter.	93ab850b4f654b6e91d24d81d44****
Formats	string	No	The media stream format. Separate multiple formats with commas (,). Valid values: mp4 m3u8 mp3 flv mpd Note By default, streams in all formats are returned. The mpd format is returned only when the `dash` container format is configured in the transcoding template. For more information, refer to Container: container format.	mp4,m3u8
AuthTimeout	integer	No	The validity period of the playback URL. Unit: seconds. If OutputType is set to cdn: The playback URL expires periodically only when URL authentication is enabled. Otherwise, the URL is permanently valid. For information about how to enable and configure URL authentication, refer to URL authentication. Minimum value: 1. Maximum value: unlimited. Default value: If this parameter is not specified, the default validity period configured in URL authentication is used. If OutputType is set to oss: The playback URL expires periodically only when the storage permission is private. Otherwise, the URL is permanently valid. Minimum value: 1. Maximum value: To reduce security risks to the origin server, when audio or video files are stored in an ApsaraVideo VOD system bucket, the maximum value is 604800 (7 days). When audio or video files are stored in your own OSS bucket, the maximum value is 129600 (36 hours). If the maximum value does not meet your requirements, set OutputType to cdn and configure URL authentication to set a longer validity period. Default value: If this parameter is not specified, the default value is 3600.	1800
OutputType	string	No	The type of the output URL. Valid values: oss: back-to-origin URL. cdn (default): accelerated URL.	cdn
StreamType	string	No	The media stream type. Separate multiple types with commas (,). Valid values: video: video. audio: audio. By default, streams of all types are returned.	video
ReAuthInfo	string	No	The CDN reauthentication parameter. The value is a JSON string. When type A signing is enabled for URL authentication, you can use this parameter to set the `uid` and `rand` of the authentication URL. For more information, refer to Type A signing.	{"uid":"12345","rand":"abckljd"}
Definition	string	No	The definition of the video stream. Separate multiple definitions with commas (,). Valid values: FD: low definition. LD: standard definition. SD: high definition. HD: ultra-high definition. OD: original definition. 2K: 2K. 4K: 4K. SQ: standard sound quality. HQ: high sound quality. AUTO: adaptive bitrate streaming. Note By default, streams of all definitions are returned. When generating tracing watermarks, this parameter is required and must be consistent with the definition configured during tracing watermark transcoding. The AUTO definition is returned only when transcoding packaging is configured in the transcoding template. For more information, refer to PackageSetting: transcoding packaging settings.	LD
ResultType	string	No	The type of the returned data. Valid values: Single (default): returns only the latest transcoded stream for each definition and format. Multiple: returns all transcoded streams for each definition and format.	Single
PlayConfig	string	No	The custom playback settings. The value is a JSON string that supports specifying domain name playback settings. For details about parameter construction, refer to PlayConfig. Note If PlayConfig is not set or `PlayDomain` within it is not set, the operation uses the default domain name configured in ApsaraVideo VOD. If no default domain name is configured, the most recently modified domain name is used as the playback domain name based on reverse chronological order of modification time. To prevent an unexpected domain name from being returned, set a default playback domain name. Log on to the ApsaraVideo VOD console and choose Configuration Management > Media Management > Storage > Manage > Domain names that perform origin fetch from this storage address to set the default playback domain name. When the `EncryptType` parameter in PlayConfig is set to `AliyunVoDEncryption`, the playback URL of the privately encrypted stream is not returned by default to ensure video security. To return the playback URL of the privately encrypted stream, set the `ResultType` parameter to `Multiple`.	{"PlayDomain":"vod.test_domain","XForwardedFor":"yqCD7Fp1uqChoVj/sl/p5Q==","PreviewTime":"20","MtsHlsUriToken":"yqCD7Fp1uqChoVjslp5Q"}
AdditionType	string	No	Obtains the URL of the China-accessible bullet screen mask data. Valid values: danmu. Note This parameter takes effect only when `outputType` is set to `cdn`.	danmu
Trace	string	No	The custom digital watermarking settings. When `DigitalWatermarkType` is set to `TraceMark`, pass in this parameter to set the tracing watermark information for the video and return the video stream that contains the watermark information. Only English letters, digits, and Chinese characters are supported. A maximum of 1024 characters are supported. When `DigitalWatermarkType` is set to `CopyrightMark`, `Trace` corresponds to the watermark text configured when the watermark template was created. Pass in this parameter to query and return the video stream with the specified watermark text.	test mark
DigitalWatermarkType	string	No	The digital watermarking type. Valid values: TraceMark: tracing watermark. CopyrightMark: copyright watermark.	TraceMark
CodecName	string	No		H264
ReferenceId	string	No	The custom ID. Only lowercase letters, uppercase letters, digits, hyphens, and underscores are supported. The length is 6 to 64 characters. The ID is unique per user.	123-123

Response elements

Element	Type	Description	Example
	object	The response parameters.
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 follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2017-06-26T06:38:48Z
Status	string	The status of the audio or video file. For valid values and descriptions, refer to Status: audio and video status.	Normal
VideoId	string	The audio or video ID.	93ab850b4f654b6e91d24d81d44****
CoverURL	string	The thumbnail URL of the audio or video file. Note To obtain the thumbnail URL in real time after uploading a video, configure ApsaraVideo VOD callbacks. For more information, refer to HTTP callback and SnapshotComplete event.	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.	Alibaba Cloud VOD
MediaType	string	The type of the media file. Valid values: video: video. audio: audio-only.	video
DanMuURL	string	The URL of the China-accessible bullet screen mask data.	http://example.aliyundoc.com/**?auth_key=abdf2123-6783232**
StorageClass	string	The storage class of the media asset. Valid values: Standard: standard. IA: media asset infrequent access. Archive: media asset archive. ColdArchive: media asset cold archive. SourceIA: source file infrequent access. SourceArchive: source file archive. SourceColdArchive: source file cold archive. Changing: media asset storage class is being changed. SourceChanging: source file storage class is being changed.	Standard
PlayInfoList	object
PlayInfo	array<object>	The playback information (stream information) of the audio or video file.
	object	The detailed information about 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. Note 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 are: FD: Low definition. LD: Standard definition. SD: High definition. HD: Ultra high definition. OD: Original quality. 2K: 2K resolution. 4K: 4K resolution. SQ: Standard-quality audio. HQ: High-quality audio. AUTO: Adaptive bitrate.	LD
EncryptType	string	The encryption type of the media stream. Valid values: AliyunVoDEncryption: Alibaba Cloud proprietary cryptography. HLSEncryption: HLS standard encryption. Note 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. Note 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. Note 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

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.