Interface ITRTCCloudCallback

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

Namespace: trtc

Assembly: cs.temp.dll.dll

Syntax

public interface ITRTCCloudCallback

Methods

onAudioDeviceCaptureVolumeChanged(Int32, Boolean)

6.7 当前音频采集设备音量变化通知

Declaration

void onAudioDeviceCaptureVolumeChanged(int volume, bool muted)

Parameters

Type	Name	Description
System.Int32	volume	音量值，取值范围0 - 100
System.Boolean	muted	当前采集音频设备是否被静音，true：静音；false：取消静音

Remarks

使用 enableAudioVolumeEvaluation（interval>0）开启，（interval==0）关闭

onAudioDevicePlayoutVolumeChanged(Int32, Boolean)

当前音频播放设备音量变化通知

Declaration

void onAudioDevicePlayoutVolumeChanged(int volume, bool muted)

Parameters

Type	Name	Description
System.Int32	volume	音量值，取值范围0 - 100
System.Boolean	muted	当前音频播放设备是否被静音，true：静音；false：取消静音

Remarks

使用 enableAudioVolumeEvaluation（interval>0）开启，（interval==0）关闭

onCameraDidReady()

6.1 摄像头准备就绪

Declaration

void onCameraDidReady()

onConnectionLost()

5.1 SDK 跟服务器的连接断开

Declaration

void onConnectionLost()

onConnectionRecovery()

5.3 SDK 跟服务器的连接恢复

Declaration

void onConnectionRecovery()

onConnectOtherRoom(String, TXLiteAVError, String)

2.4 请求跨房通话（主播 PK）的结果回调

调用 TRTCCloud 中的 connectOtherRoom() 接口会将两个不同房间中的主播拉通视频通话，也就是所谓的“主播PK”功能。调用者会收到 onConnectOtherRoom() 回调来获知跨房通话是否成功，如果成功，两个房间中的所有用户都会收到 PK 主播的 onUserVideoAvailable() 回调。

Declaration

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

Parameters

Type	Name	Description
System.String	userId	要 PK 的目标主播 userId。
TXLiteAVError	errCode	错误码，ERR_NULL 代表切换成功，其他请参见错误码。
System.String	errMsg	错误信息

onDeviceChange(String, TRTCDeviceType, TRTCDeviceState)

6.4 本地设备通断回调

Declaration

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

Parameters

Type	Name	Description
String	deviceId	设备 ID
TRTCDeviceType	type	设备类型
TRTCDeviceState	state	事件类型

onDisconnectOtherRoom(TXLiteAVError, String)

2.5 结束跨房通话（主播 PK）的结果回调

Declaration

void onDisconnectOtherRoom(TXLiteAVError errCode, string errMsg)

Parameters

Type	Name	Description
TXLiteAVError	errCode	错误码，ERR_NULL 代表切换成功，其他请参见错误码。
System.String	errMsg	错误信息

onEnterRoom(Int32)

2.1 已加入房间的回调

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

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

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

