描述: 视频降噪选项配置结构体,用于设置视频降噪的模式和等级。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
mode | VIDEO_DENOISER_MODE | 是 | VIDEO_DENOISER_AUTO | 降噪模式,支持自动和手动 |
level | int | 是 | 50 | 降噪等级 |
描述: 视频弱光增强选项配置结构体,用于设置弱光增强的模式和等级。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
mode | LOW_LIGHT_ENHANCE_MODE | 是 | LOW_LIGHT_ENHANCE_MANUAL | 弱光增强模式,支持自动和手动 |
level | int | 是 | 0 | 弱光增强等级 |
描述: sdk基础结构体,常用于接口返回结果的基类,包含错误码和错误描述。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
error | XYError | 是 | XYError_NoError | 错误码 |
errorMsg | XYString | 是 | "" | 错误描述 |
描述: 区域信息结构体,表示一个矩形区域的位置和大小。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
x | int | 是 | 0 | 区域左上角的X坐标 |
y | int | 是 | 0 | 区域左上角的Y坐标 |
w | int | 是 | 0 | 区域宽度 |
h | int | 是 | 0 | 区域高度 |
描述: 内容采集信息结构体,用于描述内容共享的源、窗口、区域等参数。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
source | const char* | 否 | nullptr | 内容源,屏幕/URL/设备ID等,取决于采集类型 |
viewId | int64_t | 否 | 0 | 应用窗口句柄,仅XYContentCaptureType_App有效 |
withAudio | bool | 否 | false | 是否包含音频,仅部分类型有效 |
region | XYRegion | 否 | 无 | 区域信息,仅部分类型有效 |
localContentPreview | bool | 否 | false | 是否本地预览,仅部分类型有效 |
enableFluentMode | bool | 否 | false | 是否启用流畅模式 |
描述: 网络代理配置结构体,用于配置SDK的代理服务器信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
hostAddress | XYString | 否 | "" | 代理服务器主机地址 |
port | int | 否 | 0 | 代理服务器端口 |
username | const char* | 否 | "" | 账号,仅SOCKS5认证时使用 |
password | const char* | 否 | "" | 密码,仅SOCKS5认证时使用 |
描述: 服务器信息结构体,包含服务器的唯一标识、主机和端口信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
id | XYString | 否 | "" | 服务器唯一标识(UUID) |
host | XYString | 否 | "" | 服务器主机地址 |
httpPort | int | 否 | 0 | HTTP端口 |
httpsPort | int | 否 | 0 | HTTPS端口 |
描述: 多服务器地址自动探测信息结构体,用于配置服务器探测超时时间和服务器列表。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
timeout | int | 否 | 3 | 探测超时时间(秒) |
serverList | XYArray | 否 | 空 | 服务器列表 |
描述: SSL选项配置结构体,用于设置SSL相关参数。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
sslflags | unsigned int | 否 | XYSSLOPT_F_TRUST_ALL | SSL选项标志,XYSSLOPT_F_* |
sslca | const char* | 否 | "" | CA证书文件内容或路径 |
描述: sdk配置信息结构体,包含云服务、日志、能力集、代理等多项SDK初始化参数。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
cloudServer | const char* | 否 | "" | 云服务地址,私有云需带端口 |
openapiServer | const char* | 否 | "" | 开放平台地址 |
openapiToken | const char* | 否 | "" | 开放平台口令 |
logFolder | const char* | 否 | "" | 日志路径 |
logFileName | const char* | 否 | "" | 日志文件名称(默认xysdk.log) |
platformTag | const char* | 否 | "" | 平台标识,用于上传log |
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* | 否 | "" | 日志过滤规则key |
logFilterKeyNum | const char* | 否 | "" | 日志过滤规则key后num个字符 |
logFilterKeys | const char* | 否 | "" | 日志过滤规则key区间 |
enablePushVideo | bool | 否 | true | 使能SDK主动回调裸流 |
enableBulkRoster | bool | 否 | false | 全量roster(上限500人) |
enableSDKMiniDump | bool | 否 | false | win平台下是否启用SDK内部minidump |
enableLayoutPolling | bool | 否 | false | 是否启用layout轮询能力 |
描述: token登录参数结构体,用于配置token登录相关信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
loginPath | const char* | 否 | "" | 登录地址 |
loginToken | const char* | 否 | "" | 登录token |
withMcuDetect | bool | 否 | false | 是否进行网络探测 |
loginType | const char* | 否 | "" | 登录类型 |
描述: 三方公司信息结构体,包含平台码、名称、图片和跳转地址。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
platformCode | XYString | 否 | "" | 平台码 |
platformName | XYString | 否 | "" | 平台名称 |
image | XYString | 否 | "" | 平台图片 |
url | XYString | 否 | "" | 平台跳转地址 |
描述: SSO登录信息结构体,包含域名、跳转地址、企业信息等。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
domain | XYString | 否 | "" | 域名 |
returnUrl | XYString | 否 | "" | SSO登录跳转地址 |
enterpriseId | XYString | 否 | "" | 企业id |
enterpriseMail | XYString | 否 | "" | 企业邮箱 |
certificate | XYString | 否 | "" | 证书 |
hostOperationType | int | 否 | 0 | SSO登录类型,1为应用内打开,其他为web打开 |
描述: 获取SSO信息回调结构体,继承自XYBaseResult,包含状态、信息和SSO登录数据。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
error | XYError | 是 | XYError_NoError | 错误码(继承自XYBaseResult) |
errorMsg | XYString | 是 | "" | 错误描述(继承自XYBaseResult) |
status | XYString | 否 | "" | 状态码,"10200"表示成功 |
info | XYString | 否 | "" | 预留字段/未使用 |
data | XYSSOInfo | 否 | 无 | SSO登录信息 |
描述: 企业信息结构体,继承自XYBaseResult,包含企业名称。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
error | XYError | 是 | XYError_NoError | 错误码(继承自XYBaseResult) |
errorMsg | XYString | 是 | "" | 错误描述(继承自XYBaseResult) |
enterpriseName | XYString | 否 | "" | 企业名称 |
描述: 云会议室功能其他使能配置结构体,包含录制、字幕、同传等多项会议室功能开关和参数。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
hrRecord | bool | 否 | false | 是否支持超高清录制 |
showRecordTip | bool | 否 | false | 是否显示录制消息 |
onlyMainImage | int | 否 | 0 | 只录制主会场和发言 |
addDeviceName | bool | 否 | false | 录制视频中叠加终端名称 |
allowCallScope | int | 否 | 0 | 呼叫范围(0:CLOSE, 1:ALL, 2:ENTERPRISE, 3:NO_ANONYMOUS) |
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:自适应,1:aes256,2:sm4) |
maxShowedRecResolution | XYString | 否 | "" | UI决策下拉菜单录制选项 |
maxAllowedRecResolution | XYString | 否 | "" | UI决策已选值可展示内容 |
recordingResolution | XYString | 否 | "" | UI回显选择的分辨率 |
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" | IM是否允许复制 |
描述: 云会议室功能可见性配置结构体,控制会议室各项功能在UI上的可见性。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
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 | 显示级联相关选项 |
描述: 云会议室配置信息结构体,继承自XYBaseResult,包含会议室基本信息、配置和可见性设置。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
error | XYError | 是 | XYError_NoError | 错误码(继承自XYBaseResult) |
errorMsg | XYString | 是 | "" | 错误描述(继承自XYBaseResult) |
id | XYString | 否 | "" | 云会议室主键id |
meetingNumber | XYString | 否 | "" | 云会议室号码 |
displayName | XYString | 否 | "" | 云会议室名称 |
password | XYString | 否 | "" | 入会密码 |
meetingControlPassword | XYString | 否 | "" | 会控密码 |
autoMute | int | 否 | 0 | 自动静音 |
smartMutePerson | int | 否 | 0 | 智能静音个数(搭配autoMute为自动静音时使用) |
expireTime | int | 否 | 0 | 失效时间 |
adminUserId | int | 否 | 0 | 个人云会议室的用户id |
ownerUserId | int | 否 | 0 | 企业云会议室的管理员id |
permanent | bool | 否 | false | 永久或临时会议室标志 |
conferenceNumberType | int | 否 | 0 | 云会议室类型标识,0表示个人云会议室 |
enterpriseId | XYString | 否 | "" | 企业id |
configs | XYCloudMeetingRoomConfigs | 否 | 无 | 其他使能配置 |
configDisplays | XYCloudMeetingRoomConfigDisplays | 否 | 无 | 可见性配置 |
描述: 登录后的用户信息结构体,包含用户的基本信息、企业信息、设备信息等。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
callUri | XYString | 否 | "" | 终端标志,唯一呼叫号码,如123456@DESK |
displayName | XYString | 否 | "" | 用户名称 |
profilePicture | XYString | 否 | "" | 用户头像 |
extUserId | XYString | 否 | "" | 三方用户ID |
userId | long | 否 | 0 | 小鱼系统用户ID |
deviceId | long | 否 | 0 | 设备ID(软终端无需关注) |
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 | 是否为临时用户 |
描述: 缓存登录用户信息结构体,包含用户的基本信息、企业信息、设备信息等,字段类型为C风格指针。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
callUri | const char* | 否 | "" | 终端标志,唯一呼叫号码,如123456@DESK |
displayName | const char* | 否 | "" | 用户名称 |
profilePicture | const char* | 否 | "" | 用户头像 |
extUserId | const char* | 否 | "" | 三方用户ID |
userId | long | 否 | 0 | 小鱼系统用户ID |
deviceId | long | 否 | 0 | 设备ID(软终端无需关注) |
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网关签名信息结构体,包含accessToken、refreshToken、token类型、作用域、签名证书等信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
accessToken | XYString | 否 | "" | 网关accessToken |
refreshToken | XYString | 否 | "" | 网关token刷新token |
expires | long | 否 | 0 | token过期时间 |
tokenType | XYString | 否 | "" | token类型 |
scope | XYString | 否 | "" | 作用域 |
domain | XYString | 否 | "" | 作用域 |
signSecret | XYString | 否 | "" | 网关签名证书 |
signType | XYArray | 否 | 空 | 网关签名类型 |
描述: UI能力黑名单项结构体,包含GPU、CPU、操作系统版本、硬件设备名等黑名单列表。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
disableGPUs | XYArray | 否 | 空 | GPU黑名单 |
disableTranslucenceWindowCPUs | XYArray | 否 | 空 | CPU名单 |
disableTranslucenceWindowVersions | XYArray | 否 | 空 | 操作系统版本 |
deviceNames | XYArray | 否 | 空 | 硬件设备名 |
描述: UI能力黑名单结构体,包含windows黑名单配置。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
windowsItem | XYBlackListItem | 否 | 无 | windows黑名单 |
描述: 虚拟背景配置结构体,包含配置图片列表和是否为默认配置的标志。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
images | XYArray | 否 | 空 | 配置图片列表 |
initValue | bool | 否 | true | 是否为默认配置 |
描述: 企业配置信息结构体,包含企业功能开关、权限设置、显示配置等多项企业级功能参数。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
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 | 是否禁用英文转写 |
描述: 用户配置信息结构体,包含UI功能开关、权限设置、显示配置等多项用户界面定制参数。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
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功能入口 |
描述: 运营平台配置信息结构体,用于配置运营平台的各种显示选项和功能开关。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
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 | 否 | 空 | 邀请类型配置信息 |
描述: 账户状态信息结构体,用于记录账户的登录状态、错误信息和时间戳。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
account | XYString | 否 | "" | 账号 |
retryLogin | bool | 否 | false | 登录是否重试 |
errorCode | int | 否 | 0 | 错误码 |
userMessage | XYString | 否 | "" | 错误提示 |
clientTimeMillis | long double | 否 | 0.0 | 上次登录时密码安全策略最后修改时间 |
updateTimeMillis | long double | 0.0 | 当前密码安全策略最后修改时间 |
描述: 入口配置信息结构体,用于配置应用入口的类型、显示状态和跳转链接。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
flag | XYString | 否 | "" | 入口类型 |
display | bool | 否 | false | 是否显示 |
url | XYString | 否 | "" | 跳转链接 |
描述: 入口配置信息列表结构体,用于管理多个入口配置。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
entrance | XYArray | 否 | 空 | 入口配置列表 |
描述: clientConfig结果结构体,继承自XYBaseResult,包含客户端配置的各种信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
uiCustomization | XYUICustomizationInfo | 否 | 无 | 用户配置信息 |
enterpriseConfig | XYEnterpriseConfig | 否 | 无 | 企业配置信息 |
eopCustomizedConfig | XYEOPCustomizedConfig | 否 | 无 | 运营平台配置信息 |
accountStatus | XYAccountStatus | 否 | 无 | 账户状态信息 |
entranceList | XYEntranceList | 否 | 无 | 入口配置信息 |
描述: 共享app信息结构体,用于描述共享应用程序的基本信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
appId | unsigned long | 否 | 0 | app id |
appName | XYString | 否 | "" | app 名称 |
window | void* | 否 | nullptr | app 窗口句柄 |
描述: 视图请求信息结构体,用于配置视频视图的请求参数。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
isContent | bool | 否 | false | 是否为共享 |
reqFaceDetect | bool | 否 | false | 是否请求人脸识别 |
exDeviceID | const char* | 否 | "" | 扩展设备ID |
callUri | XYString | 否 | "" | 如果不指定, SDK将按照内部机制自动填充 |
resolution | XYVideoResolution | 否 | XYVideoResolution_180P | 请流分辨率 |
quality | XYVideoQuality | 否 | XYVideoQualityLow | 清流质量 |
isExtend | bool | 否 | false | 是否是扩展流 |
描述: 远端音频能量信息结构体,用于描述远端音频的能量信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
callUri | const char* | 否 | "" | 参会者标记(123456@DESK) |
energy | int | 否 | 0 | 声音能量(0-100) |
pid | int | 否 | 0 | 参会者ID |
描述: 视频配置信息结构体,用于配置视频的最大分辨率和帧率。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
maxResPvtx | XYVideoResolution | 否 | XYVideoResolution_720P | 最大发送(编码)分辨率 |
maxResPvrx | XYVideoResolution | 否 | XYVideoResolution_720P | 最大接收(解码)分辨率 |
maxFpsPvtx | XYVideoFrameRate | 否 | XYVideoFrameRate_3000 | 最大发送(编码)帧率 |
maxFpsPvrx | XYVideoFrameRate | 否 | XYVideoFrameRate_3000 | 最大接收(解码)帧率 |
描述: 视频帧信息结构体,用于描述视频帧的渲染数据和属性。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
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 | 是否镜像 |
描述: 会议信息结构体,用于描述呼叫的基本信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
callMode | int | 否 | 无 | 呼叫类型 |
remoteUri | XYString | 否 | 无 | 远端calluri |
remoteName | XYString | 否 | 无 | 远端名称 |
remoteNumber | XYString | 否 | 无 | 远端号码 |
remoteAlias | XYString | 否 | 无 | 远端别名 unused |
remoteType | XYString | 否 | 无 | unused |
remoteUserId | XYString | 否 | 无 | 远端userid |
描述: 会控接口获取的主持人,分级会议室信息结构体。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
isHost | bool | 否 | 无 | 是否为会议主持人 |
isBigConf | bool | 否 | 无 | unused |
noCtrPwd | bool | 否 | 无 | unused |
描述: 自定义布局请求结构体,用于配置布局的页面索引和视图请求列表。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
pageIndex | int | 否 | 0 | 0表示非对称布局,1表示对称第一屏 |
maxViewCountPerPage | int | 否 | 0 | 每一屏最大请流数量 |
uiShowLocalWhenPageMode | bool | 否 | true | 翻页是否包含自己 |
reqList | XYArray | 否 | 空 | 请流列表 |
描述: 呼叫状态信息结构体,用于描述呼叫的详细状态信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
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是否允许复制 |
描述: 呼叫中的远端的视频流信息结构体,用于描述远端视频流的详细信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
muteReason | XYMuteReason | 否 | 无 | 关闭原因 |
videoState | XYVideoState | 否 | 无 | 视频状态 |
videoSourceId | XYString | 否 | "" | sourece 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* | 否 | 无 | 绘制窗口句柄 |
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模板源 |
描述: 会话信息结构体,用于描述音视频会话的基本信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
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 | 参会终端数量 |
描述: 会议参会信息结构体,用于描述会议的参会者信息和内容共享信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
chairManUrl | XYString | 否 | "" | 主会场 |
contentUrl | XYString | 否 | "" | 共享 |
actSpkUri | XYString | 否 | "" | as |
participantCount | uint32_t | 否 | 无 | 参会人数 |
contentPartCount | uint32_t | 否 | 无 | 内容分享数量 |
totalEpCount | uint32_t | 否 | 无 | 参会总人数包括自己 |
displayableEpCount | uint32_t | 否 | 无 | 参会人数除去hide, onhold, contentonly |
onHoldCount | uint32_t | 否 | 0 | 等候室等待人数 |
isSelfContent | bool | 否 | 无 | 是否为自己共享 |
contentTotalNum | uint32_t | 否 | 无 | content分享人数 |
forceContent | bool | 否 | 无 | 是否强制内容共享 |
contentName | XYString | 否 | 无 | 内容名称 |
contentInfos | XYArray | 否 | 空 | 会议中的分享content信息 |
sessionInfos | std::vector | 否 | 空 | 会话信息 |
描述: 参会者信息结构体,用于描述单个参会者的基本信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
callUri | XYString | 否 | 无 | 参会者标志, 如:123456@DESK |
displayName | XYString | 否 | 无 | 显示名称 |
extUserId | XYString | 否 | 无 | 三方用户ID,同用户登录注册时提供的一样 |
Alias | XYString | 否 | 无 | 别名 |
isAudioMute | bool | 否 | 无 | 是否关闭音频 |
isVideoMute | bool | 无 | 无 | 是否关闭视频 |
描述: 参会人员详细信息结构体,用于描述参会人员的增删改信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
addParticipants | XYArray | 否 | 空 | 增加的参会方列表, 全量时也包含全部参会方 |
changeParticipants | XYArray | 否 | 空 | 有状态变化的参会方,增量时使用 |
delParticipants | XYArray | 否 | 空 | 删除的参会方(callUri),增量时使用 |
rosterType | XYRosterType | 否 | 无 | 参会人员类型,全量还是增量 |
totalEpNum | uint32_t | 否 | 无 | 总参会人数 |
描述: 人脸识别位置信息结构体,用于描述人脸在视频中的位置坐标。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
faceId | int32_t | 否 | 0 | 人脸id |
left | uint16_t | 否 | 0 | 左间距 |
top | uint16_t | 否 | 0 | 上间距 |
right | uint16_t | 否 | 0 | 右间距 |
bottom | uint16_t | 否 | 0 | 下间距 |
描述: 人脸识别详细信息结构体,用于描述人脸识别的详细用户信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
faceID | int | 否 | 无 | 人脸识别id |
position | XYFacePosition | 否 | 无 | 人脸位置信息 |
userName | XYString | 否 | "" | 用户名 |
userNickName | XYString | 否 | "" | 用户昵称 |
userAge | XYString | 否 | "" | 年龄 |
userIdentifyCard | XYString | 否 | "" | 人脸标识信息 |
userTitle | XYString | 否 | "" | 标题 |
userPhone | XYString | 否 | "" | 电话号码 |
userStatus | int | 否 | 无 | 用户状态 |
描述: 人脸识别信息结构体,用于描述人脸识别的整体信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
isLocal | bool | 否 | false | 是否为本地视频 |
calluri | XYString | 否 | "" | calluri |
participantId | uint32_t | 否 | 0 | 用户id |
type | XYFaceType | 否 | XYFaceTypeDetect | 人脸识别类型 |
seq | uint8_t | 否 | 0 | 序列号 |
detailVec | XYArray | 否 | 空 | 人脸识别位置信息 |
描述: 本地录制业务信息结构体,用于描述录制的业务相关信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
title | const char* | 否 | "" | 录制标题 |
speaker | const char* | 否 | "" | 录制者名称 |
confNum | const char* | 否 | "" | 会议号 |
描述: 视频流信息结构体,用于描述本地录制的视频源信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
sourceId | XYString | 否 | "" | sourceid |
channelId | int | 否 | 0 | 屏幕id |
ssrc | int | 否 | 0 | SSRC标识 |
描述: 视频信息结构体,继承自XYLocalRecordVideoSource,用于描述本地录制的详细视频信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
sourceId | XYString | 否 | "" | sourceid |
channelId | int | 否 | 0 | 屏幕id |
ssrc | int | 否 | 0 | SSRC标识 |
bLocalVideoSource | bool | 否 | false | 是否为本地视频 |
bContent | bool | 否 | false | 是否为共享 |
描述: 录制单个cell信息结构体,用于描述录制布局中的单个元素信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
sourceInfo | XYLocalRecordVideoSourceInfo | 否 | 无 | 视频信息 |
displayName | XYString | 否 | "" | 共享者名称 |
isVideoReceived | bool | 否 | false | 是否打开视频 |
isAudioMute | bool | 否 | true | 是否静止音频 |
left | float | 否 | 0 | 录制坐标 |
top | float | 否 | 0 | 录制坐标 |
width | float | 否 | 0 | 录制坐标 |
height | float | 否 | 0 | 录制坐标 |
描述: 录制布局信息结构体,用于描述录制的整体布局信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
canvasAspectWidth | int | 否 | 0 | 画布宽度 |
canvasAspectHeight | int | 否 | 0 | 画布高度 |
elements | XYArray | 否 | 空 | 录制cell信息 |
描述: 录制信息结构体,用于描述本地录制的详细信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
id | int | 否 | 无 | record id |
fileSize | uint64_t | 否 | 无 | 文件大小 |
sequenceId | int | 否 | 无 | 序列 |
needUpload | int | 否 | 无 | 是否需要上传 |
isLastFile | int | 否 | 无 | 是否为最后一个文件 |
eventId | XYString | 否 | 无 | classId or meetingId |
title | XYString | 否 | 无 | 名称 |
speaker | XYString | 否 | 无 | 当前说话者 |
confNumber | XYString | 否 | 无 | 会议号 |
recordingId | XYString | 否 | 无 | 录制ID |
recordingFiles | XYString | 否 | 无 | 录制文件 |
timeStamp | long long | 否 | 无 | 时间戳 |
描述: 录制储存地址结构体,用于配置录制的存储路径。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
localStorePath | const char* | 否 | "" | 储存地址 |
mobileStorePath | const char* | 否 | "" | unused |
描述: 共享媒体事件参数结构体,用于描述媒体文件事件的详细信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
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 | 是否含有音频 |
描述: 媒体文件信息结构体,用于描述媒体文件的基本信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
type | XYMediaFileType | 否 | XYMEDIAFILETYPE_NONE | 文件类型 |
width | int | 否 | 0 | 宽度 |
height | int | 否 | 0 | 高度 |
描述: 媒体设备信息结构体,用于描述媒体设备的基本信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
devId | XYString | 否 | "" | 设备id |
devName | XYString | 否 | "" | 设备名称 |
isSelected | bool | 否 | false | 是否选中 |
isDefault | bool | 否 | false | 是否是系统默认设备 |
描述: 音频PCM相关信息结构体,用于描述音频PCM格式的详细信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
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 |
描述: 分组信息结构体,用于描述会议分组的基本信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
groupType | int | 否 | -1 | 分组类型 |
groupLeader | bool | 否 | false | 是否为分组管理员 |
groupName | XYString | 否 | "" | 分组名称 |
描述: 会控信息结构体,继承自XYBaseResult,用于描述会议控制的各种配置信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
chirmanUri | XYString | 否 | "" | 主会场标识 |
confMgmtUrl | XYString | 否 | "" | 主持会议H5地址 |
confMgmtMemebersUrl | XYString | 否 | "" | 参会者H5地址 |
muteSpk | XYString | 否 | "" | on(mute speaker) |
muteMic | XYString | 否 | "" | mute |
commonJson | XYString | 否 | "" | 额外信息 |
disableMute | bool | 否 | false | 是否需要举手发言 |
disableRecord | bool | 否 | false | 禁止录制 |
disableContent | bool | 否 | false | 禁止分享 |
disableWhiteboard | bool | 否 | false | 禁止白板 |
feccIsDisabled | bool | 否 | false | 遥控摄像头 |
disableAnnotation | bool | 否 | false | 是否禁止标注 |
group | XYArray | 否 | 空 | 分组信息 |
描述: 字幕信息结构体,用于描述会议字幕的显示配置信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
action | XYString | 否 | "" | 行为 |
content | XYString | 否 | "" | 内容 |
location | XYString | 否 | "" | 显示位置 |
scroll | bool | 否 | false | 是否滚动 |
fontSize | XYString | 否 | "" | 字体大小 |
backgroundAlpha | XYString | 否 | "" | 背景透明度 |
backgroundRGB | XYString | 否 | "" | 背景颜色 |
fontRGB | XYString | 否 | "" | 字体颜色 |
scrollSpeed | XYString | 否 | "" | 滚动速度 |
fontFamily | XYString | 否 | "" | 字体类型 |
描述: 出入会信息结构体,用于描述参会者的出入会信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
displayName | XYString | 否 | "" | 显示名称 |
action | XYString | 否 | "" | in or out |
extUserId | XYString | 否 | "" | 第三方用户id |
描述: 网络统计信息结构体,用于描述网络质量的各种统计指标。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
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 | 上行丢包率 |
描述: 视频统计信息结构体,用于描述视频流的统计信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
codecType | XYString | 否 | "" | 编码类型 |
displayName | XYString | 否 | "" | 显示名称 |
actBw | int | 否 | 0 | 实际带宽 |
frameRate | int | 否 | 0 | 帧率 |
resolution | XYString | 否 | "" | 分辨率 |
描述: 音频统计信息结构体,用于描述音频流的统计信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
codecType | XYString | 否 | "" | 编码类型 |
displayName | XYString | 否 | "" | 显示名称 |
actBw | int | 否 | 0 | 实际带宽 |
描述: 音视频会话统计信息结构体,用于描述音视频会话的统计信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
audioRxInfo | XYArray | 否 | 空 | 下行音频统计数据 |
audioTxInfo | XYArray | 否 | 空 | 上行音频统计数据 |
videoRxInfo | XYArray | 否 | 空 | 下行视频统计数据 |
videoTxInfo | XYArray | 否 | 空 | 上行视频统计数据 |
描述: 呼叫中统计信息结构体,用于描述呼叫过程中的各种统计信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
people | XYAVSessionStatistics | 否 | 无 | 与会人媒体统计信息 |
content | XYAVSessionStatistics | 否 | 无 | 共享内容媒体统计信息 |
network | XYNetworkStatistics | 否 | 无 | 网络状况统计 |
encrypt | XYString | 否 | "" | 加密方式 |
描述: 呼叫中详细统计信息结构体,用于描述呼叫过程中的详细统计信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
staDBA | XYString | 否 | "" | 数据库统计信息 |
staETC | XYString | 否 | "" | 其他统计信息 |
staARX | XYString | 否 | "" | 音频接收统计 |
staATX | XYString | 否 | "" | 音频发送统计 |
staVTX | XYString | 否 | "" | 视频发送统计 |
staVRX | XYString | 否 | "" | 视频接收统计 |
staRoster | XYString | 否 | "" | 参会者统计 |
staCARX | XYString | 否 | "" | 内容音频接收统计 |
staCATX | XYString | 否 | "" | 内容音频发送统计 |
staCVTX | XYString | 否 | "" | 内容视频发送统计 |
staCVRX | XYString | 否 | "" | 内容视频接收统计 |
描述: serverconfig接口回调信息结构体,用于配置H5及反向代理相关的服务器信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
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 | 否 | "" | 第三方登录URL |
messageCenter | XYString | 否 | "" | 消息中心 |
messageCenterV2 | XYString | 否 | "" | 消息中心(新版) |
meetingInviteUrl | XYString | 否 | "" | 会中邀请通讯录成员地址 |
historySubtitle | XYString | 否 | "" | 实时转写 历史字幕 |
summaryUrl | XYString | 否 | "" | 会议纪要 |
pcMeetingAIAssistantUrl | XYString | 否 | "" | 会中AI助手 |
描述: 错误码信息结构体,继承自XYBaseResult,用于描述错误码的版本和下载地址。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
version | XYString | 否 | "" | 版本 |
url | XYString | 否 | "" | 下载地址 |
描述: 获取错误码文件回调结果结构体,继承自XYBaseResult,用于描述错误码文件的存储地址。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
filePath | XYString | 否 | "" | 错误码文件存储地址 |
描述: 获取特殊字符正则表达式回调信息结构体,继承自XYBaseResult,用于描述特殊字符的正则表达式。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
displayNameSupportCharacters | XYString | 否 | "" | 特殊字符正则表达式 |
描述: 获取默认特殊字符正则表达式回调信息结构体,继承自XYBaseResult,用于描述默认特殊字符的正则表达式。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
defaultNameSupportCharacters | XYString | 否 | "" | 默认特殊字符正则表达式 |
描述: REST API结果结构体,用于描述REST API的响应结果。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
code | XYError | 否 | 无 | 错误码 |
errorString | XYString | 否 | "" | 错误描述 |
描述: 更新用户信息回调结构体,继承自XYBaseResult,用于描述用户信息更新的结果。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
type | XYUserProfileType | 否 | 无 | 用户信息更新类型 |
profilePicture | XYString | 否 | "" | 头像地址 |
描述: 注册接口普回调结构体,继承自XYBaseResult,用于描述注册接口的额外错误信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
extErrorInfo | XYString | 否 | "" | 错误信息 |
描述: 下载结果回调结构体,用于描述下载的状态信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
status | XYDownloadStatus | 否 | 无 | 下载状态 |
cachePath | XYString | 否 | 无 | 储存地址 |
filename | XYString | 否 | 无 | 文件名 |
url | XYString | 否 | 无 | 下载地址 |
描述: 下载进度回调结构体,用于描述下载的进度信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
url | XYString | 否 | "" | 下载地址 |
progress | double | 否 | 0.0 | 下载进度 |
描述: 网络测试回调结构体,继承自XYBaseResult,用于描述网络测试的结果信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
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 | 网络发送往返时间 |
描述: 版本信息检查回调结构体,继承自XYBaseResult,用于描述版本升级检查的结果。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
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 | 否 | 无 | 最小支持版本 |
描述: 路由站点路径信息结构体,用于描述路由路径的基本信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
sitePathId | XYString | 否 | "" | pathId |
networkType | int | 否 | 0 | 1:外网 0:内网 |
描述: 路由站点信息结构体,用于描述路由站点的路径列表和基本信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
pathList | XYArray | 否 | 空 | 路径列表 |
displayName | XYString | 否 | "" | 路由名称 |
enterpriseId | XYString | 否 | "" | "default":自有线路,"":公共线路 |
描述: 路由列表结果结构体,继承自XYBaseResult,用于描述路由线路列表和当前选择的路由线路。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
siteList | XYArray | 否 | 空 | 路由线路列表 |
currentSitePathId | XYString | 否 | "" | 当前选择路由线路id |
描述: 上传日志结果回调结构体,继承自XYBaseResult,用于描述日志上传的结果。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
type | XYLogType | 否 | 无 | 日志类型 |
id | XYString | 否 | "" | 日志id |
描述: incomingCallUrl结果结构体,用于描述可呼叫设备的信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
deviceType | XYString | 否 | 无 | 设备类型 |
number | XYString | 否 | 无 | 号码 |
callUrl | XYString | 否 | 无 | url |
numberType | XYString | 否 | 无 | 号码类型 |
callNumber | XYString | 否 | 无 | 会议号码 |
displayName | XYString | 否 | 无 | 名称 |
countryCode | XYString | 否 | 无 | 国家码 |
avatar | XYString | 否 | 无 | 头像地址 |
描述: 设备信息配置回调结构体,继承自XYBaseResult,用于描述设备配置的各种参数。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
pvrxMaxRecvStream | int | 否 | 0 | 最大接收视频流数量 |
noDisturbIncall | bool | 否 | false | 会中免打扰 |
enableCallRecovery | bool | 否 | false | 云会议断线重呼 |
enableNotDisturbInHosting | bool | 否 | false | 主持会议免打扰 |
enableConferenceControlSidebar | bool | 否 | false | 会控侧边栏开关 |
描述: 获取第三方登录公司回调信息结构体,继承自XYBaseResult,用于描述第三方平台的信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
status | XYString | 否 | "" | 状态码是"10200"表示成功 |
data | XYArray | 否 | 空 | 三方公司信息列表 |
描述: WebSocket消息结构体,用于描述WebSocket消息的类型和内容。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
type | WSMsgType | 否 | 无 | ws信息类型 |
data | XYString | 否 | "" | ws信息内容 |
描述: 申请或取消发言请求信息结构体,用于描述发言申请的相关信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
callUri | const char* | 否 | "" | 发起者calluri |
apply | bool | 否 | false | 申请/取消 |
displayName | const char* | 否 | "" | 发起者名称 |
startTime | uint64_t | 否 | 0 | 发起时间 |
描述: 会议信息结构体,继承自XYBaseResult,用于描述会议用户的基本信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
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呼叫 |
描述: 会议状态信息结构体,用于描述会议的各种属性配置。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
forceVideoOn | bool | 否 | 无 | 是否强制打开摄像头 |
enableContentLive | bool | 否 | 无 | 是否为多路content会议室 |
enableContentLiveOnHold | bool | 否 | 无 | 多路会议室中是否开启管理员指定后广播 |
disableVirtualBackground | bool | 否 | 无 | 基于会议维度取消虚拟背景 |
onlyOwnerInvite | bool | 否 | 无 | 只有owner拥有分享链接权限 |
displayRealTimeTranscription | bool | 否 | 无 | 是否开启实时转写 |
aiAssistant | bool | 否 | 无 | 是否开启ai助手 |
confRoomOwnerList | XYString | 否 | 无 | 会议室owner列表 |
shareChatContentPermission | XYString | 否 | "0" | IM是否允许复制 |
描述: 麦克风输入信息结构体,用于描述发言者的音频输入信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
energyAverage | int | 否 | 0 | 平均能量 |
callUri | XYString | 否 | "" | calluri |
participantId | uint32_t | 否 | 0 | 用户在会中id标识 |
endpointName | XYString | 否 | "" | 终端名称 |
endpointAlias | XYString | 否 | "" | 终端别名 |
extUserId | XYString | 否 | "" | 外部用户id |
描述: 会控配置信息结构体,继承自XYBaseResult,用于描述会议控制的配置信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
isHost | bool | 否 | 无 | 是否为主持人 |
isBigConf | bool | 否 | 无 | 是否为主会议 |
noCtrPwd | bool | 否 | 无 | 是否不需要会控密码 |
描述: 通话记录信息结构体,用于描述通话记录的基本信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
displayName | XYString | 否 | "" | 会议名称 |
number | XYString | 否 | "" | 会议号 |
avatar | XYString | 否 | "" | 头像地址 |
userProfileId | long | 否 | 0 | unuse |
callType | int | 否 | 0 | 呼叫类型 |
numberType | XYString | 否 | "" | 会议号类型 |
callTime | XYString | 否 | "" | 呼叫时间 |
描述: 通话记录回调信息结构体,用于描述通话记录列表的查询结果。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
code | int | 否 | 0 | 错误码 |
msg | XYString | 否 | "" | 回调信息 |
historyList | XYArray | 否 | 空 | 通话记录列表 |
描述: 会中水印信息结构体,继承自XYBaseResult,用于描述会议水印的配置信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
watermark | XYString | 否 | "" | 水印 |
watermarkRange | XYWatermarkRange | 否 | WatermarkRange_Content | 水印叠加范围 |
描述: 敏感词信息回调结构体,继承自XYBaseResult,用于描述敏感词列表信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
sensitiveWords | XYArray | 否 | 空 | 敏感词列表 |
描述: 最新预约会议回调信息结构体,继承自XYBaseResult,用于描述最新预约会议的详细信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
title | XYString | 否 | "" | 会议标题 |
owner | XYString | 否 | "" | 会议所属者 |
conferenceNumber | XYString | 否 | "" | 会议号 |
id | XYString | 否 | "" | 会议id |
startTime | long long | 否 | 0 | 会议开始时间 |
endTime | long long | 否 | 0 | 会议结束时间 |
描述: 当前会议冲突的预约会议信息结构体,继承自XYBaseResult,用于描述会议冲突的信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
meetingId | XYString | 否 | 无 | 会议id |
meetingNumber | XYString | 否 | 无 | 会议号 |
displayName | XYString | 否 | 无 | 会议名称 |
描述: 互动工具事件信息结构体,用于描述互动工具的各种事件信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
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) |
描述: 互动工文案具回调信息结构体,用于描述互动工具的文案信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
indexNo | int | 否 | 0 | 互动工具类型 |
content | XYString | 否 | "" | 文案内容 |
描述: 互动工具回调信息结构体,继承自XYBaseResult,用于描述互动工具的详细信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
isSupport | bool | 否 | false | 是否支持互动工具 |
writings | XYArray | 否 | 空 | 文案信息 |
event | XYInteractiveToolEvent | 否 | 无 | 互动工具事件信息 |
描述: 申请发言回调信息结构体,用于描述申请发言的相关信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
name | XYString | 否 | "" | 发言者名称,base64编码 |
type | XYString | 否 | "" | requestSpeak:申请发言,cancelSpeak:取消发言 |
uri | XYString | 否 | "" | 发言者callUri |
startTime | XYString | 否 | "" | 发言时间 |
描述: 提交签到回调信息结构体,继承自XYBaseResult,用于描述签到提交的结果。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
status | XYString | 否 | "" | 状态信息 |
描述: kick-off conference info结构体,继承自XYBaseResult,用于描述即时会议的房间信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
inviteUrl | XYString | 否 | "" | 邀请链接 |
invokSchema | XYString | 否 | "" | 调用模式 |
linkNumber | XYString | 否 | "" | 会议号 |
pstnNumber | XYString | 否 | "" | pstn会议号 |
shareUrl | XYString | 否 | "" | 会议链接 |
voiceNumber | XYString | 否 | "" | 电话语音入会号码 |
userAvatar | XYString | 否 | "" | 会议发起者头像 |
userName | XYString | 否 | "" | 会议发起者名称 |
password | XYString | 否 | "" | 会议密码 |
displayName | XYString | 否 | "" | 会议名称 |
inMeeting | bool | 否 | false | 是在会中发起的请求 |
描述: 会议设置仅预约会议相关结构体,继承自XYBaseResult,用于描述仅预约会议的相关配置。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
onlyScheduledCall | XYString | 否 | "" | 是否仅预约入会 |
disableUserUpdateOnlyScheduledCall | XYString | 否 | "" | 关闭用户设置仅预约入会 |
allowTempUserCall | bool | 否 | false | 允许临时账号入会 |
tempUserCallApproved | bool | 否 | false | 由主持人管控入会 |
showTempUserCallApproved | bool | 否 | false | 主持人管控入会可见性开关 |
描述: 会议室容量信息结构体,继承自XYBaseResult,用于描述会议室的容量信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
attribute | int | 否 | 0 | 企业归属属性,0-有企业 1-无企业 |
buyUrl | XYString | 否 | "" | 购买链接 |
capacity_CN | XYString | 否 | "" | 会议室容量-中文 |
capacity_TW | XYString | 否 | "" | 会议室容量-繁体 |
capacity_EN | XYString | 否 | "" | 会议室容量-英文 |
描述: 预约会议通知信息结构体,用于描述预约会议的通知信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
startTime | long long | 否 | 0 | 开始时间 |
endTime | long long | 否 | 0 | 结束时间 |
title | XYString | 否 | "" | 标题 |
conferenceNumber | XYString | 否 | "" | 会议号 |
id | XYString | 否 | "" | 会议id |
ownerName | XYString | 否 | "" | 会议创建者名称 |
描述: IM权限信息结构体,用于描述IM的权限配置信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
imStatus | XYString | 否 | "" | im状态 |
meetingId | XYString | 否 | "" | 会议id |
newImStatus | XYString | 否 | "" | 新的im状态 |
waiterChatToHost | XYString | 否 | "" | unuse |
描述: App信息结构体,用于描述应用程序的基本信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
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布局请求结构体,用于描述统一布局的请求参数。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
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 |
描述: 点结构体,用于描述二维坐标点。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
x | int | 否 | 0 | x坐标 |
y | int | 否 | 0 | y坐标 |
描述: UI使用此结构体向SDK发送线条信息,用于描述线条的绘制参数。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
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 | 是否获取所有线条 |
描述: 同声传译语言信息结构体,用于描述同声传译的语言信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
id | int | 否 | 无 | 语言id |
zh_CN | XYString | 否 | 无 | 语言名称(中文) |
en_US | XYString | 否 | 无 | 语言名称(英文) |
描述: 同声传译配置信息结构体,用于描述同声传译的配置参数。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
conferenceNo | XYString | 否 | 无 | 会议号 |
meetingId | XYString | 否 | 无 | 会议id |
language | int | 否 | -1 | 语言id |
originalEnable | bool | 否 | false | 是否开启原音 |
zh_CN | XYString | 否 | 无 | 语言名称(中文) |
en_US | XYString | 否 | 无 | 语言名称(英文) |
描述: 翻译信息结构体,用于描述翻译的源语言和目标语言。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
from | int | 否 | -1 | 翻译的原始语言id |
to | int | 否 | -1 | 翻译的目标语言id |
描述: 同声传译信息结构体,用于描述同声传译的详细信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
type | XYTranslateType | 否 | 无 | 同声传译类型 |
meetingId | XYString | 否 | 无 | 会议id |
callUri | XYString | 否 | 无 | 会议calluri |
languages | XYArray | 否 | 空 | 语言列表 |
disableTranslatorChannel | bool | 否 | 无 | 是否将语音信息复制到原声通道一份 |
languageConfig | XYTranslationConfig | 否 | 无 | 配置信息 |
translator | XYTranslator | 否 | 无 | 翻译员信息 |
languagesChanged | bool | 否 | false | 相对上一次是否语言发生了变化 |
isTranslator | bool | 否 | false | 是否为翻译员 |
描述: 同声传译通道变化接口回调信息结构体,继承自XYBaseResult,用于描述语言通道的配置结果。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
languageId | int | 否 | 无 | 语言通道id |
描述: 会控mute信息变化结构体,用于描述会议控制中静音信息的变化。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
toast | XYArray | 否 | 空 | 提示 各个语言第一个为中文 第二个为英文 第三个为其他语言 |
isMuteCamera | bool | 否 | 无 | 是否关闭摄像头 |
isForceUnmuteCamera | bool | 否 | 无 | 是否强制打开摄像头 |
描述: 经过合并后的能力集接口回调信息结构体,继承自XYBaseResult,用于描述能力集的混合结果。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
mixedAbility | XYArray | 否 | 空 | 混合能力集 |
描述: AI同传字幕信息结构体,用于描述AI同传字幕的详细信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
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 | 否 | "" | 唯一标识 |
描述: 直播独立域名结构体,继承自XYBaseResult,用于描述直播域名的URL信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
liveDomainUrl | XYString | 否 | "" | 直播域名URL |
描述: H5热更新模块信息结构体,用于描述H5热更新模块的详细信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
type | XYDynUpsModuleType | 否 | XYDynUpsModuleType_Other | 模块类型 |
platform | XYString | 否 | "" | 平台信息 |
filePath | XYString | 否 | "" | 文件路径 |
version | XYString | 否 | "" | 版本号 |
entry | XYString | 否 | "" | 对应的platform下所有的H5入口 |
forceUpdate | bool | 否 | false | 是否强制更新 |
fromDownLoadFinish | bool | 否 | false | 是否从下载完成 |
描述: 白板信息结构体,用于描述白板的基本信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
ownerName | XYString | 否 | "" | 白板发起人名称 |
ownerUri | XYString | 否 | "" | 白板发起uri |
描述: AI会议纪要状态信息结构体,用于描述AI会议纪要的状态信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
transcription | XYString | 否 | "" | AI同传字幕错误提示信息 |
meetingNote | XYString | 否 | "" | 会议纪要错误提示信息 |
recordPromoter | XYString | 否 | "" | 录制发起人角色 |
描述: 企业后台推送UI项目的显示与隐藏结构体,用于描述UI显示状态的变化。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
type | XYString | 否 | "" | 类型 |
enable | bool | 否 | true | 是否启用 |
描述: 参会者音频信息结构体,用于描述参会者的音频输入信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
energy | int | 否 | 0 | 音频能量 |
callUri | XYString | 否 | "" | 参会者callUri |
participantId | int | 否 | 0 | 在接收端设置的参会者ID |
描述: 线条接口类,用于获取线条的各种属性信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
getSequence | virtual int | 否 | 无 | 获取线条的序列号,全局唯一 |
getWeight | virtual int | 否 | 无 | 获取线条粗细 |
getColor | virtual XYString | 否 | 无 | 获取线条颜色,RGBA十六进制字符串 |
getPainterId | virtual XYString | 否 | 无 | 获取绘制者ID(calluri或用户ID) |
getUUID | virtual XYString | 否 | 无 | 获取线条的UUID,可用于索引 |
isFinished | virtual bool | 否 | 无 | 线条是否包含终点 |
getPointsNum | virtual int | 否 | 无 | 获取线条上的点数 |
getPoint | virtual bool | 否 | 无 | 根据索引获取点信息 |
描述: 白板和标注点信息结构体,用于描述白板和标注中的点坐标。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
x | int | 否 | 0 | x坐标 |
y | int | 否 | 0 | y坐标 |
描述: 白板和标注线条信息结构体,用于描述白板和标注中的线条参数。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
sequece | int | 否 | 0 | 线的序列号 |
weight | int | 否 | 0 | 线的粗细 |
color | XYString | 否 | "" | 线的颜色 |
sourceCallUri | XYString | 否 | "" | 线目标发送设备calluri |
targetCallUri | XYString | 否 | "" | 线的原始发出设备calluri |
uuid | XYString | 否 | "" | 唯一校验码 |
points | XYArray | 否 | 空 | 各点合集 |
ended | bool | 否 | false | 是否是每条线的最后一条信息 |
描述: 手动媒体选择信息结构体,用于描述手动媒体选择的项目信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
name | XYMediaManualItemName | 否 | 无 | 媒体项目名称 |
type | XYMediaManualItemType | 否 | 无 | 媒体项目类型 |
描述: 统一认证结果结构体,继承自XYBaseResult,用于描述统一认证的结果信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
type | int | 否 | 0 | 同步认证类型 1:账号密码 2:验证码 3:密码 / 验证码(密码 + 验证码) 4:第三方url |
authThirdUrl | XYString | 否 | "" | 当认证方式为4时,返回第三方url |
描述: 过期文件提醒结构体,用于描述即将过期的点播文件提醒信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
name | XYString | 否 | "" | 文件名称 |
count | int | 否 | 0 | 文件数量 |
cleanDays | int | 否 | 0 | 清理天数 |
popupNotice | bool | 否 | false | 是否弹窗提醒 |
描述: 视频数据结构体,用于描述视频数据的格式和内容。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
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 | 裁剪高度 |
描述: 音频数据结构体,用于描述音频数据的格式和内容。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
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 | 时间戳(毫秒) |
描述: 媒体数据发送方式结构体,用于配置媒体数据的发送方式。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
enablePATXSelf | bool | 否 | false | UI决策主动发送视频流 |
enablePVTXSelf | bool | 否 | false | UI决策主动发送音频流 |
enableCATXSelf | bool | 否 | false | UI决策主动发送共享视频流 |
enableCVTXSelf | bool | 否 | false | UI决策主动发送共享音频流 |
描述: 云控回调信息结构体,用于描述云控配置的结果信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
code | int | 否 | 0 | 错误码 |
result | XYString | 否 | "" | 结果信息 |
描述: 同步静音状态结构体,用于描述静音状态的同步信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
type | int | 否 | 无 | 静音类型 |
status | bool | 否 | 无 | 静音状态 |
描述: 显示器大小结构体,用于描述显示器的矩形区域信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
x | float | 否 | 无 | X坐标 |
y | float | 否 | 无 | Y坐标 |
width | float | 否 | 无 | 宽度 |
height | float | 否 | 无 | 高度 |
描述: 显示器信息结构体,用于描述显示器的基本信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
monitorName | XYString | 否 | 无 | 显示器名称 |
minitorRect | XYRect | 否 | 无 | 显示器矩形区域 |
描述: 验证图片信息结果结构体,继承自XYBaseResult,用于描述验证图片的信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
ypos | int | 否 | 0 | Y位置 |
cutImageWidth | int | 否 | 0 | 裁剪图片宽度 |
cutImageHeight | int | 否 | 0 | 裁剪图片高度 |
rid | XYString | 否 | 无 | 请求ID |
cutImage | XYString | 否 | 无 | 裁剪图片 |
oriImage | XYString | 否 | 无 | 原始图片 |
描述: OpenGL选项结构体,用于描述OpenGL渲染的配置选项。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
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 | 高度 |
描述: 扩展连接参数结构体,用于配置扩展设备的连接参数。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
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 | 保活超时时间 |
描述: 扩展认证连接参数结构体,继承自XYExConnParam,用于配置需要认证的扩展设备连接参数。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
deviceID | const char* | 否 | "" | 设备ID |
localIP | const char* | 否 | "" | 本地IP地址 |
authTimeout | uint32_t | 否 | 0 | 认证超时时间 |
描述: 扩展主参数结构体,继承自XYExAuthedConnParam,用于配置主设备的连接参数。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
serial | const char* | 否 | 无 | 序列号 |
描述: 扩展视频能力结构体,用于描述扩展设备的视频编码能力。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
instanceLimit | unsigned int | 否 | 0 | 实例限制数量 |
expendMap | float[XYExResolutionIndex_Count] | 否 | 0 | 扩展映射数组 |
描述: 扩展场景编码器能力结构体,继承自XYExVideoCap,用于描述特定场景的编码器能力。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
sceneId | XYExCameraSceneID | 否 | XYExCameraSceneID_Invalid | 场景ID |
codecType | XYExDevicePTCap | 否 | XYExDevicePTCap_H264 | 编解码类型 |
maxFrameRate | float | 否 | 30.0 | 最大帧率 |
描述: 扩展编码器能力结构体,用于描述扩展设备的编码器能力。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
sceneNum | int | 否 | 0 | 场景数量 |
sceneEncCaps | XYExSceneEncoderCap[MAX_SCENE_COUNT_PER_CAMERA] | 否 | 无 | 场景编码器能力数组 |
描述: 扩展麦克风通道结构体,用于描述扩展设备的麦克风通道信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
channelID | uint32_t | 否 | 0 | 通道ID |
描述: 扩展麦克风能力结构体,用于描述扩展设备的麦克风能力。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
channelNums | int | 否 | 0 | 通道数量 |
channelArr | XYExMicChannel[MAX_CHANNEL_COUNT_PER_MICROPHONE] | 否 | 无 | 通道数组 |
描述: 扩展设备信息结构体,用于描述扩展设备的基本信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
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 | 连接类型 |
描述: 扩展能力信息结构体,用于描述扩展设备的综合能力信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
encCap | XYExEncoderCap | 否 | 无 | 编码器能力 |
decCap | XYExVideoCap | 否 | 无 | 解码器能力 |
micCap | XYExMicCap | 否 | 无 | 麦克风能力 |
extraExpend | float | 否 | 0.0 | 额外扩展 |
描述: 扩展能力设备信息结构体,继承自XYExDeviceInfo和XYExCapInfo,用于描述扩展设备的完整信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
继承自XYExDeviceInfo的所有字段 | 设备基本信息 | |||
继承自XYExCapInfo的所有字段 | 设备能力信息 |
描述: 媒体设备错误参数结构体,用于描述媒体设备的错误信息。
字段:
名称 | 类型 | 必填 | 默认值 | 描述 |
devType | XYMediaDevType | 否 | 无 | 设备类型 |
vidOrdinal | XYVideoOrdinal | 否 | 无 | 视频序号 |
devError | XYMediaDevError | 否 | 无 | 设备错误类型 |