LiteAVSDK
腾讯云音视频 SDK ,服务于数万家企业客户的高可用组件,致力于最大限度地节省您的研发成本。
ITRTCCloudCallback

详细描述

腾讯云视频通话功能的回调接口类


结构体说明

◆ ManageLiteAV::ITRTCCloudCallback

interface ManageLiteAV::ITRTCCloudCallback

错误事件和警告事件

void onError (TXLiteAVError errCode, string errMsg, IntPtr arg)
 
void onWarning (TXLiteAVWarning warningCode, string warningMsg, IntPtr arg)
 

房间事件回调

void onEnterRoom (int result)
 
void onExitRoom (int reason)
 
void onSwitchRole (TXLiteAVError errCode, string errMsg)
 
void onConnectOtherRoom (string userId, TXLiteAVError errCode, string errMsg)
 
void onDisconnectOtherRoom (TXLiteAVError errCode, string errMsg)
 

成员事件回调

void onRemoteUserEnterRoom (string userId)
 
void onRemoteUserLeaveRoom (string userId, int reason)
 
void onUserVideoAvailable (string userId, bool available)
 
void onUserSubStreamAvailable (string userId, bool available)
 
void onUserAudioAvailable (string userId, bool available)
 
void onFirstVideoFrame (string userId, TRTCVideoStreamType streamType, int width, int height)
 
void onFirstAudioFrame (string userId)
 
void onSendFirstLocalVideoFrame (TRTCVideoStreamType streamType)
 
void onSendFirstLocalAudioFrame ()
 
void onUserEnter (string userId)
 
void onUserExit (string userId, int reason)
 

统计和质量回调

void onNetworkQuality (TRTCQualityInfo localQuality, TRTCQualityInfo[] remoteQuality, uint remoteQualityCount)
 
void onStatistics (TRTCStatistics statis)
 

服务器事件回调

void onConnectionLost ()
 
void onTryToReconnect ()
 
void onConnectionRecovery ()
 
void onSpeedTest (TRTCSpeedTestResult currentResult, uint finishedCount, uint totalCount)
 

硬件设备事件回调

void onCameraDidReady ()
 
void onMicDidReady ()
 
void onUserVoiceVolume (TRTCVolumeInfo[] userVolumes, uint userVolumesCount, uint totalVolume)
 
void onDeviceChange (string deviceId, TRTCDeviceType type, TRTCDeviceState state)
 
void onTestMicVolume (uint volume)
 
void onTestSpeakerVolume (uint volume)
 

自定义消息的接收回调

void onRecvCustomCmdMsg (string userId, int cmdID, uint seq, byte[] msg, uint msgSize)
 
void onMissCustomCmdMsg (string userId, int cmdId, int errCode, int missed)
 
void onRecvSEIMsg (string userId, byte[] message, uint msgSize)
 

CDN 旁路转推回调

void onStartPublishing (int errCode, string errMsg)
 
void onStopPublishing (int errCode, string errMsg)
 
void onStartPublishCDNStream (int errCode, string errMsg)
 
void onStopPublishCDNStream (int errCode, string errMsg)
 
void onSetMixTranscodingConfig (int errCode, string errMsg)
 

音效回调

void onAudioEffectFinished (int effectId, int code)
 

屏幕分享回调

void onScreenCaptureCovered ()
 
void onScreenCaptureStarted ()
 
void onScreenCapturePaused (int reason)
 
void onScreenCaptureResumed (int reason)
 
void onScreenCaptureStoped (int reason)
 

背景混音事件回调

void onPlayBGMBegin (TXLiteAVError errCode)
 
void onPlayBGMProgress (uint progressMS, uint durationMS)
 
void onPlayBGMComplete (TXLiteAVError errCode)
 

成员函数说明

◆ onError()

void onError ( TXLiteAVError  errCode,
string  errMsg,
IntPtr  arg 
)

错误回调,SDK 不可恢复的错误,一定要监听,并分情况给用户适当的界面提示。

参数
errCode错误码
errMsg错误信息
arg扩展信息字段,个别错误码可能会带额外的信息帮助定位问题

◆ onWarning()

void onWarning ( TXLiteAVWarning  warningCode,
string  warningMsg,
IntPtr  arg 
)

