本文档包含NemoSDK中所有函数接口概览列表。
方法 | 描述 | 版本 |
NemoSDK初始化 | 3.11.0 | |
更新当前应用语言 | 3.11.0 | |
关闭SDK | 3.3.0 | |
网络波动可能造成初始化失败，网络恢复后调用此接口，无需重新初始化 | 3.11.0 | |
设置服务器 | 3.11.0 | |
设置自动探测服务器地址 | 3.11.0 | |
设置UserAgent | 3.11.0 | |
NemoSDK初始化 | 3.3.0 |
方法 | 描述 | 版本 |
账号登录(账号必须跟sdk开通时的所属企业相同, 否则会鉴权失败) | 3.11.0 | |
token登录 | 3.11.0 | |
第三方账户登录 | 3.11.0 | |
账号登录(账号必须跟sdk开通时的所属企业相同, 否则会鉴权失败) | 3.11.0 | |
使用验证码登录（默认会验证密码安全策略，链接入会及加入会议登录时无需验证） | 3.11.0 | |
使用第三方账户登录 | 3.11.0 | |
链接入会匿名登录 | 3.11.0 | |
token登录 | 3.11.0 | |
授权码登录 | 3.11.0 | |
新用户注册并自动登录 | 3.11.0 | |
SSO登录 | 3.11.0 | |
第三方登录 | 3.11.0 | |
自动登录(有cache使用cache，无cache重新调用账号密码登录) | 3.11.0 | |
认证登录 | 3.3.0 | |
登出 | 3.3.0 | |
获取验证码 | 3.11.0 | |
验证验证码是否正确 | 3.11.0 | |
获取图形验证码 | 3.11.0 | |
检验图图形验证码拖拽位置是否正确 | 3.11.0 | |
忘记密码修改新密码 | 3.11.0 | |
修改密码 | 3.11.0 | |
修改用户信息(仅限小鱼账号) | 3.11.0 | |
删除用户自定义头像(仅限小鱼账号) | 3.11.0 | |
根据邮箱获取企业域名 | 3.11.0 | |
获取企业配置. 目前只用来获取企业是否开启强密码 | 3.11.0 | |
获取消息中心未读数 | 3.11.0 | |
获取支持的三方平台列表 | 3.11.0 | |
聚合接口 获取相关配置 | 3.11.0 | |
获取服务器配置信息（主动调用是在登录成功后调用，此函数针对断网再连接时手工调用） | 3.11.0 | |
获取特殊字符正则表达式 | 3.11.0 | |
获取默认特殊字符正则表达式 | 3.11.0 | |
获取直播独立域名 | 3.11.0 | |
获取会议室配置信息(仅限小鱼账号) | 3.11.0 | |
更新会议室配置信息(仅限小鱼账号) | 3.11.0 | |
查询会议是否仅预约呼叫 | 3.11.0 | |
更新会议是否仅预约呼叫 | 3.11.0 | |
查询会议容量 | 3.11.0 | |
云会议断线重呼设置 | 3.11.0 | |
通话中免打扰设置 | 3.11.0 | |
主持会议免打扰设置 | 3.11.0 | |
使用该企业下的 XYLINK 账号登录（小鱼账号必须属于 SDK 开通时所绑定的企业，否则将鉴权失败） | 3.3.0 | |
3.3.0 | ||
3.3.0 | ||
认证登录 | 3.3.0 |
方法 | 描述 | 版本 |
获取历史通话记录 | 3.11.0 | |
删除指定历史通话记录 | 3.11.0 | |
发起呼叫 | 3.11.0 | |
挂断呼叫 | 3.3.0 | |
结束会议 | 3.11.0 | |
接受点对点(p2p)被叫 | 3.11.0 | |
拒绝点对点(p2p)被叫 | 3.3.0 | |
查询呼入会议ParticipantInfo信息 | 3.11.0 | |
请求最新一次会议预约的接口 | 3.11.0 | |
请求全部会议预约的接口 | 3.11.0 | |
获取跟相当会议冲突的预约会议信息 | 3.11.0 | |
会议中与预约会议冲突，关闭掉预约会议 | 3.11.0 | |
获取CallUrlInfo信息 | 3.11.0 | |
发起呼叫（如果 displayName 为空，则使用 loginExternalAccount 时传入的 displayName；如果不为空，则使用新的 displayName） | 3.3.0 | |
接听 | 3.3.0 |
方法 | 描述 | 版本 |
举手发言 | 3.11.0 | |
发言结束 | 3.11.0 | |
申请发言和取消申请发言 | 3.11.0 | |
签到 | 3.3.0 | |
通过会议号查询与即时会议有关的会议室信息, 该信息由onMeetingRoomInfoForInstant函数返回，信息中包含入会的网络链接等。 | 3.11.0 | |
获取敏感词 | 3.11.0 | |
查询会中水印信息 | 3.11.0 | |
会中修改用户名 | 3.11.0 | |
呼叫H323设备 | 3.11.0 | |
通过callurl遥控摄像头 | 3.11.0 | |
切换会议模式 | 3.11.0 | |
会议中停止/开始发送摄像头视频，并且通知远端 | 3.3.0 | |
会议中停止/开始发送Mic音频，并通知远端 | 3.3.0 | |
设置本地预览视频分辨率 | 3.11.0 | |
设置本地预览视频分辨率 | 3.3.0 | |
举手发言 | 3.3.0 | |
发言结束 | 3.3.0 | |
取消举手 | 3.3.0 | |
遥控远端摄像头: 远端视频流信息(对应UI上的视频窗格)SDKVideoStreamInfo包含所需参数 | 3.3.0 | |
会中邀请h323设备, remoteUri: 终端calluri, key: 号码 | 3.3.0 | |
记录日志 | 3.3.0 | |
切换通话模式 | 3.3.0 |
方法 | 描述 | 版本 |
按需请流 根据配置请求相应流数据 | 3.11.0 | |
统一layout更改布局模式 | 3.11.0 | |
返回主会场 | 3.11.0 | |
订阅参会者列表(最大20个)，优先请流，uri为参会者设备唯一标志，如：123456@DESK，123456为小鱼用户ID，DESK(桌面)为终端类型 | 3.3.0 | |
按需清流 | 3.3.0 |
方法 | 描述 | 版本 |
设置摄像头采集参数，发送、接受视频最大能力，呼叫前设置有效 | 3.11.0 | |
设置订阅参会者列表(最大20个)，优先请流 | 3.11.0 | |
设置本地视频渲染配置 | 3.11.0 | |
设置本地视频镜像翻转 | 3.11.0 | |
（D3D11）开启本地其他路视频 | 3.11.0 | |
（D3D11）关闭本地其他路视频 | 3.11.0 | |
启动摄像头采集 & 用于摄像头检测 会中或者会议建立以后（onCallStateChanged(connected)） | 3.3.0 | |
关闭摄像头采集 & 用于摄像头检测 会中或者退会之前关闭（onCallStateChanged(disconnected)） | 3.3.0 | |
清空本地视频渲染画面 | 3.11.0 | |
清空本地其它路视频渲染画面 | 3.11.0 | |
UI与native GL render绑定 | 3.11.0 | |
UI与native GL render解绑 | 3.11.0 | |
是否可以绘制GL | 3.11.0 | |
UI上调用GL render，实现OpenGL画面渲染 | 3.11.0 | |
获取视频裸数据 | 3.11.0 | |
获取视频源的图像信息 | 3.11.0 | |
获取本地扬声器能量(音量检测使用) | 3.3.0 | |
获取扬声器能量(具体值 0-100) | 3.3.0 | |
设置本地扬声器能量（具体值0-100） | 3.3.0 | |
获取本地麦克风能量（检测使用） | 3.3.0 | |
获取麦克风能量（具体值0-100） | 3.3.0 | |
设置麦克风能量（具体值0-100） | 3.3.0 | |
开始音频采集 | 3.11.0 | |
停止音频采集 | 3.11.0 | |
开启远端音频能量峰值计量 | 3.3.0 | |
获取远端音频能量 | 3.11.0 | |
音频旁路 | 3.3.0 | |
释放音频焦点, 会外设备检测完成之后, 如果需要释放音频的话调用 | 3.3.0 | |
pulse支持 | 3.3.0 | |
设置mic增益, 通过调节mic采集增益来放大输出声音, 但是噪声也会放大 | 3.3.0 | |
PSE 开启/关闭 | 3.11.0 | |
检查使用的采集设备是否为耳机 | 3.11.0 | |
获取视频裸数据(SDK会主动推流@link#onVideoFrameReady, 如果需要主动拉流，设置@startup#SDKConfigs.enablePushVideo=false) | 3.3.0 | |
设置视频配置，呼叫前设置有效 | 3.3.0 | |
获取远端音频能量 | 3.3.0 |
方法 | 描述 | 版本 |
获取显示器列表 | 3.11.0 | |
获取媒体设备列表 | 3.11.0 | |
获取音频PCM列表 | 3.11.0 | |
通用选择设备 如果type为空字符串 isInConf才生效（适配linux） | 3.11.0 | |
开始播放测试文件用于扬声器检测 | 3.3.0 | |
结束播放测试文件用于扬声器检测 | 3.3.0 | |
使能麦克风检测 | 3.3.0 | |
获取显示器列表 | 3.3.0 | |
获取设备列表 | 3.3.0 | |
通用选择设备 (Linux平台通话中选择设备, 调用chooseDev(SDKMediaDevType, const char*, bool)接口, 通话外两者都行) | 3.3.0 | |
Linux平台选择设备, isInConf: 是否在会中, 用于会中切换设备 | 3.3.0 |
方法 | 描述 | 版本 |
开始共享 | 3.11.0 | |
停止内容共享 | 3.3.0 | |
开始进行共享内容采集 | 3.11.0 | |
暂停共享内容采集 | 3.11.0 | |
恢复共享内容采集 | 3.11.0 | |
停止共享内容采集 | 3.11.0 | |
共享是否关闭扣掉小鱼程序（共享桌面相关函数 仅Windows平台实现,共享的时候咱们xysdk会把小鱼的程序扣掉，远端看不到。这个就是设置不要扣掉，让远端能看到） | 3.11.0 | |
设置wgc适配属性窗口是否不设置蓝框和标注窗口 | 3.11.0 | |
获得分享桌面中的最顶层应用名称、ID、窗口句柄列表，目前只有Windows实现 | 3.11.0 | |
根据窗口句柄获取窗口的显示区域 | 3.11.0 | |
获取显示器截图 | 3.11.0 | |
更新共享内容采集的区域 | 3.11.0 | |
根据文件路径获取文件的信息 | 3.11.0 | |
采集共享文件的某一个时间点的内容 | 3.11.0 | |
调正共享的音视频声音大小 | 3.11.0 | |
设置是否开启多路共享音频 | 3.11.0 | |
设置是否需要监听当前speaker变化 | 3.11.0 | |
设置是否开启双屏模式 | 3.11.0 |
方法 | 描述 | 版本 |
开启白板 | 3.11.0 | |
关闭白板 | 3.11.0 | |
清空白板 | 3.11.0 | |
发送白板画线 | 3.11.0 | |
开启标注 | 3.11.0 | |
关闭标注 | 3.11.0 | |
清空标注 | 3.11.0 | |
发送标注画线 | 3.11.0 | |
通知采集开始/结束标注 | 3.11.0 |
方法 | 描述 | 版本 |
加载电子铭牌模块 | 3.11.0 | |
请求本地人脸识别 | 3.11.0 | |
请求人脸信息 | 3.3.0 | |
设置Wayland模式 | 3.11.0 | |
设置虚拟背景模式 | 3.11.0 | |
设置用户自定义虚拟背景图片路径 | 3.11.0 | |
设置滤镜的风格和滤镜效果等级 | 3.11.0 | |
设置美颜的风格和效果等级 | 3.11.0 | |
启用/禁用虚拟数字人 | 3.11.0 | |
设置本地视频降噪选项 | 3.11.0 | |
设置本地视频暗光增强选项 | 3.11.0 | |
设置远端内容流锐化是否开启 | 3.11.0 | |
获取gpu信息 | 3.3.0 | |
开启gpu加速, 如果启用虚拟背景跟美颜, 在初始化之后可以开启gpu加速 | 3.3.0 | |
广播本地电子铭牌到远端: 开启后接收端可以收到广播出去的人脸信息 | 3.3.0 | |
人脸识别模式 | 3.3.0 | |
虚拟背景模式 | 3.3.0 | |
虚拟背景图片, 仅支持jpg格式 (其他格式得话应用层自己处理格式转换跟存储逻辑, 可参考demo) | 3.3.0 | |
设置美颜效果 | 3.3.0 | |
设置滤镜效果 | 3.3.0 |
方法 | 描述 | 版本 |
开启云端录制 | 3.11.0 | |
关闭云端录制 | 3.3.0 | |
开始本地录制(仅支持Windows) | 3.11.0 | |
停止本地录制(仅支持Windows) | 3.11.0 | |
更新本地录制布局信息(仅支持Windows) | 3.11.0 | |
设置本地录制文件保存路径(仅支持Windows) | 3.11.0 | |
获取录制过期文件 | 3.11.0 | |
暂停云端录制 现有客户端暂无实现 | 3.3.0 | |
开启云端录制 | 3.3.0 |
方法 | 描述 | 版本 |
同声传译配置设置 | 3.11.0 | |
开启或关闭只采集指定音频通道的声音 | 3.11.0 | |
清除只采集指定音频通道声音设定 | 3.11.0 | |
关闭额外媒体会话 | 3.11.0 | |
开启额外媒体会话 | 3.11.0 | |
更新额外媒体会话 | 3.11.0 | |
设置同声传译原声压制 | 3.11.0 |
方法 | 描述 | 版本 |
设置通话字幕语言类型 | 3.11.0 | |
是否开启通话字幕 | 3.11.0 | |
是否支持同传字幕 | 3.3.0 | |
是否开启历史字幕 | 3.11.0 | |
是否开启AI助手 | 3.11.0 | |
设置同传字幕语言类型 | 3.3.0 |
方法 | 描述 | 版本 |
设置代理 | 3.11.0 | |
验证socks proxy | 3.11.0 | |
网络测试 | 3.11.0 | |
获取后台配置线路列表 | 3.11.0 | |
保存路由线路 | 3.11.0 | |
清除路由线路 | 3.11.0 | |
探测云服务器 | 3.11.0 | |
设置代理 | 3.3.0 | |
验证socksProxy连通性 | 3.3.0 |
方法 | 描述 | 版本 |
升级检测 | 3.11.0 | |
升级包下载 | 3.11.0 | |
停止升级包下载 | 3.11.0 | |
设置文件下载路径，必须设置，如果没有，后续的操作不再执行 | 3.11.0 | |
请求模块信息 | 3.11.0 | |
获取模块信息（每次打开模块页面都需要调用） | 3.11.0 |
方法 | 描述 | 版本 |
获取通话简单统计信息 | 3.11.0 | |
获取通话详细统计信息 | 3.11.0 | |
上报事件 | 3.11.0 | |
通过SDK记录日志 | 3.11.0 | |
日志上传 | 3.11.0 | |
取消日志上传 | 3.11.0 | |
根据日志类型获取会中日志标识 | 3.11.0 | |
更新会中dump日志 | 3.3.0 | |
保存会中详细日志Dump | 3.11.0 | |
保存音频日志Dump | 3.11.0 | |
ae audio dump 入会前设置，dump本次会叫总的音频数据 | 3.3.0 | |
是否开启小鱼回声消除功能(默认启用) | 3.3.0 | |
取消aedumper | 3.11.0 | |
标记aedumper | 3.11.0 | |
ae audio dump 入会前设置，dump本次会叫总的音频数据(加密) | 3.11.0 | |
获取通话统计信息 | 3.3.0 | |
获取详细统计信息 | 3.3.0 | |
日志上传 | 3.3.0 |
方法 | 描述 | 版本 |
上报App信息至服务端 | 3.11.0 | |
更新IP和Mac地址 | 3.11.0 | |
下载文件 | 3.11.0 | |
取消下载文件 | 3.11.0 | |
AES加密算法加密 | 3.11.0 | |
AES加密算法加密 | 3.11.0 | |
RSA加密算法加密 | 3.11.0 | |
上报终端能力，做端适配云校验 | 3.11.0 | |
终端回调会控是否开启/关闭摄像头 | 3.11.0 | |
获取认证同步 | 3.11.0 | |
手动处理iPhone方向变化 | 3.11.0 | |
启动主控 | 3.11.0 | |
停止主控 | 3.3.0 | |
获取扩展设备列表 | 3.11.0 | |
打开同声传译非翻译员通道（普通参会者） | 3.11.0 | |
打开同声传译翻译员通道 | 3.11.0 | |
重置回普通通道 | 3.11.0 | |
获取当前通道id | 3.11.0 | |
更新非翻译员同声传译配置 | 3.11.0 | |
刷新翻译员同声传译配置 | 3.11.0 | |
初始化流加密模块 | 3.11.0 | |
设置加密工具实例地址 | 3.11.0 | |
手动媒体选择 | 3.11.0 | |
输入content数据视频流 | 3.3.0 | |
自定义外部视频输入源 | 3.11.0 | |
自定义音频流输入 | 3.11.0 | |
设置当前会议播放声音模式 | 3.11.0 | |
配置媒体数据发送方式：可以自定义音视频输入源，开启之后之前UI自定义音视频数据输入源 | 3.11.0 | |
将YUV格式转换为ARGB格式 | 3.3.0 | |
同步3.3版本缓存登录数据 | 3.11.0 | |
双因子+初始密码设置，取消修改初始密码时清空cache | 3.11.0 | |
设置资源文件根目录 | 3.11.0 | |
创建原生OpenGL着色器 | 3.11.0 | |
销毁原生OpenGL着色器 | 3.11.0 | |
绘制OpenGL帧 | 3.11.0 | |
获取云控配置 | 3.11.0 | |
获得当前会议室的邀请通讯录成员权限 | 3.11.0 | |
设置低性能模式 | 3.11.0 | |
立即重连WebSocket | 3.11.0 | |
获取NemoSDK版本 | 3.11.0 | |
获取企业国密状态 | 3.11.0 | |
启动主控 | 3.3.0 | |
unused | 3.3.0 |