V2TXLivePlayerObserver

Copyright (c) 2021 Tencent. All rights reserved.
﻿
Module:   V2TXLivePlayerObserver @ TXLiteAVSDK
﻿
Function: Tencent Cloud live player callback notification
﻿
FunctionPlayer callback notification for Tencent Cloud Live.
IntroduceYou can receive some callback notifications from the ﻿V2TXLivePlayer﻿ player, including player status, playback volume callback, audio and video first frame callback, statistical data, warning and error messages, etc.
﻿
V2TXLivePlayerObserver
V2TXLivePlayerObserver
FuncList
DESC
onError:code:message:extraInfo:
live player error notification, which is called back when the player encounters an error
onWarning:code:message:extraInfo:
live player warning notification
onVideoResolutionChanged:width:height:
live player resolution change notification
onConnected:extraInfo:
live player has successfully connected to the server notification
onVideoPlaying:firstPlay:extraInfo:
Video playback event
onAudioPlaying:firstPlay:extraInfo:
Audio playback event
onVideoLoading:extraInfo:
Video loading event
onAudioLoading:extraInfo:
Audio loading event
onPlayoutVolumeUpdate:volume:
Player playback volume callback
onStatisticsUpdate:statistics:
Live player statistics callback
onSnapshotComplete:image:
Screenshot callback
onRenderVideoFrame:frame:
Custom video rendering callback
onPlayoutAudioFrame:frame:
Audio Data callback
onReceiveSeiMessage:payloadType:data:
Callback of receiving an SEI message. The sender calls  sendSeiMessage  in ﻿V2TXLivePusher﻿ to send an SEI
onStreamSwitched:url:code:
Resolution stream switch callback
onPictureInPictureStateUpdate:state:message:extraInfo:
Picture-in-Picture state change callback
onLocalRecordBegin:errCode:storagePath:
The SDK returns this callback when you call ﻿startLocalRecording﻿ to start local recording.
onLocalRecording:durationMs:storagePath:
The SDK returns this callback when you call ﻿startLocalRecording﻿ to start local recording, which means recording task in progress.
onLocalRecordComplete:errCode:storagePath:
The SDK returns this callback when you call ﻿stopLocalRecording﻿ to start local recording.
onError:code:message:extraInfo:
onError:code:message:extraInfo:
- (void)onError:
(id<﻿V2TXLivePlayer﻿>)player
code:
(﻿V2TXLiveCode﻿)code
message:
(NSString *)msg
extraInfo:
(NSDictionary *)extraInfo
live player error notification, which is called back when the player encounters an errorParam
DESC
code
Error code ﻿V2TXLiveCode﻿.
extraInfo
Extended information.
msg
Error message.
player
Player object that calls back this notification.
onWarning:code:message:extraInfo:
onWarning:code:message:extraInfo:
- (void)onWarning:
(id<﻿V2TXLivePlayer﻿>)player
code:
(﻿V2TXLiveCode﻿)code
message:
(NSString *)msg
extraInfo:
(NSDictionary *)extraInfo
live player warning notificationParam
DESC
code
Warning code ﻿V2TXLiveCode﻿.
extraInfo
Extended information.
msg
Warning message.
player
Player object that calls back this notification.
onVideoResolutionChanged:width:height:
onVideoResolutionChanged:width:height:
- (void)onVideoResolutionChanged:
(id<﻿V2TXLivePlayer﻿>)player
width:
(NSInteger)width
height:
(NSInteger)height
live player resolution change notificationParam
DESC
height
Video height.
player
Player object that calls back this notification.
width
Video width.
onConnected:extraInfo:
onConnected:extraInfo:
- (void)onConnected:
(id<﻿V2TXLivePlayer﻿>)player
extraInfo:
(NSDictionary *)extraInfo
live player has successfully connected to the server notificationParam
DESC
extraInfo
Extended information.
player
Player object that calls back this notification.
onVideoPlaying:firstPlay:extraInfo:
onVideoPlaying:firstPlay:extraInfo:
- (void)onVideoPlaying:
(id<﻿V2TXLivePlayer﻿>)player
firstPlay:
(BOOL)firstPlay
extraInfo:
(NSDictionary *)extraInfo
Video playback eventParam
DESC
extraInfo
Extended information.
firstPlay
Play for the first time.
player
Player object that calls back this notification.
onAudioPlaying:firstPlay:extraInfo:
onAudioPlaying:firstPlay:extraInfo:
- (void)onAudioPlaying:
(id<﻿V2TXLivePlayer﻿>)player
firstPlay:
(BOOL)firstPlay
extraInfo:
(NSDictionary *)extraInfo
Audio playback eventParam
DESC
extraInfo
Extended information.
firstPlay
Play for the first time.
player
Player object that calls back this notification.
onVideoLoading:extraInfo:
onVideoLoading:extraInfo:
- (void)onVideoLoading:
(id<﻿V2TXLivePlayer﻿>)player
extraInfo:
(NSDictionary *)extraInfo
Video loading eventParam
DESC
extraInfo
Extended information.
player
Player object that calls back this notification.
onAudioLoading:extraInfo:
onAudioLoading:extraInfo:
- (void)onAudioLoading:
(id<﻿V2TXLivePlayer﻿>)player
extraInfo:
(NSDictionary *)extraInfo
Audio loading eventParam
DESC
extraInfo
Extended information.
player
Player object that calls back this notification.
onPlayoutVolumeUpdate:volume:
onPlayoutVolumeUpdate:volume:
- (void)onPlayoutVolumeUpdate:
(id<﻿V2TXLivePlayer﻿>)player
volume:
(NSInteger)volume
Player playback volume callbackParam
DESC
player
Player object that calls back this notification.
volume
Current playback volume.
Note
This callback notification is received after ﻿enableVolumeEvaluation﻿ is called to enable playback volume display.
onStatisticsUpdate:statistics:
onStatisticsUpdate:statistics:
- (void)onStatisticsUpdate:
(id<﻿V2TXLivePlayer﻿>)player
statistics:
(﻿V2TXLivePlayerStatistics﻿ *)statistics
Live player statistics callbackParam
DESC
player
Player object that calls back this notification.
statistics
Player statistics ﻿V2TXLivePlayerStatistics﻿.
onSnapshotComplete:image:
onSnapshotComplete:image:
- (void)onSnapshotComplete:
(id<﻿V2TXLivePlayer﻿>)player
image:
(nullable TXImage *)image
Screenshot callbackParam
DESC
image
Captured video image.
player
Player object that calls back this notification.
Note
This callback notification is received after ﻿snapshot﻿ is called to snapshot.
onRenderVideoFrame:frame:
onRenderVideoFrame:frame:
- (void)onRenderVideoFrame:
(id<﻿V2TXLivePlayer﻿>)player
frame:
(﻿V2TXLiveVideoFrame﻿ *)videoFrame
Custom video rendering callbackParam
DESC
player
Player object that calls back this notification.
videoFrame
Video frame data ﻿V2TXLiveVideoFrame﻿.
Note
Need you call ﻿enableObserveVideoFrame﻿ to turn on the callback switch.
onPlayoutAudioFrame:frame:
onPlayoutAudioFrame:frame:
- (void)onPlayoutAudioFrame:
(id<﻿V2TXLivePlayer﻿>)player
frame:
(V2TXLiveAudioFrame *)audioFrame
Audio Data callbackParam
DESC
aduioFrame
Audio frame data ﻿V2TXLiveAudioFrame﻿.
player
Player object that calls back this notification.
Note
Need you call ﻿enableObserveAudioFrame﻿ to turn on the callback switch. Please use the data of audioFrame in the current callback.
onReceiveSeiMessage:payloadType:data:
onReceiveSeiMessage:payloadType:data:
- (void)onReceiveSeiMessage:
(id<﻿V2TXLivePlayer﻿>)player
payloadType:
(int)payloadType
data:
(NSData *)data
Callback of receiving an SEI message. The sender calls `sendSeiMessage` in {@link V2TXLivePusher} to send an SEIParam
DESC
data
sei message data.
payloadType
The payload type of the received SEI message.
player
Player object that calls back this notification.
Note
You will receive this callback after calling  enableReceiveSeiMessage  in ﻿V2TXLivePlayer﻿ to enable the receiving of SEI.
onStreamSwitched:url:code:
onStreamSwitched:url:code:
- (void)onStreamSwitched:
(id<﻿V2TXLivePlayer﻿>)player
url:
(NSString *)url
code:
(NSInteger)code
Resolution stream switch callbackParam
DESC
code
Status code, 0:success, -1:timeout, -2:failed, server error, -3:failed, client error.
player
Player object that calls back this notification.
url
Switched playback address.
Note
This callback notification is received after ﻿switchStream﻿ is called to switch stream.
onPictureInPictureStateUpdate:state:message:extraInfo:
onPictureInPictureStateUpdate:state:message:extraInfo:
- (void)onPictureInPictureStateUpdate:
(id<﻿V2TXLivePlayer﻿>)player
state:
(﻿V2TXLivePictureInPictureState﻿)state
message:
(NSString *)msg
extraInfo:
(NSDictionary *)extraInfo
Picture-in-Picture state change callbackParam
DESC
extraInfo
Extended information.
player
Player object that calls back this notification.
state
Picture-in-Picture state。
Note
This callback notification is received after ﻿enablePictureInPicture﻿ is called to enable Picture-in-Picture.
onLocalRecordBegin:errCode:storagePath:
onLocalRecordBegin:errCode:storagePath:
- (void)onLocalRecordBegin:
(id<﻿V2TXLivePlayer﻿>)player
errCode:
(NSInteger)errCode
storagePath:
(NSString *)storagePath
The SDK returns this callback when you call {@link startLocalRecording} to start local recording.Param
DESC
code
status.
  0: successful.
 -1: failed.
 -2: unsupported format.
 -6: recording has been started. Stop recording first.
 -7: recording file already exists and needs to be deleted.
 -8: recording directory does not have the write permission. Please check the directory permission.