警告回调:用于告知您一些非严重性问题,例如出现了卡顿或者可恢复的解码失败。

参数
warningCode错误码
warningMsg警告信息
arg扩展信息字段,个别警告码可能会带额外的信息帮助定位问题

◆ onEnterRoom()

void onEnterRoom ( int  result)

已加入房间的回调

调用 TRTCCloud 中的 enterRoom() 接口执行进房操作后,会收到来自 SDK 的 onEnterRoom(result) 回调:

- 如果加入成功,result 会是一个正数(result > 0),代表加入房间的时间消耗,单位是毫秒(ms)。

- 如果加入失败,result 会是一个负数(result < 0),代表进房失败的错误码。

进房失败的错误码含义请参见 错误码

在 Ver6.6 之前的版本,只有进房成功会抛出 onEnterRoom(result) 回调,进房失败由 onError() 回调抛出。

在 Ver6.6 及之后改为:进房成功返回正的 result,进房失败返回负的 result,同时进房失败也会有 onError() 回调抛出。

参数
resultresult > 0 时为进房耗时(ms),result < 0 时为进房错误码。

◆ onExitRoom()

void onExitRoom ( int  reason)

离开房间的事件回调

调用 TRTCCloud 中的 exitRoom() 接口会执行退出房间的相关逻辑,例如释放音视频设备资源和编解码器资源等。 待资源释放完毕之后,SDK 会通过 onExitRoom() 回调通知到您。

如果您要再次调用 enterRoom() 或者切换到其他的音视频 SDK,请等待 onExitRoom() 回调到来之后再执行相关操作。 否则可能会遇到如摄像头、麦克风设备被强占等各种异常问题。

参数
reason离开房间原因,0:主动调用 exitRoom 退房;1:被服务器踢出当前房间;2:当前房间整个被解散。

◆ onSwitchRole()

void onSwitchRole ( TXLiteAVError  errCode,
string  errMsg 
)

切换角色结果回调

调用 TRTCCloud 中的 switchRole() 接口会切换主播和观众的角色,该操作会伴随一个线路切换的过程, 待 SDK 切换完成后,会抛出 onSwitchRole() 事件回调。

参数
errCode错误码,ERR_NULL 代表切换成功,其他请参见 错误码
errMsg错误信息

◆ onConnectOtherRoom()

void onConnectOtherRoom ( string  userId,
TXLiteAVError  errCode,
string  errMsg 
)

请求跨房通话(主播 PK)的结果回调

调用 TRTCCloud 中的 connectOtherRoom() 接口会将两个不同房间中的主播拉通视频通话,也就是所谓的“主播PK”功能。

调用者会收到 onConnectOtherRoom() 回调来获知跨房通话是否成功, 如果成功,两个房间中的所有用户都会收到 PK 主播的 onUserVideoAvailable() 回调。

参数
userId要 PK 的目标主播 userId。
errCode错误码,ERR_NULL 代表切换成功,其他请参见 错误码
errMsg错误信息

◆ onDisconnectOtherRoom()

void onDisconnectOtherRoom ( TXLiteAVError  errCode,
string  errMsg 
)

结束跨房通话(主播 PK)的结果回调

参数
errCode错误码,ERR_NULL 代表切换成功,其他请参见 错误码
errMsg错误信息

◆ onRemoteUserEnterRoom()

void onRemoteUserEnterRoom ( string  userId)

有用户加入当前房间

出于性能方面的考虑,在两种不同的应用场景下,该通知的行为会有差别:

- 通话场景(TRTCAppSceneVideoCall 和 TRTCAppSceneAudioCall):该场景下用户没有角色的区别,任何用户进入房间都会触发该通知。

- 直播场景(TRTCAppSceneLIVE 和 TRTCAppSceneVoiceChatRoom):该场景不限制观众的数量,如果任何用户进出都抛出回调会引起很大的性能损耗,所以该场景下只有主播进入房间时才会触发该通知,观众进入房间不会触发该通知。

注意 onRemoteUserEnterRoom 和 onRemoteUserLeaveRoom 只适用于维护当前房间里的“成员列表”,如果需要显示远程画面,建议使用监听 onUserVideoAvailable() 事件回调。

参数
userId用户标识

