本文档包含NemoSDK中所有交互相关的函数接口。
版本支持: 3.11.0
函数概述: 举手发言
函数定义:
virtual void speakingReq(bool speaking) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
speaking | bool | 是 | 无 | 是否举手发言 |
版本支持: 3.11.0
函数概述: 发言结束
函数定义:
virtual void speakingEnd() = 0;
版本支持: 3.11.0
函数概述: 申请发言和取消申请发言
函数定义:
virtual void applySpeaking(XYApplySpeaking speaking) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
speaking | 是 | 无 | 具体参数设置 |
版本支持: 3.3.0
函数概述: 签到
函数定义:
virtual void signIn(const char* url, const char* identifier) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
url | const char* | 是 | 无 | 签到url 从会控发起的ws消息里面拿到 |
identifier | const char* | 是 | 无 | 签到id 从会控发起签到的ws消息里面拿到 |
版本支持: 3.11.0
函数概述: 通过会议号查询与即时会议有关的会议室信息, 该信息由onMeetingRoomInfoForInstant函数返回，信息中包含入会的网络链接等。
函数定义:
virtual void getMeetingRoomInfoForInstant(const char* confNumber, const char* meetingId, const char* scheduleMeetingId, bool inMeeting) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
confNumber | const char* | 是 | 无 | 会议号 |
meetingId | const char* | 是 | 无 | 会议ID |
scheduleMeetingId | const char* | 是 | 无 | 预约会议ID |
inMeeting | bool | 是 | 无 | 是否在会议中 |
版本支持: 3.11.0
函数概述: 获取敏感词
函数定义:
virtual void getSensitiveWords() = 0;
版本支持: 3.11.0
函数概述: 查询会中水印信息
函数定义:
virtual void getWatermark(const char* meetNum) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
meetNum | const char* | 是 | 无 | 会议号 |
版本支持: 3.11.0
函数概述: 会中修改用户名
函数定义:
virtual void setUserNameInMeeting(const char* mID, const char* mNum, const char* callUri, const char* modifyName, const char* virtualNum) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
mID | const char* | 是 | 无 | 会议id |
mNum | const char* | 是 | 无 | 会议号 |
callUri | const char* | 是 | 无 | 会议callurl |
modifyName | const char* | 是 | 无 | 修改的名称 |
virtualNum | const char* | 是 | 无 | 虚拟number 从callstateinfo中拿到直接回传 |
版本支持: 3.11.0
函数概述: 呼叫H323设备
函数定义:
virtual void dialDtmf(int callIndex, const char* peerUri, const char* content) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
callIndex | int | 是 | 无 | 会议callindex |
peerUri | const char* | 是 | 无 | 会议callurl |
content | const char* | 是 | 无 | 输入内容 |
版本支持: 3.11.0
函数概述: 通过callurl遥控摄像头
函数定义:
virtual void farEndHardwareControl(const char* callUri, XYFECCCommand command, int angle) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
callUri | const char* | 是 | 无 | 被遥控者的callurl |
command | 是 | 无 | 摄像头旋转状态 | |
angle | int | 是 | 无 | 摄像头旋转弧度 |
版本支持: 3.11.0
函数概述: 切换会议模式
函数定义:
virtual void setCallMode(int callIndex, XYCallMode callMode, bool audioMute = false, bool videoMute = false) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
callIndex | int | 是 | 无 | 会议callindex |
callMode | 是 | 无 | 切换成的会议类型 | |
audioMute | bool | 否 | false | 开始/停止音频发送 |
videoMute | bool | 否 | false | 开始/停止视频发送 |
版本支持: 3.3.0
函数概述: 会议中停止/开始发送摄像头视频，并且通知远端
函数定义:
virtual void setVideoMute(bool bMute) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
bMute | bool | 是 | 无 | 停止发送或开始发送 |
版本支持: 3.3.0
函数概述: 会议中停止/开始发送Mic音频，并通知远端
函数定义:
virtual void setMicMute(bool bMute) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
bMute | bool | 是 | 无 | 停止发送或开始发送 |
版本支持: 3.11.0
函数概述: 设置本地预览视频分辨率
函数定义:
virtual void setLocalPreviewResolution(XYVideoResolution res) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
res | 是 | 无 | 视频分辨率 |
版本支持: 3.3.0
函数状态: 已废弃, 请使用 setLocalPreviewResolution(XYVideoResolution res)
函数概述: 设置本地预览视频分辨率
函数定义:
virtual void setLocalPreviewResolution(SDKVideoResolution res) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
res | SDKVideoResolution | 是 | 无 | 分辨率信息 |
版本支持: 3.3.0
函数状态: 已废弃, 请使用 speakingReq(bool speaking)
函数概述: 举手发言
函数定义:
virtual void sendSpeakingRequest() = 0;
版本支持: 3.3.0
函数状态: 已废弃, 请使用 speakingEnd()
函数概述: 发言结束
函数定义:
virtual void sendSpeakingEnd() = 0;
版本支持: 3.3.0
函数状态: 已废弃, 请使用 speakingReq(bool speaking)
函数概述: 取消举手
函数定义:
virtual void cancelSpeakingRequest() = 0;
版本支持: 3.3.0
函数状态: 已废弃, 请使用 farEndHardwareControl(const char* callUri, XYFECCCommand command, int angle)
函数概述: 遥控远端摄像头: 远端视频流信息(对应UI上的视频窗格)SDKVideoStreamInfo包含所需参数
函数定义:
virtual void farEndHardwareControl(const char* callUri, SDKFECCCommand command, int angle) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
callUri | const char* | 是 | 无 | 远端callUri |
command | SDKFECCCommand | 是 | 无 | 指令 |
angle | int | 是 | 无 | 角度(0~360) |
版本支持: 3.3.0
函数状态: 已废弃, 请使用 dialDtmf(int callIndex, const char* peerUri, const char* content)
函数概述: 会中邀请h323设备, remoteUri: 终端calluri, key: 号码
函数定义:
virtual void sendDtmf(const char* remoteUri, const char* key) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
remoteUri | const char* | 是 | 无 | 远端uri |
key | const char* | 是 | 无 | 键值 |
版本支持: 3.3.0
函数状态: 已废弃, 请使用 log(const char* log)
函数概述: 记录日志
函数定义:
virtual void dumpInfo(const char* info) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
info | const char* | 是 | 无 | 日志内容 |
版本支持: 3.3.0
函数状态: 已废弃, 请使用 setCallMode(int callIndex, XYCallMode callMode, bool audioMute = false, bool videoMute = false)
函数概述: 切换通话模式
函数定义:
virtual void switchCallMode(bool audioMode, bool audioMute, bool videoMute) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
audioMode | bool | 是 | 无 | audioMode: ture: 语音模式, false: 音视频模式 |
audioMute | bool | 是 | 无 | 当前mic状态 |
videoMute | bool | 是 | 无 | 当前camera状态 |