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
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
Parameter Template 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
DocumentationVideo on DemandPlayer SDKAPI DocumentationiOSTXVodPlayListener

TXVodPlayListener

PDF
Focus Mode
Font Size
Last updated: 2025-05-30 14:53:26

TXVodPlayListener API Introduction

Playback event and network event callback monitoring API for on-demand player

Callback API Overview

API
Description
Playback event notification.
Playback process network status event callback.
Subtitle data callback.
Picture-in-Picture state callback.
Picture-in-Picture error message callback.
AirPlay state callback (system player only).
AirPlay error message callback (system player only).

Callback API Details

onPlayEvent:event:withParam:

Playback event notification, including start playback, first frame event, Loading event, playback progress, end playback, and other events.
- (void)onPlayEvent:(TXVodPlayer *)player event:(int)EvtID withParam:(NSDictionary *)param;
Parameter Description
Parameter Name
Type
Description
player
TXVodPlayer
Current player object.
EvtID
int
Player event, see TXVODEventID for details.
param
NSDictionary
Playback event carried parameters, saved in (Key, Value) format, where Key can refer to the event parameters in TXVodSDKEventDef.

onNetStatus:withParam:

Playback process network status event callback.
- (void)onNetStatus:(TXVodPlayer *)player withParam:(NSDictionary *)param;
Parameter Description
Parameter Name
Type
Description
player
TXVodPlayer
Current player object.
param
NSDictionary
Network status parameters during playback, in the format: (Key, Value). Specific Keys can be found in TXVodSDKEventDef.

onPlayer:subtitleData:

Subtitle data callback.
- (void)onPlayer:(TXVodPlayer *)player subtitleData:(TXVodSubtitleData *)subtitleData;
Parameter Description
Parameter Name
Type
Description
player
TXVodPlayer
Current player object.
subtitleData
TXVodSubtitleData
Subtitle callback data. For details, see TXVodSubtitleData.

onPlayer:pictureInPictureStateDidChange:withParam:

Picture-in-Picture state callback.
- (void)onPlayer:(TXVodPlayer *)player pictureInPictureStateDidChange:(TX_VOD_PLAYER_PIP_STATE)pipState withParam:(NSDictionary *)param;
Parameter Description
Parameter Name
Type
Description
player
TXVodPlayer
Callback player object.
pipState
TX_VOD_PLAYER_PIP_STATE
Picture-in-picture controller status. Specific values are listed in TX_VOD_PLAYER_PIP_STATE.
param
NSDictionary
Additional parameter.

onPlayer:pictureInPictureErrorDidOccur:withParam:

Picture-in-Picture error message callback.
- (void)onPlayer:(TXVodPlayer *)player pictureInPictureErrorDidOccur:(TX_VOD_PLAYER_PIP_ERROR_TYPE)errorType withParam:(NSDictionary *)param;
Parameter Description
Parameter Name
Type
Description
player
TXVodPlayer
Callback player object.
errorType
TX_VOD_PLAYER_PIP_ERROR_TYPE
Error type. For details, see TX_VOD_PLAYER_PIP_ERROR_TYPE.
param
NSDictionary
Error message.

onPlayer:airPlayStateDidChange:withParam:

AirPlay state callback (system player only).

- (void)onPlayer:(TXVodPlayer *)player airPlayStateDidChange:(TX_VOD_PLAYER_AIRPLAY_STATE)airPlayState withParam:(NSDictionary *)param;
Parameter Description
Parameter Name
Type
Description
player
TXVodPlayer
Callback player object.
airPlayState
TX_VOD_PLAYER_AIRPLAY_STATE
AirPlay status. Specific values are listed in TX_VOD_PLAYER_AIRPLAY_STATE.
param
NSDictionary
Additional parameter.

onPlayer:airPlayErrorDidOccur:withParam:

AirPlay error message callback (system player only).

- (void)onPlayer:(TXVodPlayer *)player airPlayErrorDidOccur:(TX_VOD_PLAYER_AIRPLAY_ERROR_TYPE)errorType withParam:(NSDictionary *)param;
Parameter Description
Parameter Name
Type
Description
player
TXVodPlayer
Callback player object.
errorType
TX_VOD_PLAYER_AIRPLAY_ERROR_TYPE
AirPlay error type. For details, see TX_VOD_PLAYER_AIRPLAY_ERROR_TYPE.
param
NSDictionary
Error message.


Previous Topic: TXVodPlayerNext Topic: TXPlayerGlobalSetting

Help and Support

Was this page helpful?

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

Feedback