v2txlivepusherobserver

最近更新时间:2026-05-06 12:10:22

我的收藏
Copyright (c) 2021 Tencent. All rights reserved.

Module: V2TXLivePusherObserver @ TXLiteAVSDK

Function: 腾讯云直播推流的回调通知


功能

腾讯云直播的推流回调通知。

介绍

可以接收 V2TXLivePusher 推流器的一些推流通知,包括推流器连接状态、音视频首帧回调、统计数据、警告和错误信息等。

v2txlivepusherobserver

V2TXLivePusherObserver

函数列表
描述
直播推流器错误通知,推流器出现错误时,会回调该通知
直播推流器警告通知
首帧音频采集完成的回调通知
首帧视频采集完成的回调通知
麦克风采集音量值回调
推流器连接状态回调通知
直播推流器统计数据回调
截图回调
自定义视频预处理数据回调
当屏幕分享开始时,SDK 会通过此回调通知
当屏幕分享停止时,SDK 会通过此回调通知
录制任务开始的事件回调
录制任务正在进行中的进展事件回调
录制任务已经结束的事件回调

onError

onError
onError?:
(code: number

msg: string

extraInfo: ESObject)

直播推流器错误通知,推流器出现错误时,会回调该通知

参数
描述
code
错误码 V2TXLiveCode
extraInfo
扩展信息。
msg
错误信息。

onWarning

onWarning
onWarning?:
(code: number

msg: string

extraInfo: ESObject)

直播推流器警告通知

参数
描述
code
警告码 V2TXLiveCode
extraInfo
扩展信息。
msg
警告信息。

onCaptureFirstAudioFrame

onCaptureFirstAudioFrame
onCaptureFirstAudioFrame?:
()

首帧音频采集完成的回调通知

onCaptureFirstVideoFrame

onCaptureFirstVideoFrame
onCaptureFirstVideoFrame?:
()

首帧视频采集完成的回调通知

onMicrophoneVolumeUpdate

onMicrophoneVolumeUpdate
onMicrophoneVolumeUpdate?:
(volume: number)

麦克风采集音量值回调

参数
描述
volume
音量大小。
注意
调用 enableVolumeEvaluation 开启采集音量大小提示之后,会收到这个回调通知。

onPushStatusUpdate

onPushStatusUpdate
onPushStatusUpdate?:
(status: V2TXLivePushStatus

msg: string

extraInfo: ESObject)

推流器连接状态回调通知

参数
描述
extraInfo
扩展信息。
msg
连接状态信息。
status
推流器连接状态 V2TXLivePushStatus

onStatisticsUpdate

onStatisticsUpdate
onStatisticsUpdate?:
(statistics: V2TXLivePusherStatistics)

直播推流器统计数据回调

参数
描述
statistics
推流器统计数据 V2TXLivePusherStatistics

onSnapshotComplete

onSnapshotComplete
onSnapshotComplete?:
(pixelMap: image.PixelMap)

截图回调

参数
描述
pixelMap
已截取的视频画面。
注意
调用 snapshot 截图之后,会收到这个回调通知。

onProcessVideoFrame

onProcessVideoFrame
onProcessVideoFrame?:
(srcFrame: V2TXLiveVideoFrame

dstFrame: V2TXLiveVideoFrame)

自定义视频预处理数据回调

参数
描述
dstFrame
处理后的视频帧。
srcFrame
处理前的视频帧。
注意
调用 enableCustomVideoProcessing 接口开启/关闭自定义视频处理回调。Windows 暂时只支持 YUV420 格式。

返回值说明:

0: 成功。
其他: 错误。

onScreenCaptureStarted

onScreenCaptureStarted
onScreenCaptureStarted?:
()

当屏幕分享开始时,SDK 会通过此回调通知

onScreenCaptureStopped

onScreenCaptureStopped
onScreenCaptureStopped?:
(reason: number)

当屏幕分享停止时,SDK 会通过此回调通知

参数
描述
reason
停止原因
0:表示用户主动停止。
1:iOS 表示录屏被系统中断;Mac、Windows 表示屏幕分享窗口被关闭。
2:Windows 表示屏幕分享的显示屏状态变更(如接口被拔出、投影模式变更等);其他平台不抛出。

onLocalRecordBegin

onLocalRecordBegin
onLocalRecordBegin?:
(code: number

storagePath: string)

录制任务开始的事件回调

参数
描述
code
状态码。
0:录制任务启动成功。
-1:内部错误导致录制任务启动失败。
-2:文件后缀名有误(例如不支持的录制格式)。
-6:录制已经启动,需要先停止录制。
-7:录制文件已存在,需要先删除文件。
-8:录制目录无写入权限,请检查目录权限问题。
storagePath
录制的文件地址。

onLocalRecording

onLocalRecording
onLocalRecording?:
(durationMs: number

storagePath: string)

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

参数
描述
durationMs
录制时长。
storagePath
录制的文件地址。

onLocalRecordComplete

onLocalRecordComplete
onLocalRecordComplete?:
(code: number

storagePath: string)

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

参数
描述
code
状态码。
0:结束录制任务成功。
-1:录制失败。
-2:切换分辨率或横竖屏导致录制结束。
-3:录制时间太短,或未采集到任何视频或音频数据,请检查录制时长,或是否已开启音、视频采集。
storagePath
录制的文件地址。