player
Player object that calls back this notification.
storagePath
recording filePath.
onLocalRecording:durationMs:storagePath:
onLocalRecording:durationMs:storagePath:
- (void)onLocalRecording:
(id<﻿V2TXLivePlayer﻿>)player
durationMs:
(NSInteger)durationMs
storagePath:
(NSString *)storagePath
The SDK returns this callback when you call {@link startLocalRecording} to start local recording, which means recording task in progress.Param
DESC
durationMs
recording duration.
player
Player object that calls back this notification.
storagePath
recording filePath.
onLocalRecordComplete:errCode:storagePath:
onLocalRecordComplete:errCode:storagePath:
- (void)onLocalRecordComplete:
(id<﻿V2TXLivePlayer﻿>)player
errCode:
(NSInteger)errCode
storagePath:
(NSString *)storagePath
The SDK returns this callback when you call {@link stopLocalRecording} to start local recording.Param
DESC
code
status
  0: successful.
 -1: failed.
 -2: Switching resolution or horizontal and vertical screen causes the recording to stop.
 -3: recording duration is too short or no video or audio data is received. Check the recording duration or whether audio or video capture is enabled.
player
Player object that calls back this notification.
storagePath
recording filePath.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

FuncList	DESC
onError:code:message:extraInfo:	live player error notification, which is called back when the player encounters an error
onWarning:code:message:extraInfo:	live player warning notification
onVideoResolutionChanged:width:height:	live player resolution change notification
onConnected:extraInfo:	live player has successfully connected to the server notification
onVideoPlaying:firstPlay:extraInfo:	Video playback event
onAudioPlaying:firstPlay:extraInfo:	Audio playback event
onVideoLoading:extraInfo:	Video loading event
onAudioLoading:extraInfo:	Audio loading event
onPlayoutVolumeUpdate:volume:	Player playback volume callback
onStatisticsUpdate:statistics:	Live player statistics callback
onSnapshotComplete:image:	Screenshot callback
onRenderVideoFrame:frame:	Custom video rendering callback
onPlayoutAudioFrame:frame:	Audio Data callback
onReceiveSeiMessage:payloadType:data:	Callback of receiving an SEI message. The sender calls `sendSeiMessage` in V2TXLivePusher to send an SEI
onStreamSwitched:url:code:	Resolution stream switch callback
onPictureInPictureStateUpdate:state:message:extraInfo:	Picture-in-Picture state change callback
onLocalRecordBegin:errCode:storagePath:	The SDK returns this callback when you call startLocalRecording to start local recording.
onLocalRecording:durationMs:storagePath:	The SDK returns this callback when you call startLocalRecording to start local recording, which means recording task in progress.
onLocalRecordComplete:errCode:storagePath:	The SDK returns this callback when you call stopLocalRecording to start local recording.