◆ onRemoteUserLeaveRoom()

void onRemoteUserLeaveRoom ( string  userId,
int  reason 
)

有用户离开当前房间,与 onuserEnterRoom 相对应

与 onRemoteUserEnterRoom 相对应,在两种不同的应用场景下,该通知的行为会有差别:

- 通话场景(TRTCAppSceneVideoCall 和 TRTCAppSceneAudioCall):该场景下用户没有角色的区别,任何用户的离开都会触发该通知。

- 直播场景(TRTCAppSceneLIVE 和 TRTCAppSceneVoiceChatRoom):只有主播离开房间时才会触发该通知,观众离开房间不会触发该通知。

参数
userId用户标识
reason离开原因,0表示用户主动退出房间,1表示用户超时退出,2表示被踢出房间。

◆ onUserVideoAvailable()

void onUserVideoAvailable ( string  userId,
bool  available 
)

远端用户是否存在可播放的主路画面(一般用于摄像头)

当您收到 onUserVideoAvailable(userId, YES) 通知时,代表该路画面已经有可用的视频数据帧到达。

之后,您需要调用 startRemoteView(userId) 接口加载该用户的远程画面。

再之后,您还会收到名为 onFirstVideoFrame(userId) 的首帧画面渲染回调。

当您收到了 onUserVideoAvailable(userId, NO) 通知时,代表该路远程画面已经被关闭,这可能是 由于该用户调用了 muteLocalVideo() 或 stopLocalPreview() 所致。

参数
userId用户标识
available画面是否开启

◆ onUserSubStreamAvailable()

void onUserSubStreamAvailable ( string  userId,
bool  available 
)

远端用户是否存在可播放的辅路画面(一般用于屏幕分享)

显示辅路画面使用的函数是 startRemoteSubStreamView() 而非 startRemoteView()。

参数
userId用户标识
available屏幕分享是否开启

◆ onUserAudioAvailable()

void onUserAudioAvailable ( string  userId,
bool  available 
)

远端用户是否存在可播放的音频数据

参数
userId用户标识
available声音是否开启

◆ onFirstVideoFrame()

void onFirstVideoFrame ( string  userId,
TRTCVideoStreamType  streamType,
int  width,
int  height 
)

开始渲染本地或远程用户的首帧画面

如果 userId 为 null,代表开始渲染本地采集的摄像头画面,需要您先调用 startLocalPreview 触发。

如果 userId 不为 null,代表开始渲染远程用户的首帧画面,需要您先调用 startRemoteView 触发。

只有当您调用 startLocalPreview()、startRemoteView() 或 startRemoteSubStreamView() 之后,才会触发该回调。

参数
userId本地或远程用户 ID,如果 userId == null 代表本地,userId != null 代表远程。
streamType视频流类型:摄像头或屏幕分享。
width画面宽度
height画面高度

◆ onFirstAudioFrame()

void onFirstAudioFrame ( string  userId)

开始播放远程用户的首帧音频(本地声音暂不通知)

参数
userId远程用户 ID

◆ onSendFirstLocalVideoFrame()

void onSendFirstLocalVideoFrame ( TRTCVideoStreamType  streamType)

首帧本地视频数据已经被送出

SDK 会在 enterRoom() 并 startLocalPreview() 成功后开始摄像头采集,并将采集到的画面进行编码。

当 SDK 成功向云端送出第一帧视频数据后,会抛出这个回调事件。

参数
streamType视频流类型,大画面还是小画面或辅流画面(屏幕分享)

◆ onSendFirstLocalAudioFrame()

void onSendFirstLocalAudioFrame ( )

首帧本地音频数据已经被送出

SDK 会在 enterRoom() 并 startLocalAudio() 成功后开始麦克风采集,并将采集到的声音进行编码。

当 SDK 成功向云端送出第一帧音频数据后,会抛出这个回调事件。

◆ onUserEnter()

void onUserEnter ( string  userId)

废弃接口:有主播加入当前房间

该回调接口可以被看作是 onRemoteUserEnterRoom 的废弃版本,不推荐使用。请使用 onUserVideoAvailable 或 onRemoteUserEnterRoom 进行替代。

该接口已被废弃,不推荐使用

参数
userId用户标识

◆ onUserExit()

