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

TXPlayerGlobalSetting

PDF
Focus Mode
Font Size
Last updated: 2025-05-30 14:54:19

TXPlayerGlobalSetting API Introduction

VOD player global configuration.。

API Overview

API
Description
Set the Cache directory for the playback engine.
Retrieve the Cache directory of the playback engine.
Set the maximum cache size for the playback engine.
Retrieve the maximum cache size of the playback engine.
Judge the feature capability of the player.
Set flexible verification for player License. Once enabled, the first 3 playback verifications will default allow after the player's first launch.
Set the list of domain addresses for Tencent Cloud PlayCGI hosts.

API Detail

setCacheFolderPath:

Set the Cache directory for the playback engine. After configuration, the player and preloading will preferentially read from and store in this directory.
+ (void)setCacheFolderPath:(NSString *)cacheFolder;
Parameter Description
Parameter Name
Type
Description
cacheFolder
NSString
Cache directory path, nil means caching is disabled.

cacheFolderPath

Retrieve the Cache directory set for the playback engine.
+ (NSString *)cacheFolderPath;

setMaxCacheSize:

Set the maximum cache size for the playback engine. After configuration, files in the Cache directory will be automatically cleaned up based on the set value.
+ (void)setMaxCacheSize:(NSInteger)maxCacheSizeMB;
Parameter Description
Parameter Name
Type
Description
maxCacheSizeMB
NSInteger
Maximum cache size, unit: MB.

maxCacheSize

Retrieve the set maximum cache size of the playback engine. Unit: MB.
+ (NSInteger)maxCacheSize;

getOptions:

Judge the feature capability of the player.
+ (id)getOptions:(NSNumber *)featureId;

setLicenseFlexibleValid:

Enable flexible verification for player License. Once enabled, the first 2 playback verifications will default allow after the player's first launch.
+ (void)setLicenseFlexibleValid:(BOOL)value;

setPlayCGIHosts:

Set the list of domain addresses for Tencent Cloud PlayCGI hosts. When the request to the built-in domain fails, the set backup domain name will be enabled.
+ (void)setPlayCGIHosts:(NSArray<NSString *> *)hosts;
Parameter Description
Parameter Name
Type
Description
hosts
NSArray<NSString *>
List of domain addresses, domain name format: playvideo.qcloud.com.
Trigger a PlayCGI request and sequentially use the passed-in host addresses. If a request to a certain host fails, automatically switch to the next host and retry the request.

Help and Support

Was this page helpful?

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

Feedback