进房失败的错误码含义请参见 [错误码](https://cloud.tencent.com/document/product/647/32257)。

Declaration

void onEnterRoom(int result)

Parameters

Type	Name	Description
System.Int32	result	result > 0 时为进房耗时（ms），result < 0 时为进房错误码。

Remarks

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

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

onError(TXLiteAVError, String, IntPtr)

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

Declaration

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

Parameters

Type	Name	Description
TXLiteAVError	errCode	错误码
String	errMsg	错误信息
IntPtr	arg	扩展信息字段，个别错误码可能会带额外的信息帮助定位问题

onExitRoom(Int32)

2.2 离开房间的事件回调

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

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

Declaration

void onExitRoom(int reason)

Parameters

Type	Name	Description
System.Int32	reason	离开房间原因，0：主动调用 exitRoom 退房；1：被服务器踢出当前房间；2：当前房间整个被解散。

onFirstAudioFrame(String)

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

Declaration

void onFirstAudioFrame(String userId)

Parameters

Type	Name	Description
String	userId	远程用户 ID

onFirstVideoFrame(String, TRTCVideoStreamType, Int32, Int32)

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

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

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

Declaration

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

Parameters

Type	Name	Description
String	userId	本地或远程用户 ID，如果 userId == null 代表本地，userId != null 代表远程。
TRTCVideoStreamType	streamType	视频流类型：摄像头或屏幕分享。
System.Int32	width	画面宽度
System.Int32	height	画面高度

Remarks

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

onMicDidReady()

6.2 麦克风准备就绪

Declaration

void onMicDidReady()

onMissCustomCmdMsg(String, Int32, Int32, Int32)

7.2 自定义消息丢失回调

实时音视频使用 UDP 通道，即使设置了可靠传输（reliable）也无法确保100@%不丢失，只是丢消息概率极低，能满足常规可靠性要求。

在发送端设置了可靠传输（reliable）后，SDK 都会通过此回调通知过去时间段内（通常为5s）传输途中丢失的自定义消息数量统计信息。

Declaration

void onMissCustomCmdMsg(String userId, int cmdID, int errCode, int missed)

Parameters

Type	Name	Description
String	userId	用户标识
System.Int32	cmdID	命令 ID
System.Int32	errCode	错误码
System.Int32	missed	丢失的消息数量

Remarks

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

onNetworkQuality(TRTCQualityInfo, TRTCQualityInfo[], UInt32)

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

Declaration

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

Parameters

Type	Name	Description
TRTCQualityInfo	localQuality	上行网络质量
TRTCQualityInfo[]	remoteQuality	下行网络质量的数组
UInt32	remoteQualityCount	下行网络质量的数组大小

Remarks

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

onRecvCustomCmdMsg(String, Int32, Int32, Byte[], Int32)

7.1 收到自定义消息回调

Declaration

void onRecvCustomCmdMsg(String userId, int cmdID, int seq, Byte[] message, int messageSize)

Parameters

Type	Name	Description
String	userId	用户标识
System.Int32	cmdID	命令 ID
System.Int32	seq	消息序号
Byte[]	message	消息数据
System.Int32	messageSize	消息数据大小

onRecvSEIMsg(String, Byte[], UInt32)

7.3 收到 SEI 消息的回调

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

Declaration

void onRecvSEIMsg(String userId, Byte[] message, UInt32 msgSize)

Parameters

Type	Name	Description
String	userId	用户标识
Byte[]	message	数据
UInt32	msgSize	数据大小

onRemoteUserEnterRoom(String)

3.1 有用户加入当前房间

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

- 通话场景（TRTCAppSceneVideoCall 和 TRTCAppSceneAudioCall）：该场景下用户没有角色的区别，任何用户进入房间都会触发该通知。

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

Declaration

void onRemoteUserEnterRoom(String userId)

Parameters

Type	Name	Description
String	userId	用户标识

Remarks

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

onRemoteUserLeaveRoom(String, Int32)

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

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

- 通话场景（TRTCAppSceneVideoCall 和 TRTCAppSceneAudioCall）：该场景下用户没有角色的区别，任何用户的离开都会触发该通知。

- 直播场景（TRTCAppSceneLIVE 和 TRTCAppSceneVoiceChatRoom）：只有主播离开房间时才会触发该通知，观众离开房间不会触发该通知。

Declaration

void onRemoteUserLeaveRoom(String userId, int reason)

Parameters

Type	Name	Description
String	userId	用户标识
System.Int32	reason	离开原因，0表示用户主动退出房间，1表示用户超时退出，2表示被踢出房间。

onScreenCapturePaused(Int32)

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

Declaration

void onScreenCapturePaused(int reason)

Parameters

Type	Name	Description
System.Int32	reason	停止原因，0：表示用户主动暂停；1：表示设置屏幕分享参数导致的暂停；2：表示屏幕分享窗口被最小化导致的暂停；3：表示屏幕分享窗口被隐藏导致的暂停

onScreenCaptureResumed(Int32)

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

Declaration

void onScreenCaptureResumed(int reason)

Parameters

Type	Name	Description
System.Int32	reason	停止原因，0：表示用户主动恢复，1：表示屏幕分享参数设置完毕后自动恢复；2：表示屏幕分享窗口从最小化被恢复；3：表示屏幕分享窗口从隐藏被恢复

onScreenCaptureStarted()

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

Declaration

void onScreenCaptureStarted()

onScreenCaptureStoped(Int32)

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

Declaration

void onScreenCaptureStoped(int reason)

Parameters

Type	Name	Description
System.Int32	reason	停止原因，0：表示用户主动停止；1：表示屏幕分享窗口被关闭

onSendFirstLocalAudioFrame()

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

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

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

Declaration

void onSendFirstLocalAudioFrame()

onSendFirstLocalVideoFrame(TRTCVideoStreamType)

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

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

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

Declaration

void onSendFirstLocalVideoFrame(TRTCVideoStreamType streamType)

Parameters

Type	Name	Description
TRTCVideoStreamType	streamType	视频流类型，大画面还是小画面或辅流画面（屏幕分享）

onSetMixTranscodingConfig(Int32, String)

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

Declaration

void onSetMixTranscodingConfig(int errCode, String errMsg)

Parameters

Type	Name	Description
System.Int32	errCode	0表示成功，其余值表示失败
String	errMsg	具体错误原因

onSpeedTest(TRTCSpeedTestResult, Int32, Int32)

Declaration

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

Parameters

Type	Name	Description
TRTCSpeedTestResult	currentResult
System.Int32	finishedCount
System.Int32	totalCount

onStartPublishCDNStream(Int32, String)

8.3 对应于 TRTCCloud 中的 startPublishCDNStream() 接口注意：Start 回调如果成功，只能说明转推请求已经成功告知给腾讯云，如果目标 CDN 有异常，还是有可能会转推失败。

Declaration

void onStartPublishCDNStream(int errCode, String errMsg)

Parameters

Type	Name	Description
System.Int32	errCode	0表示成功，其余值表示失败
String	errMsg	具体错误原因

onStartPublishing(Int32, String)

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

Declaration

void onStartPublishing(int errCode, String errMsg)

Parameters

Type	Name	Description
System.Int32	errCode	0表示成功，其余值表示失败
String	errMsg	具体错误原因

onStatistics(TRTCStatistics)

4.2 技术指标统计回调

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

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

Declaration

void onStatistics(TRTCStatistics statis)

Parameters

Type	Name	Description
TRTCStatistics	statis	统计数据，包括本地和远程的

Remarks

每2秒回调一次

onStopPublishCDNStream(Int32, String)

8.4 停止旁路推流到 CDN 完成的回调对应于 TRTCCloud 中的 stopPublishCDNStream() 接口

Declaration

void onStopPublishCDNStream(int errCode, String errMsg)

Parameters

Type	Name	Description
System.Int32	errCode	0表示成功，其余值表示失败
String	errMsg	具体错误原因

onStopPublishing(Int32, String)

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

Declaration

void onStopPublishing(int errCode, String errMsg)

Parameters

Type	Name	Description
System.Int32	errCode	0表示成功，其余值表示失败
String	errMsg	具体错误原因

onSwitchRole(TXLiteAVError, String)

2.3 切换角色结果回调

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

Declaration

void onSwitchRole(TXLiteAVError errCode, String errMsg)

Parameters

Type	Name	Description
TXLiteAVError	errCode	错误码，ERR_NULL 代表切换成功，其他请参见错误码。
String	errMsg	错误信息

onSwitchRoom(TXLiteAVError, String)

2.6 切换房间 (switchRoom) 的结果回调

Declaration

void onSwitchRoom(TXLiteAVError errCode, string errMsg)

Parameters

Type	Name	Description
TXLiteAVError	errCode	错误码，ERR_NULL 代表切换成功，其他请参见错误码。
System.String	errMsg	错误信息

onTestMicVolume(Int32)

6.5 麦克风测试音量回调

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

Declaration

void onTestMicVolume(int volume)

Parameters

Type	Name	Description
System.Int32	volume	音量值，取值范围0 - 100

onTestSpeakerVolume(Int32)

6.6 扬声器测试音量回调

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

Declaration

void onTestSpeakerVolume(int volume)

Parameters

Type	Name	Description
System.Int32	volume	音量值，取值范围0 - 100

onTryToReconnect()

5.2 SDK 尝试重新连接到服务器

Declaration

void onTryToReconnect()

onUserAudioAvailable(String, Boolean)

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

Declaration

void onUserAudioAvailable(String userId, bool available)

Parameters

Type	Name	Description
String	userId	用户标识
System.Boolean	available	声音是否开启

onUserSubStreamAvailable(String, Boolean)

3.4 用户是否开启屏幕分享

Declaration

void onUserSubStreamAvailable(String userId, bool available)

Parameters

Type	Name	Description
String	userId	用户标识
System.Boolean	available	屏幕分享是否开启

onUserVideoAvailable(String, Boolean)

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

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

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

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

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

Declaration

void onUserVideoAvailable(String userId, bool available)

Parameters

Type	Name	Description
String	userId	用户标识
System.Boolean	available	画面是否开启

onUserVoiceVolume(TRTCVolumeInfo[], UInt32, UInt32)

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

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

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

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

Declaration

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

Parameters

Type	Name	Description
TRTCVolumeInfo[]	userVolumes	所有正在说话的房间成员的音量，取值范围0 - 100。
UInt32	userVolumesCount	房间成员数量
UInt32	totalVolume	所有远端成员的总音量, 取值范围0 - 100。

Remarks

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

onWarning(TXLiteAVWarning, String, IntPtr)

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

Declaration

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

Parameters

Type	Name	Description
TXLiteAVWarning	warningCode	错误码
String	warningMsg	警告信息
IntPtr	arg	扩展信息字段，个别警告码可能会带额外的信息帮助定位问题