本文档包含NemoSDK中所有其他杂项功能的函数接口。
版本支持: 3.11.0
函数概述: 上报App信息至服务端
函数定义:
virtual void reportAppInfo(long long floor) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
floor | long long | 是 | 无 | 楼层信息 |
版本支持: 3.11.0
函数概述: 更新IP和Mac地址
函数定义:
virtual void updateNetworkAddress(const char* ipAddress, const char* macAddress) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
ipAddress | const char* | 是 | 无 | IP地址 |
macAddress | const char* | 是 | 无 | MAC地址 |
版本支持: 3.11.0
函数概述: 下载文件
函数定义:
virtual void downloadFile(const char* url, const char* fileSaveDir) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
url | const char* | 是 | 无 | 下载文件url地址 |
fileSaveDir | const char* | 是 | 无 | 文件储存地址 |
版本支持: 3.11.0
函数概述: 取消下载文件
函数定义:
virtual void cancelDownload(const char* url) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
url | const char* | 是 | 无 | 下载文件url地址 |
版本支持: 3.11.0
函数概述: AES加密算法加密
函数定义:
virtual bool AESCTR_decrypt(unsigned char* key, int keylen, const unsigned char* input, int inputlen, unsigned char* output, int& outputlen) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
key | unsigned char* | 是 | 无 | 加密key |
keylen | int | 是 | 无 | 加密key长度 |
input | const unsigned char* | 是 | 无 | 加密的文本 |
inputlen | int | 是 | 无 | 加密文本长度 |
output | unsigned char* | 是 | 无 | 加密完成后的密文 |
outputlen | int& | 是 | 无 | 密文长度 |
返回值:
bool - 是否成功
版本支持: 3.11.0
函数概述: AES加密算法加密
函数定义:
virtual bool AESCTR_encrypt(unsigned char* key, int keylen, const unsigned char* input, int inputlen, unsigned char* output, int& outputlen) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
key | unsigned char* | 是 | 无 | 加密key |
keylen | int | 是 | 无 | 加密key长度 |
input | const unsigned char* | 是 | 无 | 加密的文本 |
inputlen | int | 是 | 无 | 加密文本长度 |
output | unsigned char* | 是 | 无 | 加密完成后的密文 |
outputlen | int& | 是 | 无 | 密文长度 |
返回值:
bool - 是否成功
版本支持: 3.11.0
函数概述: RSA加密算法加密
函数定义:
virtual void RSA_encrypt(const char* text) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
text | const char* | 是 | 无 | 要加密的文本 |
版本支持: 3.11.0
函数概述: 上报终端能力,做端适配云校验
函数定义:
virtual void reportCapability(const XYArray<XYAbilityType>& localAbility) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
localAbility | const XYArray<XYAbilityType>& | 是 | 无 | 本地终端能力 |
版本支持: 3.11.0
函数概述: 终端回调会控是否开启/关闭摄像头
函数定义:
virtual void replyMeetingControlMuteAction(bool agree, const char* reason) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
agree | bool | 是 | 无 | 是否同意 |
reason | const char* | 是 | 无 | 原因 |
版本支持: 3.11.0
函数概述: 获取认证同步
函数定义:
virtual void getAuthSync(const char* hostAddress) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
hostAddress | const char* | 是 | 无 | 服务器地址 |
版本支持: 3.11.0
函数概述: 手动处理iPhone方向变化
函数定义:
virtual void orientationChanged(int orientation) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
orientation | int | 是 | 无 | 方向值 |
版本支持: 3.11.0
函数概述: 启动主控
函数定义:
virtual void startMaster(const XYExMasterParam& param) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
param | const XYExMasterParam& | 是 | 无 | 主控参数 |
版本支持: 3.3.0
函数概述: 停止主控
函数定义:
virtual void stopMaster() = 0;
版本支持: 3.11.0
函数概述: 获取扩展设备列表
函数定义:
virtual std::vector<XYExCapDeviceInfo> getExDeviceList() = 0;
返回值:
std::vector<XYExCapDeviceInfo> - 扩展设备信息列表
版本支持: 3.11.0
函数概述: 打开同声传译非翻译员通道(普通参会者)
函数定义:
virtual void openLanguageChannel(int id, const char* language, bool audioMute = false, bool originalChanelMute = false) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
id | int | 是 | 无 | 同声传译通道id |
language | const char* | 是 | 无 | 语言描述 |
audioMute | bool | 否 | false | 是否关闭麦克风 |
originalChanelMute | bool | 否 | false | 是否关闭原音 |
版本支持: 3.11.0
函数概述: 打开同声传译翻译员通道
函数定义:
virtual void openLanguageTranslatorChanel(int id, const char* language, bool audioMute = false) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
id | int | 是 | 无 | 同声传译通道id |
language | const char* | 是 | 无 | 语言描述 |
audioMute | bool | 否 | false | 是否关闭麦克风 |
版本支持: 3.11.0
函数概述: 重置回普通通道
函数定义:
virtual void resetLanguageChannel(bool clearTranslationSource) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
clearTranslationSource | bool | 是 | 无 | 是否清除所有同声传译信息 |
版本支持: 3.11.0
函数概述: 获取当前通道id
函数定义:
virtual int getLastLanguageId() = 0;
返回值:
int - 当前通道id
版本支持: 3.11.0
函数概述: 更新非翻译员同声传译配置
函数定义:
virtual void refeshTranslateConfig(bool micMute, bool originalChanelMute = false) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
micMute | bool | 是 | 无 | 是否关闭麦克风 |
originalChanelMute | bool | 否 | false | 是否关闭原音 |
版本支持: 3.11.0
函数概述: 刷新翻译员同声传译配置
函数定义:
virtual void refreshTranslatorConfig(bool micMute) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
micMute | bool | 是 | 无 | 是否关闭麦克风 |
版本支持: 3.11.0
函数概述: 初始化流加密模块
函数定义:
virtual void cryptoInit(const char* clientInfo, const char* bodyStr) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
clientInfo | const char* | 是 | 无 | 客户端信息json字符串(host cerPath等) |
bodyStr | const char* | 是 | 无 | json字符串(host port) |
版本支持: 3.11.0
函数概述: 设置加密工具实例地址
函数定义:
virtual void setEncryptor(long long util) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
util | long long | 是 | 无 | 加密工具子类实例化的内存地址 |
版本支持: 3.11.0
函数概述: 手动媒体选择
函数定义:
virtual void setManualMedia(const XYArray<XYMediaManualItem>& manualMediaItems) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
manualMediaItems | const XYArray<XYMediaManualItem>& | 是 | 无 | 手动媒体选择类型数组 |
版本支持: 3.3.0
函数概述: 输入content数据视频流
函数定义:
virtual void putContentData(void *data, size_t bufLen, int width, int height, int stride) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
data | void* | 是 | 无 | 视频数据 |
bufLen | size_t | 是 | 无 | 数据长度 |
width | int | 是 | 无 | 视频宽度 |
height | int | 是 | 无 | 视频高度 |
stride | int | 是 | 无 | 视频步长 |
版本支持: 3.11.0
函数概述: 自定义外部视频输入源
函数定义:
virtual bool inputExternalVideoData(XYVideoData &sdkVideoData) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
sdkVideoData | 是 | 无 | 视频源 |
返回值:
bool - 是否成功
版本支持: 3.11.0
函数概述: 自定义音频流输入
函数定义:
virtual bool inputExternalAudioData(XYAudioData& sdkAudioData) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
sdkAudioData | 是 | 无 | 音频数据 |
返回值:
bool - 是否成功
版本支持: 3.11.0
函数概述: 设置当前会议播放声音模式
函数定义:
virtual void setAudioPlayFilter(const XYArray<XYString>& calluris, XYAudioPlayMode mode) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
calluris | 是 | 无 | callUri或者externalUserId数组 | |
mode | 是 | 无 | 播放模式 |
版本支持: 3.11.0
函数概述: 配置媒体数据发送方式:可以自定义音视频输入源,开启之后之前UI自定义音视频数据输入源
函数定义:
virtual void enableMeidiaTXConfig(XYMeidiaTXConfig config) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
config | 是 | 无 | 自定义输入源配置 |
版本支持: 3.3.0
函数概述: 将YUV格式转换为ARGB格式
函数定义:
virtual void convertYUV2ARGB(const uint8_t* data, uint8_t* dst_argb, size_t bufLen, int width, int height, int rotate, bool flip) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
data | const uint8_t* | 是 | 无 | 源YUV数据 |
dst_argb | uint8_t* | 是 | 无 | 目标ARGB数据 |
bufLen | size_t | 是 | 无 | 数据长度 |
width | int | 是 | 无 | 图像宽度 |
height | int | 是 | 无 | 图像高度 |
rotate | int | 是 | 无 | 旋转角度 |
flip | bool | 是 | 无 | 是否翻转 |
版本支持: 3.11.0
函数概述: 同步3.3版本缓存登录数据
函数定义:
virtual void synchronousLoginCacheInfo(XYSynchronousAccountInfo info) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
info | 是 | 无 | 登录信息 |
版本支持: 3.11.0
函数概述: 双因子+初始密码设置,取消修改初始密码时清空cache
函数定义:
virtual void clearCacheLoginInfo() = 0;
版本支持: 3.11.0
函数概述: 设置资源文件根目录
函数定义:
virtual void setResourceRootPath(const char* path) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
path | const char* | 是 | 无 | 目录地址 |
版本支持: 3.11.0
函数概述: 创建原生OpenGL着色器
函数定义:
virtual void* createGLRender() const = 0;
返回值:
void* - OpenGL渲染器指针
版本支持: 3.11.0
函数概述: 销毁原生OpenGL着色器
函数定义:
virtual void destoryGLRender(void* render) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
render | void* | 是 | 无 | OpenGL渲染器指针 |
版本支持: 3.11.0
函数概述: 绘制OpenGL帧
函数定义:
virtual void drawGLFrame(void* render, const char* sourceId, bool isContent, int width, int height) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
render | void* | 是 | 无 | 由createGLRender创建的渲染器指针 |
sourceId | const char* | 是 | 无 | 视频源ID,参考onVideoStreamChanged |
isContent | bool | 是 | 无 | 是否为内容窗口 |
width | int | 是 | 无 | 当前视频窗口宽度 |
height | int | 是 | 无 | 当前视频窗口高度 |
版本支持: 3.11.0
函数概述: 获取云控配置
函数定义:
virtual void getCloudConfig(const char* enterpriseId, bool isLogined) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
enterpriseId | const char* | 是 | 无 | 企业id |
isLogined | bool | 是 | 无 | 是否登录 |
版本支持: 3.11.0
函数概述: 获得当前会议室的邀请通讯录成员权限
函数定义:
virtual void getMeetingInvitedPermission() = 0;
版本支持: 3.11.0
函数概述: 设置低性能模式
函数定义:
virtual void setLowPerfMode(bool lowMode) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
lowMode | bool | 是 | 无 | 是否设置低性能模式 |
版本支持: 3.11.0
函数概述: 立即重连WebSocket
函数定义:
virtual void reConnectWsRightNow() = 0;
版本支持: 3.11.0
函数概述: 获取NemoSDK版本
函数定义:
virtual const char* getNemoSDKVersion() = 0;
返回值:
const char* - SDK版本字符串
版本支持: 3.11.0
函数概述: 获取企业国密状态
函数定义:
virtual void getGMStatus() = 0;
版本支持: 3.3.0
函数状态: 已废弃, 请使用 startMaster(const XYExMasterParam& param)
函数概述: 启动主控
函数定义:
virtual void startMaster(const SDKExMasterParam& param) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
param | const SDKExMasterParam& | 是 | 无 | 主控参数 |
版本支持: 3.3.0
函数状态: 已废弃, 请使用 getExDeviceList()
函数概述: unused
函数定义:
virtual std::vector<SDKExCapDeviceInfo> getExDeviceList(bool isOld = true) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
isOld | bool | 否 | true | 用来区分是否是3.3.0版本的接口,无实际意义 |
返回值:
std::vector - unused