版本支持: v3.3.0+
回调概述: SDK错误回调
回调定义:
virtual void onError(XYError code) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
code | 是 | 无 | 错误码 |
版本支持: v3.3.0+
回调概述: socks验证连通性回调
回调定义:
virtual void onSocksProxyValidateResult(const char* errorCode) {
(void)errorCode;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
errorCode | const char* | 是 | 无 | 错误码 |
版本支持: v3.3.0+
回调概述: 网络状态变化回调(在已登录的情况下这个回调接口上报网络连接状况,未登录的情况下不上报 1) 如果是在呼叫中:如果App层收到 onNetworkStateChanged(connected == false), App层应该禁止用户除了挂断外的其他操作。 如果在 40 秒内恢复网络连接, 通话继续进行,否则App层会收到 onCallStateChanged(callState == XYCallState_Disconnected) 消息 2) 如果不是在呼叫中:如果App层收到 onNetworkStateChanged(connected == false), App层应该禁止用户发起呼叫操作。
回调定义:
virtual void onNetworkStateChanged(bool connected, const char* localIp) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
connected | bool | 是 | 无 | 网络是否连接 |
localIp | const char* | 是 | 无 | 本地ip地址 |
版本支持: v3.3.0+
回调概述: ws消息连接状态变化回调
回调定义:
virtual void onWsConnectStateChanged(bool connected, const char* localIp) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
connected | bool | 是 | 无 | 是否连接 |
localIp | const char* | 是 | 无 | 本地ip地址 |
版本支持: v3.3.0+
回调概述: 网络测试结果回调
回调定义:
virtual void onNetTestResult(const XYNetTestResult& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 获取后台配置线路列表回调
回调定义:
virtual void onGetRouteListResult(const XYRouteListResult& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 保存路由线路回调
回调定义:
virtual void onSaveRouteCodeResult(const XYBaseResult& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 清除路由线路回调
回调定义:
virtual void onDeleteRouteCodeResult(const XYBaseResult& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 登录状态回调
回调定义:
virtual void onLoginStateChanged(XYLoginState state, XYError error, const XYAccountInfo& info) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
state | 是 | 无 | 登录状态 | |
error | 是 | 无 | 错误 | |
info | 是 | 无 | 用户登录信息 |
版本支持: v3.3.0+
回调概述: 获取用户所有信息
回调定义:
virtual void onGetUserFullInfo(const XYAccountInfo& info, int error) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
info | 是 | 无 | 用户登录信息 | |
error | int | 是 | 无 | 错误码 |
版本支持: v3.3.0+
回调概述: 用户被登出回调,需要重新登录 1) 4000 :多个重复长连接建立 2) 4001 :用户在另一台设备登录 4003 :无效的SK、登录过期(默认1年)
回调定义:
virtual void onKickOut(XYKickOutReason reason) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
reason | 是 | 无 | 被登出原因 |
版本支持: v3.3.0+
回调概述: 新用户注册回调
回调定义:
virtual void onRegisterNewUserError(const XYNewRegisterResult& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 获取验证码回调
回调定义:
virtual void onSendVerifyCodeShortMessageResult(const XYBaseResult& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 验证码验证回调
回调定义:
virtual void onCheckVerifyCodeResult(const XYBaseResult& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 图形验证 图形信息回调
回调定义:
virtual void onGetVerifyImageResult(const XYVerifyImageInfoResult& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 图形验证 校验结果回调
回调定义:
virtual void onCheckVerifyImageResult(const XYBaseResult& result) {
(void)result;
}
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 同步WebSocket时间戳到UI
回调定义:
virtual void onSyncWSTimeStampToUI(long long wsTimeStamp) {
(void)wsTimeStamp;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
wsTimeStamp | long long | 是 | 无 | WebSocket时间戳 |
版本支持: v3.3.0+
回调概述: 修改密码回调
回调定义:
virtual void onChangePasswordResult(const XYBaseResult& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 服务器配置信息回调
回调定义:
virtual void onServerConfigChanged(const XYServerConfig& serverConf) {
(void)serverConf;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
serverConf | 是 | 无 | 服务器配置信息 |
版本支持: v3.3.0+
回调概述: 登录聚合回调
回调定义:
virtual void onAuthCompositeResult(const XYBaseResult& userConf) {
(void)userConf;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
userConf | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 修改用户信息回调
回调定义:
virtual void onUpdateProfileResult(const XYUpdateProfileResult& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 聚合接口回调
回调定义:
virtual void onClientConfigResult(const XYClientConfigResult& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 是否为强密码回调
回调定义:
virtual void onGetEnterpriseConfigResult(bool ifInEnterprise) {
(void)ifInEnterprise;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
ifInEnterprise | bool | 是 | 无 | 是否为强密码 |
版本支持: v3.3.0+
回调概述: 未读消息
回调定义:
virtual void onGetUnreadNotificationMsgsCountResult(int unreadNum, const char* lastUnReadNotice) {
(void)unreadNum;
(void)lastUnReadNotice;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
unreadNum | int | 是 | 无 | 未读数量 |
lastUnReadNotice | const char* | 是 | 无 | 最新一条未读公告 |
版本支持: v3.3.0+
回调概述: 获取特殊字符正则表达式回调
回调定义:
virtual void onGetExclusiveNameCharactersResult(const XYExclusiveNameCharactersResult& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 获取默认特殊字符正则表达式回调
回调定义:
virtual void onGetDefaultNameCharactersResult(const XYDefaultNameCharactersResult& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 设备配置回调
回调定义:
virtual void onDeviceConfigResult(const XYDeviceConfigResult& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 获取第三方登录公司回调
回调定义:
virtual void onGetThirdPlatformsResult(const XYThirdPlatformsResult& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 获取SSO信息回调
回调定义:
virtual void onGetEnterpriseDomainNameResult(const XYEnterpriseDomainNameResult& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 获取企业信息回调
回调定义:
virtual void onGetEnterpriseInfoResult(const XYEnterpriseInfoResult& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 用户配置响应回调
回调定义:
virtual void onUserConfigResponse(const XYDeviceConfigResult& config) {
(void)config;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
config | 是 | 无 | 设备配置结果 |
版本支持: v3.3.0+
回调概述: 会议室配置信息回调
回调定义:
virtual void onMeetingRoomConfigResult(const XYCloudMeetingRoomResult& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 会议室信息更新回调
回调定义:
virtual void onUpdateConfConfigResult(const XYBaseResult& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 查询会议室是否仅预约呼叫回调
回调定义:
virtual void onGetConfConfigAboutScheduledCallResult(const XYOnlySchemeMeetingInfo& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 更新会议室是否仅预约呼叫回调
回调定义:
virtual void onUpdateConfConfigAboutScheduledCallResult(const XYBaseResult& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 获取会议容量回调
回调定义:
virtual void onGetConfCapacityResult(const XYMeetingCapacityInfo& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 设置中开启或关闭云会议断线重呼接口回调
回调定义:
virtual void onSetRecoveryConfAfterReconnectionResult(const XYBaseResult& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 设置中开启或关闭主持会议免打扰接口回调
回调定义:
virtual void onSetNoDisturbInHostingResult(const XYBaseResult& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 设置中开启或关闭通话中免打扰接口回调
回调定义:
virtual void onSetNoDisturbInCallResult(const XYBaseResult& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 用户名已被修改回调
回调定义:
virtual void onUserNameChanged(int userId, const char* displayName) {
(void)userId;
(void)displayName;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
userId | int | 是 | 无 | 用户id |
displayName | const char* | 是 | 无 | 新用户名 |
版本支持: v3.3.0+
回调概述: 后台推送UI项目的显示与隐藏
回调定义:
virtual void onUIDisplayChanged(const XYArray& uidiaplaychanged)
{
(void)uidiaplaychanged;
}
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
uidiaplaychanged | 是 | 无 | UI显示变更信息 |
版本支持: v3.3.0+
回调概述: 邮箱已验证回调
回调定义:
virtual void onUserHasValidateEmail() {};
版本支持: v3.3.0+
回调概述: 网关信息变更回调
回调定义:
virtual void onApiGatewayInfoChanged(const XYApiGatewayInfo& gatewayInfo) {
(void)gatewayInfo;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
gatewayInfo | 是 | 无 | 网关信息 |
版本支持: v3.3.0+
回调概述: 多个服务器地址,自动探测结果回调
回调定义:
virtual void onDetectCloudServerResult(const XYServerInfo& serverInfo) {
(void)serverInfo;
}
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
serverInfo | 是 | 无 | 当前可用的服务器地址 |
版本支持: v3.3.0+
回调概述: app保活时间到期回调
回调定义:
virtual void onKeepAliveTimeOut() = 0;
版本支持: v3.3.0+
回调概述: 获取直播独立域名回调
回调定义:
virtual void onGetLiveDomainUrlResult(const XYLiveDomainUrlResult& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 历史通话记录回调
回调定义:
virtual void onGetCallHistoryResult(const XYCallHistoryResult& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 删除历史通话记录回调
回调定义:
virtual void onDeleteCallHistoryResult(const XYBaseResult& result, const char* meetingNumber) {
(void)result;
(void)meetingNumber;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 | |
meetingNumber | const char* | 是 | 无 | 会议号码 |
版本支持: v3.3.0+
回调概述: 获取callurlInfo接口回调
回调定义:
virtual void onUserInfoByNumberResult(const XYCallUserInfo& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 会议呼叫状态回调
回调定义:
virtual void onCallStateChanged(const XYCallStateInfo& callStateInfo) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
callStateInfo | 是 | 无 | 呼叫状态 |
版本支持: v3.3.0+
回调概述: 收到点对点(p2p)呼叫回调
回调定义:
virtual void onCallInvited(bool invited, const XYCallInfo& info) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
invited | bool | 是 | 无 | 是否被邀请 |
info | 是 | 无 | 呼叫信息 |
版本支持: v3.3.0+
回调概述: 收到会议邀请回调
回调定义:
virtual void onMeetingInvited(const char* number, const char* displayName) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
number | const char* | 是 | 无 | 会议号码 |
displayName | const char* | 是 | 无 | 邀请人名称 |
版本支持: v3.3.0+
回调概述: 会议锁定状态的回调
回调定义:
virtual void onMeetingLocked(const char* meetingId, bool locked) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
meetingId | const char* | 是 | 无 | 会议id |
locked | bool | 是 | 无 | 锁定状态 |
版本支持: v3.3.0+
回调概述: 呼叫错误的回调
回调定义:
virtual void onCallError(int error) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
error | int | 是 | 无 | 错误码 |
版本支持: v3.3.0+
回调概述: 直播状态回调
回调定义:
virtual void onLiveStatusNotification(int callIndex, bool isStart, const char* uri, const char* callUri) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
callIndex | int | 是 | 无 | 直播callIndex |
isStart | bool | 是 | 无 | 是否开始直播 |
uri | const char* | 是 | 无 | 用户名称 |
callUri | const char* | 是 | 无 | 直播callUri |
版本支持: v3.3.0+
回调概述: 收到点对点呼叫会议信息查询回调
回调定义:
virtual void onGetParticipantInfoResult(const XYCallableInfo& info) {
(void)info;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
info | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 获取最新预约会议信息回调
回调定义:
virtual void onGetScheduledMeetingInfoResult(const XYTheLatestMeetingResult& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 获取全部预约会议信息回调
回调定义:
virtual void onGetAllScheduledMeetingInfoResult(const XYArray& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 获取与当前会议冲突的预约会议信息回调
回调定义:
virtual void onGetMeetingConlictInfoResult(const XYMeetingConlictInfo& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 会议中与预约会议冲突,关闭掉预约会议回调
回调定义:
virtual void onEndMeetingConflictResult(const XYBaseResult& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 预约会议通知
回调定义:
virtual void onScheduleMeetingNotification(const XYScheduleMeetingInfo& info) {
(void)info;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
info | 是 | 无 | 预约会议具体信息 |
版本支持: v3.3.0+
回调概述: 预约会议事件改变的通知
回调定义:
virtual void onScheduleMeetingChanged(XYScheduleEvent event, bool live) {
(void)event;
(void)live;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
event | 是 | 无 | 预约事件类型 | |
live | bool | 是 | 无 | 是否为直播 |
版本支持: v3.3.0+
回调概述: 音频旁路数据
回调定义:
virtual void onMicDataByAEReady(const void* data, int length, int formatType, int samplesPerSec, int numChannels, int bitsPerSample) {
(void)data;
(void)length;
(void)formatType;
(void)samplesPerSec;
(void)numChannels;
(void)bitsPerSample;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
data | const void* | 是 | 无 | 数据起始地址 |
length | int | 是 | 无 | 数据长度 |
formatType | int | 是 | 无 | 数据格式 |
samplesPerSec | int | 是 | 无 | 采样率 |
numChannels | int | 是 | 无 | 声道数 |
bitsPerSample | int | 是 | 无 | 采样位数 |
版本支持: v3.3.0+
回调概述: 视频流裸数据回调
回调定义:
virtual void onVideoFrameReady(const char* dataSourceId, const XYVideoFrame& videoFrame) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
dataSourceId | const char* | 是 | 无 | SDK为每路视频流分配的资源标志 本地预览的 dataSourceId 固定为:LocalPreviewID 本地预览的固定帧率为30fps@720p,推流最大帧率也为30fps |
videoFrame | 是 | 无 | 视频帧数据 |
版本支持: v3.3.0+
回调概述: 麦克风能量变化回调(0-100)
回调定义:
virtual void onMicEnergyChanged(int energy) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
energy | int | 是 | 无 | 麦克风能量 |
版本支持: v3.3.0+
回调概述: 音频设备输入输出量的变化
回调定义:
virtual void onAudioVolumeChanged(XYAudioDataType audioype, bool changedBySelf) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
audioype | 是 | 无 | 音频设备类型 | |
changedBySelf | bool | 是 | 无 | 是否是自己操作改变 |
版本支持: v3.3.0+
回调概述: 音频设备静音/非静音回调
回调定义:
virtual void onAudioSpeakerMuteChanged(bool muted) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
muted | bool | 是 | 无 | 音频设备是否静音 |
版本支持: v3.3.0+
回调概述: 是否检测到啸叫(用户可降低声音或关闭麦克风结束啸叫)
回调定义:
virtual void onHowlingDetected(bool detected) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
detected | bool | 是 | 无 | 是否检测到 |
版本支持: v3.3.0+
回调概述: 视频状态变化回调
回调定义:
virtual void onVideoStatusChanged(XYVideoStatus status) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
status | 是 | 无 | 视频状态变化原因 |
版本支持: v3.3.0+
回调概述: 本地媒体设备变化回调
回调定义:
virtual void onDeviceChanged(const XYMediaDevType& devType) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
devType | 是 | 无 | 媒体设备类型 |
版本支持: v3.3.0+
回调概述: 本地媒体设备异常回调
回调定义:
virtual void onMediaDeviceError(const XYMediaDevErrorParam& param) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
param | 是 | 无 | 设备错误参数 |
版本支持: v3.3.0+
回调概述: 升级检查结果回调
回调定义:
virtual void onUpgradeCheckResult(const XYUpgradeCheckResult& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 升级下载结果回调
回调定义:
virtual void onUpgradeDownloadResult(const XYBaseResult& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 升级下载进度回调
回调定义:
virtual void onUpgradeDownloadProgressChanged(double progress) {
(void)progress;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
progress | double | 是 | 无 | 下载进度(0-1) |
版本支持: v3.3.0+
回调概述: 共享状态变化回调
回调定义:
virtual void onContentStateChanged(XYContentState state, const char* reason) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
state | 是 | 无 | 共享状态 | |
reason | const char* | 是 | 无 | 状态变化原因 |
版本支持: v3.3.0+
回调概述: app共享状态回调
回调定义:
virtual void onAppWindowCaptureStateChanged(bool isClosed, bool isOccluded, bool isPaused) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
isClosed | bool | 是 | 无 | app是否被关闭 |
isOccluded | bool | 是 | 无 | app是否被遮挡 |
isPaused | bool | 是 | 无 | 是否暂停共享 |
版本支持: v3.3.0+
回调概述: app共享状态回调(无外接屏)
回调定义:
virtual void onAppWindowCapture_noExternalScreenStateChanged(bool isClosed, bool isOccluded, bool isPaused) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
isClosed | bool | 是 | 无 | app是否被关闭 |
isOccluded | bool | 是 | 无 | app是否被遮挡 |
isPaused | bool | 是 | 无 | 是否暂停共享 |
版本支持: v3.3.0+
回调概述: 共享媒体文件事件回调
回调定义:
virtual void onShareMediaFileStatusChanged(const XYMediaFileEventType& mediaType, const XYMediaFileEventArg& arg) {
(void)mediaType;
(void)arg;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
mediaType | 是 | 无 | 共享媒体文件状态 | |
arg | 是 | 无 | 媒体文件信息 |
版本支持: v3.3.0+
回调概述: 媒体文件开始播放回调
回调定义:
virtual void onMediaFileStart(bool hasAudio, bool hasVideo) {
(void)hasAudio;
(void)hasVideo;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
hasAudio | bool | 是 | 无 | 文件是否包含音频 |
hasVideo | bool | 是 | 无 | 文件是否包含视频 |
版本支持: v3.3.0+
回调概述: 媒体文件停止播放回调
回调定义:
virtual void onMediaFileStop(bool hasAudio, bool hasVideo) {
(void)hasAudio;
(void)hasVideo;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
hasAudio | bool | 是 | 无 | 文件是否包含音频 |
hasVideo | bool | 是 | 无 | 文件是否包含视频 |
版本支持: v3.3.0+
回调概述: app共享采集区域回调
回调定义:
virtual void onAppWindowVisibleArea(int x, int y, int w, int h) {
(void)x;
(void)y;
(void)w;
(void)h;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
x | int | 是 | 无 | 采集区域x坐标 |
y | int | 是 | 无 | 采集区域y坐标 |
w | int | 是 | 无 | 采集区域宽度 |
h | int | 是 | 无 | 采集区域高度 |
版本支持: v3.3.0+
回调概述: 白板开启回调
回调定义:
virtual void onWhiteboardStart(const XYWhiteBoardInfo& whiteBoardInfo) {
(void)whiteBoardInfo;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
whiteBoardInfo | 是 | 无 | 白板信息 |
版本支持: v3.3.0+
回调概述: 白板关闭回调
回调定义:
virtual void onWhiteboardStop() {};
版本支持: v3.3.0+
回调概述: 白板收线回调
回调定义:
virtual void onWhiteboardReceiveLine(const IXYPaintLineParam& lines) {
(void)lines;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
lines | 是 | 无 | 线条结构 |
版本支持: v3.3.0+
回调概述: 白板线条清除回调
回调定义:
virtual void onWhiteboardClean() {};
版本支持: v3.3.0+
回调概述: 标注开启回调
回调定义:
virtual void onAnnotationStart() {};
版本支持: v3.3.0+
回调概述: 标注关闭回调
回调定义:
virtual void onAnnotationStop() {};
版本支持: v3.3.0+
回调概述: 标注收线回调
回调定义:
virtual void onAnnotationReceiveLine(const IXYPaintLineParam& lines) {
(void)lines;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
lines | 是 | 无 | 线条结构 |
版本支持: v3.3.0+
回调概述: 标注画面清除回调
回调定义:
virtual void onAnnotationClean() {};
版本支持: v3.3.0+
回调概述: 标注线条清除回调
回调定义:
virtual void onAnnotationLineRecvFeedback(const char* uuid) {
(void)uuid;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
uuid | const char* | 是 | 无 | 标注线条的uuid,用于清除发送方已画在本地屏幕上的画线 |
版本支持: v3.3.0+
回调概述: 会议室配置信息回调
回调定义:
virtual void onMeetingRoomInfoForInstant(const XYMeetingRoomInfoForInstant& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 会控清空举手信息回调
回调定义:
virtual void onConfHandupCancelledResult() {};
版本支持: v3.3.0+
回调概述: 出入会通知回调
回调定义:
virtual void onConfInOutNotification(const XYArray& info) {
(void)info;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
info | 是 | 无 | 出入会通知信息 |
版本支持: v3.3.0+
回调概述: 会控字幕信息变化/主会场点名回调
回调定义:
virtual void onConfCaptionChanged(const XYConfCaption& notify) {
(void)notify;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
notify | 是 | 无 | 字幕信息 |
版本支持: v3.3.0+
回调概述: 签到接口信息回调
回调定义:
virtual void onSignInResult(const XYSubmitSignResult& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 申请发言回调
回调定义:
virtual void onApplySpeakingResult(int callIndex, const XYApplySpeakInfo& info) {
(void)callIndex;
(void)info;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
callIndex | int | 是 | 无 | 会议callIndex |
info | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 会中改名结果回调
回调定义:
virtual void onSetUserNameInMeetingResult(const XYBaseResult& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 切换会议模式回调
回调定义:
virtual void onConfCallModeChanged(int callIndex, XYCallMode callMode, const char* reason) {
(void)callIndex;
(void)callMode;
(void)reason;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
callIndex | int | 是 | 无 | 会议callIndex |
callMode | 是 | 无 | 会议模式 | |
reason | const char* | 是 | 无 | 切换结果状态信息 |
版本支持: v3.3.0+
回调概述: 互动工具回调
回调定义:
virtual void onInteractiveToolInfoResult(const XYInteractiveToolInfo& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 获取敏感词回调
回调定义:
virtual void onGetSensitiveWordsResult(const XYSensitiveWordsInfo& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 敏感词列表 |
版本支持: v3.3.0+
回调概述: 查询水印回调
回调定义:
virtual void onGetWatermarkResult(const XYWatermarkInfo& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 麦克风状态变化回调
回调定义:
virtual void onMicStatusChanged(bool muted) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
muted | bool | 是 | 无 | 是否静音 |
版本支持: v3.3.0+
回调概述: 本地网络状况上报 回调频率根据入会终端期望带宽和DBA(动态带宽调整)探测带宽的比例计算
回调定义:
virtual void onNetworkIndicatorLevelChanged(int level) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
level | int | 是 | 无 | 网络状况等级 一共4档:1、2、3、4 分别为:差、中、良、优 计算的Level不同会上报,同时也跟终端网络的稳定性有关 |
版本支持: v3.3.0+
回调概述: 会议室状态回调
回调定义:
virtual void onConfPropertyChanged(const XYConfProperty& confProperty) {
(void)confProperty;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
confProperty | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 主持权限变更
回调定义:
virtual void onHostAuthorityChanged(bool host) {
(void)host;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
host | bool | 是 | 无 | 是否有主持权限 |
版本支持: v3.3.0+
回调概述: 联席主持人权限变更
回调定义:
virtual void onCoChairAuthorityChanged(bool chChair) {
(void)chChair;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
chChair | bool | 是 | 无 | 是否有联席主持人权限 |
版本支持: v3.3.0+
回调概述: im权限变更
回调定义:
virtual void onIMPermissionChanged(const XYIMPermission& permission) {
(void)permission;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
permission | 是 | 无 | im权限信息 |
版本支持: v3.3.0+
回调概述: 消息中心消息
回调定义:
virtual void onReceiveNotificationMsg(const char* jsonMsg) {
(void)jsonMsg;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
jsonMsg | const char* | 是 | 无 | 消息内容 |
版本支持: v3.3.0+
回调概述: 会议中改名权限变更通知
回调定义:
virtual void onModifyNameAuthority(const char* meetingId, bool enable) {
(void)meetingId;
(void)enable;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
meetingId | const char* | 是 | 无 | 会议id |
enable | bool | 是 | 无 | 是否允许改名 |
版本支持: v3.3.0+
回调概述: 会控排序
回调定义:
virtual void onMeetingControlEnableSort(const XYString& meetingId) {
(void)meetingId;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
meetingId | 是 | 无 | 会议id |
版本支持: v3.3.0+
回调概述: 会控静音/取消静音
回调定义:
virtual void onMeetingControlMuteActionChange(const XYString& operation) {
(void)operation;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
operation | 是 | 无 | 具体操作 |
版本支持: v3.3.0+
回调概述: 会控开启/关闭摄像头
回调定义:
virtual void onMeetingControlVideoMuteActionChange(const XYMeetingControlMuteChangeParam& operation) {
(void)operation;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
operation | 是 | 无 | 具体操作 |
版本支持: v3.3.0+
回调概述: 会中最新发言人
回调定义:
virtual void onSpeakersChanged(XYArray& speakersInfos) {
(void)speakersInfos;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
speakersInfos | 是 | 无 | 发言人列表 |
版本支持: v3.3.0+
回调概述: 远端麦克风音量大小
回调定义:
virtual void onParticipantAudioChanged(const XYArray& audioInfoPuts) {
(void)audioInfoPuts;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
audioInfoPuts | 是 | 无 | 远端麦克风音量大小列表 |
版本支持: v3.3.0+
回调概述: 会中参会人员信息变化回调
回调定义:
virtual void onRosterChanged(const XYRosterInfo& info) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
info | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 远端视频流状态信息变化回调
回调定义:
virtual void onVideoStreamChanged(const XYArray& streamArray) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
streamArray | 是 | 无 | 所有远端视频流信息 |
版本支持: v3.3.0+
回调概述: 会议信息变化上报
回调定义:
virtual void onConfInfoChanged(const XYConfInfo& info) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
info | 是 | 无 | 会议信息 |
版本支持: v3.3.0+
回调概述: 结束分组回调
回调定义:
virtual void onEndDynamicGroupResult(const XYBaseResult& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 日志上传结果回调
回调定义:
virtual void onLogUploadResult(const XYLogUploadResult& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 日志上传进度回调
回调定义:
virtual void onLogUploadProgressChanged(double progress) {
(void)progress;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
progress | double | 是 | 无 | 上传进度(0-1) |
版本支持: v3.3.0+
回调概述: 是否可以使用视频虚拟背景功能,登录即有回调,无需请求
回调定义:
virtual void onCanUseVideoVirtualBackground(bool canUse) {
(void)canUse;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
canUse | bool | 是 | 无 | 设备条件是否可以使用视频虚拟背景功能 |
版本支持: v3.3.0+
回调概述: 是否可以使用视频美颜滤镜,设置本地显示句柄或打开摄像头均有回调
回调定义:
virtual void onCanUseVideoFilters(bool canUse) {
(void)canUse;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
canUse | bool | 是 | 无 | 设备条件是否可以使用美颜滤镜(beauty filter and LUT filter)功能. |
版本支持: v3.3.0+
回调概述: 是否可以使用视频虚拟数字人功能,登录即有回调,无需请求
回调定义:
virtual void onCanUseDigitalHuman(bool canUse) {
(void)canUse;
}
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
canUse | bool | 是 | 无 | 设备条件是否可以使用视频虚拟数字人功能 |
版本支持: v3.3.0+
回调概述: 检查人脸识别权限结果回调, 登录即有回调,无需请求
回调定义:
virtual void onCanUseFaceRecognition(bool canUse, const char* enterpriseID) {
(void)canUse;
(void)enterpriseID;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
canUse | bool | 是 | 无 | 是否可用 |
enterpriseID | const char* | 是 | 无 | 企业id |
版本支持: v3.3.0+
回调概述: 请求本地人脸识别结果回调
回调定义:
virtual void onAIFaceInfoResult(const XYFace& face) {
(void)face;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
face | 是 | 无 | 人脸识别基本信息 |
版本支持: v3.3.0+
回调概述: 云端录制状态回调
回调定义:
virtual void onRecordResult(const XYCloudRecordState& state, int err, const char* recordInfo, const char* reason) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
state | 是 | 无 | 录制状态 | |
err | int | 是 | 无 | 状态码信息 |
recordInfo | const char* | 是 | 无 | 录制信息 |
reason | const char* | 是 | 无 | 原因 |
版本支持: v3.3.0+
回调概述: 云端录制失败回调
回调定义:
virtual void onRecordErrorResult(const XYBaseResult& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 失败信息 |
版本支持: v3.3.0+
回调概述: 本地录制状态回调
回调定义:
virtual void onLocalRecordStatusChanged(bool isInRecord, const char* bizId) {
(void)isInRecord;
(void)bizId;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
isInRecord | bool | 是 | 无 | 是否正在录制 |
bizId | const char* | 是 | 无 | 录制id |
版本支持: v3.3.0+
回调概述: 录制文件过期回调
回调定义:
virtual void onNearExpiredVodNoticeInfo(XYNearExpiredVodNoticeInfo &info) {
(void)info;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
info | 是 | 无 | 回调信息 |
版本支持: v3.3.0+
回调概述: 开启本地录制是否成功回调
回调定义:
virtual void onLocalRecordResult(bool isSuccess, XYLocalRecordErrorType code, const char* filePath, const char* bizId) {
(void)isSuccess;
(void)code;
(void)filePath;
(void)bizId;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
isSuccess | bool | 是 | 无 | 是否成功 |
code | 是 | 无 | 错误码 | |
filePath | const char* | 是 | 无 | 录制储存地址 |
bizId | const char* | 是 | 无 | 录制id |
版本支持: v3.3.0+
回调概述: 本地录制数据库变化回调
回调定义:
virtual void onLocalRecordDbChanged(const std::vector& records) {
(void)records;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
records | const std::vector<XYLocalRecording>& | 是 | 无 | 录制记录列表 |
版本支持: v3.3.0+
回调概述: 同声传译配置结果回调
回调定义:
virtual void onTranslationLanguageConfigResult(const XYTranslationLanguageConfigResult& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 同声传译收到ws消息回调
回调定义:
virtual void onTranslatioWSMessageRecieved(const XYTranlationSource& msg) {
(void)msg;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
msg | 是 | 无 | 消息内容 |
版本支持: v3.3.0+
回调概述: 获取会控H5链接回调
回调定义:
virtual void onHostMeetingUrlResult(const char* url, const char* displayName) {
(void)url;
(void)displayName;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
url | const char* | 是 | 无 | 会控H5链接 |
displayName | const char* | 是 | 无 | 显示名称 |
版本支持: v3.3.0+
回调概述: 会控状态变化回调
回调定义:
virtual void onConfMgmtChanged(const XYConfMgmtInfo& info) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
info | 是 | 无 | 会控状态信息 |
版本支持: v3.3.0+
回调概述: 会控静音回调
回调定义:
virtual void onMeetingControlMuteResult(const XYBaseResult& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 获取主持会议的相关配置信息和状态回调
回调定义:
virtual void onGetMeetingControlConfigResult(const XYMeetingControlConfigInfo& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: H5热更新模块下载完成回调
回调定义:
virtual void onDynUpsDidFinishDownloadModule(XYDynUpsModuleType type, const XYDynUpsInfo& info) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
type | 是 | 无 | 模块类型 | |
info | 是 | 无 | 模块信息 |
版本支持: v3.3.0+
回调概述: 下载文件结果回调
回调定义:
virtual void onDownloadStatusChanged(const XYDownloadStatusInfo& info) {
(void)info;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
info | 是 | 无 | 回调结果 |
版本支持: v3.3.0+
回调概述: 下载文件进度回调
回调定义:
virtual void onDownloadProgressChanged(const XYDownloadProgress& progress) {
(void)progress;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
progress | 是 | 无 | 下载进度(0-1) |
版本支持: v3.3.0+
回调概述: 终端获取能力
回调定义:
virtual void onReportCapabilityResult(const XYCapabilityResult& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 经过合并后的能力集 |
版本支持: v3.3.0+
回调概述: 外部设备变化回调
回调定义:
virtual void onExDevicesChanged() {};
版本支持: v3.3.0+
回调概述: 获取同步认证结果回调
回调定义:
virtual void onAuthSyncResult(const XYAuthSyncResult& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 同步认证结果 |
版本支持: v3.3.0+
回调概述: 云端录制权限回调
回调定义:
virtual void onCloudRecordPermissionChanged(bool authorized) {
(void)authorized;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
authorized | bool | 是 | 无 | 是否有云端录制权限 |
版本支持: v3.3.0+
回调概述: CPU及内存使用上报
回调定义:
virtual void onResUsageReport(int appCpu, int totalCpu, int appMem, int totalMem) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
appCpu | int | 是 | 无 | app使用的cpu |
totalCpu | int | 是 | 无 | total使用的cpu |
appMem | int | 是 | 无 | app使用的内存 |
totalMem | int | 是 | 无 | total使用的内存 |
版本支持: v3.3.0+
回调概述: 获取IM权限回调
回调定义:
virtual void onGetIMPermissionsResult(bool chatSetting) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
chatSetting | bool | 是 | 无 | IM权限 |
版本支持: v3.3.0+
回调概述: RSA加密回调
回调定义:
virtual void onRSAEncrypt(const XYString& text) {};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
text | 是 | 无 | 加密文本 |
版本支持: v3.3.0+
回调概述: 检测是否支持同传字幕功能回调
回调定义:
virtual void onAICaptionLanguageSupportResult(bool isSupport) {
(void)isSupport;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
isSupport | bool | 是 | 无 | 是否支持同传字幕功能 |
版本支持: v3.3.0+
回调概述: 同传字幕信息回调
回调定义:
virtual void onAICaptionInfoChanged(const XYAICaptionInfo& captionInfo) {
(void)captionInfo;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
captionInfo | 是 | 无 | 同传字幕信息 |
版本支持: v3.3.0+
回调概述: 国密状态回调
回调定义:
virtual void onGetGMStatusResult(bool isGM) {
(void)isGM;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
isGM | bool | 是 | 无 | 是否为国密 |
版本支持: v3.3.0+
回调概述: 同传字幕、会议纪要错误信息回调
回调定义:
virtual void onAITransMeetingNoteChanged(const XYAIMeetingNoteStatusInfo& statusInfo)
{
(void)statusInfo;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
statusInfo | 是 | 无 | 错误信息 |
版本支持: v3.3.0+
回调概述: 云控配置回调
回调定义:
virtual void onGetCloudConfig(const XYCloudConfigResult& result) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 云控配置结果 |
版本支持: v3.3.0+
回调概述: UI Audio状态 纠正回调
回调定义:
virtual void onSyncMuteStatus(int callindex, XYArray& muteGroupStatus) {
}
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
callindex | int | 是 | 无 | 会议索引 |
muteGroupStatus | 是 | 无 | audio状态回调 |
版本支持: v3.3.0+
回调概述: 会控邀请通讯录成员权限
回调定义:
virtual void onMeetingInvitedPermisssion(bool permisssion) {
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
permisssion | bool | 是 | 无 | 是否允许 |
版本支持: v3.3.0+
回调概述: 恢复默认头像回调
回调定义:
virtual void onDeleteUserAvatarResult(const XYBaseResult& result) {
(void)result;
};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | 是 | 无 | 恢复结果 |
版本支持: v3.3.0+
回调概述: 返回登录状态
回调定义:
virtual void onLoginStateChanged(SDKLoginState state, const XYString& code, const SDKLoginInfo& info) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
state | SDKLoginState | 是 | 无 | 登录状态 |
code | 是 | 无 | 状态码 | |
info | SDKLoginInfo | 是 | 无 | 登录信息 |
版本支持: v3.3.0+
回调概述: 用户被登出回调,需要重新登录 1) 4000 :多个重复长连接建立 2) 4001 :用户在另一台设备登录 3) 4003 :无效的SK、登录过期(默认1年)
回调定义:
virtual void onKickOut(const XYString& code) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
code | 是 | 无 | 登出原因码 |
版本支持: v3.3.0+
回调概述: 返回呼叫状态
回调定义:
virtual void onCallStateChanged(const SDKCallStateInfo& callStateInfo) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
callStateInfo | SDKCallStateInfo | 是 | 无 | 呼叫状态信息 |
版本支持: v3.3.0+
回调概述: 收到点对点(p2p)呼叫
回调定义:
virtual void onCallInvited(const SDKCallInfo& info) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
info | SDKCallInfo | 是 | 无 | 呼叫信息 |
版本支持: v3.3.0+
回调概述: 在已登录的情况下这个回调接口上报网络连接状况,未登录的情况下不上报 1) 如果是在呼叫中:如果App层收到 onNetworkStateChanged( connectedfalse), App层应该禁止用户除了挂断外的其他操作。如果在 40 秒内恢复网络连接, 通话继续进行,否则App层会收到 OnCallStateChanged(statedisconnected) 消息 2) 如果不是在呼叫中:如果App层收到 onNetworkStateChanged( connected==false), App层应该禁止用户发起呼叫操作。
回调定义:
virtual void onNetworkStateChanged(bool connected) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
connected | bool | 是 | 无 | 网络是否连接 |
版本支持: v3.3.0+
回调概述: 会议信息变化上报
回调定义:
virtual void onConfInfoChanged(const SDKConfInfo& info) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
info | SDKConfInfo | 是 | 无 | 会议信息 |
版本支持: v3.3.0+
回调概述: 处理会控消息 控制操作:静音、非静音 控制状态:举手发言、取消举手、结束发言
回调定义:
virtual void onConfMgmtChanged(const SDKConfMgmtInfo& info) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
info | SDKConfMgmtInfo | 是 | 无 | 会控信息 |
版本支持: v3.3.0+
回调概述: 参会信息变化上报
回调定义:
virtual void onRosterChanged(const SDKRosterInfo& info) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
info | SDKRosterInfo | 是 | 无 | 参会信息 |
版本支持: v3.3.0+
回调概述: 返回内容共享状态
回调定义:
virtual void onContentStateChanged(SDKContentState state) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
state | SDKContentState | 是 | 无 | 内容共享状态 |
版本支持: v3.3.0+
回调概述: 返回远端视频流状态信息
回调定义:
virtual void onVideoStreamChanged(const XYArray& streamArray) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
streamArray | 是 | 无 | 远端视频流信息 |
版本支持: v3.3.0+
回调概述: 上报视频流裸数据 dataSourceId : SDK为没路视频流的分配的资源标志 本地预览的sourceId 固定为:LocalPreviewID 本地预览的固定帧率为30fps@720p,推流最大帧率也为30fps
回调定义:
virtual void onVideoFrameReady(const char* dataSourceId, const SDKVideoFrame& videoFrame) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
dataSourceId | const char* | 是 | 无 | SDK为每路视频流分配的资源标志 |
videoFrame | SDKVideoFrame | 是 | 无 | 视频帧数据 |
版本支持: v3.3.0+
回调概述: 某种因素引起视频状态的变化
回调定义:
virtual void onVideoStatusChanged(SDKVideoStatus status) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
status | SDKVideoStatus | 是 | 无 | 视频状态 |
版本支持: v3.3.0+
回调概述: 本地网络状况上报 回调频率根据入会终端期望带宽和DBA(动态带宽调整)探测带宽的比例计算 计算的Level不同会上报,同时也跟终端网络的稳定性有关 一共4档:1、2、3、4 分别为:差、中、良、优
回调定义:
virtual void onNetworkIndicatorLevel(int level) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
level | int | 是 | 无 | 网络状况等级 |
版本支持: v3.3.0+
回调概述: 本地设备发生变化上报
回调定义:
virtual void onDeviceChanged(const SDKMediaDevType& devType) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
devType | SDKMediaDevType | 是 | 无 | 媒体设备类型 |
版本支持: v3.3.0+
回调概述: 上报麦克风状态
回调定义:
virtual void onMicMuted(bool muted) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
muted | bool | 是 | 无 | 是否静音 |
版本支持: v3.3.0+
回调概述: Mic能量改变(0-100)
回调定义:
virtual void onMicEnergyReported(int energy) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
energy | int | 是 | 无 | 麦克风能量 |
版本支持: v3.3.0+
回调概述: SDK错误回调
回调定义:
virtual void onError(const XYString& code) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
code | 是 | 无 | 错误码 |
版本支持: v3.3.0+
回调概述: 会控字幕
回调定义:
virtual void onConfCaptionChanged(const SDKConfCaption& notify) {};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
notify | SDKConfCaption | 是 | 无 | 字幕信息 |
版本支持: v3.3.0+
回调概述: 出入会通知
回调定义:
virtual void onInOutReminder(const XYArray& info) {};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
info | 是 | 无 | 出入会信息 |
版本支持: v3.3.0+
回调概述: 会控清空举手信息回调
回调定义:
virtual void onConfHandupCancelled() {};
版本支持: v3.3.0+
回调概述: 发言者列表
回调定义:
virtual void onSpeakersChanged(const XYArray& meters) {};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
meters | 是 | 无 | 音频计量信息 |
版本支持: v3.3.0+
回调概述: 人脸识别数据回调
回调定义:
virtual void onAIFaceRecv(const SDKAIParam& info) {};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
info | SDKAIParam | 是 | 无 | AI参数信息 |
版本支持: v3.3.0+
回调概述: getFaceInfo回调
回调定义:
virtual void onAIFaceInfo(const XYString& data) {};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
data | 是 | 无 | 人脸信息数据 |
版本支持: v3.3.0+
回调概述: getGPUInfo回调
回调定义:
virtual void onGPUInfoResult(const XYArray& gInfo) {};
回调参数:
版本支持: v3.3.0+
回调概述: 云端录制状态通知 isStart: 开始/结束 uri: 录制发起者名称
回调定义:
virtual void onRecordStatusNotification(int callIndex, bool isStart, const XYString& uri, const XYString& callUri, const XYString& status) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
callIndex | int | 是 | 无 | 会议索引 |
isStart | bool | 是 | 无 | 是否开始 |
uri | 是 | 无 | 录制发起者名称 | |
callUri | 是 | 无 | 呼叫URI | |
status | 是 | 无 | 状态 |
版本支持: v3.3.0+
回调概述: 云端录制回调 recordState: 录制状态 reason: 原因, 见(json error code)
回调定义:
virtual void onRecordingStateChanged(SDKRecordingState recordState, const XYString& reason, bool isRecorded) = 0;
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
recordState | SDKRecordingState | 是 | 无 | 录制状态 |
reason | 是 | 无 | 原因 | |
isRecorded | bool | 是 | 无 | 是否已录制 |
版本支持: v3.3.0+
回调概述: 会控关闭摄像头回调
回调定义:
virtual void onMeetingMuteQuery(const XYString& meetingId, const XYString& key) {};
回调参数:
版本支持: v3.3.0+
回调概述: 日志上传回调
回调定义:
virtual void onLoguploadResult(const SDKRestApiResult& result) {};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | SDKRestApiResult | 是 | 无 | 上传结果 |
版本支持: v3.3.0+
回调概述: 会控主持人回调
回调定义:
virtual void onConfHostChanged(const SDKConfHost& meetingHost) {};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
meetingHost | SDKConfHost | 是 | 无 | 会议主持人信息 |
版本支持: v3.3.0+
回调概述: 互动工具回调
回调定义:
virtual void onInteractiveToolInfoResult(const SDKInteractiveToolInfo& result) {};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | SDKInteractiveToolInfo | 是 | 无 | 互动工具信息 |
版本支持: v3.3.0+
回调概述: 签到回调
回调定义:
virtual void onSubmitSignatureInfosResult(const SDKSubmitSignResult& result) {};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
result | SDKSubmitSignResult | 是 | 无 | 签到结果 |
版本支持: v3.3.0+
回调概述: 同传字母是否支持回调
回调定义:
virtual void onSupportAiCaptionResult(bool isSupport) {};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
isSupport | bool | 是 | 无 | 是否支持 |
版本支持: v3.3.0+
回调概述: AI字幕信息变化回调
回调定义:
virtual void onAiCaptionInfoChanged(const SDKAiCaptionInfo& info) {};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
info | SDKAiCaptionInfo | 是 | 无 | AI字幕信息 |
版本支持: v3.3.0+
回调概述: socksProxy验证连通性回调
回调定义:
virtual void onSocksProxyValidateCompleted(SDKSocksValidateError error) {};
回调参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
error | SDKSocksValidateError | 是 | 无 | 错误码 |