void onUserExit ( string  userId,
int  reason 
)

有用户(主播)离开当前房间

该回调接口可以被看作是 onRemoteUserLeaveRoom 的废弃版本,不推荐使用。请使用 onUserVideoAvailable 或 onRemoteUserEnterRoom 进行替代。

该接口已被废弃,不推荐使用

参数
userId用户标识
reason离开原因

◆ onNetworkQuality()

void onNetworkQuality ( TRTCQualityInfo  localQuality,
TRTCQualityInfo[]  remoteQuality,
uint  remoteQualityCount 
)

网络质量:该回调每2秒触发一次,统计当前网络的上行和下行质量

userId == null 代表自己当前的视频质量

参数
localQuality上行网络质量
remoteQuality下行网络质量的数组
remoteQualityCount下行网络质量的数组大小

◆ onStatistics()

void onStatistics ( TRTCStatistics  statis)

技术指标统计回调

如果您是熟悉音视频领域相关术语,可以通过这个回调获取 SDK 的所有技术指标。

如果您是首次开发音视频相关项目,可以只关注 onNetworkQuality 回调。

每2秒回调一次

参数
statis统计数据,包括本地和远程的

◆ onConnectionLost()

void onConnectionLost ( )

SDK 跟服务器的连接断开

◆ onTryToReconnect()

void onTryToReconnect ( )

SDK 尝试重新连接到服务器

◆ onConnectionRecovery()

void onConnectionRecovery ( )

SDK 跟服务器的连接恢复

◆ onSpeedTest()

void onSpeedTest ( TRTCSpeedTestResult  currentResult,
uint  finishedCount,
uint  totalCount 
)

服务器测速的回调,SDK 对多个服务器 IP 做测速,每个 IP 的测速结果通过这个回调通知

参数
currentResult当前完成的测速结果
finishedCount已完成测速的服务器数量
totalCount需要测速的服务器总数量

◆ onCameraDidReady()

void onCameraDidReady ( )

摄像头准备就绪

◆ onMicDidReady()

void onMicDidReady ( )

麦克风准备就绪

◆ onUserVoiceVolume()

void onUserVoiceVolume ( TRTCVolumeInfo[]  userVolumes,
uint  userVolumesCount,
uint  totalVolume 
)

用于提示音量大小的回调,包括每个 userId 的音量和远端总音量

您可以通过调用 TRTCCloud 中的 enableAudioVolumeEvaluation 接口来开关这个回调。

需要注意的是,调用 enableAudioVolumeEvaluation 开启音量回调后,无论频道内是否有人说话,都会按设置的时间间隔调用这个回调;

如果没有人说话,则 userVolumes 为空,totalVolume 为0。

userId 为 null 时表示自己的音量,userVolumes 内仅包含正在说话(音量不为0)的用户音量信息。

参数
userVolumes所有正在说话的房间成员的音量,取值范围0 - 100。
userVolumesCount房间成员数量
totalVolume所有远端成员的总音量, 取值范围0 - 100。

◆ onDeviceChange()

void onDeviceChange ( string  deviceId,
TRTCDeviceType  type,
TRTCDeviceState  state 
)

本地设备通断回调

参数
deviceId设备 ID
type设备类型
state事件类型

◆ onTestMicVolume()

void onTestMicVolume ( uint  volume)

麦克风测试音量回调

麦克风测试接口 startMicDeviceTest 会触发这个回调

参数
volume音量值,取值范围0 - 100

◆ onTestSpeakerVolume()

void onTestSpeakerVolume ( uint  volume)

扬声器测试音量回调

扬声器测试接口 startSpeakerDeviceTest 会触发这个回调

参数
volume音量值,取值范围0 - 100

◆ onRecvCustomCmdMsg()

void onRecvCustomCmdMsg ( string  userId,
int  cmdID,
uint  seq,
byte[]  msg,
uint  msgSize 
)

收到自定义消息回调

当房间中的某个用户使用 sendCustomCmdMsg 发送自定义消息时,房间中的其它用户可以通过 onRecvCustomCmdMsg 接口接收消息

参数
userId用户标识
cmdID命令 ID
seq消息序号
msg消息数据
msgSize消息数据大小

◆ onMissCustomCmdMsg()