- (void)onError:	(id<V2TXLivePlayer>)player
code:	(V2TXLiveCode)code
message:	(NSString *)msg
extraInfo:	(NSDictionary *)extraInfo

Param	DESC
code	Error code V2TXLiveCode.
extraInfo	Extended information.
msg	Error message.
player	Player object that calls back this notification.

- (void)onWarning:	(id<V2TXLivePlayer>)player
code:	(V2TXLiveCode)code
message:	(NSString *)msg
extraInfo:	(NSDictionary *)extraInfo

- (void)onVideoResolutionChanged:	(id<V2TXLivePlayer>)player
width:	(NSInteger)width
height:	(NSInteger)height

Param	DESC
height	Video height.
player	Player object that calls back this notification.
width	Video width.

- (void)onConnected:	(id<V2TXLivePlayer>)player
extraInfo:	(NSDictionary *)extraInfo

- (void)onVideoPlaying:	(id<V2TXLivePlayer>)player
firstPlay:	(BOOL)firstPlay
extraInfo:	(NSDictionary *)extraInfo

- (void)onAudioPlaying:	(id<V2TXLivePlayer>)player
firstPlay:	(BOOL)firstPlay
extraInfo:	(NSDictionary *)extraInfo

- (void)onVideoLoading:	(id<V2TXLivePlayer>)player
extraInfo:	(NSDictionary *)extraInfo

