描述: 视频降噪选项配置
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
mode | VIDEO_DENOISER_MODE | 否 | VIDEO_DENOISER_AUTO | 降噪模式 | |
level | VIDEO_DENOISER_LEVEL | 否 | 50 | 降噪级别 |
嵌套枚举:
VIDEO_DENOISER_MODE: 降噪模式VIDEO_DENOISER_AUTO = 0: 自动模式VIDEO_DENOISER_MANUAL = 1: 手动模式构造函数:
XYVideoDenoiserOptions(VIDEO_DENOISER_MODE denoiserMode, VIDEO_DENOISER_LEVEL denoiserLevel): 带参数构造函数XYVideoDenoiserOptions(): 默认构造函数描述: 视频低光增强选项配置
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
mode | LOW_LIGHT_ENHANCE_MODE | 否 | LOW_LIGHT_ENHANCE_MANUAL | 低光增强模式 | |
level | LOW_LIGHT_ENHANCE_LEVEL | 否 | 0 | 低光增强级别 |
嵌套枚举:
LOW_LIGHT_ENHANCE_MODE: 低光增强模式LOW_LIGHT_ENHANCE_AUTO = 0: 自动模式LOW_LIGHT_ENHANCE_MANUAL = 1: 手动模式构造函数:
XYVideoLowLightEnhanceOptions(LOW_LIGHT_ENHANCE_MODE lowLightMode, LOW_LIGHT_ENHANCE_LEVEL lowLightLevel): 带参数构造函数XYVideoLowLightEnhanceOptions(): 默认构造函数描述: sdk基础结构体
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
error | XYError | 否 | XYError_NoError | 错误码 | |
errorMsg | XYString | 否 | "" | 错误描述 |
描述: 区域信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
x | int | 否 | 0 | 区域左上角X坐标 | |
y | int | 否 | 0 | 区域左上角Y坐标 | |
w | int | 否 | 0 | 区域宽度 | |
h | int | 否 | 0 | 区域高度 |
描述: 内容信息，用于startContentCapture函数作为参数
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
source | const char* | 否 | nullptr | 屏幕时为显示器名称，网络时为URL，媒体文件时为URL，摄像头时为设备ID | 备注 |
viewId | int64_t | 否 | 0 | app时为窗口句柄，其他时为0 | |
withAudio | bool | 否 | false | 仅屏幕和app时可用，是否包含音频 | |
region | XYRegion | 否 | - | 仅屏幕时可用，区域信息 | |
localContentPreview | bool | 否 | false | 仅屏幕时可用，是否本地内容预览 | |
enableFluentMode | bool | 否 | false | 是否启用流畅模式 |
描述: 网络代理配置
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
hostAddress | XYString | 否 | "" | 代理主机地址 | |
port | int | 否 | 0 | 代理端口 | |
username | const char* | 否 | "" | 账号，仅SOCKS5认证时使用 | |
password | const char* | 否 | "" | 密码，仅SOCKS5认证时使用 |
描述: 服务器信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
id | XYString | 否 | "" | 数据的唯一标识uuid | |
host | XYString | 否 | "" | 服务器主机地址 | |
httpPort | int | 否 | 0 | HTTP端口 | |
httpsPort | int | 否 | 0 | HTTPS端口 |
描述: 多服务器地址自动信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
timeout | int | 否 | 3 | 探测超时时间 | |
serverList | XYArray | 否 | - | 服务器列表 |
描述: SSL选项配置
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
sslflags | unsigned int | 否 | XYSSLOPT_F_TRUST_ALL | SSL标志位 | |
sslca | const char* | 否 | "" | CA证书文件内容或路径 |
描述: sdk配置信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
cloudServer | const char* | 否 | "" | 云服务地址 | |
openapiServer | const char* | 否 | "" | 开放平台地址 | |
openapiToken | const char* | 否 | "" | 开放平台口令 | |
logFolder | const char* | 否 | "" | 日志路径 | |
logFileName | const char* | 否 | "" | 日志文件名称 | 备注 |
platformTag | const char* | 否 | "" | 平台标识 | |
appType | const char* | 否 | "" | 应用标识 | |
appVersion | const char* | 否 | "" | App版本号 | |
clientId | const char* | 否 | "" | 应用clientId | |
clientSecret | const char* | 否 | "" | 应用clientSecret | |
clientType | const char* | 否 | "" | 应用clientType | |
osVersion | const char* | 否 | "" | 操作系统版本 | |
hwVersion | const char* | 否 | "" | 硬件系统版本 | |
ability | XYArray | 否 | - | 客户端能力集 | |
sslopts | XYSSLOpts | 否 | - | SSL设置 | |
eid | const char* | 否 | "" | 企业id | |
capture | int | 否 | 0 | 采集方法 | |
render | int | 否 | 0 | 渲染方法 | |
contentEncodec | int | 否 | 0 | 共享编码方法 | |
useUnityLayout | bool | 否 | false | 是否使用统一layout | |
appDataDir | const char* | 否 | "" | app data路径 | |
networkProxy | XYNetProxy | 否 | - | 代理相关设置 | |
supportCapabilities | bool | 否 | true | 是否支持能力集 | |
detectServerInfo | XYAutoDetectServerInfo | 否 | - | 多服务器配置信息 | |
configLoginType | const char* | 否 | "" | 信创登录方式 | |
customKey | const char* | 否 | "" | 信创定制ck | |
logFilterKey | const char* | 否 | "" | 日志过滤规则 | |
logFilterKeyNum | const char* | 否 | "" | 日志过滤规则 | |
logFilterKeys | const char* | 否 | "" | 日志过滤规则 | |
enablePushVideo | bool | 否 | true | 使能SDK主动回调裸流 | |
enableBulkRoster | bool | 否 | false | 全量roster | |
enableSDKMiniDump | bool | 否 | false | 是否启用SDK内部minidump | |
enableLayoutPolling | bool | 否 | false | 是否启用layout轮询能力 |
描述: token登陆参数
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
loginPath | const char* | 否 | "" | 登录地址 | |
loginToken | const char* | 否 | "" | 登录token | |
withMcuDetect | bool | 否 | false | 是否进行网络探测 | |
loginType | const char* | 否 | "" | 登录类型 |
描述: 三方公司信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
platformCode | XYString | 否 | "" | 平台码 | |
platformName | XYString | 否 | "" | 平台名称 | 备注 |
image | XYString | 否 | "" | 平台图片 | |
url | XYString | 否 | "" | 平台跳转地址 |
描述: SSO登录信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
domain | XYString | 否 | "" | 域名 | |
returnUrl | XYString | 否 | "" | SSO登录跳转地址 | |
enterpriseId | XYString | 否 | "" | 企业id | |
enterpriseMail | XYString | 否 | "" | 企业邮箱 | |
certificate | XYString | 否 | "" | 证书 | |
hostOperationType | int | 否 | 0 | SSO登录类型，1为应用内打开，其他为web打开 |
描述: 获取SSO信息回调
版本: 3.11.0
继承: XYBaseResult
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
status | XYString | 否 | "" | 状态码，10200表示成功 | |
info | XYString | 否 | "" | 信息（unused） | |
data | XYSSOInfo | 否 | - | SSO登录信息 |
描述: 企业信息
版本: 3.11.0
继承: XYBaseResult
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
enterpriseName | XYString | 否 | "" | 企业名称 | 备注 |
描述: 云会议室功能其他使能配置
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
hrRecord | bool | 否 | false | 是否支持超高清录制 | |
showRecordTip | bool | 否 | false | 是否显示录制消息 | |
onlyMainImage | int | 否 | 0 | 只录制主会场和发言 | |
addDeviceName | bool | 否 | false | 录制视频中叠加终端名称 | 备注 |
allowCallScope | int | 否 | 0 | 呼叫范围：CLOSE(0), ALL(1), ENTERPRISE(2), NO_ANONYMOUS(3) | |
multipleRecord | int | 否 | 0 | 允许多路录制 | |
separateRecordAudio | bool | 否 | false | 所有入会终端声音单独录制 | |
allowSeparateRecord | bool | 否 | false | 所有入会终端单独录制 | |
forceRecord | bool | 否 | false | 强制录制 | |
inoutReminder | bool | 否 | false | 出入会通知 | |
disableTranscriptionEng | bool | 否 | false | 禁用字幕英文翻译 | |
recordMode | int | 否 | 0 | 录制模式：0音视频录制，1仅音频录制 | |
watermark | int | 否 | 0 | 水印：0不开启，1明水印，2暗水印，3明暗水印 | |
watermarkRange | int | 否 | 0 | 水印叠加范围：0内容共享时，1全画面 | |
mediaEncrypt | XYString | 否 | "" | 加密算法：0自适应，1aes256，2sm4 | |
maxShowedRecResolution | XYString | 否 | "" | 最大显示录制分辨率 | |
maxAllowedRecResolution | XYString | 否 | "" | 最大允许录制分辨率 | |
recordingResolution | XYString | 否 | "" | 录制分辨率 | |
translate | bool | 否 | false | 是否打开同声传译 | |
displayConfNo | bool | 否 | false | 会议详情 | |
enableWaitingRoom | bool | 否 | false | 开启等候室 | |
allowEnterBeforePresenter | bool | 否 | false | 允许在主持人前进入 | |
enableContentLive | bool | 否 | false | 允许多路内容共享 | |
enableContentLiveOnHold | bool | 否 | false | 管理员广播才能收看共享 | |
allowMaxContentNum | int | 否 | 0 | 最大内容共享路数 | |
forceVideoOn | bool | 否 | false | 入会强制开启摄像头 | |
onlyScheduledCall | bool | 否 | false | 仅允许预约呼叫 | |
allowTempUserCall | bool | 否 | false | 允许临时账号入会 | |
tempUserCallApproved | bool | 否 | false | 由主持人管控入会 | |
meetingCapacityCount | int | 否 | 0 | 会议容量 | |
subtitle | bool | 否 | false | 通话字幕开关 | |
transcription | bool | 否 | false | 录制自动生成会议转写 | |
intelligentMeetingMinutes | bool | 否 | false | 录制自动生成智能纪要 | |
transcriptionInMeeting | bool | 否 | false | 入会自动生成会议纪要 | |
onlyOwnerInvite | bool | 否 | false | 只有owner拥有分享链接权限 | |
userJoinMeetingPwdNotNull | bool | 否 | false | 入会密码不能为空 | |
audioWatermark | bool | 否 | false | 音频水印 | |
cascadeBetweenMeeting | bool | 否 | false | 开启会间级联 | |
forbidInvitedCascade | bool | 否 | false | 会间级联禁止被邀请 | |
enableInvitedAutoCascade | bool | 否 | false | 收到邀请自动级联 | |
crossCloudCallScope | int | 否 | 0 | 跨云呼叫权限 | |
cloudId | XYString | 否 | "" | 分区号 | |
shareChatContentPermission | XYString | 否 | "0" | 分享聊天内容权限 |
描述: 云会议室功能可见性配置
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
allowSeparateRecord | bool | 否 | false | 独立终端录制 | |
contacts | bool | 否 | false | 通讯录可见配置 | |
enableHrLive | bool | 否 | false | 高清直播 | |
forceRecord | bool | 否 | false | 强制录制 | |
hideWatermark | bool | 否 | false | 暗水印 | |
multipleRecord | bool | 否 | false | 多路录制 | |
separateRecordAudio | bool | 否 | false | 参会终端声音单独录制 | |
showForceVideoOn | bool | 否 | false | 入会是否强制打开摄像头 | |
subtitle | bool | 否 | false | 同传字幕 | |
transcription | bool | 否 | false | 录制自动生成会议转写 | |
showIntelligentMeetingMinutes | bool | 否 | false | 录制自动生成会议纪要 | |
translate | bool | 否 | false | 同声传译 | |
showWatermark | bool | 否 | false | 明水印 | |
showTranscriptionInMeeting | bool | 否 | false | 入会自动生成会议纪要 | |
showRecordMode | bool | 否 | false | recordMode可见性配置 | |
showAudioWatermark | bool | 否 | false | 音频水印 | |
enableCascade | bool | 否 | false | 显示级联相关选项 |
描述: 云会议室配置信息
版本: 3.11.0
继承: XYBaseResult
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
id | XYString | 否 | "" | 云会议室主键id | |
meetingNumber | XYString | 否 | "" | 云会议室号码 | |
displayName | XYString | 否 | "" | 云会议室名称 | 备注 |
password | XYString | 否 | "" | 入会密码 | |
meetingControlPassword | XYString | 否 | "" | 会控密码 | |
autoMute | int | 否 | 0 | 自动静音 | |
smartMutePerson | int | 否 | 0 | 智能静音个数 | |
expireTime | int | 否 | 0 | 失效时间 | |
adminUserId | int | 否 | 0 | 个人云会议室的用户id | |
ownerUserId | int | 否 | 0 | 企业云会议室的管理员id | |
permanent | bool | 否 | false | 永久or临时会议室标志 | |
conferenceNumberType | int | 否 | 0 | 云会议室类型标识 | |
enterpriseId | XYString | 否 | "" | 企业id | |
configs | XYCloudMeetingRoomConfigs | 否 | - | 其他使能配置 | |
configDisplays | XYCloudMeetingRoomConfigDisplays | 否 | - | 可见性配置 |
描述: 账户信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
callUri | XYString | 否 | "" | 终端标志，小鱼后台给登陆账号分配的唯一呼叫号码 | |
displayName | XYString | 否 | "" | 用户名称 | 备注 |
profilePicture | XYString | 否 | "" | 用户头像 | |
extUserId | XYString | 否 | "" | 三方用户ID | |
userId | long | 否 | 0 | 小鱼系统用户ID | |
deviceId | long | 否 | 0 | 软终端无需关注 | |
XYString | 否 | "" | 邮箱 | ||
peerNumber | XYString | 否 | "" | 用于点对点呼叫号码 | |
callNum | XYString | 否 | "" | 用于呼叫号码 | |
userInEnterprise | bool | 否 | false | 用户是否存在与企业之中 | |
securityKey | XYString | 否 | "" | 安全码 | |
enterpriseAdmin | bool | 否 | false | 是否为企业管理员 | |
initPassword | bool | 否 | false | 初始密码安全 | |
enhancePassword | bool | 否 | false | 强密码策略 | |
validate | bool | 否 | false | 邮箱验证 | |
enterpriseId | XYString | 否 | "" | 企业ID | |
extErrorInfo | XYString | 否 | "" | 额外信息 | |
userDevice | XYString | 否 | "" | 用户设备 | |
loginType | XYString | 否 | "" | 登录类型 | |
enterpriseSecurityConfigTimeMillis | long long | 否 | 0 | 密码安全策略最后修改时间戳 | |
realUserId | XYString | 否 | "" | userid字符串类型 | |
tempUser | bool | 否 | false | 临时用户 |
描述: 缓存登录用户信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
callUri | const char* | 否 | "" | 终端标志，小鱼后台给登陆账号分配的唯一呼叫号码 | |
displayName | const char* | 否 | "" | 用户名称 | 备注 |
profilePicture | const char* | 否 | "" | 用户头像 | |
extUserId | const char* | 否 | "" | 三方用户ID | |
userId | long | 否 | 0 | 小鱼系统用户ID | |
deviceId | long | 否 | 0 | 软终端无需关注 | |
const char* | 否 | "" | 邮箱 | ||
peerNumber | const char* | 否 | "" | 用于点对点呼叫号码 | |
userInEnterprise | bool | 否 | false | 用户是否存在与企业之中 | |
securityKey | const char* | 否 | "" | 安全码 | |
enterpriseAdmin | bool | 否 | false | 是否为企业管理员 | |
initPassword | bool | 否 | false | 初始密码安全 | |
enhancePassword | bool | 否 | false | 强密码策略 | |
validate | bool | 否 | false | 邮箱验证 | |
enterpriseId | const char* | 否 | "" | 企业ID | |
extErrorInfo | const char* | 否 | "" | 额外信息 | |
userDevice | const char* | 否 | "" | 用户设备 | |
loginType | const char* | 否 | "" | 登录类型 | |
enterpriseSecurityConfigTimeMillis | long long | 否 | 0 | 密码安全策略最后修改时间戳 | |
realUserId | const char* | 否 | "" | userid字符串类型 | |
tempUser | bool | 否 | false | 临时用户 |
描述: API网关签名信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
accessToken | XYString | 否 | "" | 网关accessToken | |
refreshToken | XYString | 否 | "" | 网关token刷新token | |
expires | long | 否 | 0 | token过期时间 | |
tokenType | XYString | 否 | "" | token类型 | |
scope | XYString | 否 | "" | 作用域 | |
domain | XYString | 否 | "" | 作用域 | |
signSecret | XYString | 否 | "" | 网关签名证书 | |
signType | XYArray | 否 | - | 网关签名类型 |
描述: 黑名单项目
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
disableGPUs | XYArray | 否 | - | GPU黑名单 | |
disableTranslucenceWindowCPUs | XYArray | 否 | - | CPU名单 | |
disableTranslucenceWindowVersions | XYArray | 否 | - | 操作系统版本 | |
deviceNames | XYArray | 否 | - | 硬件设备名 |
描述: UI能力黑名单
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
windowsItem | XYBlackListItem | 否 | - | windows黑名单 |
描述: 虚拟背景配置
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
images | XYArray | 否 | - | 配置图片列表 | |
initValue | bool | 否 | true | 是否为默认配置 |
描述: 企业配置信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
displayCloudMeetingRoomUpgradeBadge | bool | 否 | false | 是否显示云会议室升级标识 | |
displayEnterpriseResource | bool | 否 | false | 是否显示企业资源 | |
enableApplySpeak | bool | 否 | false | 是否启用申请发言 | |
enableEnterpriseMemberInvatition | bool | 否 | false | 是否启用企业成员邀请 | |
enableModifyPhone | bool | 否 | false | 是否启用修改手机号 | |
enableMonitor | bool | 否 | false | 是否启用监控 | |
enableVodShare | bool | 否 | false | 是否启用点播分享 | |
shareMaxNumSetting | bool | 否 | false | 是否启用分享最大数量设置 | |
displayEnterpriseOrUnitString | XYString | 否 | "" | 显示企业或单位字符串 | |
enableMultipleShared | bool | 否 | false | 是否启用多路共享 | |
multipleSharedCount | int | 否 | 0 | 多路共享数量 | |
userAvatarMode | int | 否 | 1 | 是否开启用户文本头像 | |
forbidChangeName | bool | 否 | false | 是否禁止修改名称 | 备注 |
openTempAccount | bool | 否 | false | 是否开启临时账号 | |
disableTranscriptionEng | bool | 否 | false | 是否禁用英文转写 |
描述: 用户配置信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
customerExperienceNemo | int | 否 | 0 | 配置188188 | |
customerServiceNemo | int | 否 | 0 | 视频客服 | |
customerServicePhone | XYString | 否 | "" | 电话客服 | |
customizedEnterpriseLogo4Desktop | XYString | 否 | "" | 自定义企业logo | |
customizedEnterpriseLogo | XYString | 否 | "" | 自定义企业logo | |
customizedEnterpriseName | XYString | 否 | "" | 自定义企业名称 | 备注 |
enableChangeMail | bool | 否 | false | 能否修改邮箱 | |
enableChangeName | bool | 否 | false | 能否修改用户名 | |
enableChangePassword | bool | 否 | false | 能否修改密码 | |
enableCreateLive | bool | 否 | false | 能否创建直播 | |
enableCreateMeeting | bool | 否 | false | 能否创建会议 | |
enableHrRecord | bool | 否 | false | 能否开启高清录制 | |
enableInfinitePageFlip | bool | 否 | false | 能否无限翻页 | |
enableLive | bool | 否 | false | 是否显示直播 | |
enableNettoolUdp | bool | 否 | false | 是否显示网络调试工具 | |
enableShareCenter | bool | 否 | false | 是否启用分享中心 | |
enableShowDesktopSharing | bool | 否 | false | 是否显示桌面共享 | |
enableWindowSizeFollowup | bool | 否 | false | 是否启用窗口大小跟随 | |
enableLocalRecording | bool | 否 | false | 是否显示本地录制 | |
officialSite | XYString | 否 | "" | 官方网站 | |
showApChannel | bool | 否 | false | 是否显示AP通道 | |
showAttendee | bool | 否 | false | 是否显示参会者 | |
showCalendar | bool | 否 | false | 是否显示日程 | |
showEnableSitePath | bool | 否 | false | 是否显示mcu路径的配置项 | |
showFaceDetect | bool | 否 | false | 是否显示人脸识别 | |
showHostMeeting | bool | 否 | false | 是否显示主持会议 | |
showImageShare | bool | 否 | false | 是否显示图片共享 | |
showInviteCall | bool | 否 | false | 是否显示邀请通话 | |
showInviteMeeting | bool | 否 | false | 是否显示发起会议 | |
showJoinMeeting | bool | 否 | false | 是否显示加入会议 | |
showLive | bool | 否 | false | 是否显示直播 | |
showMailbox | bool | 否 | false | 是否显示邮箱 | |
showPassword | bool | 否 | false | 是否显示密码 | |
showRecordInCall | bool | 否 | false | 是否显示云端录制 | |
showRecording | bool | 否 | false | 是否显示云端录制 | |
showScheduleMeeting | bool | 否 | false | 是否显示预约会议 | |
showShareCenter | bool | 否 | false | 是否显示共享中心 | |
showSharedFolder | bool | 否 | false | 是否显示共享文件夹 | |
showUserName | bool | 否 | false | 是否显示用户名 | |
showWhiteboard | bool | 否 | false | 是否显示白板 | |
customerServiceLicense | bool | 否 | false | 是否显示隐私政策 | |
blackList | XYBlackList | 否 | - | 黑名单列表 | |
lowPerfList | XYBlackList | 否 | - | 低性能列表 | |
virtualBgImageList | XYVirtualBgImageList | 否 | - | 虚拟背景配置 | |
showRealTimeTranslation | bool | 否 | false | 是否显示实时转写 | |
showPseConfig | bool | 否 | false | 是否显示PSE功能入口 |
描述: 运营平台配置信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
showService188 | bool | 否 | false | 是否显示188188 | |
showUseGuide | bool | 否 | false | 是否显示用户引导 | |
showPhoneService | bool | 否 | false | 是否显示客服信息 | |
showVideoService | bool | 否 | false | 是否显示288288 | |
showOwnedEnterprise | bool | 否 | false | 是否显示所属企业 | |
enableShareMeetingLink | bool | 否 | false | 是否显示发起会议邀请 | |
enableInviteInMeeting | bool | 否 | false | 是否显示会议中邀请 | |
hideInviteTypeConfig | XYArray | 否 | - | 邀请类型配置信息 |
描述: 账户状态信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
account | XYString | 否 | "" | 账号 | |
retryLogin | bool | 否 | false | 登录是否重试 | |
errorCode | int | 否 | 0 | 错误码 | |
userMessage | XYString | 否 | "" | 错误提示 | |
clientTimeMillis | long double | 否 | 0.0 | 上次登录时密码安全策略最后修改时间 | |
updateTimeMillis | long double | 否 | 0.0 | 当前密码安全策略最后修改时间 |
描述: 入口配置信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
flag | XYString | 否 | "" | 入口类型 | |
display | bool | 否 | false | 是否显示 | |
url | XYString | 否 | "" | 跳转链接 |
描述: 入口配置信息列表
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
entrance | XYArray | 否 | - | 入口列表 |
描述: clientConfig结果
版本: 3.11.0
继承: XYBaseResult
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
uiCustomization | XYUICustomizationInfo | 否 | - | 用户配置信息 | |
enterpriseConfig | XYEnterpriseConfig | 否 | - | 企业配置信息 | |
eopCustomizedConfig | XYEOPCustomizedConfig | 否 | - | 运营平台配置信息 | |
accountStatus | XYAccountStatus | 否 | - | 账户状态信息 | |
entranceList | XYEntranceList | 否 | - | 入口配置信息 |
描述: 共享app信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
appId | unsigned long | 否 | 0 | app id | |
appName | XYString | 否 | "" | app名称 | 备注 |
window | void* | 否 | nullptr | app窗口句柄 |
描述: 视图请求信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
isContent | bool | 否 | false | 是否为共享 | |
reqFaceDetect | bool | 否 | false | 是否请求人脸识别 | |
exDeviceID | const char* | 否 | "" | 扩展设备ID | |
callUri | XYString | 否 | "" | 如果不指定，SDK将按照内部机制自动填充 | |
resolution | XYVideoResolution | 否 | XYVideoResolution_180P | 请流分辨率 | |
quality | XYVideoQuality | 否 | XYVideoQualityLow | 清流质量 | |
isExtend | bool | 否 | false | 是否是扩展流 |
描述: 远端音频能量信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
callUri | const char* | 否 | "" | 参会者标记(123456@DESK) | |
energy | int | 否 | 0 | 声音能量(0-100) | |
pid | int | 否 | 0 | 进程ID |
描述: 视频配置信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
maxResPvtx | XYVideoResolution | 否 | XYVideoResolution_720P | 最大发送(编码)分辨率 | |
maxResPvrx | XYVideoResolution | 否 | XYVideoResolution_720P | 最大接收(解码)分辨率 | |
maxFpsPvtx | XYVideoFrameRate | 否 | XYVideoFrameRate_3000 | 最大发送(编码)帧率 | |
maxFpsPvrx | XYVideoFrameRate | 否 | XYVideoFrameRate_3000 | 最大接收(解码)帧率 |
描述: 视频帧信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
buffer | uint8_t* | 否 | nullptr | 渲染数据 | |
bufLen | size_t | 否 | 0 | 数据长度 | |
width | int | 否 | 0 | 视频帧宽度 | |
height | int | 否 | 0 | 视频帧高度 | |
sarWidth | int | 否 | 0 | 除去黑边高度 | |
sarHeight | int | 否 | 0 | 除去黑边宽度 | |
rotation | int | 否 | 0 | 方向 | |
flipping | bool | 否 | false | 是否镜像 |
描述: 会议信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
callMode | int | 否 | - | 呼叫类型 | |
remoteUri | XYString | 否 | "" | 远端calluri | |
remoteName | XYString | 否 | "" | 远端名称 | 备注 |
remoteNumber | XYString | 否 | "" | 远端号码 | |
remoteAlias | XYString | 否 | "" | 远端别名(unused) | |
remoteType | XYString | 否 | "" | 远端类型(unused) | |
remoteUserId | XYString | 否 | "" | 远端userid |
描述: 会控接口获取的主持人，分级会议室信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
isHost | bool | 否 | false | 是否为会议主持人 | |
isBigConf | bool | 否 | false | 是否为大会议(unused) | |
noCtrPwd | bool | 否 | false | 无控制密码(unused) |
描述: 自定义布局请求
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
pageIndex | int | 否 | 0 | 0表示非对称布局，1表示对称第一屏 | |
maxViewCountPerPage | int | 否 | 0 | 每一屏最大请流数量 | |
uiShowLocalWhenPageMode | bool | 否 | true | 翻页是否包含自己 | |
reqList | XYArray | 否 | - | 请流列表 |
描述: 呼叫状态信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
callState | XYCallState | 否 | XYCallState_Disconnected | 呼叫状态 | |
sdkError | XYCallError | 否 | XYCallError_None | 错误信息 | |
disconnectReason | XYString | 否 | "" | 断开原因 | |
disconnectDesc | XYString | 否 | "" | 断开描述 | |
meetingNumber | XYString | 否 | "" | 会议号 | |
numberType | XYString | 否 | "" | 会议号类型 | |
displayName | XYString | 否 | "" | 会中显示名称 | 备注 |
displayNumber | XYString | 否 | "" | 会中显示号码 | |
meetingID | XYString | 否 | "" | 会议ID | |
watermark | XYString | 否 | "" | 水印类型 0不开启，1明水印，2暗水印，3明暗水印 | |
waitingReason | XYString | 否 | "" | 加入等候室原因 | |
mpvc | XYString | 否 | "" | 虚拟号，跨云使用 | |
isOnhold | bool | 否 | false | 是否处于等候室 | |
forceVideoOn | bool | 否 | false | 强制开启视频 | |
needHandleWaitingRoom | bool | 否 | false | 是否需要处理进入等候室 | |
callUrl | XYString | 否 | "" | 会议url | |
callMode | int | 否 | -1 | 呼叫类型 | |
displayConfNo | bool | 否 | false | 是否显示会议号 | |
commonStr | XYString | 否 | "" | 额外信息（json字符串） | |
invalidatingPassword | bool | 否 | false | 是否需要密码入会 | |
newCallType | XYNewCallType | 否 | XYNewCallType_Normal | 呼叫类型 | |
shareChatContentPermission | XYString | 否 | "0" | im是否允许复制 |
描述: 呼叫中的远端的视频流信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
muteReason | XYMuteReason | 否 | - | 关闭原因 | |
videoState | XYVideoState | 否 | - | 视频状态 | |
videoSourceId | XYString | 否 | "" | source id | |
displayName | XYString | 否 | "" | 显示名称 | 备注 |
userNumber | XYString | 否 | "" | 用户号 | |
extUserId | XYString | 否 | "" | 三方用户ID | |
callUri | XYString | 否 | "" | 用户calluri | |
dataType | XYDeviceDataType | 否 | - | 设备标识 | |
alias | XYString | 否 | "" | 别名 | |
exDeviceId | XYString | 否 | "" | 扩展设备ID | |
audioMute | bool | 否 | false | 是否静音 | |
isContent | bool | 否 | false | 是否为共享 | |
isActiveSpeaker | bool | 否 | false | 是否当前正在讲话 | |
feccOri | uint32_t | 否 | 0 | 遥控摄像头能力 | |
renderWnd | void* | 否 | nullptr | 绘制窗口句柄 | |
pid | int | 否 | 0 | 进程ID | |
videoWidth | uint32_t | 否 | 0 | 视频宽度 | |
videoHeight | uint32_t | 否 | 0 | 视频高度 | |
oriWidth | uint32_t | 否 | 0 | 原始视频宽度 | |
oriHeight | uint32_t | 否 | 0 | 原始视频高度 | |
x | float | 否 | 0 | x坐标 | |
y | float | 否 | 0 | y坐标 | |
z | float | 否 | 0 | z坐标 | |
w | float | 否 | 0 | 宽度 | |
h | float | 否 | 0 | 高度 | |
flag | uint64_t | 否 | XYLayoutFlag_None | 视频窗口标志 | |
layoutMargin | uint64_t | 否 | XYLayoutMargin_None | 视频窗口间距 | |
viewId | int | 否 | 0 | 视频窗口视图id | |
layoutMode | XYUnityLayoutMode | 否 | XYLayoutMode_Speaker | 布局模式 | |
windowId | XYString | 否 | "" | 窗口唯一id | |
uiTemplateSource | XYUnityLayoutUITemplateSource | 否 | XYLayoutUITemplateSource_None | UI模板源 |
描述: 会话信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
sessionId | int | 否 | 0 | 会话id | |
sessionType | XYAVSessionType | 否 | XYAVSESSION_TYPE_PEOPLE | 0 people, 1 共享 | |
isAtxMute | bool | 否 | false | 关闭音频发送 | |
isArxMute | bool | 否 | false | 关闭音频接收 | |
isVtxMute | bool | 否 | false | 关闭视频发送 | |
isVrxMute | bool | 否 | false | 关闭视频接受 | |
endpointCount | int | 否 | 0 | 参会终端数量 |
描述: 会议参会信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
chairManUrl | XYString | 否 | "" | 主会场 | |
contentUrl | XYString | 否 | "" | 共享 | |
actSpkUri | XYString | 否 | "" | as | |
participantCount | uint32_t | 否 | 0 | 参会人数 | |
contentPartCount | uint32_t | 否 | 0 | 内容分享数量 | |
totalEpCount | uint32_t | 否 | 0 | 参会总人数包括自己 | |
displayableEpCount | uint32_t | 否 | 0 | 参会人数除去hide, onhold, contentonly | |
onHoldCount | uint32_t | 否 | 0 | 等候室等待人数 | |
isSelfContent | bool | 否 | false | 是否为自己共享 | |
contentTotalNum | uint32_t | 否 | 0 | content分享人数 | |
forceContent | bool | 否 | false | 是否强制内容 | |
contentName | XYString | 否 | "" | 内容名称 | 备注 |
contentInfos | XYArray | 否 | - | 会议中的分享content信息 | |
sessionInfos | std::vector | 否 | - | 会话信息 |
描述: 参会者信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
callUri | XYString | 否 | "" | 参会者标志, 如：123456@DESK | |
displayName | XYString | 否 | "" | 显示名称 | 备注 |
extUserId | XYString | 否 | "" | 三方用户ID | |
Alias | XYString | 否 | "" | 别名 | |
isAudioMute | bool | 否 | false | 是否关闭音频 | |
isVideoMute | bool | 否 | false | 是否关闭视频 |
描述: 参会人员详细信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
addParticipants | XYArray | 否 | - | 增加的参会方列表，全量时也包含全部参会方 | |
changeParticipants | XYArray | 否 | - | 有状态变化的参会方，增量时使用 | |
delParticipants | XYArray | 否 | - | 删除的参会方（callUri），增量时使用 | |
rosterType | XYRosterType | 否 | - | 参会人员类型，全量还是增量 | |
totalEpNum | uint32_t | 否 | 0 | 总参会人数 |
描述: 人脸识别位置信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
faceId | int32_t | 否 | 0 | 人脸id | |
left | uint16_t | 否 | 0 | 左间距 | |
top | uint16_t | 否 | 0 | 上间距 | |
right | uint16_t | 否 | 0 | 右间距 | |
bottom | uint16_t | 否 | 0 | 下间距 |
描述: 人脸识别详细信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
faceID | int | 否 | 0 | 人脸识别id | |
position | XYFacePosition | 否 | - | 人脸位置信息 | |
userName | XYString | 否 | "" | 用户名 | |
userNickName | XYString | 否 | "" | 用户昵称 | |
userAge | XYString | 否 | "" | 年龄 | |
userIdentifyCard | XYString | 否 | "" | 人脸标识信息 | |
userTitle | XYString | 否 | "" | 标题 | |
userPhone | XYString | 否 | "" | 电话号码 | |
userStatus | int | 否 | 0 | 用户状态 |
描述: 人脸识别信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
isLocal | bool | 否 | false | 是否为本地视频 | |
calluri | XYString | 否 | "" | calluri | |
participantId | uint32_t | 否 | 0 | 用户id | |
type | XYFaceType | 否 | XYFaceTypeDetect | 人脸识别类型 | |
seq | uint8_t | 否 | 0 | 序列号 | |
detailVec | XYArray | 否 | - | 人脸识别位置信息 |
描述: 本地录制业务信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
title | const char* | 否 | "" | 录制标题 | |
speaker | const char* | 否 | "" | 录制者名称 | 备注 |
confNum | const char* | 否 | "" | 会议号 |
描述: 视频流信息 for local, sourceId means deviceId, if empty string means builtin camara.channelId measn sceanId. for remote, sourceId means remote uri,channelId is useless
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
sourceId | XYString | 否 | "" | sourceid | |
channelId | int | 否 | 0 | 屏幕id | |
ssrc | int | 否 | 0 | SSRC |
描述: 视频信息
版本: 3.11.0
继承: XYLocalRecordVideoSource
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
bLocalVideoSource | bool | 否 | false | 是否为本地视频 | |
bContent | bool | 否 | false | 是否为共享 |
方法:
description() const: 返回描述信息（便于调试）描述: 录制单个cell信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
sourceInfo | XYLocalRecordVideoSourceInfo | 否 | - | 视频信息 | |
displayName | XYString | 否 | "" | 共享者名称 | 备注 |
isVideoReceived | bool | 否 | false | 是否打开视频 | |
isAudioMute | bool | 否 | true | 是否静止音频 | |
left | float | 否 | 0 | 录制坐标 | |
top | float | 否 | 0 | 录制坐标 | |
width | float | 否 | 0 | 录制坐标 | |
height | float | 否 | 0 | 录制坐标 |
方法:
description() const: 返回描述信息（便于调试）描述: 录制布局信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
canvasAspectWidth | int | 否 | 0 | 画布宽度 | |
canvasAspectHeight | int | 否 | 0 | 画布高度 | |
elements | XYArray | 否 | - | 录制cell信息 |
方法:
description() const: 返回描述信息（便于调试）描述: 录制信息(unused)
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
id | int | 否 | 0 | record id | |
fileSize | uint64_t | 否 | 0 | 文件大小 | |
sequenceId | int | 否 | 0 | 序列 | |
needUpload | int | 否 | 0 | 是否需要上传 | |
isLastFile | int | 否 | 0 | 是否为最后一个文件 | |
eventId | XYString | 否 | "" | classId or meetingId | |
title | XYString | 否 | "" | 名称 | 备注 |
speaker | XYString | 否 | "" | 当前说话者 | |
confNumber | XYString | 否 | "" | 会议号 | |
recordingId | XYString | 否 | "" | 录制ID | |
recordingFiles | XYString | 否 | "" | 录制文件 | |
timeStamp | long long | 否 | 0 | 时间戳 |
描述: 录制储存地址
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
localStorePath | const char* | 否 | "" | 储存地址 | |
mobileStorePath | const char* | 否 | "" | 移动端储存地址(unused) |
描述: 共享媒体事件参数
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
errorCode | XYMediaFileErrorType | 否 | XYMediaFileErrorType_NO_ERROR | 错误码 | |
position | int | 否 | 0 | 位置 | |
duration | int | 否 | 0 | 内容事件长度 | |
videoWidth | int | 否 | 0 | 视频宽度 | |
videoHeight | int | 否 | 0 | 视频长度 | |
aspectRatioW | int | 否 | 0 | 比例 | |
aspectRatioH | int | 否 | 0 | 比例 | |
hasVideo | bool | 否 | false | 是否含有视频 | |
hasAudio | bool | 否 | false | 是否含有音频 |
描述: 媒体文件信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
type | XYMediaFileType | 否 | XYMEDIAFILETYPE_NONE | 文件类型 | |
width | int | 否 | 0 | 宽度 | |
height | int | 否 | 0 | 高度 |
描述: 扩展连接参数
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
connType | XYExConnectionType | 否 | XYExConnectionType_UnDefined | 连接类型 | |
moduleType | XYExModuleType | 否 | XYExModuleType_Unknown | 模块类型 | |
serverIP | const char* | 否 | "" | 服务器IP | |
serverPort | uint16_t | 否 | 0 | 服务器端口 | |
maxDataLength | size_t | 否 | 0 | 最大数据长度 | |
readInterval | uint32_t | 否 | 0 | 读取间隔 | |
name | const char* | 否 | "" | 名称 | 备注 |
keepAliveInterval | uint32_t | 否 | 0 | 保活间隔 | |
keepAliveTimeout | uint32_t | 否 | 0 | 保活超时 |
描述: 扩展认证连接参数
版本: 3.11.0
继承: XYExConnParam
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
deviceID | const char* | 否 | "" | 设备ID | |
localIP | const char* | 否 | "" | 本地IP | |
authTimeout | uint32_t | 否 | 0 | 认证超时 |
描述: 扩展主设备参数
版本: 3.11.0
继承: XYExAuthedConnParam
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
serial | const char* | 否 | "" | 序列号 |
描述: 扩展视频能力
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
instanceLimit | unsigned int | 否 | 0 | 实例限制 | |
expendMap | float[XYExResolutionIndex_Count] | 否 | 0 | 扩展映射 |
方法:
operator=(const XYExVideoCap& other): 赋值操作符描述: 扩展场景编码器能力
版本: 3.11.0
继承: XYExVideoCap
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
sceneId | XYExCameraSceneID | 否 | XYExCameraSceneID_Invalid | 场景ID | |
codecType | XYExDevicePTCap | 否 | XYExDevicePTCap_H264 | 编解码器类型 | |
maxFrameRate | float | 否 | 30.0 | 最大帧率 |
方法:
operator=(const XYExSceneEncoderCap& other): 赋值操作符描述: 扩展编码器能力
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
sceneNum | int | 否 | 0 | 场景数量 | |
sceneEncCaps | XYExSceneEncoderCap[MAX_SCENE_COUNT_PER_CAMERA] | 否 | - | 场景编码器能力数组 |
方法:
operator=(const XYExEncoderCap& other): 赋值操作符描述: 扩展麦克风通道
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
channelID | uint32_t | 否 | 0 | 通道ID |
方法:
XYExMicChannel(): 默认构造函数XYExMicChannel(const XYExMicChannel& other): 拷贝构造函数operator=(const XYExMicChannel& other): 赋值操作符描述: 扩展麦克风能力
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
channelNums | int | 否 | 0 | 通道数量 | |
channelArr | XYExMicChannel[MAX_CHANNEL_COUNT_PER_MICROPHONE] | 否 | - | 通道数组 |
方法:
XYExMicCap(): 默认构造函数XYExMicCap(const XYExMicCap& other): 拷贝构造函数operator=(const XYExMicCap& other): 赋值操作符描述: 扩展设备信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
isLocal | bool | 否 | false | 是否为本地设备 | |
deviceID | std::string | 否 | "" | 设备ID | |
name | std::string | 否 | "" | 设备名称 | 备注 |
ip | std::string | 否 | "" | 设备IP | |
type | XYExDeviceType | 否 | XYExDeviceType_Unknown | 设备类型 | |
capType | XYExCapType | 否 | XYExCapType_Undefined | 能力类型 | |
version | std::string | 否 | "" | 版本 | |
model | std::string | 否 | "" | 型号 | |
productId | std::string | 否 | "" | 产品ID | |
hwVersion | std::string | 否 | "" | 硬件版本 | |
connType | XYExConnectionType | 否 | XYExConnectionType_UnDefined | 连接类型 |
方法:
XYExDeviceInfo(): 默认构造函数XYExDeviceInfo(const XYExDeviceInfo& other): 拷贝构造函数operator=(const XYExDeviceInfo& other): 赋值操作符描述: 扩展能力信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
encCap | XYExEncoderCap | 否 | - | 编码器能力 | |
decCap | XYExVideoCap | 否 | - | 解码器能力 | |
micCap | XYExMicCap | 否 | - | 麦克风能力 | |
extraExpend | float | 否 | 0.0 | 额外扩展 |
方法:
XYExCapInfo(): 默认构造函数XYExCapInfo(const XYExCapInfo& other): 拷贝构造函数operator=(const XYExCapInfo& other): 赋值操作符描述: 扩展能力设备信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
(继承自XYExDeviceInfo) | - | - | - | 继承扩展设备信息的所有字段 | |
(继承自XYExCapInfo) | - | - | - | 继承扩展能力信息的所有字段 |
方法:
XYExCapDeviceInfo(): 默认构造函数XYExCapDeviceInfo(const XYExCapDeviceInfo& other): 拷贝构造函数operator=(const XYExCapDeviceInfo& other): 赋值操作符描述: 媒体设备信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
devId | XYString | 否 | "" | 设备id | |
devName | XYString | 否 | "" | 设备名称 | 备注 |
isSelected | bool | 否 | false | 是否选中 | |
isDefault | bool | 否 | false | 是否是系统默认设备 |
描述: 音频PCM相关信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
formatType | uint32_t | 是 | - | PCM_FORMAT_PCM表示定点类型，可以理解为short（16bit）或者int32（32bit），PCM_FORMAT_IEEE_FLOAT表示浮点类型，即float（32bit） | |
samplesPerSec | uint32_t | 是 | - | 一秒钟样点数，即采样率，常见44100Hz，48000Hz等 | |
numChannels | uint32_t | 是 | - | 数据通道数 | |
channelMask | uint32_t | 是 | - | 根据通道数计算出的一组掩码，主要用于表示声道特性，单声道，立体声等 | |
bitsPerSample | uint32_t | 是 | - | 16或者32，表示每个采样点bit数 | |
containerSize | uint32_t | 是 | - | 容器bit数，可以简单认为等于bitsPerSample |
描述: 媒体设备错误参数
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
devType | XYMediaDevType | 是 | - | 设备类型 | |
vidOrdinal | XYVideoOrdinal | 是 | - | 视频序号 | |
devError | XYMediaDevError | 是 | - | 设备错误 |
描述: 分组信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
groupType | int | 否 | -1 | 分组类型 | |
groupLeader | bool | 否 | false | 是否为分组管理员 | |
groupName | XYString | 否 | "" | 分组名称 | 备注 |
描述: 会控信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
chirmanUri | XYString | 否 | "" | 主会场标识 | |
confMgmtUrl | XYString | 否 | "" | 主持会议H5地址 | |
confMgmtMemebersUrl | XYString | 否 | "" | 参会者H5地址 | |
muteSpk | XYString | 否 | "" | on(mute speaker) | off(unmute speaker) |
muteMic | XYString | 否 | "" | mute | unmute |
commonJson | XYString | 否 | "" | 额外信息 | |
disableMute | bool | 否 | false | 是否需要举手发言 | |
disableRecord | bool | 否 | false | 禁止录制 | |
disableContent | bool | 否 | false | 禁止分享 | |
disableWhiteboard | bool | 否 | false | 禁止白板 | |
feccIsDisabled | bool | 否 | false | 遥控摄像头 | |
disableAnnotation | bool | 否 | false | 是否禁止标注 | |
group | XYArray | 否 | - | 分组信息 |
描述: 字幕信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
action | XYString | 否 | "" | 行为 | |
content | XYString | 否 | "" | 内容 | |
location | XYString | 否 | "" | 显示位置 | |
scroll | bool | 否 | false | 是否滚动 | |
fontSize | XYString | 否 | "" | 字体大小 | |
backgroundAlpha | XYString | 否 | "" | 背景透明度 | |
backgroundRGB | XYString | 否 | "" | 背景颜色 | |
fontRGB | XYString | 否 | "" | 字体颜色 | |
scrollSpeed | XYString | 否 | "" | 滚动速度 | |
fontFamily | XYString | 否 | "" | 字体类型 |
描述: 出入会信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
displayName | XYString | 否 | "" | 显示名称 | 备注 |
action | XYString | 否 | "" | in or out | |
extUserId | XYString | 否 | "" | 第三方用户id |
描述: 网络统计信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
rtt | int | 否 | 0 | 往返时间 ms | |
rxDetectBw | int | 否 | 0 | 下行带宽 kbps | |
rxJitter | int | 否 | 0 | 下行抖动 ms | |
rxLost | int | 否 | 0 | 下行丢包率 | |
txDetectBw | int | 否 | 0 | 上行带宽 kbps | |
txJitter | int | 否 | 0 | 上行抖动 ms | |
txLost | int | 否 | 0 | 上行丢包率 |
描述: 视频统计信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
codecType | XYString | 否 | "" | 编码类型 | |
displayName | XYString | 否 | "" | 显示名称 | 备注 |
actBw | int | 否 | 0 | 实际带宽 | |
frameRate | int | 否 | 0 | 帧率 | |
resolution | XYString | 否 | "" | 分辨率 |
描述: 音频统计信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
codecType | XYString | 否 | "" | 编码类型 | |
displayName | XYString | 否 | "" | 显示名称 | 备注 |
actBw | int | 否 | 0 | 实际带宽 |
描述: 音视频会话统计信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
audioRxInfo | XYArray | 否 | - | 下行音频统计数据 | |
audioTxInfo | XYArray | 否 | - | 上行音频统计数据 | |
videoRxInfo | XYArray | 否 | - | 下行视频统计数据 | |
videoTxInfo | XYArray | 否 | - | 上行视频统计数据 |
描述: 呼叫中统计信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
people | XYAVSessionStatistics | 否 | - | 与会人媒体统计信息 | |
content | XYAVSessionStatistics | 否 | - | 共享内容媒体统计信息 | |
network | XYNetworkStatistics | 否 | - | 网络状况统计 | |
encrypt | XYString | 否 | "" | 加密方式 |
描述: 呼叫中详细统计信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
staDBA | XYString | 否 | "" | 下行音频统计 | |
staETC | XYString | 否 | "" | 下行音频统计 | |
staARX | XYString | 否 | "" | 下行音频统计 | |
staATX | XYString | 否 | "" | 上行音频统计 | |
staVTX | XYString | 否 | "" | 上行视频统计 | |
staVRX | XYString | 否 | "" | 下行视频统计 | |
staRoster | XYString | 否 | "" | 花名册统计 | |
staCARX | XYString | 否 | "" | 下行内容统计 | |
staCATX | XYString | 否 | "" | 上行内容统计 | |
staCVTX | XYString | 否 | "" | 上行内容视频统计 | |
staCVRX | XYString | 否 | "" | 下行内容视频统计 |
描述: serverconfig接口回调信息,H5,及反向代理
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
confMgmtUrl | XYString | 否 | "" | 主持会议H5地址 | |
confMgmtMemebersUrl | XYString | 否 | "" | 会控H5地址 | |
pcScheduledMeetingUrl | XYString | 否 | "" | 我的会议H5地址 | |
pcScheduledMeetingUrlV2 | XYString | 否 | "" | 我的会议H5地址(新版) | |
pcContactUrl | XYString | 否 | "" | 联系人H5地址 | |
pcContactUrlV2 | XYString | 否 | "" | 联系人H5地址(新版) | |
pcFolderUrl | XYString | 否 | "" | 文件夹H5地址 | |
pcFolderUrlV2 | XYString | 否 | "" | 文件夹H5地址(新版) | |
pcclientLiveEntryUrl | XYString | 否 | "" | 直播H5地址 | |
pcclientLiveEntryUrlV2 | XYString | 否 | "" | 直播H5地址(新版) | |
pcMeetingDetailUrl | XYString | 否 | "" | 预约会议H5地址 | |
clientImUrl | XYString | 否 | "" | im H5地址 | |
clientImWsUrl | XYString | 否 | "" | im ws地址 | |
callCenterUrl | XYString | 否 | "" | CCC呼叫H5地址 | |
sidebarMeetingControlUrl | XYString | 否 | "" | 侧边栏会控H5地址 | |
webServerUrl | XYString | 否 | "" | 互动工具&聊天H5地址中的h参数 | |
consoleThirdLoginUrl | XYString | 否 | "" | 第三方登录地址 | |
messageCenter | XYString | 否 | "" | 消息中心 | |
messageCenterV2 | XYString | 否 | "" | 消息中心(新版) | |
meetingInviteUrl | XYString | 否 | "" | 会中邀请通讯录成员地址 | |
historySubtitle | XYString | 否 | "" | 实时转写 历史字幕 | |
summaryUrl | XYString | 否 | "" | 会议纪要 | |
pcMeetingAIAssistantUrl | XYString | 否 | "" | 会中AI助手 |
描述: 错误码信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
version | XYString | 否 | "" | 版本 | |
url | XYString | 否 | "" | 下载地址 |
描述: 获取错误码文件回调结果
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
filePath | XYString | 否 | "" | 错误码文件存储地址 |
描述: 获取特殊字符正则表达式回调信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
displayNameSupportCharacters | XYString | 否 | "" | 特殊字符正则表达式 |
描述: 获取默认特殊字符正则表达式回调信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
defaultNameSupportCharacters | XYString | 否 | "" | 默认特殊字符正则表达式 |
描述: unuse
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
code | XYError | 是 | - | 错误码 | |
errorString | XYString | 否 | "" | 错误字符串 |
描述: 更新用户信息回调
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
type | XYUserProfileType | 是 | - | 用户信息更新类型 | |
profilePicture | XYString | 否 | "" | 头像地址 |
描述: 注册接口普回调
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
extErrorInfo | XYString | 否 | "" | 错误信息 |
描述: 下载结果回调
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
status | XYDownloadStatus | 是 | - | 下载状态 | |
cachePath | XYString | 否 | - | 储存地址 | |
filename | XYString | 否 | - | 文件名 | |
url | XYString | 否 | - | 下载地址 |
描述: 下载进度回调
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
url | XYString | 否 | "" | 下载地址 | |
progress | double | 否 | 0.0 | 下载进度 |
描述: 网络测试回调
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
recvQualityLevel | int | 否 | 0 | 网络接收质量等级 | |
sendQualityLevel | int | 否 | 0 | 网络发送质量等级 | |
jitterRecv | double | 否 | 0 | 网络接收抖动 | |
jitterSend | double | 否 | 0 | 网络发送抖动 | |
lostRecv | double | 否 | 0 | 网络接收丢包 | |
lostSend | double | 否 | 0 | 网络发送丢包 | |
missorderRecv | double | 否 | 0 | 网络接收乱序 | |
missorderSend | double | 否 | 0 | 网络发送乱序 | |
rttRecv | double | 否 | 0 | 网络接收往返时间 | |
rttSend | double | 否 | 0 | 网络发送往返时间 |
描述: 版本信息检查回调
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
ss_app_name | XYString | 否 | - | app安装包名称 | 备注 |
platform | XYString | 否 | - | 平台名称 | 备注 |
versionName | XYString | 否 | - | 版本名称 | 备注 |
releaseNote | XYString | 否 | - | 版本注释 | |
md5 | XYString | 否 | - | 安装包MD5 | |
sha256 | XYString | 否 | - | 安装包SHA256 | |
folder | XYString | 否 | - | 安装包下载地址 | |
versionCode | int | 否 | - | 大版本号 | |
devRevision | int | 否 | - | 小版本号 | |
minSupportVersion | int | 否 | - | 最小支持版本 |
描述: 路由站点路径
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
sitePathId | XYString | 否 | "" | pathId | |
networkType | int | 否 | 0 | 1：外网 0：内网 |
描述: 路由站点
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
pathList | XYArray | 否 | - | 路径列表 | |
displayName | XYString | 否 | "" | 路由名称 | 备注 |
enterpriseId | XYString | 否 | "" | "default"：自有线路，""：公共线路 |
描述: 路由列表结果
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
siteList | XYArray | 否 | - | 路由线路列表 | |
currentSitePathId | XYString | 否 | "" | 当前选择路由线路id |
描述: 上传日志结果回调
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
type | XYLogType | 是 | - | 日志类型 | |
id | XYString | 否 | "" | 日志id |
描述: incomingCallUrl结果
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
deviceType | XYString | 否 | - | 设备类型 | |
number | XYString | 否 | - | 号码 | |
callUrl | XYString | 否 | - | url | |
numberType | XYString | 否 | - | 号码类型 | |
callNumber | XYString | 否 | - | 会议号码 | |
displayName | XYString | 否 | - | 名称 | 备注 |
countryCode | XYString | 否 | - | 国家码 | |
avatar | XYString | 否 | - | 头像地址 |
描述: 设备信息配置回调
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
pvrxMaxRecvStream | int | 否 | 0 | 最大接收视频流数量 | |
noDisturbIncall | bool | 否 | false | 会中免打扰 | |
enableCallRecovery | bool | 否 | false | 云会议断线重呼 | |
enableNotDisturbInHosting | bool | 否 | false | 主持会议免打扰 | |
enableConferenceControlSidebar | bool | 否 | false | 会控侧边栏开关 |
描述: 获取第三方登录公司回调信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
status | XYString | 否 | "" | 状态码是"10200"表示成功 | |
data | XYArray | 否 | - | 三方公司信息列表 |
描述: ws信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
type | WSMsgType | 是 | - | ws信息类型 | |
data | XYString | 否 | "" | ws信息内容 |
描述: 申请或取消发言请求信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
callUri | const char* | 否 | "" | 发起者calluri | |
apply | bool | 否 | false | 申请/取消 | |
displayName | const char* | 否 | "" | 发起者名称 | 备注 |
startTime | uint64_t | 否 | 0 | 发起时间 |
描述: 会议信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
number | XYString | 否 | "" | 会议号 | |
callMode | int | 否 | 0 | 呼叫类型 | |
enablePwd | bool | 否 | false | 是否需要密码 | |
meetingPwd | XYString | 否 | "" | 会议密码 | |
displayName | XYString | 否 | "" | 会议用户显示名称 | 备注 |
avatar | XYString | 否 | "" | 头像地址 | |
numberType | XYString | 否 | "" | 会议号类型 | |
target | XYString | 否 | "" | handle virtual number | |
newCallType | int | 否 | 0 | 是否为CCC呼叫 |
描述: 会议状态信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
forceVideoOn | bool | 否 | - | 是否强制打开摄像头 | |
enableContentLive | bool | 否 | - | 是否为多路content会议室 | |
enableContentLiveOnHold | bool | 否 | - | 多路会议室中是否开启管理员指定后广播 | |
disableVirtualBackground | bool | 否 | - | 基于会议维度取消虚拟背景 | |
onlyOwnerInvite | bool | 否 | - | 只有owner拥有分享链接权限 | |
displayRealTimeTranscription | bool | 否 | - | 是否开启实时转写 | |
aiAssistant | bool | 否 | - | 是否开启ai助手 | |
confRoomOwnerList | XYString | 否 | - | 会议室owner列表 | |
shareChatContentPermission | XYString | 否 | "0" | 分享聊天内容权限 |
描述: 麦克风输入信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
energyAverage | int | 否 | 0 | 平均能量 | |
callUri | XYString | 否 | "" | calluri | |
participantId | uint32_t | 否 | 0 | 用户在会中id标识 | |
endpointName | XYString | 否 | "" | 终端名称 | 备注 |
endpointAlias | XYString | 否 | "" | 终端别名 | |
extUserId | XYString | 否 | "" | 外部用户id |
描述: 会控配置信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
isHost | bool | 否 | - | 是否为主持人 | |
isBigConf | bool | 否 | - | 是否为主会议 | |
noCtrPwd | bool | 否 | - | 是否不需要会控密码 |
描述: 通话记录信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
displayName | XYString | 否 | "" | 会议名称 | 备注 |
number | XYString | 否 | "" | 会议号 | |
avatar | XYString | 否 | "" | 头像地址 | |
userProfileId | long | 否 | 0 | unuse | |
callType | int | 否 | 0 | 呼叫类型 | |
numberType | XYString | 否 | "" | 会议号类型 | |
callTime | XYString | 否 | "" | 呼叫时间 |
描述: 通话记录回调信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
code | int | 否 | 0 | 错误码 | |
msg | XYString | 否 | "" | 回调信息 | |
historyList | XYArray | 否 | - | 通话记录列表 |
描述: 会中水印信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
watermark | XYString | 否 | "" | 水印 | |
watermarkRange | XYWatermarkRange | 否 | WatermarkRange_Content | 水印叠加范围 |
描述: 敏感词信息回调
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
sensitiveWords | XYArray | 否 | - | 敏感词列表 |
描述: 最新预约会议回调信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
title | XYString | 否 | "" | 会议标题 | |
owner | XYString | 否 | "" | 会议所属者 | |
conferenceNumber | XYString | 否 | "" | 会议号 | |
id | XYString | 否 | "" | 会议id | |
startTime | long long | 否 | 0 | 会议开始时间 | |
endTime | long long | 否 | 0 | 会议结束时间 |
描述: 当前会议冲突的预约会议信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
meetingId | XYString | 否 | - | 会议id | |
meetingNumber | XYString | 否 | - | 会议号 | |
displayName | XYString | 否 | - | 会议名称 | 备注 |
描述: 互动工具事件信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
eventType | XYInteractiveToolEventType | 是 | - | 事件类型 | |
processType | XYInteractiveToolProcessType | 否 | XYInteractiveToolProcessType_None | 互动工具种类 | |
endAuto | bool | 否 | false | 是否自动结束 | |
voteType | int | 否 | 0 | 互动工具类型 | |
duration | int | 否 | 0 | 倒计时时长 | |
endUtcTime | long long | 否 | 0 | 倒计时时间戳 | |
startWebViewUrl | XYString | 否 | "" | 开始链接地址 | |
resultWebViewUrl | XYString | 否 | "" | 结束链接地址 | |
questionnaireId | XYString | 否 | "" | 互动工具id | |
meetingId | XYString | 否 | "" | 会议id | |
business | XYString | 否 | "" | 业务相关（答题、投票结果展示关闭场景 answerResultShow） |
描述: 互动工文案具回调信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
indexNo | int | 否 | 0 | 互动工具类型 | |
content | XYString | 否 | "" | 文案内容 |
描述: 互动工具回调信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
isSupport | bool | 否 | false | 是否支持互动工具 | |
writings | XYArray | 否 | - | 文案信息 | |
event | XYInteractiveToolEvent | 否 | - | 互动工具事件信息 |
描述: 申请发言回调信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
name | XYString | 否 | "" | 发言者名称，base64编码 | 备注 |
type | XYString | 否 | "" | requestSpeak：申请发言，cancelSpeak：取消发言 | |
uri | XYString | 否 | "" | 发言者callUri | |
startTime | XYString | 否 | "" | 发言时间 |
描述: 提交签到回调信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
status | XYString | 否 | "" | 状态信息 |
描述: kick-off conference info
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
inviteUrl | XYString | 否 | "" | 邀请链接 | |
invokSchema | XYString | 否 | "" | 调用模式 | |
linkNumber | XYString | 否 | "" | 会议号 | |
pstnNumber | XYString | 否 | "" | pstn会议号 | |
shareUrl | XYString | 否 | "" | 会议链接 | |
voiceNumber | XYString | 否 | "" | 电话语音入会号码 | |
userAvatar | XYString | 否 | "" | 会议发起者头像 | |
userName | XYString | 否 | "" | 会议发起者名称 | 备注 |
password | XYString | 否 | "" | 会议密码 | |
displayName | XYString | 否 | "" | 会议名称 | 备注 |
inMeeting | bool | 否 | false | 是在会中发起的请求 |
描述: 会议设置仅预约会议相关
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
onlyScheduledCall | XYString | 否 | "" | 是否仅预约入会 | |
disableUserUpdateOnlyScheduledCall | XYString | 否 | "" | 关闭用户设置仅预约入会 | |
allowTempUserCall | bool | 否 | false | 允许临时账号入会 | |
tempUserCallApproved | bool | 否 | false | 由主持人管控入会 | |
showTempUserCallApproved | bool | 否 | false | 主持人管控入会可见性开关 |
描述: 会议室容量信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
attribute | int | 否 | 0 | 企业归属属性，0-有企业 1-无企业 | |
buyUrl | XYString | 否 | "" | 购买链接 |
描述: 预约会议通知信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
startTime | long long | 否 | 0 | 开始时间 | |
endTime | long long | 否 | 0 | 结束时间 | |
title | XYString | 否 | "" | 标题 | |
conferenceNumber | XYString | 否 | "" | 会议号 | |
id | XYString | 否 | "" | 会议id | |
ownerName | XYString | 否 | "" | 会议创建者名称 | 备注 |
描述: im权限信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
imStatus | XYString | 否 | "" | im状态 | |
meetingId | XYString | 否 | "" | 会议id | |
newImStatus | XYString | 否 | "" | 新的im状态 | |
waiterChatToHost | XYString | 否 | "" | unuse |
描述: App信息(unuse)
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
floor | long long | 否 | 0 | 楼层 | |
sysType | const char* | 否 | "" | 系统类型 | |
version | const char* | 否 | "" | 版本 | |
osVersion | const char* | 否 | "" | 操作系统版本 | |
hwVersion | const char* | 否 | "" | 硬件版本 | |
locale | const char* | 否 | "" | 本地化 | |
macAddress | const char* | 否 | "" | MAC地址 | |
innerIp | const char* | 否 | "" | 内网IP |
描述: 统一layout布局请求
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
windowId | const char* | 否 | "" | window id | |
layoutMode | XYUnityLayoutMode | 否 | XYLayoutMode_Speaker | 布局模式 | |
pageIndex | int | 否 | -1 | 0表示非对称布局，1表示对称第一屏 | |
maxViewCountPerPage | int | 否 | -1 | 每一屏最大请流数量 | |
viewId | int | 否 | -1 | force layout 时传递id | |
localContent | bool | 否 | false | 本地共享独立回显 | |
onlyContent | bool | 否 | false | 仅共享屏幕入会 | |
templateSource | XYUnityLayoutUITemplateSource | 否 | XYLayoutUITemplateSource_None | 模板layout时需要传入source |
描述: 点
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
x | int | 否 | 0 | x坐标 | |
y | int | 否 | 0 | y坐标 |
描述: UI use this struct to send a line to SDK
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
weight | int | 否 | 0 | 线条粗细 | |
color | const char* | 否 | nullptr | 颜色，如"#121212ff" RGBA | |
calluri | const char* | 否 | nullptr | 标识发送到哪里 | |
uuid | const char* | 否 | nullptr | 唯一标识符 | |
points | XYArray | 否 | - | 点数组 | |
ended | bool | 否 | false | 是否结束 | |
getAllLines | bool | 否 | false | 是否获取所有线条 |
描述: 同声传译语言信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
id | int | 是 | - | 语言id | |
zh_CN | XYString | 否 | - | 语言名称（中文） | 备注 |
en_US | XYString | 否 | - | 语言名称（英文） | 备注 |
描述: 同声传译配置信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
conferenceNo | XYString | 否 | - | 会议号 | |
meetingId | XYString | 否 | - | 会议id | |
language | int | 否 | -1 | 语言id | |
originalEnable | bool | 否 | false | 是否开启原音 | |
zh_CN | XYString | 否 | - | 语言名称（中文） | 备注 |
en_US | XYString | 否 | - | 语言名称（英文） | 备注 |
描述: 翻译信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
from | int | 否 | -1 | 翻译的原始语言id | |
to | int | 否 | -1 | 翻译的目标语言id |
描述: 同声传译信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
type | XYTranslateType | 是 | - | 同声传译类型 | |
meetingId | XYString | 否 | - | 会议id | |
callUri | XYString | 否 | - | 会议calluri | |
languages | XYArray | 否 | - | 语言列表 | |
disableTranslatorChannel | bool | 否 | - | 是否将语音信息复制到原声通道一份 | |
languageConfig | XYTranslationConfig | 否 | - | 配置信息 | |
translator | XYTranslator | 否 | - | 翻译员信息 | |
languagesChanged | bool | 否 | false | 相对上一次是否语言发生了变化 | |
isTranslator | bool | 否 | false | 是否为翻译员 |
描述: 同声传译通道变化接口回调信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
languageId | int | 否 | - | 语言通道id |
描述: 会控mute信息变化
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
toast | XYArray | 否 | - | 提示 各个语言第一个为中文 第二个为英文 第三个为其他语言 | |
isMuteCamera | bool | 否 | - | 是否关闭摄像头 | |
isForceUnmuteCamera | bool | 否 | - | 是否强制打开摄像头 |
描述: 经过合并后的能力集接口回调信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
mixedAbility | XYArray | 否 | - | 混合能力集 |
描述: AI同传字幕信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
src | XYString | 否 | "" | 源语言 | |
target | XYString | 否 | "" | 翻译后的语言 | |
isEnd | bool | 否 | false | 一句话是否已经结束 | |
isActive | bool | 否 | false | 收三路,同时只有一路active | |
srcLang | XYAICaptionLanguage | 否 | XYAICaptionLanguage_Chinese | 源语言类型 | |
targetLang | XYAICaptionLanguage | 否 | XYAICaptionLanguage_Chinese | 翻译后语言类型 | |
displayName | XYString | 否 | "" | 用户显示名称 | 备注 |
url | XYString | 否 | "" | 用户callUri | |
meetingId | XYString | 否 | "" | 会议id | |
pid | uint32_t | 否 | 0 | 参会人id | |
wholeMsg | XYString | 否 | "" | 整个消息体数据 | |
endTime | uint64_t | 否 | 0 | 字幕结束时间 | |
seqNo | uint32_t | 否 | 0 | 序列号 | |
uniqueId | XYString | 否 | "" | 唯一标识符 |
方法:
operator==(const XYAICaptionInfo& info) const: 比较操作符描述: 直播独立域名
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
liveDomainUrl | XYString | 否 | "" | 直播域名URL |
描述: H5热更新模块信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
type | XYDynUpsModuleType | 否 | XYDynUpsModuleType_Other | 模块类型 | |
platform | XYString | 否 | "" | 平台 | |
filePath | XYString | 否 | "" | 文件路径 | |
version | XYString | 否 | "" | 版本 | |
entry | XYString | 否 | "" | 对应的platform下所有的H5入口 | |
forceUpdate | bool | 否 | false | 是否强制更新 | |
fromDownLoadFinish | bool | 否 | false | 是否从下载完成 |
方法:
description() const: 返回描述信息描述: 白板信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
ownerName | XYString | 否 | "" | 白板发起人名称 | 备注 |
ownerUri | XYString | 否 | "" | 白板发起uri |
描述: AI会议纪要状态信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
transcription | XYString | 否 | "" | AI同传字幕错误提示信息 | |
meetingNote | XYString | 否 | "" | 会议纪要错误提示信息 | |
recordPromoter | XYString | 否 | "" | 录制发起人角色 |
描述: 企业后台推送UI项目的显示与隐藏
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
type | XYString | 否 | "" | 类型 | |
enable | bool | 否 | true | 是否启用 |
描述: 参会者音频信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
energy | int | 否 | 0 | 能量 | |
callUri | XYString | 否 | "" | 呼叫URI | |
participantId | int | 否 | 0 | 参会者ID |
描述: 白板和标注点信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
x | int | 否 | 0 | x坐标 | |
y | int | 否 | 0 | y坐标 |
描述: 白板和标注线条信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
sequece | int | 否 | 0 | 线的序列号 | |
weight | int | 否 | 0 | 线的粗细 | |
color | XYString | 否 | "" | 线的颜色 | |
sourceCallUri | XYString | 否 | "" | 线目标发送设备calluri | |
targetCallUri | XYString | 否 | "" | 线的原始发出设备calluri | |
uuid | XYString | 否 | "" | 唯一校验码 | |
points | XYArray | 否 | - | 各点合集 | |
ended | bool | 否 | false | 是否是每条线的最后一条信息 |
描述: 手动媒体选择信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
name | XYMediaManualItemName | 是 | - | 媒体手动选择类型 | |
type | XYMediaManualItemType | 是 | - | 媒体手动选择项目类型 |
描述: 统一认证结果
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
type | int | 否 | 0 | 同步认证类型 1：账号密码 2：验证码 3：密码 / 验证码（密码 + 验证码） 4：第三方url | |
authThirdUrl | XYString | 否 | "" | 当认证方式为4时，返回第三方url |
描述: 过期文件提醒
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
name | XYString | 否 | "" | 名称 | 备注 |
count | int | 否 | 0 | 数量 | |
cleanDays | int | 否 | 0 | 清理天数 | |
popupNotice | bool | 否 | false | 是否弹窗提醒 |
描述: 视频数据
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
isContent | bool | 否 | false | 是否为内容视频 | |
width | uint32_t | 否 | 0 | 宽度 | |
height | uint32_t | 否 | 0 | 高度 | |
stride | uint32_t | 否 | 0 | 步长 | |
format | XYVideoFormat | 否 | YUY2 | 视频格式 | |
dataPtr | uint8_t* | 否 | nullptr | 视频数据指针 | |
timeStamp | uint64_t | 否 | 0 | 时间戳（毫秒） | |
cropX | uint32_t | 否 | 0 | 裁剪起始X位置 | |
cropY | uint32_t | 否 | 0 | 裁剪起始Y位置 | |
cropWidth | uint32_t | 否 | 0 | 裁剪宽度 | |
cropHeight | uint32_t | 否 | 0 | 裁剪高度 |
描述: 音频数据
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
isContent | bool | 否 | false | 是否为内容音频 | |
formatType | XYAudioSampleType | 否 | TYPE_PCM | 音频采样类型 | |
samplesPerSec | uint32_t | 否 | 0 | 采样率 | |
numChannels | uint32_t | 否 | 0 | 通道数 | |
bitsPerSample | uint32_t | 否 | 16 | 每个采样的有效位数 | |
containerSize | uint32_t | 否 | 16 | 每个采样的容器位数 | |
dataPtr | uint8_t* | 否 | nullptr | 音频数据指针 | |
dataLen | uint32_t | 否 | 0 | 数据长度 | |
timeStamp | uint64_t | 否 | 0 | 时间戳（毫秒） |
描述: 媒体数据发送方式
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
enablePATXSelf | bool | 否 | false | UI决策主动发送视频流 | |
enablePVTXSelf | bool | 否 | false | UI决策主动发送音频流 | |
enableCATXSelf | bool | 否 | false | UI决策主动发送共享视频流 | |
enableCVTXSelf | bool | 否 | false | UI决策主动发送共享音频流 |
描述: 云控回调信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
code | int | 否 | 0 | 状态码 | |
result | XYString | 否 | "" | 结果信息 |
描述: 同步静音状态
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
type | int | 否 | - | 类型 | |
status | bool | 否 | - | 状态 |
描述: 显示器大小
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
x | float | 否 | - | X坐标 | |
y | float | 否 | - | Y坐标 | |
width | float | 否 | - | 宽度 | |
height | float | 否 | - | 高度 |
描述: 显示器信息
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
monitorName | XYString | 否 | - | 显示器名称 | 备注 |
minitorRect | XYRect | 否 | - | 显示器矩形区域 |
描述: 验证图片信息结果
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
ypos | int | 否 | 0 | Y位置 | |
cutImageWidth | int | 否 | 0 | 裁剪图片宽度 | |
cutImageHeight | int | 否 | 0 | 裁剪图片高度 | |
rid | XYString | 否 | - | 请求ID | |
cutImage | XYString | 否 | - | 裁剪图片 | |
oriImage | XYString | 否 | - | 原始图片 |
描述: OpenGL选项
版本: 3.11.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
sourceId | const char* | 否 | "" | 源ID | |
isContent | bool | 否 | false | 是否为内容 | |
scaleRatio | float | 否 | 1.0f | 缩放比例 | |
x | int | 否 | 0 | X坐标 | |
y | int | 否 | 0 | Y坐标 | |
width | int | 否 | 0 | 宽度 | |
height | int | 否 | 0 | 高度 |