版本支持: v1.0.0+
回调说明: 登录结果
/**
登录结果
只有在调用登录接口后会触发回调,退出登录不会触发
@param user 登陆成功时返回用户信息,登录失败时返回对应的错误码
@param success 是否登录成功
*/
- (void)nemoSDKDidLoginResult:(nullable XYUser *)user success:(BOOL)success;
参数说明:
参数名 | 类型 | 说明 |
user | 登陆成功时返回用户信息,登录失败时返回对应的错误码 | |
success | BOOL | 是否登录成功 |
版本支持: v1.0.0+
回调说明: 登录后与小鱼的连接状态
/**
登录后与小鱼的连接状态
登录成功后小鱼SDK会与服务器保持长连接,所有的会议都需要建立在长连接正常情况下,长连接断开后约40s左右会议被迫中断
所以,建议您在保证此接口isConnect=YES时再进行呼叫入会等相关操作,退出登录后长连接会断开
@param isConnect 是否连接
*/
- (void)nemoSDKDidConnectStateWithNemo:(BOOL)isConnect;
参数说明:
参数名 | 类型 | 说明 |
isConnect | BOOL | 是否连接 |
版本支持: v1.0.0+
回调说明: 登出状态
/**
登出状态
调用退出登录接口后触发
@param success 登出是否成功
*/
- (void)nemoSDKDidLogoutState:(BOOL)success;
参数说明:
参数名 | 类型 | 说明 |
success | BOOL | 登出是否成功 |
版本支持: v1.0.0+
回调说明: 被迫下线
/**
被迫下线
同一个账号在其他设备登录时,当前的设备会被强制下线,小鱼不允许同一账号同时在多台移动设备上同时登录,但是允许同一个账号同时在移动端和桌面端登录
*/
- (void)nemoSDKDidAccountWasKickOut;
参数说明: 无
版本支持: v1.0.0+
回调说明: 呼叫状态的回调
/**
呼叫状态的回调
此接口返回整个会议的状态,调用makeCall开会呼叫之后会返回
NemoCallState_Connecting表示正在连接会议室,
NemoCallState_Connected表示已经成功进入会议室
NemoCallState_DisConnected表示会议已经断开,正常结束时reason返回”state:200“,异常结束时返回对应的错误码,可查阅错误码文档获取详情信息
@param info 会议状态信息
*/
- (void)nemoSDKDidCallStateChange:(NemoMeetingStateInfo *)info;
参数说明:
参数名 | 类型 | 说明 |
info | 会议状态信息(3.3.1之前为number、callState、reason) |
版本支持: v1.0.0+
回调说明: 接收到会议邀请或点对点呼叫
/**
接收到会议邀请或点对点呼叫
只有在登录并且长连接正常时,小鱼才能正确下发邀请回调,收到点对点呼叫邀请时,您必须先挂断当前会议再接受邀请,
如果您想点对点呼叫他人,需要在makeCall时传入callNumber,callNumber可以从XYUser获取
@param inComingCallInfo 远端信息
*/
- (void)nemoSDKDidReceiveCall:(NemoInComingCallInfo *)inComingCallInfo;
参数说明:
参数名 | 类型 | 说明 |
inComingCallInfo | 远端信息 |
版本支持: v1.0.0+
回调说明: 分享内容回调
/**
分享内容回调
只有您自己发起分享图片或屏幕时才会触发,另外一种情况是:您正在分享被会中其他人抢断,也会触发
@param type 类型
@param state 状态
*/
- (void)nemoSDKDidContentShareStateChanged:(NemoShareContentType)type state:(NemoShareContentState)state;
参数说明:
参数名 | 类型 | 说明 |
type | 类型 | |
state | 状态 |
版本支持: v1.0.0+
回调说明: 视频流信息改变回调
/**
视频流信息改变回调
调用setCustomLayout请流之后会触发,返回您请求的视频流,如果会议中的视频流状态发生变化时也会触发
您需要监听此接口,通过返回的视频流数据来刷新页面
@param videos 当前通话视频信息,与会人Stream信息数组(包含streamID和其他stream信息)
*/
- (void)nemoSDKDidVideoChanged:(NSArray<NemoLayout*> *)videos;
参数说明:
参数名 | 类型 | 说明 |
videos | NSArray<NemoLayout*> * | 当前通话视频信息,与会人Stream信息数组(包含streamID和其他stream信息) |
版本支持: v1.0.0+
回调说明: 单个视频流信息回调
/**
单个视频流信息回调
此接口配合批注使用,返回分享画面的实际分辨率
@param streamInfo 视频流信息
*/
- (void)nemoSDKDidVideoStreamInfo:(NemoVideoStramInfo *)streamInfo;
参数说明:
参数名 | 类型 | 说明 |
streamInfo | 视频流信息 |
版本支持: v1.0.0+
回调说明: 参会者信息变化回调
/**
参会者信息变化回调
入会成功后会自动触发,返回会议中的参会者信息,当会中有人员状态变动时也会触发
您需要监听此接口,通过返回的参会者信息确认会中的人数,决定如何去请求(setCustomLayout)参会者的视频流
@param rosters 参会者信息
*/
- (void)nemoSDKDidRosterChanged:(NemoRosters *)rosters;
参数说明:
参数名 | 类型 | 说明 |
rosters | 参会者信息 |
版本支持: v3.3.3+
回调说明: 参会者信息变化回调
/**
参会者信息变化回调
会议中上报所有参会者信息,使用前需要配置“全量roster”开关为打开状态,否则此接口不会触发
@param rosters 参会者信息
*/
- (void)nemoSDKDidBulkRosterChanged:(NemoBulkRosters *)rosters;
参数说明:
参数名 | 类型 | 说明 |
rosters | 参会者信息 |
版本支持: v1.0.0+
回调说明: 会控消息的回调
/**
会控消息的回调
入会成功后会自动触发,返回当前会议的会控消息,比如主持人设置主会场,静音和一些功能权限,当主持人操作了会控时也会触发
@param type 会控消息类型
@param info 会控消息
*/
- (void)nemoSDKDidConferenceManagementStateChanged:(NemoConferenceManagerManagementType)type confMgmtInfo:(NemoConfMgmtInfo *)info;
参数说明:
参数名 | 类型 | 说明 |
type | 会控消息类型 | |
confMgmtInfo | 会控消息 |
版本支持: v2.29.2+
回调说明: 出入会通知
/**
出入会通知
有参会者入会、退会时触发
@param noticeInfos 通知信息
*/
- (void)nemoSDKDidInOutNotice:(NSArray<NemoInOutNotice *> *)noticeInfos;
参数说明:
参数名 | 类型 | 说明 |
noticeInfos | NSArray<NemoInOutNotice *> * | 通知信息 |
版本支持: v1.0.0+
回调说明: 录制状态
/**
录制状态
录制状态改变时触发
@param recordingInfo 录制信息
*/
- (void)nemoSDKDidRecordingStateChanged:(NemoRecordingInfo *)recordingInfo;
参数说明:
参数名 | 类型 | 说明 |
recordingInfo | 录制信息(3.3.1老版本之前为start) |
版本支持: v1.0.0+
回调说明: 视频状态变化提示
/**
视频状态变化提示
请监听 nemoSDKDidNetworkIndicatorLevel 代替此接口
@param state 当前视频状态
*/
- (void)nemoSDKDidVideoStateChanged:(NemoVideoState)state;
参数说明:
参数名 | 类型 | 说明 |
state | 当前视频状态 |
版本支持: v1.0.0+
回调说明: 网络等级指示
/**
网络等级指示
返回本地设置网络状态
@param level 网络等级(共分为4个等级-> 1 2 3 4,由低到高分别为差,中,良,优)
*/
- (void)nemoSDKDidNetworkIndicatorLevel:(NSInteger)level;
参数说明:
参数名 | 类型 | 说明 |
level | NSInteger | 网络等级(共分为4个等级-> 1 2 3 4,由低到高分别为差,中,良,优) |
版本支持: v1.0.0+
回调说明: 呼叫中心提示回调
/**
呼叫中心提示回调
SDK用户无需关系此接口
@param msg 信息
*/
- (void)nemoSDKDidIMNotification:(NSString *)msg;
参数说明:
参数名 | 类型 | 说明 |
msg | NSString * | 信息 |
版本支持: v1.0.0+
回调说明: 音频注册回调被修改时调用
/**
音频注册回调被修改时调用
当会议中有其他App或设备占用音频通道时会触发,比如会中来电话,您可以监听此接口获取相应的通知
@param began 开始 or 结束
*/
- (void)nemoSDKDidAudioInterrupt:(BOOL)began;
参数说明:
参数名 | 类型 | 说明 |
began | BOOL | 开始 or 结束 |
版本支持: v1.0.0+
回调说明: 音频单位注册回调出现错误时调用
/**
音频单位注册回调出现错误时调用
初始化音频单元失败是触发,此场景比较少见
@param error 错误信息
*/
- (void)nemoSDKDidAudioInitFailed:(NSString *)error;
参数说明:
参数名 | 类型 | 说明 |
error | NSString * | 错误信息 |
版本支持: v1.0.0+
回调说明: 日志上传结果回调
/**
日志上传结果回调
调用sendFeedbackLogWithComments接口上传日志结束时触发,上传成功时errorInfo为空
@param errorInfo 上传失败是返回的错误信息
*/
- (void)nemoSDKDidUploadLogFileErrorInfo:(NSString *)errorInfo;
参数说明:
参数名 | 类型 | 说明 |
errorInfo | NSString * | 上传失败是返回的错误信息 |
版本支持: v1.0.0+
回调说明: 白板改变状态
/**
白板改变状态
会议中有人发起或结束白板时触发,小鱼SDK同一个会议中同一时间只允许一个人发起白板,其他人只有等白板结束后才能再次发起
@param remoteState 远端状态
@param reason 原因
*/
- (void)nemoSDKDidWhiteboardStateChanged:(NemoWhiteboardRemoteState)remoteState reason:(NSString *_Nullable)reason;
参数说明:
参数名 | 类型 | 说明 |
remoteState | 远端状态 | |
reason | NSString * | 原因 |
版本支持: v1.0.0+
回调说明: 白板远端消息
/**
白板远端消息
白板开启状态下,远端在白板上画线等操作会触发此回调,remoteMessage为消息内容,对应每一条画线,具体可参照demo
@param remoteMessage 消息
@param type 类型
*/
- (void)nemoSDKDidWhiteboardReceieved:(id)remoteMessage type:(NemoWhiteboardOperationState)type;
参数说明:
参数名 | 类型 | 说明 |
remoteMessage | id | 消息 |
type | 类型 |
版本支持: v1.0.0+
回调说明: 批注状态变化
/**
批注状态变化
打开或关闭批注时触发,根据返回的状态值做相应的逻辑处理
@param state 状态
*/
- (void)nemoSDKDidAnnotationStateChanged:(NemoAnnotationStatus)state;
参数说明:
参数名 | 类型 | 说明 |
state | 状态 |
版本支持: v1.0.0+
回调说明: 接收到批注消息
/**
接收到批注消息
批注开启状态下,远端在分享画面上画线等操作会触发此回调,message为消息内容,对应每一条画线,具体可参照demo
@param message 消息内容
@param operation 动作
*/
- (void)nemoSDKDidAnnotationMsgReceived:(id)message operation:(NemoAnnotationOperation)operation;
参数说明:
参数名 | 类型 | 说明 |
message | id | 消息内容 |
operation | 动作 |
版本支持: v3.3.3+
回调说明: 同传字幕回调
/**
同传字幕回调
实时上报会议字幕
@param aiCaptionInfo 字幕信息
*/
- (void)nemoSDKDidAiCaptionInfo:(NemoAICaptionInfo *)aiCaptionInfo;
参数说明:
参数名 | 类型 | 说明 |
aiCaptionInfo | 字幕信息 |
版本支持: v1.0.0+
回调说明: 旁路音频数据回调
/**
旁路音频数据回调
返回会中自己的音频原始数据,需要您在入会前调用setMicDataByAEReadyEnabled打开音频旁路开关
小端存储,单声道16比特PCM,采样率16kHz
@param size 数据大小
@param data 数据内容
*/
- (void)nemoSDKDidMicDataByAEReady:(NSInteger)size data:(void *)data;
参数说明:
参数名 | 类型 | 说明 |
size | NSInteger | 数据大小 |
data | void * | 数据内容 |
版本支持: v1.0.0+
回调说明: 接收到字幕回调
/**
接收到字幕回调
会议中,会控可以向所有人发送字幕消息,字幕消息包含文字内容、字体大小、颜色、背景等
@param captionInfo 字幕信息
*/
- (void)nemoSDKDidRecieveCaptionDisplay:(NemoCaptionInfoModel *)captionInfo;
参数说明:
参数名 | 类型 | 说明 |
captionInfo | 字幕信息 |
版本支持: v2.29.6+
回调说明: 会控互动回调
/**
会控互动回调
主持人发起互动时触发此接口回调,state返回互动的状态,interactiveInfo对象返回互动相关内容,您可以监听
此回调,当收到主持人互动消息时,做出相应的UI展示
@param state 互动状态
@param interactiveInfo 互动内容
*/
- (void)nemoSDKDidInteractiveEvent:(NemoInteractiveState)state
interactiveInfo:(NemoInteractiveInfo *)interactiveInfo;
参数说明:
参数名 | 类型 | 说明 |
state | 互动状态 | |
interactiveInfo | 互动内容 |
版本支持: v2.29.6+
回调说明: 会议锁定回调
/**
会议锁定回调
主持人锁定当前会议时,触发此回调,会议锁定后,新的参会者将无法加入当前会议
@param locked 是否锁定,yes代表锁定,no代表解锁
*/
- (void)nemoSDKDidMeetingLocked:(BOOL)locked;
参数说明:
参数名 | 类型 | 说明 |
locked | BOOL | 是否锁定,yes代表锁定,no代表解锁 |
版本支持: v3.3.0+
回调说明: 主持人状态变更回调
/**
主持人状态变更回调
参会人主持人身份变化时回调,会议结束后主持人身份失效
@param meetingId 当前会议id
@param host 是否是主持人 YES:是 NO:否
*/
- (void)nemoSDKDidMeetingHostChanged:(NSString *)meetingId host:(BOOL)host;
参数说明:
参数名 | 类型 | 说明 |
meetingId | NSString * | 当前会议id |
host | BOOL | 是否是主持人 YES:是 NO:否 |
版本支持: v1.0.0+
回调说明: 联席主持人状态改变
/**
联席主持人状态改变
参会人联席主持人身份变化时回调,会议结束后联席主持人身份失效
@param meetingId 会议id
@param coHost YES:是联席主持人, NO:不是联席主持人
*/
- (void)nemoSDKDidMeetingCoHostChanged:(NSString *)meetingId coHost:(BOOL)coHost;
参数说明:
参数名 | 类型 | 说明 |
meetingId | NSString * | 会议id |
coHost | BOOL | YES:是联席主持人, NO:不是联席主持人 |
版本支持: v3.3.3+
回调说明: 会议室owner(会议室所有者)状态回调
/**
会议室owner(会议室所有者)状态回调
入会之后回调
@param meetingId 会议id
@param owner YES:是所有者 NO:不是所有者
*/
- (void)nemoSDKDidMeetingOwnerChanged:(NSString *)meetingId owner:(BOOL)owner;
参数说明:
参数名 | 类型 | 说明 |
meetingId | NSString * | 会议id |
owner | BOOL | YES:是所有者 NO:不是所有者 |
版本支持: v3.3.0+
回调说明: 会控请求操作您的摄像头或麦克风
/**
会控请求操作您的摄像头或麦克风
会议中,可以通过会控向参会者发起请求消息,请求参会者打开、关闭摄像头、麦克风
@param meetingId 当前会议id
@param query 请求类型
*/
- (void)nemoSDKDidMeetingMuteQuery:(NSString *)meetingId query:(NemoMediaQuery)query;
参数说明:
参数名 | 类型 | 说明 |
meetingId | NSString * | 当前会议id |
query | 请求类型 |
版本支持: v3.3.3+
回调说明: 会控清除举手发言
/**
会控清除举手发言
会议中申请举手发言之后,会控清除举手时触发此回调
*/
- (void)nemoSDKDidMeetingForceHandDown;
参数说明:无
版本支持: v2.29.2+
回调说明: 讲话的人回调(最多3个人)
/**
讲话的人回调(最多3个人)
返回当前正在讲话的3个人,使用此接口需要在初始化时设置needSpeakers=YES,此接口返回讲话者id,用户可以从NemoRosters中查询用户名
@param speakers 讲话的人
*/
- (void)nemoSDKDidSpeakersChanged:(NSArray <NemoSpeakers *>*)speakers;
参数说明:
参数名 | 类型 | 说明 |
speakers | NSArray<NemoSpeakers *> * | 讲话的人 |
版本支持: v1.0.0+
回调说明: 啸叫检测
/**
啸叫检测
当多台设备距离比较近时容易引发啸叫从而触发此接口,detected=YES代表检测到啸叫,detected=NO代表啸叫结束
@param detected 是否探测到啸叫
*/
- (void)nemoSDKDidHowlingDetected:(BOOL)detected;
参数说明:
参数名 | 类型 | 说明 |
detected | BOOL | 是否探测到啸叫 |
版本支持: v1.0.0+
回调说明: 系统音量变化
/**
系统音量变化
@param value 音量值
*/
- (void)nemoSDKDidSystemVolumeChanged:(CGFloat)value;
参数说明:
参数名 | 类型 | 说明 |
value | CGFloat | 音量值 |
版本支持: v2.29.6+
回调说明: 本地麦克风音量
/**
本地麦克风音量
@param value 音量值
*/
- (void)nemoSDKDidLocalMicrophoneDecibelChanged:(CGFloat)value;
参数说明:
参数名 | 类型 | 说明 |
value | CGFloat | 音量值 |
版本支持: v1.0.0+
回调说明: 代理服务器测试接口回调
/**
代理服务器测试接口回调
设置代理服务器时,小鱼提供了测试接口validateSocksProxy,测试结果从此接口返回
@param result 结果 成功时返回OK,失败返回其他信息
*/
- (void)nemoSDKDidSocksProxyValidateResult:(NSString *)result;
参数说明:
参数名 | 类型 | 说明 |
result | NSString * | 结果 成功时返回OK,失败返回其他信息 |
版本支持: v3.3.0+
回调说明: 人脸信息回调
/**
人脸信息回调
需要调用enableFaceRecognize接口打开人脸识别开关才会触发此回调
@param face 人脸信息
@param isLocal YES:本地 NO:远端
*/
- (void)nemoSDKDidRecieveAiFace:(NemoFace *)face isLocal:(BOOL)isLocal;
参数说明:
参数名 | 类型 | 说明 |
face | 人脸信息 | |
isLocal | BOOL | YES:本地 NO:远端 |
版本支持: v1.0.0+
回调说明: XYRTCSDK 错误回调,详见错误码
/**
XYRTCSDK 错误回调,详见错误码
在使用小鱼SDK过程中,监听此接口以获得异常反馈
@param code 错误码
@param message 错误信息
*/
- (void)nemoSDKDidError:(NSString *)code message:(NSString *)message;
参数说明:
参数名 | 类型 | 说明 |
code | NSString * | |
message | NSString * | 错误信息 |