TRTCCloudListenerEnum enum
监听器类型枚举
Constants
- onAudioRouteChanged → const TRTCCloudListenerEnum
-
音频路由发生变化,音频路由即声音由哪里输出(扬声器或听筒)
const TRTCCloudListenerEnum(22)
- onCameraDidReady → const TRTCCloudListenerEnum
-
摄像头准备就绪。
const TRTCCloudListenerEnum(20)
- onConnectionLost → const TRTCCloudListenerEnum
-
SDK 跟服务器的连接断开
const TRTCCloudListenerEnum(16)
- onConnectionRecovery → const TRTCCloudListenerEnum
-
SDK 跟服务器的连接恢复。
const TRTCCloudListenerEnum(18)
- onEnterRoom → const TRTCCloudListenerEnum
-
已加入房间的回调
调用 TRTCCloud 中的 enterRoom() 接口执行进房操作后,会收到来自 SDK 的 onEnterRoom(result) 回调:
如果加入成功,result 会是一个正数(result > 0),代表加入房间的时间消耗,单位是毫秒(ms)。
如果加入失败,result 会是一个负数(result < 0),代表进房失败的错误码。
参数param:
result > 0 时为进房耗时(ms),result < 0 时为进房错误码
const TRTCCloudListenerEnum(2)
- onError → const TRTCCloudListenerEnum
-
错误回调,表示 SDK 不可恢复的错误,一定要监听并分情况给用户适当的界面提示
参数param:
errCode 错误码
errMsg 错误信息
extraInfo 扩展信息字段,个别错误码可能会带额外的信息帮助定位问题
const TRTCCloudListenerEnum(0)
- onExitRoom → const TRTCCloudListenerEnum
-
离开房间的事件回调
调用 TRTCCloud 中的 exitRoom() 接口会执行退出房间的相关逻辑,例如释放音视频设备资源和编解码器资源等。 待资源释放完毕,SDK 会通过 onExitRoom() 回调通知到您。
如果您要再次调用 enterRoom() 或者切换到其他的音视频 SDK,请等待 onExitRoom() 回调到来之后再执行相关操作。 否则可能会遇到音频设备被占用等各种异常问题。
参数param:
reason 离开房间原因,0:主动调用 exitRoom 退房;1:被服务器踢出当前房间;2:当前房间整个被解散。
const TRTCCloudListenerEnum(3)
- onFirstAudioFrame → const TRTCCloudListenerEnum
-
开始播放远程用户的首帧音频(本地声音暂不通知)。
参数param:
userId 远程用户 ID。
const TRTCCloudListenerEnum(11)
- onFirstVideoFrame → const TRTCCloudListenerEnum
-
开始渲染本地或远程用户的首帧画面
如果 userId 为 null,代表开始渲染本地采集的摄像头画面,需要您先调用 startLocalPreview 触发。 如果 userId 不为 null,代表开始渲染远程用户的首帧画面,需要您先调用 startRemoteView 触发。
只有当您调用 startLocalPreview()、startRemoteView() 或 startRemoteSubStreamView() 之后,才会触发该回调。
参数param:
userId 本地或远程用户 ID,如果 userId == null 代表本地,userId != null 代表远程。
streamType 视频流类型:摄像头或屏幕分享。
width 画面宽度
height 画面高度
const TRTCCloudListenerEnum(10)
- onMicDidReady → const TRTCCloudListenerEnum
-
麦克风准备就绪
const TRTCCloudListenerEnum(21)
- onMusicObserverComplete → const TRTCCloudListenerEnum
-
背景音乐已播放完毕
const TRTCCloudListenerEnum(27)
- onMusicObserverPlayProgress → const TRTCCloudListenerEnum
-
背景音乐的播放进度
const TRTCCloudListenerEnum(26)
- onMusicObserverStart → const TRTCCloudListenerEnum
-
背景音乐开始播放
const TRTCCloudListenerEnum(25)
- onNetworkQuality → const TRTCCloudListenerEnum
-
网络质量:该回调每2秒触发一次,统计当前网络的上行和下行质量。
userId 为本地用户 ID 代表自己当前的视频质量
参数param:
localQuality 上行网络质量
remoteQuality 下行网络质量
const TRTCCloudListenerEnum(14)
- onRemoteUserEnterRoom → const TRTCCloudListenerEnum
-
有用户加入当前房间。
出于性能方面的考虑,在两种不同的应用场景下,该通知的行为会有差别:
通话场景(TRTCCloudDef.TRTC_APP_SCENE_VIDEOCALL 和 TRTCCloudDef.TRTC_APP_SCENE_AUDIOCALL):该场景下用户没有角色的区别,任何用户进入房间都会触发该通知。
直播场景(TRTCCloudDef.TRTC_APP_SCENE_LIVE 和 TRTCCloudDef.TRTC_APP_SCENE_VOICE_CHATROOM):该场景不限制观众的数量,如果任何用户进出都抛出回调会引起很大的性能损耗,所以该场景下只有主播进入房间时才会触发该通知,观众进入房间不会触发该通知。
参数param:
userId 用户标识
const TRTCCloudListenerEnum(5)
- onRemoteUserLeaveRoom → const TRTCCloudListenerEnum
-
有用户离开当前房间。
与 onRemoteUserEnterRoom 相对应,在两种不同的应用场景下,该通知的行为会有差别:
通话场景(TRTCCloudDef.TRTC_APP_SCENE_VIDEOCALL 和 TRTCCloudDef.TRTC_APP_SCENE_AUDIOCALL):该场景下用户没有角色的区别,任何用户的离开都会触发该通知。
直播场景(TRTCCloudDef.TRTC_APP_SCENE_LIVE 和 TRTCCloudDef.TRTC_APP_SCENE_VOICE_CHATROOM):只有主播离开房间时才会触发该通知,观众离开房间不会触发该通知。
参数param:
userId 用户标识
reason 离开原因,0表示用户主动退出房间,1表示用户超时退出,2表示被踢出房间。
const TRTCCloudListenerEnum(6)
- onSendFirstLocalAudioFrame → const TRTCCloudListenerEnum
-
首帧本地音频数据已经被送出
SDK 会在 enterRoom() 并 startLocalAudio() 成功后开始麦克风采集,并将采集到的声音进行编码。 当 SDK 成功向云端送出第一帧音频数据后,会抛出这个回调事件。
const TRTCCloudListenerEnum(13)
- onSendFirstLocalVideoFrame → const TRTCCloudListenerEnum
-
首帧本地音频数据已经被送出。
SDK 会在 enterRoom() 并 startLocalPreview() 成功后开始摄像头采集,并将采集到的画面进行编码。 当 SDK 成功向云端送出第一帧视频数据后,会抛出这个回调事件。
参数param:
streamType 视频流类型,大画面、小画面或辅流画面(屏幕分享)
const TRTCCloudListenerEnum(12)
- onSetMixTranscodingConfig → const TRTCCloudListenerEnum
-
设置云端的混流转码参数的回调,对应于 TRTCCloud 中的 setMixTranscodingConfig() 接口。
参数param:
errCode 0表示成功,其余值表示失败
errMsg 具体错误原因
const TRTCCloudListenerEnum(24)
- onSnapshotComplete → const TRTCCloudListenerEnum
-
截图完成时回调
参数
errorCode为0表示截图成功,其他值表示失败
const TRTCCloudListenerEnum(28)
- onSpeedTest → const TRTCCloudListenerEnum
-
服务器测速的回调,SDK 对多个服务器 IP 做测速,每个 IP 的测速结果通过这个回调通知。
参数param:
currentResult 当前完成的测速结果
finishedCount 已完成测速的服务器数量
totalCount 需要测速的服务器总数量
const TRTCCloudListenerEnum(19)
- onStatistics → const TRTCCloudListenerEnum
-
技术指标统计回调
如果您是熟悉音视频领域相关术语,可以通过这个回调获取 SDK 的所有技术指标。 如果您是首次开发音视频相关项目,可以只关注 onNetworkQuality 回调。
注意:每2秒回调一次
参数param:
statics 状态数据
const TRTCCloudListenerEnum(15)
- onSwitchRole → const TRTCCloudListenerEnum
-
切换角色的事件回调
调用 TRTCCloud 中的 switchRole() 接口会切换主播和观众的角色,该操作会伴随一个线路切换的过程, 待 SDK 切换完成后,会抛出 onSwitchRole() 事件回调。
参数param:
errCode 错误码,0代表切换成功
errMsg 错误信息。
const TRTCCloudListenerEnum(4)
- onTryToReconnect → const TRTCCloudListenerEnum
-
SDK 尝试重新连接到服务器。
const TRTCCloudListenerEnum(17)
- onUserAudioAvailable → const TRTCCloudListenerEnum
-
远端用户是否存在可播放的音频数据
参数param:
userId 用户标识
available 声音是否开启
const TRTCCloudListenerEnum(9)
- onUserSubStreamAvailable → const TRTCCloudListenerEnum
-
远端用户是否存在可播放的辅路画面(一般用于屏幕分享)
参数param:
userId 用户标识
available 屏幕分享是否开启
const TRTCCloudListenerEnum(8)
- onUserVideoAvailable → const TRTCCloudListenerEnum
-
远端用户是否存在可播放的主路画面(一般用于摄像头)
当您收到 onUserVideoAvailable(userId, true) 通知时,表示该路画面已经有可用的视频数据帧到达。 此时,您需要调用 startRemoteView(userid) 接口加载该用户的远程画面。 然后,您会收到名为 onFirstVideoFrame(userid) 的首帧画面渲染回调。
当您收到 onUserVideoAvailable(userId, false) 通知时,表示该路远程画面已经被关闭,可能由于该用户调用了 muteLocalVideo() 或 stopLocalPreview()。
参数param:
userId 用户标识
available 画面是否开启
const TRTCCloudListenerEnum(7)
- onUserVoiceVolume → const TRTCCloudListenerEnum
-
用于提示音量大小的回调,包括每个 userId 的音量和远端总音量。
您可以通过调用 TRTCCloud 中的 enableAudioVolumeEvaluation 接口来开关这个回调或者设置它的触发间隔。 需要注意的是,调用 enableAudioVolumeEvaluation 开启音量回调后,无论频道内是否有人说话,都会按设置的时间间隔调用这个回调; 如果没有人说话,则 userVolumes 为空,totalVolume 为0。
注意:userId 为本地用户 ID 时表示自己的音量,userVolumes 内仅包含正在说话(音量不为0)的用户音量信息。
参数param:
userVolumes 所有正在说话的房间成员的音量,取值范围0 - 100。
totalVolume 所有远端成员的总音量, 取值范围0 - 100。
const TRTCCloudListenerEnum(23)
- onWarning → const TRTCCloudListenerEnum
-
警告回调,用于告知您一些非严重性问题,例如出现卡顿或者可恢复的解码失败。
参数param:
warningCode 错误码
warningMsg 警告信息
extraInfo 扩展信息字段,个别警告码可能会带额外的信息帮助定位问题
const TRTCCloudListenerEnum(1)
-
values
→ const List<
TRTCCloudListenerEnum> -
A constant List of the values in this enum, in order of their declaration.
const List<
TRTCCloudListenerEnum>
Properties
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed. [...]
inherited
-
toString(
) → String -
Returns a string representation of this object.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator. [...]
inherited