void onMissCustomCmdMsg ( string  userId,
int  cmdId,
int  errCode,
int  missed 
)

自定义消息丢失回调

TRTC 所使用的传输通道为 UDP 通道,所以即使设置了 reliable,也做不到100不丢失,只是丢消息概率极低,能满足常规可靠性要求。

在过去的一段时间内(通常为5s),自定义消息在传输途中丢失的消息数量的统计,SDK 都会通过此回调通知出来。

只有在发送端设置了可靠传输(reliable),接收方才能收到消息的丢失回调

参数
userId用户标识
cmdId命令 ID
errCode错误码,当前版本为-1
missed丢失的消息数量

◆ onRecvSEIMsg()

void onRecvSEIMsg ( string  userId,
byte[]  message,
uint  msgSize 
)

收到 SEI 消息的回调

当房间中的某个用户使用 sendSEIMsg 发送数据时,房间中的其它用户可以通过 onRecvSEIMsg 接口接收数据。

参数
userId用户标识
message数据
msgSize数据大小

◆ onStartPublishing()

void onStartPublishing ( int  errCode,
string  errMsg 
)

开始向腾讯云的直播 CDN 推流的回调,对应于 TRTCCloud 中的 startPublishing() 接口

参数
errCode0表示成功,其余值表示失败
errMsg具体错误原因

◆ onStopPublishing()

void onStopPublishing ( int  errCode,
string  errMsg 
)

停止向腾讯云的直播 CDN 推流的回调,对应于 TRTCCloud 中的 stopPublishing() 接口

参数
errCode0表示成功,其余值表示失败
errMsg具体错误原因

◆ onStartPublishCDNStream()

void onStartPublishCDNStream ( int  errCode,
string  errMsg 
)

启动旁路推流到 CDN 完成的回调

对应于 TRTCCloud 的 startPublishCDNStream() 接口

Start 回调如果成功,只能说明转推请求已经成功告知给腾讯云,如果目标 CDN 有异常,还是有可能会转推失败。

参数
errCode错误码,参考 TXLiteAVCode.h
errMsg错误详细信息

◆ onStopPublishCDNStream()

void onStopPublishCDNStream ( int  errCode,
string  errMsg 
)

停止旁路推流到 CDN 完成的回调

对应于 TRTCCloud 中的 stopPublishCDNStream() 接口

参数
errCode错误码,参考 TXLiteAVCode.h
errMsg错误详细信息

◆ onSetMixTranscodingConfig()

void onSetMixTranscodingConfig ( int  errCode,
string  errMsg 
)

设置云端的混流转码参数的回调,对应于 TRTCCloud 中的 setMixTranscodingConfig() 接口

对应于 TRTCCloud 中的 setMixTranscodingConfig() 接口

参数
errCode0表示成功,其余值表示失败
errMsg具体错误原因

◆ onAudioEffectFinished()

void onAudioEffectFinished ( int  effectId,
int  code 
)

播放音效结束回调

参数
effectId音效 ID
code0表示播放正常结束;其他表示异常结束

◆ onScreenCaptureCovered()

void onScreenCaptureCovered ( )

当屏幕分享窗口被遮挡无法正常捕获时,SDK 会通过此回调通知,可在此回调里通知用户移开遮挡窗口

◆ onScreenCaptureStarted()

void onScreenCaptureStarted ( )

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

◆ onScreenCapturePaused()

void onScreenCapturePaused ( int  reason)

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

参数
reason停止原因,0:表示用户主动暂停;1:表示设置屏幕分享参数导致的暂停;2:表示屏幕分享窗口被最小化导致的暂停;3:表示屏幕分享窗口被隐藏导致的暂停

◆ onScreenCaptureResumed()

void onScreenCaptureResumed ( int  reason)

当屏幕分享恢复时,SDK 会通过此回调通知

参数
reason停止原因,0:表示用户主动恢复,1:表示屏幕分享参数设置完毕后自动恢复;2:表示屏幕分享窗口从最小化被恢复;3:表示屏幕分享窗口从隐藏被恢复

◆ onScreenCaptureStoped()

void onScreenCaptureStoped ( int  reason)

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

参数
reason停止原因,0:表示用户主动停止;1:表示屏幕分享窗口被关闭

