LiteAVSDK
Tencent Cloud TRTC SDK, is a high availability components serving tens of thousands of enterprise customers, which is committed to helping you to minimize your research and development costs.
TXVodSDKEventDef

Macros

#define EVT_VOD_PLAY_TCP_CONNECT_SUCC   VOD_PLAY_EVT_VOD_PLAY_TCP_CONNECT_SUCC
 
#define EVT_VOD_PLAY_FIRST_VIDEO_PACKET   VOD_PLAY_EVT_VOD_PLAY_FIRST_VIDEO_PACKET
 
#define EVT_VOD_PLAY_DNS_RESOLVED   VOD_PLAY_EVT_VOD_PLAY_DNS_RESOLVED
 
#define EVT_VOD_PLAY_SEEK_COMPLETE   VOD_PLAY_EVT_VOD_PLAY_SEEK_COMPLETE
 
#define VOD_PLAY_EVENT_IMAGESPRIT_WEBVTTURL   @"EVT_IMAGESPRIT_WEBVTTURL"
 
#define VOD_PLAY_EVENT_IMAGESPRIT_IMAGEURL_LIST   @"EVT_IMAGESPRIT_IMAGEURL_LIST"
 
#define VOD_PLAY_EVENT_KEY_FRAME_CONTENT_LIST   @"EVT_KEY_FRAME_CONTENT_LIST"
 
#define VOD_PLAY_EVENT_KEY_FRAME_TIME_LIST   @"EVT_KEY_FRAME_TIME_LIST"
 
#define VOD_PLAY_EVENT_KEY_VIDEO_ROTATION   @"EVT_KEY_VIDEO_ROTATION"
 
#define EVT_KEY_SELECT_TRACK_INDEX   @"EVT_KEY_SELECT_TRACK_INDEX"
 
#define EVT_KEY_SELECT_TRACK_ERROR_CODE   @"EVT_KEY_SELECT_TRACK_ERROR_CODE"
 

Enumerations

enum  TXVODEventID
 
enum  TX_VOD_PLAYER_PIP_STATE : NSInteger
 
enum  TX_VOD_PLAYER_PIP_ERROR_TYPE : NSInteger
 
enum  TX_VOD_PLAYER_SUBTITLE_MIME_TYPE : NSInteger
 

Detailed Description

Definitions of event codes and error codes The following are VOD event codes and error codes.

Macro Definition Documentation

◆ EVT_KEY_SELECT_TRACK_ERROR_CODE

#define EVT_KEY_SELECT_TRACK_ERROR_CODE   @"EVT_KEY_SELECT_TRACK_ERROR_CODE"

External subtitle Event parameter return — return error code for switching media tracks.

◆ EVT_KEY_SELECT_TRACK_INDEX

#define EVT_KEY_SELECT_TRACK_INDEX   @"EVT_KEY_SELECT_TRACK_INDEX"

External subtitle Event parameter return — switched media track index.

◆ EVT_VOD_PLAY_DNS_RESOLVED

#define EVT_VOD_PLAY_DNS_RESOLVED   VOD_PLAY_EVT_VOD_PLAY_DNS_RESOLVED

◆ EVT_VOD_PLAY_FIRST_VIDEO_PACKET

#define EVT_VOD_PLAY_FIRST_VIDEO_PACKET   VOD_PLAY_EVT_VOD_PLAY_FIRST_VIDEO_PACKET

◆ EVT_VOD_PLAY_SEEK_COMPLETE

#define EVT_VOD_PLAY_SEEK_COMPLETE   VOD_PLAY_EVT_VOD_PLAY_SEEK_COMPLETE

◆ EVT_VOD_PLAY_TCP_CONNECT_SUCC

#define EVT_VOD_PLAY_TCP_CONNECT_SUCC   VOD_PLAY_EVT_VOD_PLAY_TCP_CONNECT_SUCC

Compatible definitions The following definitions are used for compatibility with error code definitions on early versions. Use new definitions on the right in your code as much as possible.

◆ VOD_PLAY_EVENT_IMAGESPRIT_IMAGEURL_LIST

#define VOD_PLAY_EVENT_IMAGESPRIT_IMAGEURL_LIST   @"EVT_IMAGESPRIT_IMAGEURL_LIST"

Sprite image download URL list (NSArray type)

◆ VOD_PLAY_EVENT_IMAGESPRIT_WEBVTTURL

#define VOD_PLAY_EVENT_IMAGESPRIT_WEBVTTURL   @"EVT_IMAGESPRIT_WEBVTTURL"

Sprite map web Vtt description file download URL.

◆ VOD_PLAY_EVENT_KEY_FRAME_CONTENT_LIST

#define VOD_PLAY_EVENT_KEY_FRAME_CONTENT_LIST   @"EVT_KEY_FRAME_CONTENT_LIST"

Video key frame description information.

◆ VOD_PLAY_EVENT_KEY_FRAME_TIME_LIST

#define VOD_PLAY_EVENT_KEY_FRAME_TIME_LIST   @"EVT_KEY_FRAME_TIME_LIST"

Key frame time (seconds)

◆ VOD_PLAY_EVENT_KEY_VIDEO_ROTATION

#define VOD_PLAY_EVENT_KEY_VIDEO_ROTATION   @"EVT_KEY_VIDEO_ROTATION"

Video rotation angle.

Enumeration Type Documentation

◆ TX_VOD_PLAYER_PIP_ERROR_TYPE

enum TX_VOD_PLAYER_PIP_ERROR_TYPE : NSInteger

