ApsaraVideo VOD:Download media files

Scenarios

• Download from the console: Suitable for quick validation or temporary export of a small number of files.

• Download using an API: Suitable for automated batch processing of files.

• Download offline using a player SDK: Suitable for custom application scenarios.

Scenario 1: Download from the console

Download a single file

The console is ideal for downloading a few files for quick validation or testing.

1. Log on to the ApsaraVideo VOD console.

2. In the left navigation pane, choose Media Files > Audio/Video.

3. Find the target file, click Manage in the Actions column, select the Video URL or Audio URL tab, then click Copy for the desired definition.

4. Paste the copied URL into a browser or download tool to start the download.

Download multiple files

Use the batch export feature to export media asset information for multiple files.

1. Log on to the ApsaraVideo VOD console.

2. In the left navigation pane, choose Media Files, then select Audio/Video or Image.

3. Use the filter or search feature to locate and select the files to export.

4. Click the icon in the upper-right corner to export the media asset information.

5. Paste the URLs for the media assets into a browser or download tool to start the download.

Scenario 2: Download using an API

Obtain download URLs

Use the following APIs to obtain download URLs for source files, transcoded files, and thumbnails.

Obtain download URLs in batches

Perform the download operation

The following Python SDK example automates the download. Additional examples are available in the OpenAPI Portal.

1. Prepare the environment.

   Install the VOD Python SDK.

   pip install aliyun-python-sdk-vod

2. Obtain the download URL.

   Call the GetMezzanineInfo operation to retrieve the source file information.

   import json
   from aliyunsdkcore.client import AcsClient
   from aliyunsdkvod.request.v20170321 import GetMezzanineInfoRequest
   
   # Initialize the client
   # Replace with your AccessKey ID, AccessKey secret, and region ID
   client = AcsClient('YOUR_ACCESS_KEY_ID', 'YOUR_ACCESS_KEY_SECRET', 'cn-shanghai')
   
   # 1. Create a request
   request = GetMezzanineInfoRequest()
   request.set_accept_format('json')
   request.set_VideoId("YOUR_VIDEO_ID") # Replace with your video ID
   request.set_OutputType("oss")  # Recommended: Returns the OSS storage address for lower cost
   request.set_AuthTimeout(3600)  # Set the URL validity period to 1 hour (3600 seconds)
   
   # 2. Send the request and get the response
   response = client.do_action_with_exception(request)
   result = json.loads(response)
   
   # 3. Parse the download URL
   download_url = result['Mezzanine']['FileURL']
   print(f"Source file download URL: {download_url}")
   
   # (Optional) Use the requests library to download the file
   import requests
   print("Starting file download...")
   file_response = requests.get(download_url, stream=True)
   if file_response.status_code == 200:
       with open('downloaded_video.mp4', 'wb') as f:
           for chunk in file_response.iter_content(chunk_size=8192):
               f.write(chunk)
       print("File downloaded successfully: downloaded_video.mp4")
   else:
       print(f"Download failed, status code: {file_response.status_code}")
       print(f"Error message: {file_response.text}")

Scenario 3: Download offline using a player SDK

VOD supports caching videos locally on mobile devices for offline viewing in two modes: standard download and secure download.

• Standard download: The video is not encrypted and can be copied and played by any player. Suitable for public content or low-copyright scenarios.

• Secure download: The video is encrypted and can only be played by an ApsaraVideo Player SDK integrated with the matching key. Suitable for paid courses and copyright-sensitive content.

Steps

1. Configure the download mode.

   1. Log on to the ApsaraVideo VOD console. Go to Configuration Management > CDN Configuration > Download Settings.

   2. Select standard or secure download. For secure download, generate and securely store the encryption key on this page.

2. Integrate the player SDK.

   Integrate the ApsaraVideo Player SDK into your Android or iOS project: Integrate the Android SDK, Integrate the iOS SDK.

3. Complete the video download.

   Integrate the video download module into your Android or iOS project: Video download for Android, Video download for iOS.

4. Download multiple videos concurrently.

   The ApsaraVideo Player SDK does not support downloading multiple videos at the same time with a single downloader instance. Instantiate a separate AliMediaDownloader for each video. When you download multiple videos, note the following limits and recommendations:

   • Use the singleton pattern to manage the download queue, and maintain a fixed pool of active downloaders, such as three to five, for concurrent processing.

   • After a download task ends, call stop() and release() to release the downloader resources.

   • PlayAuth is valid for 3000 seconds. Before you call prepare, make sure that the credential is still valid. If the credential has expired, call updateSource() to refresh the PlayAuth credential and then continue the download.

Billing

Download URLs fall into two categories:

• Storage address

  • Without an accelerated domain name, downloads use the storage address directly and incur outbound traffic fees.

• Accelerated address:

  • If you configure an accelerated domain name, download URLs become accelerated URLs, providing faster downloads and incurring acceleration service fees.

  • If you configure blacklists and whitelists, restrictions such as Referer hotlink protection and IP blacklists apply, consistent with online playback rules.

FAQ

Why can't I play the downloaded video?

If the transcoded output uses encryption (such as HLS encryption), the downloaded file remains encrypted. Use the ApsaraVideo Player SDK to decrypt and play it. Video encryption.

How do I download many media files?

Use SearchMedia - Search Media Information with paging to retrieve file URLs, then follow Scenario 2: Download via API to download.

Can I dynamically add a watermark when I download a video?

ApsaraVideo VOD does not support dynamically adding a watermark through an API when a video is downloaded. To download a watermarked video but play a non-watermarked video, configure the watermarked version and the non-watermarked version as different definitions. Then follow Scenario 1 or Scenario 2 in this topic to obtain and download the video file of the definition that you need.

Does URL expiration affect an ongoing download?

If a download URL expires during a download, the download is not interrupted and does not slow down. The download that has already started continues to completion. If you request the file again and the request fails or the download becomes slow, call the GetPlayInfo operation to generate a new download URL. Set the OutputType parameter to oss, extend the URL validity period as appropriate, and then retry the download.