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

TXPlayerAuthParams

PDF
Focus Mode
Font Size
Last updated: 2025-05-30 14:58:08

Introducing the TXPlayerAuthParams API

on-demand player playback media parameters, the Tencent Cloud fileId and playback address can be configured through TXPlayInfoParams.

API Overview

API
Description
appId
Application appId.
fileId
Video file ID.
timeout
Encrypted link timeout timestamp.
exper
Preview duration.
us
Unique identification of request.
sign
Hotlink protection signature.
https
Whether to use HTTPS request.
url
Video file URL.
mediaType
Media asset type.
MP4 encryption level.
headers
HTTP Header.
Preloaded audio track name.

API Detail

appId

application ID. If the URL is not set, this field is required.
@property(nonatomic, assign) int appId;

fileId

video file ID. If the URL is not set, this field is required.
@property(nonatomic, copy) NSString *fileId;

timeout

encrypted link timeout timestamp. Optional, will be converted to a lowercase hexadecimal string, and the CDN server will judge whether the link is valid based on this timestamp.
@property(nonatomic, copy) NSString *fileId;

exper

Preview duration (in seconds), optional.
@property(nonatomic, assign) int exper;

us

Unique identification of request, increase link uniqueness.
@property(nonatomic, copy) NSString *us;

sign

Hotlink protection. If hotlink protection is not used, leave this parameter blank. The hotlink protection parameters (t, us, exper) used by the player API are consistent with the CDN, with the only difference being the calculation method of the sign.
Common hotlink protection signature: sign = md5(KEY + appId + fileId + t + us).
Preview edition hotlink protection signature: sign = md5(KEY + appId + fileId + t + exper + us).
@property(nonatomic, copy) NSString *sign;

https

Whether to use HTTPS request, defaults to NO.
@property(nonatomic, assign) BOOL https;

url

video URL.
@property(nonatomic, copy) NSString *url;

mediaType

Media type. Defaults to MEDIA_TYPE_AUTO.
@property(nonatomic, assign) TX_Enum_MediaType mediaType;
Parameter Description
Parameter Name
Type
Description
mediaType
Set media asset type. Defaults to auto type.

encryptedMp4Level

Set the encryption level for MP4 playback.
@property(nonatomic, assign) TX_Enum_MP4EncryptionLevel encryptedMp4Level;
Parameter Description
Parameter Name
Type
Description
encryptedMp4Level
Set the encryption level for MP4 playback and storage, supported starting from Player Premium version 12.2.

headers

Customize the Http headers carried during online playback by the player.
@property(nonatomic, strong) NSDictionary *headers;

preferAudioTrack

Set the preferred audio track for playback startup. In pre-download scenarios, configure the preferred download audio track.
Notes:
Note: Player Premium version 12.3 or later is supported.
@property(nonatomic, copy) NSString *preferAudioTrack;
Parameter Description
Parameter Name
Type
Description
preferAudioTrack
NSString
audio track name.


Help and Support

Was this page helpful?

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

Feedback