◆ onPlayBGMBegin()

void onPlayBGMBegin ( TXLiteAVError  errCode)

开始播放背景音乐

参数
errCode错误码

◆ onPlayBGMProgress()

void onPlayBGMProgress ( uint  progressMS,
uint  durationMS 
)

播放背景音乐的进度

参数
progressMS已播放时间
durationMS总时间

◆ onPlayBGMComplete()

void onPlayBGMComplete ( TXLiteAVError  errCode)

播放背景音乐结束

参数
errCode错误码

◆ ManageLiteAV::ITRTCVideoRenderCallback

interface ManageLiteAV::ITRTCVideoRenderCallback

Public 成员函数

void onRenderVideoFrame (string userId, TRTCVideoStreamType streamType, TRTCVideoFrame frame)
 

成员函数说明

◆ onRenderVideoFrame()

void onRenderVideoFrame ( string  userId,
TRTCVideoStreamType  streamType,
TRTCVideoFrame  frame 
)

自定义视频渲染回调

可以通过 setLocalVideoRenderCallback 和 setRemoteVideoRenderCallback 接口设置自定义渲染回调

参数
userId用户标识
streamType流类型:即摄像头还是屏幕分享
frame视频帧数据

◆ ManageLiteAV::ITRTCAudioFrameCallback

interface ManageLiteAV::ITRTCAudioFrameCallback

Public 成员函数

void onCapturedAudioFrame (TRTCAudioFrame frame)
 
void onPlayAudioFrame (TRTCAudioFrame frame, string userId)
 
void onMixedPlayAudioFrame (TRTCAudioFrame frame)
 

成员函数说明

◆ onCapturedAudioFrame()

void onCapturedAudioFrame ( TRTCAudioFrame  frame)

本地麦克风采集到的音频数据回调

  • 请不要在此回调函数中做任何耗时操作,建议直接拷贝到另一线程进行处理,否则会导致各种声音问题。

- 此接口回调出的音频数据支持修改。

- 此接口回调出的音频时间帧长固定为0.02s。

由时间帧长转化为字节帧长的公式为【采样率 × 时间帧长 × 声道数 × 采样点位宽】。

以SDK默认的音频录制格式48000采样率、单声道、16采样点位宽为例,字节帧长为【48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节】。

- 此接口回调出的音频数据包含背景音、音效、混响等前处理效果。

参数
frame音频数据

◆ onPlayAudioFrame()

void onPlayAudioFrame ( TRTCAudioFrame  frame,
string  userId 
)

混音前的每一路远程用户的音频数据(例如您要对某一路的语音进行文字转换,必须要使用这里的原始数据,而不是混音之后的数据)

  • 请不要在此回调函数中做任何耗时操作,建议直接拷贝到另一线程进行处理,否则会导致各种声音问题。

- 此接口回调出的音频数据是只读的,不支持修改。

参数
frame音频数据
userId用户标识

◆ onMixedPlayAudioFrame()

void onMixedPlayAudioFrame ( TRTCAudioFrame  frame)

各路音频数据混合后送入喇叭播放的音频数据

  • 请不要在此回调函数中做任何耗时操作,建议直接拷贝到另一线程进行处理,否则会导致各种声音问题。

- 此接口回调出的音频数据支持修改。

- 此接口回调出的音频时间帧长固定为0.02s。

由时间帧长转化为字节帧长的公式为【采样率 × 时间帧长 × 声道数 × 采样点位宽】。

以SDK默认的音频播放格式48000采样率、双声道、16采样点位宽为例,字节帧长为【48000 × 0.02s × 2 × 16bit = 30720bit = 3840字节】。

- 此接口回调出的音频数据是各路音频播放数据的混合,不包含耳返的音频数据。

参数
frame音频数据

◆ ManageLiteAV::ITRTCLogCallback

interface ManageLiteAV::ITRTCLogCallback

Public 成员函数

void onLog (string log, TRTCLogLevel level, string module)
 

成员函数说明

◆ onLog()

void onLog ( string  log,
TRTCLogLevel  level,
string  module 
)

有日志打印时的回调

参数
log日志内容
level日志等级 参见 TRTCLogLevel
module暂无具体意义,目前为固定值 TXLiteAVSDK