tencent cloud

Video on Demand

Release Notes and Announcements
Release Notes
Announcements
Product Introduction
Overview
Product Features
Features
Strengths
Scenarios
Solutions
Professional Edition
Introduction to Video On Demand Professional Edition
Quick Start
Console Guide
Development Guide
Purchase Guide
Billing Overview
Billing Modes
Purchase Guide
Viewing Bills
Renewal
Overdue Policy
Refund Policy
Getting Started
Console Guide
Console Overview
Service Overview
Application Management
Media Management
Package Management
License Management
Real-Time Log Analysis
Practical Tutorial
Media Upload
Smart Cold Storage of VOD Media Asset Files
Video Processing
Distribution and Playback
How to Receive Event Notification
How to Migrate Files from Origin Server to VOD
Live Recording
How to Pull from Custom Origin Servers
How to Use EdgeOne to Distribute Content in VOD
Development Guide
Media Upload
Media Processing
Video AI
Event Notification
Video Playback
Media Encryption and Copyright Protection
Broadcast Channel
CAM
Media File Download
Subapplication System
Error Codes
Player SDK
Overview
Basic Concepts
Features
Free Demo
Free Trial License
Purchase Guide
SDK Download
Licenses
Player Guide
Integration (UI Included)
Integration (No UI)
Advanced Features
API Documentation
Player Adapter
Player SDK Policy
Server APIs
History
Introduction
API Category
Other APIs
Media Processing APIs
Parameter Template APIs
Task Management APIs
Media Upload APIs
Media Management APIs
Event Notification Relevant API
Media Categorization APIs
Domain Name Management APIs
Distribution APIs
AI-based Sample Management APIs
Region Management APIs
Data Statistics APIs
Carousel-Related APIs
Just In Time Transcode APIs
No longer recommended APIs
Making API Requests
AI-based image processing APIs
Task Flow APIs
Data Types
Error Codes
Video on Demand API 2024-07-18
FAQs
Mobile Playback
Fees
Video Upload
Video Publishing
Video Playback
Web Playback
Full Screen Playback
Statistics
Access Management
Cold Storage
Agreements
Service Level Agreement
VOD Policy
Privacy Policy
Data Processing And Security Agreement
Contact Us
Glossary

TXVodDownloadMediaInfo

PDF
Focus Mode
Font Size
Last updated: 2025-05-30 14:55:21

Downloading TXVod Media Information Overview

Download on-demand media asset description.

Status Enumeration

TXVodDownloadMediaInfoState

Parameter Name
Type
Value
Description
TXVodDownloadMediaInfoStateInit
NSInteger
0
Download initial state.
TXVodDownloadMediaInfoStateStart
NSInteger
1
Download started.
TXVodDownloadMediaInfoStateStop
NSInteger
2
Download stopped.
TXVodDownloadMediaInfoStateError
NSInteger
3
Download error.
TXVodDownloadMediaInfoStateFinish
NSInteger
4
Download completed.

API Overview

API
Description
Retrieve the source media asset information passed in when downloading with Tencent Cloud Video fileId.
url
Retrieve the actual download address.
userName
Retrieve the download account name.
duration
Get the total duration of the video, in milliseconds.
Retrieve the playable duration of the downloaded content, in milliseconds.
size
Retrieve the total download file size, in Bytes, valid only for the fileId download source.
Note: The total size refers to the size of the original file uploaded to the Tencent Cloud VOD console. The substream sizes after adaptive dynamic streaming cannot be accessed temporarily.
Retrieve the downloaded file size, in Bytes, valid only for the fileId download source.
segments
Total video segments
Number of downloaded segments
progress
Retrieve the current download progress.
playPath
Retrieve the playback path of the currently downloaded resource, which can be transmitted to TXVodPlayer for playback.
speed
Retrieve the download speed, in KByte per second. (Supported starting from version 10.9.)
Retrieve the download status.
Retrieve the preferred download resolution.
Judge whether the downloaded video resource is damaged. Return true if it is deleted after download or in similar cases. (Supported starting from version 11.0.)
Determine whether the download is complete.

API Detail

dataSource

Retrieve the source media asset information passed in when downloading with Tencent Cloud Video fileId.
@property(nonatomic, strong) TXVodDownloadDataSource *dataSource;
Return Value
Download resource object information:TXVodDownloadDataSource.

url

Retrieve the actual download address.
@property(nonatomic, copy) NSString *url;

userName

Retrieve the download account name. Default is default.
@property(nonatomic, copy) NSString *userName;

duration

Get the total duration of the video, in milliseconds.
@property(nonatomic, assign) int duration;

playableDuration

Retrieve the playable duration of the downloaded content, in milliseconds.
@property(nonatomic, assign) int playableDuration;

size

Retrieve the total download file size, in Bytes, valid only for the Tencent Cloud Video fileId download source.
Note: The total size refers to the size of the original file uploaded to the Tencent Cloud VOD console. The substream sizes after adaptive dynamic streaming cannot be accessed temporarily.
@property(nonatomic, assign) long size;

downloadSize

Retrieve the downloaded file size, in Bytes, valid only for the Tencent Cloud Video fileId download source.
@property(nonatomic, assign) long downloadSize;

segments

Total video segments
@property(nonatomic, assign) int segments;

downloadSegments

Total video segments
@property(nonatomic, assign) int downloadSegments;

progress

Retrieve the current download progress.
@property(nonatomic, assign) float progress;

playPath

Retrieve the playback path of the currently downloaded resource, which can be transmitted to TXVodPlayer for playback.
@property(nonatomic, copy) NSString *playPath;

speed

Retrieve the download speed, in KByte per second. (Supported starting from version 10.9.)
@property(nonatomic, assign) int speed;

downloadState

Retrieve the download status.
@property(nonatomic, assign) TXVodDownloadMediaInfoState downloadState;
Return Value
Download status. For details, see TXVodDownloadMediaInfoState.

preferredResolution

Retrieve the preferred download resolution.
@property(nonatomic, assign) long preferredResolution;

isResourceBroken

Judge whether the downloaded video resource is damaged. Return true if it is deleted after download or in similar cases. (Supported starting from version 11.0.)
@property(nonatomic, assign) BOOL isResourceBroken;

isDownloadFinished

Determine whether the download is complete.
- (BOOL)isDownloadFinished;


Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback