直播 SDK V2TXLivePlayerObserver-客户端 API-文档中心-腾讯云

Copyright (c) 2021 Tencent. All rights reserved.
﻿
Module:   V2TXLivePlayerObserver @ TXLiteAVSDK
﻿
Function: 腾讯云直播的播放器回调通知
﻿
功能腾讯云直播的播放器回调通知。
介绍可以接收 ﻿V2TXLivePlayer﻿ 播放器的一些回调通知，包括播放器状态、播放音量回调、音视频首帧回调、统计数据、警告和错误信息等。
﻿
V2TXLivePlayerObserver
V2TXLivePlayerObserver
函数列表
描述
onError:code:message:extraInfo:
直播播放器错误通知，播放器出现错误时，会回调该通知
onWarning:code:message:extraInfo:
直播播放器警告通知
onVideoResolutionChanged:width:height:
直播播放器分辨率变化通知
onConnected:extraInfo:
已经成功连接到服务器
onVideoPlaying:firstPlay:extraInfo:
视频播放事件
onAudioPlaying:firstPlay:extraInfo:
音频播放事件
onVideoLoading:extraInfo:
视频加载事件
onAudioLoading:extraInfo:
音频加载事件
onPlayoutVolumeUpdate:volume:
播放器音量大小回调
onStatisticsUpdate:statistics:
直播播放器统计数据回调
onSnapshotComplete:image:
截图回调
onRenderVideoFrame:frame:
自定义视频渲染回调
onPlayoutAudioFrame:frame:
音频数据回调
onReceiveSeiMessage:payloadType:data:
收到 SEI 消息的回调，发送端通过 ﻿V2TXLivePusher﻿ 中的  sendSeiMessage  来发送 SEI 消息
onStreamSwitched:url:code:
分辨率无缝切换回调
onPictureInPictureStateUpdate:state:message:extraInfo:
画中画状态变更回调
onLocalRecordBegin:errCode:storagePath:
录制任务开始的事件回调
onLocalRecording:durationMs:storagePath:
录制任务正在进行中的进展事件回调
onLocalRecordComplete:errCode:storagePath:
录制任务已经结束的事件回调
onError:code:message:extraInfo:
onError:code:message:extraInfo:
- (void)onError:
(id<﻿V2TXLivePlayer﻿>)player
code:
(﻿V2TXLiveCode﻿)code
message:
(NSString *)msg
extraInfo:
(NSDictionary *)extraInfo
直播播放器错误通知，播放器出现错误时，会回调该通知参数
描述
code
错误码 ﻿V2TXLiveCode﻿。
extraInfo
扩展信息。
msg
错误信息。
player
回调该通知的播放器对象。
onWarning:code:message:extraInfo:
onWarning:code:message:extraInfo:
- (void)onWarning:
(id<﻿V2TXLivePlayer﻿>)player
code:
(﻿V2TXLiveCode﻿)code
message:
(NSString *)msg
extraInfo:
(NSDictionary *)extraInfo
直播播放器警告通知参数
描述
code
警告码 ﻿V2TXLiveCode﻿。
extraInfo
扩展信息。
msg
警告信息。
player
回调该通知的播放器对象。
onVideoResolutionChanged:width:height:
onVideoResolutionChanged:width:height:
- (void)onVideoResolutionChanged:
(id<﻿V2TXLivePlayer﻿>)player
width:
(NSInteger)width
height:
(NSInteger)height
直播播放器分辨率变化通知参数
描述
height
视频高。
player
回调该通知的播放器对象。
width
视频宽。
onConnected:extraInfo:
onConnected:extraInfo:
- (void)onConnected:
(id<﻿V2TXLivePlayer﻿>)player
extraInfo:
(NSDictionary *)extraInfo
已经成功连接到服务器参数
描述
extraInfo
扩展信息。
player
回调该通知的播放器对象。
onVideoPlaying:firstPlay:extraInfo:
onVideoPlaying:firstPlay:extraInfo:
- (void)onVideoPlaying:
(id<﻿V2TXLivePlayer﻿>)player
firstPlay:
(BOOL)firstPlay
extraInfo:
(NSDictionary *)extraInfo
视频播放事件参数
描述
extraInfo
扩展信息。
firstPlay
第一次播放标志。
player
回调该通知的播放器对象。
onAudioPlaying:firstPlay:extraInfo:
onAudioPlaying:firstPlay:extraInfo:
- (void)onAudioPlaying:
(id<﻿V2TXLivePlayer﻿>)player
firstPlay:
(BOOL)firstPlay
extraInfo:
(NSDictionary *)extraInfo
音频播放事件参数
描述
extraInfo
扩展信息。
firstPlay
第一次播放标志。
player
回调该通知的播放器对象。
onVideoLoading:extraInfo:
onVideoLoading:extraInfo:
- (void)onVideoLoading:
(id<﻿V2TXLivePlayer﻿>)player
extraInfo:
(NSDictionary *)extraInfo
视频加载事件参数
描述
extraInfo
扩展信息。
player
回调该通知的播放器对象。
onAudioLoading:extraInfo:
onAudioLoading:extraInfo:
- (void)onAudioLoading:
(id<﻿V2TXLivePlayer﻿>)player
extraInfo:
(NSDictionary *)extraInfo
音频加载事件参数
描述
extraInfo
扩展信息。
player
回调该通知的播放器对象。
onPlayoutVolumeUpdate:volume:
onPlayoutVolumeUpdate:volume:
- (void)onPlayoutVolumeUpdate:
(id<﻿V2TXLivePlayer﻿>)player
volume:
(NSInteger)volume
播放器音量大小回调参数
描述
player
回调该通知的播放器对象。
volume
音量大小。
注意
调用 ﻿enableVolumeEvaluation﻿ 开启播放音量大小提示之后，会收到这个回调通知。
onStatisticsUpdate:statistics:
onStatisticsUpdate:statistics:
- (void)onStatisticsUpdate:
(id<﻿V2TXLivePlayer﻿>)player
statistics:
(﻿V2TXLivePlayerStatistics﻿ *)statistics
直播播放器统计数据回调参数
描述
player
回调该通知的播放器对象。
statistics
播放器统计数据 ﻿V2TXLivePlayerStatistics﻿。
onSnapshotComplete:image:
onSnapshotComplete:image:
- (void)onSnapshotComplete:
(id<﻿V2TXLivePlayer﻿>)player
image:
(nullable TXImage *)image
截图回调参数
描述
image
已截取的视频画面。
player
回调该通知的播放器对象。
注意
调用 ﻿snapshot﻿ 截图之后，会收到这个回调通知。
onRenderVideoFrame:frame:
onRenderVideoFrame:frame:
- (void)onRenderVideoFrame:
(id<﻿V2TXLivePlayer﻿>)player
frame:
(﻿V2TXLiveVideoFrame﻿ *)videoFrame
自定义视频渲染回调参数
描述
player
回调该通知的播放器对象。
videoFrame
视频帧数据 ﻿V2TXLiveVideoFrame﻿。
注意
需要您调用 ﻿enableObserveVideoFrame﻿ 开启回调开关。
onPlayoutAudioFrame:frame:
onPlayoutAudioFrame:frame:
- (void)onPlayoutAudioFrame:
(id<﻿V2TXLivePlayer﻿>)player
frame:
(﻿V2TXLiveAudioFrame﻿ *)audioFrame
音频数据回调参数
描述
audioFrame
音频帧数据 ﻿V2TXLiveAudioFrame﻿。
player
回调该通知的播放器对象。
注意
需要您调用 ﻿enableObserveAudioFrame﻿ 开启回调开关。请在当前回调中使用 audioFrame 的 data。
onReceiveSeiMessage:payloadType:data:
onReceiveSeiMessage:payloadType:data:
- (void)onReceiveSeiMessage:
(id<﻿V2TXLivePlayer﻿>)player
payloadType:
(int)payloadType
data:
(NSData *)data
收到 SEI 消息的回调，发送端通过 {@link V2TXLivePusher} 中的 `sendSeiMessage` 来发送 SEI 消息参数
描述
data
数据。
payloadType
回调数据的SEI payloadType。
player
回调该通知的播放器对象。
注意
调用 ﻿V2TXLivePlayer﻿ 中的  enableReceiveSeiMessage  开启接收 SEI 消息之后，会收到这个回调通知。
onStreamSwitched:url:code:
onStreamSwitched:url:code:
- (void)onStreamSwitched:
(id<﻿V2TXLivePlayer﻿>)player
url:
(NSString *)url
code:
(NSInteger)code
分辨率无缝切换回调参数
描述
code
状态码，0：成功，-1：切换超时，-2：切换失败，服务端错误，-3：切换失败，客户端错误。
player
回调该通知的播放器对象。
url
切换的播放地址。
注意
调用 ﻿V2TXLivePlayer﻿ 中的  switchStream  切换分辨率，会收到这个回调通知。
onPictureInPictureStateUpdate:state:message:extraInfo:
onPictureInPictureStateUpdate:state:message:extraInfo:
- (void)onPictureInPictureStateUpdate:
(id<﻿V2TXLivePlayer﻿>)player
state:
(﻿V2TXLivePictureInPictureState﻿)state
message:
(NSString *)msg
extraInfo:
(NSDictionary *)extraInfo
画中画状态变更回调参数
描述
extraInfo
扩展信息。
player
回调该通知的播放器对象。
state
画中画的状态。
注意
调用 ﻿V2TXLivePlayer﻿ 中的  enablePictureInPicture  开启画中画之后，会收到这个回调通知。
onLocalRecordBegin:errCode:storagePath:
onLocalRecordBegin:errCode:storagePath:
- (void)onLocalRecordBegin:
(id<﻿V2TXLivePlayer﻿>)player
errCode:
(NSInteger)errCode
storagePath:
(NSString *)storagePath
录制任务开始的事件回调参数
描述
code
状态码。
 0：录制任务启动成功。
 -1：内部错误导致录制任务启动失败。
 -2：文件后缀名有误（比如不支持的录制格式）。
 -6：录制已经启动，需要先停止录制。
 -7：录制文件已存在，需要先删除文件。
 -8：录制目录无写入权限，请检查目录权限问题。
player
回调该通知的播放器对象。
storagePath
录制的文件地址。
onLocalRecording:durationMs:storagePath:
onLocalRecording:durationMs:storagePath:
- (void)onLocalRecording:
(id<﻿V2TXLivePlayer﻿>)player
durationMs:
(NSInteger)durationMs
storagePath:
(NSString *)storagePath
录制任务正在进行中的进展事件回调参数
描述
durationMs
录制时长。
player
回调该通知的播放器对象。
storagePath
录制的文件地址。
onLocalRecordComplete:errCode:storagePath:
onLocalRecordComplete:errCode:storagePath:
- (void)onLocalRecordComplete:
(id<﻿V2TXLivePlayer﻿>)player
errCode:
(NSInteger)errCode
storagePath:
(NSString *)storagePath
录制任务已经结束的事件回调参数
描述
code
状态码。
  0：结束录制任务成功。
 -1：录制失败。
 -2：切换分辨率或横竖屏导致录制结束。
 -3：录制时间太短，或未采集到任何视频或音频数据，请检查录制时长，或是否已开启音、视频采集。
player
回调该通知的播放器对象。
storagePath
录制的文件地址。

函数列表	描述
onError:code:message:extraInfo:	直播播放器错误通知，播放器出现错误时，会回调该通知
onWarning:code:message:extraInfo:	直播播放器警告通知
onVideoResolutionChanged:width:height:	直播播放器分辨率变化通知
onConnected:extraInfo:	已经成功连接到服务器
onVideoPlaying:firstPlay:extraInfo:	视频播放事件
onAudioPlaying:firstPlay:extraInfo:	音频播放事件
onVideoLoading:extraInfo:	视频加载事件
onAudioLoading:extraInfo:	音频加载事件
onPlayoutVolumeUpdate:volume:	播放器音量大小回调
onStatisticsUpdate:statistics:	直播播放器统计数据回调
onSnapshotComplete:image:	截图回调
onRenderVideoFrame:frame:	自定义视频渲染回调
onPlayoutAudioFrame:frame:	音频数据回调
onReceiveSeiMessage:payloadType:data:	收到 SEI 消息的回调，发送端通过 V2TXLivePusher 中的 `sendSeiMessage` 来发送 SEI 消息
onStreamSwitched:url:code:	分辨率无缝切换回调
onPictureInPictureStateUpdate:state:message:extraInfo:	画中画状态变更回调
onLocalRecordBegin:errCode:storagePath:	录制任务开始的事件回调
onLocalRecording:durationMs:storagePath:	录制任务正在进行中的进展事件回调
onLocalRecordComplete:errCode:storagePath:	录制任务已经结束的事件回调

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