The PiP error type

Enumerator
TX_VOD_PLAYER_PIP_ERROR_TYPE_NONE 

No error.

TX_VOD_PLAYER_PIP_ERROR_TYPE_DEVICE_NOT_SUPPORT 

The player doesn't support PiP.

TX_VOD_PLAYER_PIP_ERROR_TYPE_PLAYER_NOT_SUPPORT 

The video doesn't support PiP.

TX_VOD_PLAYER_PIP_ERROR_TYPE_VIDEO_NOT_SUPPORT 

The PiP controller is unavailable.

TX_VOD_PLAYER_PIP_ERROR_TYPE_PIP_IS_NOT_POSSIBLE 

The PiP controller is unavailable.

TX_VOD_PLAYER_PIP_ERROR_TYPE_ERROR_FROM_SYSTEM 

The PiP controller reported an error.

TX_VOD_PLAYER_PIP_ERROR_TYPE_PLAYER_NOT_EXIST 

The player object does not exist.

TX_VOD_PLAYER_PIP_ERROR_TYPE_PIP_IS_RUNNING 

The PiP feature is running.

TX_VOD_PLAYER_PIP_ERROR_TYPE_PIP_NOT_RUNNING 

The PiP feature has not been started.

◆ TX_VOD_PLAYER_PIP_STATE

enum TX_VOD_PLAYER_PIP_STATE : NSInteger

The PiP controller status

Enumerator
TX_VOD_PLAYER_PIP_STATE_UNDEFINED 

No status is set.

TX_VOD_PLAYER_PIP_STATE_WILL_START 

PiP will start soon.

TX_VOD_PLAYER_PIP_STATE_DID_START 

PiP started.

TX_VOD_PLAYER_PIP_STATE_WILL_STOP 

PiP will end soon.

TX_VOD_PLAYER_PIP_STATE_DID_STOP 

PiP ended.

TX_VOD_PLAYER_PIP_STATE_RESTORE_UI 

The UI was reset.

◆ TX_VOD_PLAYER_SUBTITLE_MIME_TYPE

External subtitle Mime Type type

Enumerator
TX_VOD_PLAYER_MIMETYPE_TEXT_SRT 

External subtitle SRT format.

TX_VOD_PLAYER_MIMETYPE_TEXT_VTT 

External subtitle VTT format.

◆ TXVODEventID

Definitions of event codes and error codes The following are VOD event codes and error codes

Enumerator
VOD_PLAY_EVT_RCV_FIRST_I_FRAME 

Playback event: Received the first video frame successfully.

VOD_PLAY_EVT_RCV_FIRST_AUDIO_FRAME 

Playback event: Received the first audio frame successfully.

VOD_PLAY_EVT_PLAY_BEGIN 

Playback event: Playback started.

VOD_PLAY_EVT_PLAY_PROGRESS 

Playback event: The playback progress was updated. This event is applicable to the VOD player only.

VOD_PLAY_EVT_PLAY_END 

Playback event: Playback ended.

VOD_PLAY_EVT_PLAY_LOADING 

Playback event: The data is buffering.

VOD_PLAY_EVT_START_VIDEO_DECODER 

Playback event: The video decoder started.

VOD_PLAY_EVT_CHANGE_RESOLUTION 

Playback event: The video resolution changed.

VOD_PLAY_EVT_GET_PLAYINFO_SUCC 

Playback event: Obtained the information of the VOD file successfully. This event is applicable to the VOD player only.

VOD_PLAY_EVT_CHANGE_ROTATION 

Playback event: The rotation angle of the MP4 video changed. This event is applicable to the VOD player only.

VOD_PLAY_EVT_GET_MESSAGE 

Playback event: The SEI message (https://cloud.tencent.com/document/product/454/7880#Message) in the video stream was received.

VOD_PLAY_EVT_VOD_PLAY_PREPARED 

Playback event: Video loading was completed. This event is applicable to the VOD player only.

VOD_PLAY_EVT_VOD_LOADING_END 

Playback event: Video buffering ended. This event is applicable to the VOD player only.

VOD_PLAY_EVT_STREAM_SWITCH_SUCC 

Playback event: Switched the video stream between different definitions successfully.

VOD_PLAY_EVT_VOD_PLAY_TCP_CONNECT_SUCC 

TCP connection succeeded.

VOD_PLAY_EVT_VOD_PLAY_FIRST_VIDEO_PACKET 

Received the first data frame successfully.

VOD_PLAY_EVT_VOD_PLAY_DNS_RESOLVED 

DNS resolution was completed.

VOD_PLAY_EVT_VOD_PLAY_SEEK_COMPLETE 

Video playback seeking was completed.

VOD_PLAY_EVT_AUDIO_SESSION_INTERRUPT 

Playback event: The audio session was interrupted by another app. This event is applicable to iOS only.

VOD_PLAY_ERR_NET_DISCONNECT 

Live streaming error: The network was disconnected and couldn't be reconnected after three retries.

VOD_PLAY_ERR_FILE_NOT_FOUND 

VOD error: The file to be played back does not exist.

VOD_PLAY_ERR_HLS_KEY 

VOD error: Failed to get the HLS decryption key.

VOD_PLAY_ERR_GET_PLAYINFO_FAIL 

VOD error: Failed to get the information of the VOD file.

VOD_PLAY_ERR_LICENCE_CHECK_FAIL 

The license is invalid, the playback failed.

VOD_PLAY_EVT_LOOP_ONCE_COMPLETE 

Playback event: the end of a round of playback (available since version 10.8).