详细描述
通过频道事件回调可以监听和报告指定频道的事件和数据。
方法
onJoinSuccess
定义
- (void)onJoinSuccess:(NSString*)channelName uid:(NSUInteger)uid role:(QttChannelRole)role muted:(bool)muted;
|
说明
自己加入成功,实现加入频道成功的逻辑。
参数
参数名 |
说明 |
channelName |
频道名字 |
uid |
用户id。如果用户加入频道前没有设置id,这位服务器自动分配的id |
role |
加入频道的角色。TALKER表示主播,可说可听;AUDIENCE表示听众,只能听不能说 |
muted |
加入频道的静音状态。0表示未静音,1表示静音 |
方法
onReJoinSuccess
定义
- (void)onReJoinSuccess:(NSString*)channelName uid:(NSUInteger)uid role:(QttChannelRole)role muted:(bool)muted;
|
说明
自己重新加入频道成功,实现重新加入频道成功的逻辑。
参数
参数名 |
说明 |
channelName |
频道名字 |
uid |
用户id。如果用户加入频道前没有设置id,这位服务器自动分配的id |
role |
加入频道的角色。TALKER表示主播,可说可听;AUDIENCE表示听众,只能听不能说 |
muted |
加入频道的静音状态。0表示未静音,1表示静音 |
onOtherJoin
定义
- (void)onOtherJoin:(NSUInteger)uid role:(QttChannelRole)role muted:(bool)muted;
|
说明
其他用户加入,实现别人进入频道的逻辑。
参数
参数名 |
说明 |
uid |
加入频道的用户id |
role |
加入频道的角色。TALKER表示主播,可说可听;AUDIENCE表示听众,只能听不能说 |
muted |
加入频道的静音状态。0表示未静音,1表示静音 |
onJoinFail
定义
- (void)onJoinFail:(int)code message:(NSString*)message;
|
说明
自己加入失败,实现加入频道失败的逻辑。
参数
参数名 |
说明 |
code |
失败状态 |
message |
失败信息 |
onConnectionBreak
定义
- (void)onConnectionBreak;
|
说明
网络打断。
onConnectionLost
定义
- (void)onConnectionLost;
|
说明
网络失去连接。
onError
定义
- (void)onError:(int)err message:(NSString*)message;
|
说明
运行过程中的错误信息,SDK无法自行恢复。一般情况下应用需要提示用户并进行对应的处理。
参数
参数名 |
说明 |
err |
错误码 |
message |
错误描述 |
onWarning
定义
- (void)onWarning:(int)warn message:(NSString*)message;
|
说明
运行过程中的警告信息,通常是网络或者音频设备相关的。一般情况下应用可以忽略,SDK会自己尝试恢复。
参数
参数名 |
说明 |
warn |
警告码 |
message |
警告描述 |
onLeave
定义
说明
实现退出频道的逻辑。
onOtherLeave
定义
- (void)onOtherLeave:(NSUInteger)uid role:(QttChannelRole)role;
|
说明
其他用户离开,实现别人离开频道的逻辑。
参数
参数名 |
说明 |
uid |
离开频道用户的id |
role |
离开频道用户的角色 |
onTalkingVolumeIndication
定义
- (void)onTalkingVolumeIndication:(NSArray<QttVolumeInfo*> *_Nonnull)volumeInfos userNum:(NSInteger)userNum;
|
说明
用户音量提示
参数
参数名 |
说明 |
volumeInfos |
用户音量信息集合 |
userNum |
volumeInfos中用户个数 |
onMuteStatusChanged
定义
- (void)onMuteStatusChanged:(NSUInteger)uid muted:(bool) muted;
|
说明
用户mute状态,实现静音状态改变的逻辑。
参数
参数名 |
说明 |
uid |
用户id。如果为0,表示自己静音状态,否则表示他人静音状态 |
muted |
0表示未静音,1表示静音 |
onRoleStatusChanged
定义
- (void)onRoleStatusChanged:(NSUInteger)uid role:(QttChannelRole)role;
|
说明
用户角色状态,实现角色状态改变的逻辑。
参数
参数名 |
说明 |
uid |
用户id。如果为0,表示自己角色状态,否则表示他人角色状态 |
role |
TALKER表示主播,可说可听;AUDIENCE表示听众,只能听不能说 |
onNetworkStats
定义
- (void)onNetworkStats:(NSUInteger)uid txQuality:(QttQualityType)txQuality rxQuality:(QttQualityType)rxQuality stat:(QttRtcStat*)stat;
|
说明
当前通话网络统计回调,通话中每两秒触发一次。
参数
参数名 |
说明 |
uid |
用户ID。表示该ID的用户的网络质量,如果为0,表示本地用户的网络质量 |
txQuality |
该用户的上行网络质量 |
rxQuality |
该用户的下行网络质量 |
stat |
通话相关的统计信息 |
onAudioRouteChanged
定义
- (void)onAudioRouteChanged:(int)route;
|
说明
语音路由变更。
参数
onSoundStateChanged
定义
- (void)onSoundStateChanged:(int)state;
|
说明
音乐文件播放状态发生改变。
参数
onEffectFinished
定义
- (void)onEffectFinished:(int)effectId;
|
说明
音效文件播放完毕
参数
onUserEnableVideo
定义
- (void)onUserEnableVideo:(uint32_t)uid enabled:(bool)enabled;
|
说明
远端用户开/关视频模块回调。
该回调是由远端用户调用 enableVideo 或 disableVideo 方法开启或关闭视频模块触发的。
参数
参数名 |
说明 |
uid |
uid 用户 ID,提示是哪个用户的视频流 |
enabled |
true:该用户已启用视频功能;false:该用户已关闭视频功能。 |
onUserEnableLocalVideo
定义
- (void)onUserEnableLocalVideo:(uint32_t)uid enabled:(bool)enabled;
|
说明
远端用户开/关视频模块回调。
该回调是由远端用户调用 enableLocalVideo 方法开启或关闭视频模块触发的。
参数
参数名 |
说明 |
uid |
uid 用户 ID,提示是哪个用户的视频流 |
enabled |
true:该用户已启用本地视频功能。启用后,其他用户可以接收到该用户的视频流;false:该用户已关闭视频功能。关闭后,该用户仍然可以接收其他用户的视频流,但其他用户接收不到该用户的视频流 |
onUserMuteVideo
定义
- (void)onUserMuteVideo:(uint32_t)uid enabled:(bool)enabled;
|
说明
远端用户取消或恢复发布视频流回调。
当远端用户调用muteLocalVideoStream取消或恢复发布视频流时,SDK会触发该回调向本地用户报告远端用户的发流状况
参数
参数名 |
说明 |
uid |
远端用户UID |
muted |
远端用户是否取消发布视频流:true:取消发布视频流;false:发布视频流 |