参数	描述
code	错误码 V2TXLiveCode。
extraInfo	扩展信息。
msg	错误信息。
player	回调该通知的播放器对象。

- (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

参数	描述
height	视频高。
player	回调该通知的播放器对象。
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

参数	描述
image	已截取的视频画面。
player	回调该通知的播放器对象。

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

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

参数	描述
audioFrame	音频帧数据 V2TXLiveAudioFrame。
player	回调该通知的播放器对象。

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

参数	描述
data	数据。
payloadType	回调数据的SEI payloadType。
player	回调该通知的播放器对象。

V2TXLivePlayerObserver

本页目录：

功能

介绍

V2TXLivePlayerObserver

onError:code:message:extraInfo:

直播播放器错误通知，播放器出现错误时，会回调该通知

onWarning:code:message:extraInfo:

直播播放器警告通知

onVideoResolutionChanged:width:height:

直播播放器分辨率变化通知

onConnected:extraInfo:

已经成功连接到服务器

onVideoPlaying:firstPlay:extraInfo:

视频播放事件

onAudioPlaying:firstPlay:extraInfo:

音频播放事件

onVideoLoading:extraInfo:

视频加载事件

onAudioLoading:extraInfo:

音频加载事件

onPlayoutVolumeUpdate:volume:

播放器音量大小回调

onStatisticsUpdate:statistics:

直播播放器统计数据回调

onSnapshotComplete:image:

截图回调

onRenderVideoFrame:frame:

自定义视频渲染回调

onPlayoutAudioFrame:frame:

音频数据回调

onReceiveSeiMessage:payloadType:data:

收到 SEI 消息的回调，发送端通过 {@link V2TXLivePusher} 中的 `sendSeiMessage` 来发送 SEI 消息

onStreamSwitched:url:code:

分辨率无缝切换回调

onPictureInPictureStateUpdate:state:message:extraInfo:

画中画状态变更回调

onLocalRecordBegin:errCode:storagePath:

录制任务开始的事件回调

onLocalRecording:durationMs:storagePath:

录制任务正在进行中的进展事件回调

onLocalRecordComplete:errCode:storagePath:

录制任务已经结束的事件回调

- (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

参数	描述
durationMs	录制时长。
player	回调该通知的播放器对象。
storagePath	录制的文件地址。

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