- (void)onAudioLoading:	(id<V2TXLivePlayer>)player
extraInfo:	(NSDictionary *)extraInfo

- (void)onPlayoutVolumeUpdate:	(id<V2TXLivePlayer>)player
volume:	(NSInteger)volume

- (void)onStatisticsUpdate:	(id<V2TXLivePlayer>)player
statistics:	(V2TXLivePlayerStatistics *)statistics

- (void)onSnapshotComplete:	(id<V2TXLivePlayer>)player
image:	(nullable TXImage *)image

Param	DESC
image	Captured video image.
player	Player object that calls back this notification.

- (void)onRenderVideoFrame:	(id<V2TXLivePlayer>)player
frame:	(V2TXLiveVideoFrame *)videoFrame

- (void)onPlayoutAudioFrame:	(id<V2TXLivePlayer>)player
frame:	(V2TXLiveAudioFrame *)audioFrame

Param	DESC
aduioFrame	Audio frame data V2TXLiveAudioFrame.
player	Player object that calls back this notification.

- (void)onReceiveSeiMessage:	(id<V2TXLivePlayer>)player
payloadType:	(int)payloadType
data:	(NSData *)data

Param	DESC
data	sei message data.
payloadType	The payload type of the received SEI message.
player	Player object that calls back this notification.

tencent cloud

Sign Up

Log in

Compute

Microservice

Data Migration

Database SaaS Tool

Data Security

Application Security

Big Data

Tencent Big Model

Internet of Things

Stream Services

Cloud Real-time Rendering

Cloud Resource Management

More

Edge Computing

Serverless

Relational Database

Networking

Business Security

Domains & Websites

Face Recognition

AI Platform Service

Middleware

Media On-Demand

Game Services

Management and Audit Tools

Container

Essential Storage Service

Enterprise Distributed DBMS

CDN and Acceleration

Security Services

Enterprise Applications

Voice Technology

Natural Language Processing

Communication

Media Process Services

Education Sevices

Developer Tools

Distributed cloud

Data Process and Analysis

NoSQL Database

Network Security

Cloud Security

Office Collaboration

Image Creation

Optical Character Recognition

Interactive Video Services

Media SDK

Medical Services

Monitor and Operation

Function

Introduce

V2TXLivePlayerObserver

onError:code:message:extraInfo:

live player error notification, which is called back when the player encounters an error

onWarning:code:message:extraInfo:

live player warning notification

onVideoResolutionChanged:width:height:

live player resolution change notification

onConnected:extraInfo:

live player has successfully connected to the server notification

onVideoPlaying:firstPlay:extraInfo:

Video playback event

onAudioPlaying:firstPlay:extraInfo:

Audio playback event

onVideoLoading:extraInfo:

Video loading event

onAudioLoading:extraInfo:

Audio loading event

onPlayoutVolumeUpdate:volume:

Player playback volume callback

onStatisticsUpdate:statistics:

Live player statistics callback

onSnapshotComplete:image:

Screenshot callback

onRenderVideoFrame:frame:

Custom video rendering callback

onPlayoutAudioFrame:frame:

- (void)onStreamSwitched:	(id<V2TXLivePlayer>)player
url:	(NSString *)url
code:	(NSInteger)code

- (void)onPictureInPictureStateUpdate:	(id<V2TXLivePlayer>)player
state:	(V2TXLivePictureInPictureState)state
message:	(NSString *)msg
extraInfo:	(NSDictionary *)extraInfo

- (void)onLocalRecordBegin:	(id<V2TXLivePlayer>)player
errCode:	(NSInteger)errCode
storagePath:	(NSString *)storagePath

- (void)onLocalRecording:	(id<V2TXLivePlayer>)player
durationMs:	(NSInteger)durationMs
storagePath:	(NSString *)storagePath

Param	DESC
durationMs	recording duration.
player	Player object that calls back this notification.
storagePath	recording filePath.

- (void)onLocalRecordComplete:	(id<V2TXLivePlayer>)player
errCode:	(NSInteger)errCode
storagePath:	(NSString *)storagePath