开发者中心 - 小鱼易连

XYConfProperty

描述: 会议状态信息
字段:

名称	类型	必填	默认值	描述
forceVideoOn	boolean	是	无	是否强制打开摄像头
enableContentLive	boolean	是	无	是否为多路content会议室
enableContentLiveOnHold	boolean	是	无	多路会议室中是否开启管理员指定后广播
disableVirtualBackground	boolean	是	无	基于会议维度取消虚拟背景
onlyOwnerInvite	boolean	是	无	仅主持人允许邀请

XYSDKAccountDeletePermissionCheckResult

描述: 账号权限检测结果

字段:

名称	类型	必填	默认值	描述
inEnterprisePassed	boolean	是	无	企业内通过状态
bindNemoPassed	boolean	是	无	绑定Nemo通过状态

XYSDKAccountDeleteUserCheckResult

描述: 账号注销用户信息检测结果

字段:

名称	类型	必填	默认值	描述
virtualCellPhone	boolean	是	无	虚拟手机号状态

XYSDKAccountInfo

描述: 用于存储账户相关信息

字段:

名称	类型	必填	默认值	描述
callUri	string	是	无	终端标志，小鱼后台给登陆账号分配的唯一呼叫号码，如：123456@DESK， 123456为小鱼系统ID，DESK为终端类型
displayName	string	是	无	用户名称
profilePicture	string	是	无	用户头像
extUserId	string	是	无	三方用户ID，同用户登录注册时提供的一样
userId	number	是	无	小鱼系统用户ID
deviceId	number	是	无	软终端无用
email	string	是	无	邮箱
peerNumber	string	是	无	用于点对点呼叫号码
userInEnterprise	boolean	是	无	用户是否存在与企业之中
securityKey	string	是	无	安全码
enterpriseAdmin	boolean	是	无	是否为企业管理员
initPassword	boolean	是	无	初始密码安全
enhancePassword	boolean	是	无	强密码策略
validate	boolean	是	无	邮箱验证
enterpriseId	string	是	无	企业ID
extErrorInfo	string	是	无	额外信息
userDevice	string	是	无	用户设备
loginType	string	是	无	登录类型
enterpriseSecurityConfigTimeMillis	BigInt	是	无	密码安全策略最后修改时间戳
realUserId	string	是	无	userid 字符串类型
tempUser	boolean	是	无	临时用户

XYSDKAccountStatus

描述: 账户状态信息
字段:

名称	类型	必填	默认值	描述
account	string	是	无	账号
retryLogin	boolean	是	无	登录是否重试
errorCode	number	是	无	错误码
userMessage	string	是	无	错误提示
clientTimeMillis	number	是	无	上次登录时密码安全策略最后修改时间
updateTimeMillis	number	是	无	当前密码安全策略最后修改时间

XYSDKAddCloudRoomToScheduleResult

描述: 添加云会议室到日程
字段:

名称	类型	必填	默认值	描述
code	number	是	无	无
msg	string	是	无	无
number	string	是	无	无
scheduledMeetingId	string	是	无	无
title	string	是	无	无
sensitiveWords	string	是	无	无

XYSDKAddressBookGroupInfo

描述: 通讯录群组信息
字段:

名称	类型	必填	默认值	描述
id	string	是	无	ID
name	string	是	无	名称
visible	boolean	是	无	是否可见
callable	boolean	是	无	是否可呼叫
confNumber	string	是	无	会议号码
count	number	是	无	数量
contactShow	number	是	无	联系人显示

XYSDKAddressBookMeetingRoomInfo

描述: 通讯录会议室信息
字段:

名称	类型	必填	默认值	描述
id	string	是	无	ID
meetingNumber	string	是	无	会议号码
displayName	string	是	无	显示名称
deptId	number	是	无	部门ID
deptName	string	是	无	部门名称
contacts	number	是	无	联系人数量
nameCode	string	是	无	名称代码
ownerUserId	number	是	无	所有者用户ID
deptAllFlag	number	是	无	部门全部标志

XYSDKAddressBookMemberInfo

描述: 通讯录成员信息
字段:

名称	类型	必填	默认值	描述
id	string	是	无	ID
avatar	string	是	无	头像
phone	string	是	无	电话
name	string	是	无	名称
number	string	是	无	号码
type	number	是	无	类型
clientType	XYClientType	是	无	客户端类型
departmentId	number	是	无	部门ID
confNumber	string	是	无	会议号码
departments	string	是	无	部门
groupId	string	是	无	组ID
email	string	是	无	邮箱
namePinyin	string	是	无	名称拼音
order	number	是	无	排序
callUri	string	是	无	呼叫URI
callNum	string	是	无	呼叫号码
deviceSn	string	是	无	设备序列号
position	string	是	无	职位

XYSDKAddressBookMemberListInfo

描述: 通讯录成员列表信息
字段:

名称	类型	必填	默认值	描述
pageIndex	number	是	无	页码
pageSize	number	是	无	每页大小
totalPage	number	是	无	总页数
totalElements	number	是	无	总元素数
deptId	number	是	无	部门ID
groupId	string	是	无	组ID
content	XYSDKAddressBookMemberInfo[]	是	无	成员信息列表

XYSDKAddressBookMemberListInfoResult

描述: 通讯录成员列表信息结果
字段:

名称	类型	必填	默认值	描述
info	string	是	无	信息
status	number	是	无	状态
data	XYSDKAddressBookMemberListInfo	是	无	成员列表信息数据

XYSDKAddressBookResponseResult

描述: 通讯录请求响应体结构
字段:

名称	类型	必填	默认值	描述
code	number	是	无	状态码
retStr	string	是	无	返回字符串
deptId	string	是	无	部门ID
isLoadMG	boolean	是	无	是否加载管理组
groupId	string	是	无	组ID

XYSDKAICaptionInfo

描述: AI同传字幕信息
字段:

名称	类型	必填	默认值	描述
src	string	是	无	源语言
target	string	是	无	翻译后的语言
isEnd	boolean	是	无	一句话是否已经结束
isActive	boolean	是	无	收三路,同时只有一路active
srcLang	XYSDKAICaptionLanguage	是	无	源语言类型
targetLang	XYSDKAICaptionLanguage	是	无	翻译后语言类型
displayName	string	是	无	用户显示名称
url	string	是	无	用户callUri
meetingId	string	是	无	会议id
pid	number	是	无	参会人id

XYSDKApiGatewayInfo

描述: API网关签名信息
字段:

名称	类型	必填	默认值	描述
accessToken	string	是	无	网关accessToken
refreshToken	string	是	无	网关token刷新token
expires	number	是	无	token过期时间
tokenType	string	是	无	token类型
scope	string	是	无	作用域
domain	string	是	无	作用域
signSecret	string	是	无	网关签名证书
signType	string[]	是	无	网关签名类型

XYSDKAppInfo

描述: App信息(unuse)
字段:

名称	类型	必填	默认值	描述
floor	BigInt	是	无	无
sysType	string	是	无	无
version	string	是	无	无
osVersion	string	是	无	无
hwVersion	string	是	无	无
locale	string	是	无	无
macAddress	string	是	无	无
innerIp	string	是	无	无

XYSDKApplySpeakInfo

描述: 申请发言回调信息
字段:

名称	类型	必填	默认值	描述
name	string	是	无	发言者名称，base64编码
type	string	是	无	requestSpeak：申请发言，cancelSpeak：取消发言
uri	string	是	无	发言者callUri
startTime	string	是	无	发言时间

XYSDKApplySpeaking

描述: 申请或取消发言请求信息
字段:

名称	类型	必填	默认值	描述
callUri	string	是	无	发起者calluri
apply	boolean	是	无	申请/取消
displayName	string	是	无	发起者名称
startTime	BigInt	是	无	发起时间

XYSDKAudioData

描述: 用于存储音频相关信息

字段:

名称	类型	必填	默认值	描述
isContent	boolean	是	无	是否content
formatType	XYSDKAudioSampleType	是	无	编码格式
samplesPerSec	number	是	无	采样率
numChannels	number	是	无	通道数
bitsPerSample	number	是	无	valid size per sample in bits 使用16
containerSize	number	是	无	container size per sample in bits 使用16
dataPtr	ArrayBuffer	是	无	audio data
dataLen	number	是	无	数据长度
timeStamp	BigInt	否	无	the following parameters are optional and automatically populated internally with the default value

XYSDKAudioMeterInfo

描述: 远端音频能量信息
字段:

名称	类型	必填	默认值	描述
callUri	string	是	无	参会者标记(123456@DESK)
energy	number	是	无	声音能量(0-100)
pid	number	是	无	参会者ID

XYSDKAudioStatistics

描述: 音频统计信息
字段:

名称	类型	必填	默认值	描述
codecType	string	是	无	编码类型
displayName	string	是	无	显示名称
actBw	number	是	无	实际带宽

XYSDKAuthSyncResult

描述: 统一认证结果
字段:

名称	类型	必填	默认值	描述
error	XYSDKError	是	无	错误码
errorMsg	string	是	无	错误描述
type	number	是	无	同步认证类型 1：账号密码 2：验证码 3：密码 / 验证码（密码 + 验证码） 4：第三方url
authThirdUrl	string	是	无	当认证方式为4时，返回第三方url

XYSDKAVSessionStatistics

描述: 音视频会话统计信息
字段:

名称	类型	必填	默认值	描述
audioRxInfo	XYSDKAudioStatistics[]	是	无	下行音频统计数据
audioTxInfo	XYSDKAudioStatistics[]	是	无	上行音频统计数据
videoRxInfo	XYSDKVideoStatistics[]	是	无	下行视频统计数据
videoTxInfo	XYSDKVideoStatistics[]	是	无	上行视频统计数据

XYSDKBaseResult

描述: 用于定义sdk基础结构体

字段:

名称	类型	必填	默认值	描述
error	XYSDKError	是	无	错误码
errorMsg	string	是	无	错误描述

XYSDKBlackList

描述: UI能力黑名单
字段:

名称	类型	必填	默认值	描述
windowsItem	XYSDKBlackListItem	是	无	windows 黑名单

XYSDKBlackListItem

描述: ai相关配置
字段:

名称	类型	必填	默认值	描述
disableGPUs	string[]	是	无	GPU黑名单
disableTranslucenceWindowCPUs	string[]	是	无	CPU名单
disableTranslucenceWindowVersions	string[]	是	无	操作系统版本
deviceNames	string[]	是	无	硬件设备名

XYSDKCallableInfo

描述: incomingCallUrl结果
字段:

名称	类型	必填	默认值	描述
deviceType	string	是	无	设备类型
number	string	是	无	号码
callUrl	string	是	无	url
numberType	string	是	无	号码类型
callNumber	string	是	无	会议号码
displayName	string	是	无	名称
countryCode	string	是	无	国家码
avatar	string	是	无	头像地址

XYSDKCallConfig

描述: 呼叫信息
字段:

名称	类型	必填	默认值	描述
number	string	是	无	会议号
meetingPwd	string	否	无	密码
displayName	string	否	无	名称
liveId	string	否	无	直播id
callModel	XYSDKCallMode	是	无	会议模式
scheduleEventId	string	否	无	日程id
videoMute	boolean	是	无	视频状态
audioMute	boolean	是	无	音频状态
startTime	number	否	无	开始时间
title	string	否	无	会议标题

XYSDKCallConfigV2

描述: 呼叫信息-V2
字段:

名称	类型	必填	默认值	描述
id	string	否	无	云会议室号码或者终端号码
mute	boolean	否	无	入会是否静音 [true, false]
camera	boolean	否	无	入会是否开启摄像头[true, false]
noPwd	boolean	否	无	是否无条件入会 [true: 不需要密码， false:需要密码]
scheduledEventId	string	否	无	会议id
pwd	string	否	无	入会密码
hostPwd	string	是	无	主持密码
cCode	string	否	无	国家码
number	string	否	无	会议室号
title	string	否	无	会议标题
startTime	number	否	无	会议开始时间

XYSDKCallHistory

描述: 通话记录信息
字段:

名称	类型	必填	默认值	描述
displayName	string	是	无	会议名称
number	string	是	无	会议号
avatar	string	是	无	头像地址
userProfileId	number	是	无	unuse
callType	number	是	无	呼叫类型
numberType	string	是	无	会议号类型
callTime	string	是	无	呼叫时间
callUrl	string	是	无	无
top	boolean	是	无	无

XYSDKCallHistoryResult

描述: 通话记录回调信息
字段:

名称	类型	必填	默认值	描述
code	number	是	无	错误码
msg	string	是	无	回调信息
historyList	XYSDKCallHistory[]	是	无	通话记录列表

XYSDKCallInfo

描述: 会议信息
字段:

名称	类型	必填	默认值	描述
callMode	XYSDKCallMode	是	无	呼叫类型
remoteUri	string	是	无	远端calluri
remoteName	string	是	无	远端名称
remoteNumber	string	是	无	远端号码
remoteAlias	string	是	无	远端别名 unused
remoteType	string	是	无	unused

XYSDKCallStateInfo

描述: 用于存储呼叫状态相关信息

字段:

名称	类型	必填	默认值	描述
callState	XYSDKCallState	是	无	呼叫状态
errorCode	XYSDKCallError	是	无	错误信息
disconnectReason	string	是	无	断开原因
disconnectDesc	string	是	无	断开描述
meetingNumber	string	是	无	会议号
numberType	string	是	无	会议号类型
displayName	string	是	无	会中显示名称
displayNumber	string	是	无	会中显示号码
meetingID	string	是	无	会议ID
watermark	string	是	无	水印类型 0 不开启， 1 明水印 2 暗水印 3 明暗水印
avatar	string	是	无	头像
waitingReason	string	是	无	加入等候室原因
mpvc	string	是	无	虚拟号，跨云使用
isOnhold	boolean	是	无	是否处于等候室
forceVideoOn	boolean	是	无	强制开启视频
needHandleWaitingRoom	boolean	是	无	是否需要处理进入等候室
callUrl	string	是	无	会议url
callMode	XYSDKCallMode	是	无	呼叫类型
displayConfNo	boolean	是	无	是否显示会议号
commonStr	string	是	无	额外信息（json字符串）
invalidatingPassword	boolean	是	无	是否需要密码入会
newCallType	XYSDKNewCallType	是	无	呼叫类型

XYSDKCallUserInfo

描述: 会议信息
字段:

名称	类型	必填	默认值	描述
number	string	是	无	会议号
callMode	number	是	无	呼叫类型
enablePwd	boolean	是	无	是否需要密码
meetingPwd	string	是	无	会议密码
displayName	string	是	无	会议用户显示名称
avatar	string	是	无	头像地址
numberType	string	是	无	会议号类型
target	string	是	无	handle virtual number
newCallType	number	是	无	是否为CCC呼叫

XYSDKCapabilityResult

描述: 经过合并后的能力集接口回调信息
字段:

名称	类型	必填	默认值	描述
mixedAbility	XYSDKAbilityType[]	是	无	无

XYSDKCheckErrorCodeResult

描述: 错误码信息
字段:

名称	类型	必填	默认值	描述
version	string	是	无	版本
url	string	是	无	下载地址

XYSDKClientConfigResult

描述: clientConfig结果
字段:

名称	类型	必填	默认值	描述
uiCustomization	XYSDKUICustomizationInfo	是	无	用户配置信息
enterpriseConfig	XYSDKEnterpriseConfig	是	无	企业配置信息
eopCustomizedConfig	XYSDKEOPCustomizedConfig	是	无	运营平台配置信息
accountStatus	XYSDKAccountStatus	是	无	账户状态信息
entranceList	XYSDKEntranceList	是	无	入口配置信息

XYSDKCloudConfig

描述: 云配置信息
字段:

名称	类型	必填	默认值	描述
packageMenu	XYSDKCloudConfigPackage	否	new XYSDKCloudConfigPackage()	包菜单配置
loginAndRegisterMenu	XYSDKCloudConfigLoginAndRegister	否	new XYSDKCloudConfigLoginAndRegister()	登录和注册菜单配置
otherConfigurationMenu	XYSDKCloudConfigOtherConfiguration	否	new XYSDKCloudConfigOtherConfiguration()	其他配置菜单
contactMenu	XYSDKCloudConfigContact	否	new XYSDKCloudConfigContact()	联系人菜单配置
aboutConfigMenu	XYSDKCloudConfigAboutConfig	否	new XYSDKCloudConfigAboutConfig()	关于配置菜单
personalCenterMenu	XYSDKCloudConfigPersonalCenter	否	new XYSDKCloudConfigPersonalCenter()	个人中心菜单配置
loginConfigMenu	XYSDKCloudConfigLoginConfig	否	new XYSDKCloudConfigLoginConfig()	登录配置菜单
folderMenu	XYSDKCloudConfigFolder	否	new XYSDKCloudConfigFolder()	文件夹菜单配置
feedbackConfigMenu	XYSDKCloudConfigFeedbackConfig	否	new XYSDKCloudConfigFeedbackConfig()	反馈配置菜单
upgradeStrategyMenu	XYSDKCloudConfigUpgradeStrategy	否	new XYSDKCloudConfigUpgradeStrategy()	升级策略菜单配置
meetingMenu	XYSDKCloudConfigMeeting	否	new XYSDKCloudConfigMeeting()	会议菜单配置
enterpriseId	string	否	"962882ab7a574708017a60c78fd900e4"	企业ID
customizedKey	string	否	"xylink"	定制密钥

XYSDKCloudConfigAboutConfig

描述: 云配置关于配置信息
字段:

名称	类型	必填	默认值	描述
aboutConfig	string	否	""	关于配置

XYSDKCloudConfigContact

描述: 云配置联系人信息
字段:

名称	类型	必填	默认值	描述
showContact	boolean	否	true	是否显示联系人

XYSDKCloudConfigFeedbackConfig

描述: 云配置反馈配置信息
字段:

名称	类型	必填	默认值	描述
feedbackConfig	string	否	""	反馈配置

XYSDKCloudConfigFolder

描述: 云配置文件夹信息
字段:

名称	类型	必填	默认值	描述
showOperateFolder	boolean	否	true	是否显示操作文件夹
enableShareFolder	boolean	否	true	是否启用共享文件夹
showFolder	boolean	否	true	是否显示文件夹

XYSDKCloudConfigLoginAndRegister

描述: 云配置登录和注册
字段:

名称	类型	必填	默认值	描述
allowRegisterAccount	boolean	是	true	是否允许注册账号
showLoginForgotPwd	boolean	是	true	是否显示忘记密码
allowThirdCountLogin	boolean	是	true	是否允许第三方登录
allowLoginType	string	是	"allowAccountPasswordLogin,allowVerificationLogin"	允许的登录类型

XYSDKCloudConfigLoginConfig

描述: 云配置登录配置信息
字段:

名称	类型	必填	默认值	描述
loginConfig	string	否	""	登录配置

XYSDKCloudConfigMeeting

描述: 云配置会议信息
字段:

名称	类型	必填	默认值	描述
allowPstnCall	boolean	否	true	是否允许PSTN呼叫
showMeetingShareShortcut	boolean	否	true	是否显示会议分享快捷方式
enableMeetingShare	boolean	否	true	是否启用会议分享
showMeetingRecord	boolean	否	true	是否显示会议记录
meetingQRScanPrompt	string	否	""	会议二维码扫描提示
showContentOnly	boolean	否	true	是否仅显示内容
roomLogoUrlPc	string	否	""	PC端会议室标志URL
showCalendar	boolean	否	true	是否显示日历
showAboutButton	string	否	""	是否显示关于按钮
showMeetingShareScreen	boolean	否	true	是否显示会议分享屏幕
enableMeetingCaptureWaterMark	boolean	否	true	是否启用会议捕获水印
meetingQRLogo	string	否	""	会议二维码标志
showScan	boolean	否	true	是否显示扫描
enableLive	boolean	否	true	是否启用直播
showChairmanMode	boolean	否	true	是否显示主席模式
showCreateMeeting	boolean	否	true	是否显示创建会议
showMeetingShareImg	boolean	否	true	是否显示会议分享图片
joinMeetingSetting	string	否	""	加入会议设置
liveAboutButtonText	string	否	""	直播关于按钮文本
showLiveAboutButton	boolean	否	true	是否显示直播关于按钮
enableShareMeetingCaptureShare	boolean	否	true	是否启用共享会议捕获分享
showCloudResource	boolean	否	true	是否显示云资源
meetingQRExtIcon	string	否	""	会议二维码扩展图标
showLiveRecord	boolean	否	true	是否显示直播记录
liveLogoUrl	string	否	""	直播标志URL
showMeetingShareWhiteBoard	boolean	否	true	是否显示会议分享白板
showHostMeeting	boolean	否	true	是否显示主持会议
showMeetingShare	boolean	否	true	是否显示会议分享
liveAboutButtonUrl	string	否	""	直播关于按钮URL
enableMeetingQRResouce	boolean	否	true	是否启用会议二维码资源
enableShareLive	boolean	否	true	是否启用共享直播
showChat	boolean	否	true	是否显示聊天
allowAnonymousConference	boolean	否	true	是否允许匿名会议
showMeetingQRModel	string	否	""	会议二维码模型
showInviteMeeting	boolean	否	true	是否显示邀请会议
roomLogoUrl	string	否	""	会议室标志URL
showMonitorRecord	boolean	否	true	是否显示监控记录
meetingShareMode	string	否	""	会议分享模式
showKeyboard	boolean	否	true	是否显示键盘
showFecc	boolean	否	true	是否显示FECC
showShareConfig	boolean	否	true	是否显示分享配置

XYSDKCloudConfigOtherConfiguration

描述: 云配置其他配置信息
字段:

名称	类型	必填	默认值	描述
sdk3DirUrl	string	否	""	SDK3目录URL
licenseDialogContent	string	否	""	许可证对话框内容
showGuideCallLayer	boolean	否	true	是否显示引导呼叫层
showSysAlbumPer	boolean	否	true	是否显示系统相册权限
showPrivacyDevInfo	boolean	否	true	是否显示隐私设备信息
host	string	否	""	主机地址
licenseDialog3SdkDirUrl	string	否	""	许可证对话框SDK3目录URL
showServiceVideo	boolean	否	true	是否显示服务视频
sysVideoDesc	string	否	""	系统视频描述
showSysCalendarPer	boolean	否	true	是否显示系统日历权限
sysCalendarDesc	string	否	""	系统日历描述
httpPort	string	否	""	HTTP端口
showPrivacy	boolean	否	true	是否显示隐私
showSysLocalNetPer	boolean	否	true	是否显示系统本地网络权限
showLicenseDialog3SharedInfo	boolean	否	true	是否显示许可证对话框共享信息
sysLocalNetDesc	string	否	""	系统本地网络描述
infoListUrl	string	否	""	信息列表URL
showCopyRightInfo	boolean	否	true	是否显示版权信息
showMineAbout	boolean	否	true	是否显示我的关于
show3SharedInfo	boolean	否	true	是否显示3共享信息
showSysAudioPer	boolean	否	true	是否显示系统音频权限
sysAudioDesc	string	否	""	系统音频描述
showSysCallPer	boolean	否	true	是否显示系统呼叫权限
showUserGuide	boolean	否	true	是否显示用户指南
sysCallDesc	string	否	""	系统呼叫描述
showInfoList	boolean	否	true	是否显示信息列表
showLicenseDialog3SdkDir	boolean	否	true	是否显示许可证对话框SDK3目录
httpsPort	string	否	""	HTTPS端口
servicePhoneNumber	string	否	""	服务电话号码
shared3InfoUrl	string	否	""	共享3信息URL
showServerConfig	boolean	否	true	是否显示服务器配置
copyRightContentType	string	否	""	版权内容类型
showPrivacyManage	boolean	否	true	是否显示隐私管理
userGuideUrl	string	否	""	用户指南URL
licenseDialogChildrenUrl	string	否	""	许可证对话框子项URL
serviceVideoNumber	string	否	""	服务视频号码
showAboutPrivacy	boolean	否	true	是否显示关于隐私
showLicenseDialogChildren	boolean	否	true	是否显示许可证对话框子项
privacyLicenseUrl	string	否	""	隐私许可证URL
showNetTest	boolean	否	true	是否显示网络测试
personalInfomationCollectionList	string	否	""	个人信息收集列表
showPrivacySysPer	boolean	否	true	是否显示隐私系统权限
showLicenseInfo	boolean	否	true	是否显示许可证信息
showSysVideoPer	boolean	否	true	是否显示系统视频权限
showGuideCallPage	boolean	否	true	是否显示引导呼叫页面
showServicePhone	boolean	否	true	是否显示服务电话
show3SdkDir	boolean	否	true	是否显示3SDK目录
showLicenseInfoType	string	否	""	许可证信息类型
licenseDialog3SharedInfoUrl	string	否	""	许可证对话框3共享信息URL
showPrivacyPolicy	boolean	否	true	是否显示隐私政策
servicePhoneDesc	string	否	""	服务电话描述
serviceLicenseUrl	string	否	""	服务许可证URL
showFeedBack	boolean	否	true	是否显示反馈
sysAlbumDesc	string	否	""	系统相册描述

XYSDKCloudConfigPackage

描述: 云配置包信息
字段:

名称	类型	必填	默认值	描述
companyName	string	否	""	公司名称
unitRefEnglish	string	否	""	单位英文引用
unitRefName	string	否	""	单位引用名称
appNameCn	string	否	""	应用中文名称
appNameTw	string	否	""	应用繁体名称
en	string	否	""	英文
priorityCloudControlConfig	boolean	否	false	优先云控制配置
unitAllName	string	否	""	单位全称
companyTwName	string	否	""	公司繁体名称
meetingCaptureWaterMarkIcon	string	否	""	会议捕获水印图标
softVersion	string	否	""	软件版本
companyEnglishSimpleName	string	否	""	公司英文简称
companySimpleName	string	否	""	公司简称
privacyLicenseEnUrl	string	否	""	隐私许可证英文URL
appNameEn	string	否	""	应用英文名称
companyEnglishName	string	否	""	公司英文名称
companyTwSimpleName	string	否	""	公司繁体简称
cn	string	否	""	中文
showGuideAfterRegister	boolean	否	true	注册后是否显示指南
enterpriseLogo	string	否	""	企业标志
serviceLicenseEnUrl	string	否	""	服务许可证英文URL
unitAllEnglish	string	否	""	单位全称英文

XYSDKCloudConfigPersonalCenter

描述: 云配置个人中心信息
字段:

名称	类型	必填	默认值	描述
deleteAccountServiceNumber	string	否	""	删除账户服务号码
showShareLink	boolean	否	true	是否显示分享链接
showDeleteAccount	boolean	否	true	是否显示删除账户

XYSDKCloudConfigResult

描述: 云控回调信息
字段:

名称	类型	必填	默认值	描述
errorCode	XYSDKError	是	无	错误码
result	string	是	无	结果

XYSDKCloudConfigUpgradeStrategy

描述: 云配置升级策略信息
字段:

名称

类型

必填

默认值

描述

XYSDKCloudMeetingRoomConfigDisplays

描述: 云会议室功能可见性配置
字段:

名称	类型	必填	默认值	描述
allowSeparateRecord	boolean	是	无	独立终端录制
contacts	boolean	是	无	通讯录可见配置
enableHrLive	boolean	是	无	高清直播
forceRecord	boolean	是	无	强制录制
hideWatermark	boolean	是	无	暗水印
multipleRecord	boolean	是	无	多路录制
separateRecordAudio	boolean	是	无	参会终端声音单独录制
showForceVideoOn	boolean	是	无	入会是否强制打开摄像头
subtitle	boolean	是	无	同传字幕
transcription	boolean	是	无	录制自动生成会议纪要
translate	boolean	是	无	同声传译
showTranscriptionInMeeting	boolean	是	无	入会自动生成会议纪要
showRecordMode	boolean	是	无	recordMode 可见性配置

XYSDKCloudMeetingRoomConfigs

描述: 云会议室功能其他使能配置
字段:

名称	类型	必填	默认值	描述
hrRecord	boolean	是	无	是否支持超高清录制
showRecordTip	boolean	是	无	是否显示录制消息
onlyMainImage	number	是	无	只录制主会场和发言
addDeviceName	boolean	是	无	录制视频中叠加终端名称
allowCallScope	number	是	无	CLOSE(0), ALL(1), ENTERPRISE(2), NO_ANONYMOUS(3)
multipleRecord	number	是	无	允许多路录制
separateRecordAudio	boolean	是	无	所有入会终端声音单独录制
allowSeparateRecord	boolean	是	无	所有入会终端单独录制
forceRecord	boolean	是	无	强制录制
inoutReminder	boolean	是	无	出入会通知
disableTranscriptionEng	boolean	是	无	禁用字幕英文翻译。默认：false：不禁用；true：禁用
recordMode	number	是	无	录制模式，仅音频录制 0：音视频录制；1：仅音频录制
watermark	number	是	无	0:不开启水印，1：明水印，2：暗水印，3：明暗水印
watermarkRange	number	是	无	0: 内容共享时叠加水印 1: 全画面叠加水印
mediaEncrypt	string	是	无	加密算法 0：自适应 —— default 1：aes256 2：sm4
maxShowedRecResolution	string	是	无	UI用来决策下拉菜单中是否包含范围(720P、1080P、4K、8K)录制选项
maxAllowedRecResolution	string	是	无	UI用来决策已选值可展示内容，如已选值高于此变量，则降级
recordingResolution	string	是	无	UI回显选择的分辨率
translate	boolean	是	无	是否打开同声传译
displayConfNo	boolean	是	无	会议详情
enableWaitingRoom	boolean	是	无	开启等候室
allowEnterBeforePresenter	boolean	是	无	允许在主持人前进入
enableContentLive	boolean	是	无	允许多路内容共享
enableContentLiveOnHold	boolean	是	无	管理员广播才能收看共享
allowMaxContentNum	number	是	无	最大内容共享路数
forceVideoOn	boolean	是	无	入会强制开启摄像头
onlyScheduledCall	boolean	是	无	仅允许预约呼叫
meetingCapacityCount	number	是	无	会议容量
subtitle	boolean	是	无	通话字幕开关
transcription	boolean	是	无	录制自动生成会议纪要
transcriptionInMeeting	boolean	是	无	入会自动生成会议纪要

XYSDKCloudMeetingRoomResult

描述: 云会议室配置信息
字段:

名称	类型	必填	默认值	描述
id	string	是	无	云会议室主键id
meetingNumber	string	是	无	云会议室号码
displayName	string	是	无	云会议室名称
password	string	是	无	入会密码
meetingControlPassword	string	是	无	会控密码
autoMute	number	是	无	自动静音
smartMutePerson	number	是	无	智能静音个数（搭配autoMute为自动静音时候使用）
expireTime	number	是	无	失效时间
adminUserId	number	是	无	个人云会议室的用户id
ownerUserId	number	是	无	企业云会议室的管理员id（企业管理平台可以设置）
permanent	boolean	是	无	永久or临时会议室标志
conferenceNumberType	number	是	无	云会议室类型标识0表示个人云会议室
enterpriseId	string	是	无	企业id
configs	XYSDKCloudMeetingRoomConfigs	是	无	其他使能配置
configDisplays	XYSDKCloudMeetingRoomConfigDisplays	是	无	可见性配置

XYSDKCloudRoomInfo

描述: 会议室信息
字段:

名称	类型	必填	默认值	描述
conference_id	number	是	无	id
createTime	BigInt	是	无	创建时间
startTime	BigInt	是	无	开始时间
enterpriseId	string	是	无	企业ID
meetingNumber	string	是	无	会议号
displayName	string	是	无	名称
password	string	是	无	密码
meetingControlPassword	string	是	无	会控密码
needConferencePwd	boolean	是	无	是否需要会议密码
chargeType	string	是	无	无
sessionType	string	是	无	无
isBusy	number	是	无	无
fixedorShare	number	是	无	无
shareTitle_cn	string	是	无	无
shareTitle_en	string	是	无	无
shareTitle_tw	string	是	无	无

XYSDKCloudRoomResult

描述: 会议室列表
字段:

名称	类型	必填	默认值	描述
code	number	是	无	无
roomList	XYSDKCloudRoomInfo[]	是	无	无

XYSDKConfCaption

描述: 字幕信息
字段:

名称	类型	必填	默认值	描述
action	string	是	无	行为
content	string	是	无	内容
location	string	是	无	显示位置
scroll	boolean	是	无	是否滚动
fontSize	string	是	无	字体大小
backgroundAlpha	string	是	无	背景透明度
backgroundRGB	string	是	无	背景颜色
fontRGB	string	是	无	字体颜色
scrollSpeed	string	是	无	滚动速度
fontFamily	string	是	无	字体类型

XYSDKConfig

描述: SDK配置信息
字段:

名称	类型	必填	默认值	描述
cloudServer	string	是	无	服务器地址
openapiServer	string	是	无	开放平台地址, 暂不自定义, 请传""
openapiToken	string	是	无	开放平台口令, 暂不自定义, 请传""
logFolder	string	是	无	日志目录必须设置有权限的路径
logFileName	string	是	无	日志文件名称
platformTag	string	是	无	平台标识，用于上传log使用, 请传 HarmonyOS
appType	XYSDKBusinessType	是	无	应用标识, sdk请使用 XYSDKBusinessType.Sdk
appVersion	string	是	无	App版本号，用于上传log使用
clientId	string	是	无	应用clientId
clientSecret	string	是	无	应用clientSecret
clientType	string	是	无	应用clientType, 请使用 harmony_sdk
osVersion	string	是	无	操作系统版本
hwVersion	string	是	无	硬件系统版本
pemFile	string	是	无	pem证书路径暂不自定义, 请传""
eid	string	是	无	企业id
capture	number	是	无	采集方法暂不支持, 请传0
render	number	是	无	渲染方法暂不支持, 请传0
useUnityLayout	boolean	是	无	是否使用统一layout 暂不自定义, 请传true
appDataDir	string	是	无	app data路径必须设置有权限的路径
supportCapabilities	boolean	是	无	是否支持能力集暂不自定义, 请传true
customKey	string	是	无	定制ck
logFilterKey	string	是	无	日志过滤规则 - 将设置的key替换为*
logFilterKeyNum	string	是	无	日志过滤规则 - 将设置的key后num个字符替换为*
logFilterKeys	string	是	无	日志过滤规则 - 将设置的两个key之间的字符替换为*
cloudConfigJsonPath	string	是	无	云控配置数据文件路径，暂不自定义, 请传""
ability	XYSDKAbilityType[]	是	无	客户端能力集 sdk 请使用 [XYSDKAbilityType.DynamicErrorCode, XYSDKAbilityType.APIGateway, XYSDKAbilityType.UnsafeHttpMethod]
useNativeCamera	boolean	是	无	是否采用NativeCamera, 暂不自定义, 请传 false
forceApiGateway	boolean	是	无	强制接口使用网关暂不自定义, 请传 false
configLoginType	string	是	无	登录类型暂不自定义, 请传 ""
deviceType	number	是	无	设备类型 pc 5, 手机 1
deviceSn	string	是	无	设备标识

XYSDKConfInfo

描述: 会议信息
字段:

名称	类型	必填	默认值	描述
chairManUrl	string	是	无	主会场
contentUrl	string	是	无	共享
actSpkUri	string	是	无	as
participantCount	number	是	无	参会人数
contentPartCount	number	是	无	内容分享数量
totalEpCount	number	是	无	参会总人数包括自己
displayableEpCount	number	是	无	参会人数除去hide, onhold, contentonly
onHoldCount	number	是	无	等候室等待人数
isSelfContent	boolean	是	无	是否为共享
contentTotalNum	number	是	无	content分享人数
forceContent	boolean	是	无	是不是广播的content
contentName	string	是	无	分享者名称
contentInfos	string[]	是	无	会议中的分享content信息
sessionInfos	XYSDKSessionInfo[]	是	无	会话信息

XYSDKConfMgmtInfo

描述: 会控信息
字段:

名称	类型	必填	默认值	描述
chirmanUri	string	是	无	主会场标识
confMgmtUrl	string	是	无	主持会议H5地址
confMgmtMemebersUrl	string	是	无	参会者H5地址
muteSpk	string	是	无	on(mute speaker)
muteMic	string	是	无	mute
commonJson	string	是	无	额外信息
disableMute	boolean	是	无	是否需要举手发言
disableRecord	boolean	是	无	禁止录制
disableContent	boolean	是	无	禁止分享
disableWhiteboard	boolean	是	无	禁止白板
feccIsDisabled	boolean	是	无	遥控摄像头
disableAnnotation	boolean	是	无	是否禁止标注
group	XYSDKGroupInfo	是	无	分组信息

XYSDKControlMuteAction

描述: 控制静音操作
字段:

名称	类型	必填	默认值	描述
confUri	string	是	无	会议URI
encryption	string	是	无	加密信息
meetingId	string	是	无	会议ID
uri	string	是	无	URI

XYSDKCrmFolderData

描述: 操作指南，拓客文件夹数量

字段:

名称	类型	必填	默认值	描述
manualCount	number	是	无	手册数量
distributorDataCount	number	是	无	经销商数据数量
manualVersion	string	是	无	手册版本
distributorVersion	string	是	无	经销商版本
manualChanged	boolean	是	无	手册是否更改
distributorChanged	boolean	是	无	经销商是否更改

XYSDKDefaultNameCharactersResult

描述: 获取默认特殊字符正则表达式回调信息
字段:

名称	类型	必填	默认值	描述
defaultNameSupportCharacters	string	是	无	默认特殊字符正则表达式

XYSDKDeleteParam

描述: 删除参数
字段:

名称	类型	必填	默认值	描述
cloudMeetingRoomId	string	是	无	云会议室ID
userProfileId	number	是	无	用户配置文件ID
fileId	string	是	无	文件ID
favoriteId	string	是	无	收藏ID
nemoId	number	是	无	Nemo ID

XYSDKDepartmentInfo

描述: 通讯录部门信息
字段:

名称	类型	必填	默认值	描述
id	number	是	无	ID
name	string	是	无	名称
order	number	是	无	排序
childs	XYSDKDepartmentInfo[]	是	无	子部门
level	number	是	无	级别
depCode	string	是	无	部门代码
parentId	number	是	无	父部门ID

XYSDKDetailStatistics

描述: 呼叫中详细统计信息
字段:

名称	类型	必填	默认值	描述
staDBA	string	是	无	数据库统计信息
staETC	string	是	无	其他统计信息
staARX	string	是	无	音频接收统计信息
staATX	string	是	无	音频发送统计信息
staVTX	string	是	无	视频发送统计信息
staVRX	string	是	无	视频接收统计信息
staRoster	string	是	无	参会者统计信息
staCARX	string	是	无	内容音频接收统计信息
staCATX	string	是	无	内容音频发送统计信息
staCVTX	string	是	无	内容视频发送统计信息
staCVRX	string	是	无	内容视频接收统计信息

XYSDKDeviceConfigResult

描述: 设备信息配置回调
字段:

名称	类型	必填	默认值	描述
pvrxMaxRecvStream	number	是	无	最大接收视频流数量
noDisturbIncall	boolean	是	无	会中免打扰
enableCallRecovery	boolean	是	无	云会议断线重呼
enableNotDisturbInHosting	boolean	是	无	主持会议免打扰
enableConferenceControlSidebar	boolean	是	无	会控侧边栏开关

XYSDKDownloadProgress

描述: 下载进度回调
字段:

名称	类型	必填	默认值	描述
url	string	是	无	下载地址
progress	number	是	无	下载进度

XYSDKDownloadStatusInfo

描述: 下载结果回调
字段:

名称	类型	必填	默认值	描述
status	XYSDKDownloadStatus	是	无	下载状态
cachePath	string	是	无	储存地址
filename	string	是	无	文件名
url	string	是	无	下载地址

XYSDKDynUpsInfo

描述: H5热更新模块信息
字段:

名称	类型	必填	默认值	描述
type	XYSDKDynUpsModuleType	是	无	模块类型
platform	string	是	无	平台信息
filePath	string	是	无	文件路径
version	string	是	无	版本信息
entry	string	是	无	对应的platform下所有的H5入口
forceUpdate	boolean	是	无	是否强制更新
fromDownLoadFinish	boolean	是	无	是否从下载完成

XYSDKEnterpriseConfig

描述: 企业配置信息
字段:

名称	类型	必填	默认值	描述
displayCloudMeetingRoomUpgradeBadge	boolean	是	无	是否显示云会议室升级标识
displayEnterpriseResource	boolean	是	无	是否显示企业资源
enableApplySpeak	boolean	是	无	是否启用申请发言
enableEnterpriseMemberInvatition	boolean	是	无	是否启用企业成员邀请
enableModifyPhone	boolean	是	无	是否允许修改电话
enableMonitor	boolean	是	无	是否启用监控
enableVodShare	boolean	是	无	是否启用点播分享
shareMaxNumSetting	boolean	是	无	是否启用最大分享数设置
displayEnterpriseOrUnitString	string	是	无	显示企业或单位字符串
enableMultipleShared	boolean	是	无	是否启用多路共享
multipleSharedCount	number	是	无	多路共享数量
userAvatarMode	number	是	无	是否开启用户文本头像
forbidChangeName	boolean	是	无	是否禁止修改名称
disableTranscriptionEng	boolean	是	无	是否禁用英文转录
openTempAccount	boolean	是	无	是否开启临时账号
showSoftRandomMeetingRoom	boolean	是	无	是否显示软随机会议室

XYSDKEnterpriseDomainNameResult

描述: 用于定义获取SSO信息回调

字段:

名称	类型	必填	默认值	描述
error	XYSDKError	是	无	错误码
errorMsg	string	是	无	错误描述
status	string	是	无	状态码是"10200"表示成功
info	string	是	无	unused
data	XYSDKSSOInfo	是	无	SSO登录信息

XYSDKEnterpriseInfoResult

描述: 企业信息
字段:

名称	类型	必填	默认值	描述
enterpriseName	string	是	无	企业名称

XYSDKEntrance

描述: 入口配置信息
字段:

名称	类型	必填	默认值	描述
flag	string	是	无	入口类型
display	boolean	是	无	是否显示
url	string	是	无	跳转链接

XYSDKEntranceData

描述: 文件夹入口信息

字段:

名称	类型	必填	默认值	描述
cloudDomainName	string	是	无	云域名
enterpriseShareCenterId	string	是	无	企业共享中心ID
enterpriseShareCenterDisplayName	string	是	无	企业共享中心显示名称
userProfileId	number	是	无	用户配置文件ID
clientVersion	string	是	无	客户端版本
customizedConfig	string	是	无	自定义配置
ownerType	number	是	无	所有者类型
ownerId	number	是	无	所有者ID
dev	boolean	是	无	开发模式
manager	boolean	是	无	管理员状态
recordFileExpireTime	string	是	无	记录文件过期时间
nemos	XYSDKNemosData[]	是	无	Nemo数据列表

XYSDKEntranceList

描述: 入口配置信息列表
字段:

名称	类型	必填	默认值	描述
entrance	XYSDKEntrance[]	是	无	入口配置信息数组

XYSDKEOPCustomizedConfig

描述: 运营平台配置信息
字段:

名称	类型	必填	默认值	描述
showService188	boolean	是	无	是否显示188188
showUseGuide	boolean	是	无	是否显示用户引导
showPhoneService	boolean	是	无	是否显示客服信息
showVideoService	boolean	是	无	是否显示288288
showOwnedEnterprise	boolean	是	无	是否显示所属企业
enableShareMeetingLink	boolean	是	无	是否显示发起会议邀请
enableInviteInMeeting	boolean	是	无	是否显示会议中邀请
hideInviteTypeConfig	string[]	是	无	邀请类型配置信息

XYSDKExclusiveNameCharactersResult

描述: 获取特殊字符正则表达式回调信息
字段:

名称	类型	必填	默认值	描述
displayNameSupportCharacters	string	是	无	特殊字符正则表达式

XYSDKExtensionDataList

描述: 扩展数据列表项
字段:

名称	类型	必填	默认值	描述
dataName	string	是	无	数据名称
dataUrl	string	是	无	数据URL
previewUrl	string	是	无	预览URL
day	string	是	无	日期
duration	string	是	无	时长

XYSDKExtensionFolderResult

描述: 扩展文件夹结果
字段:

名称	类型	必填	默认值	描述
code	number	是	无	状态码
msg	string	是	无	消息
page	XYSDKExtensionPage	是	无	页面信息
version	string	是	无	版本号

XYSDKExtensionPage

描述: 扩展页面信息
字段:

名称	类型	必填	默认值	描述
pageIndex	number	是	无	页码
totalPages	number	是	无	总页数
pageSize	number	是	无	每页大小
totalRows	number	是	无	总行数
data	XYSDKExtensionDataList[]	是	无	数据列表
startIndex	number	是	无	起始索引

XYSDKExtError

描述: 扩展错误详情
字段:

名称	类型	必填	默认值	描述
errorCode	number	是	无	错误码
developerMessage	string	是	无	开发者错误信息
userMessage	string	是	无	用户错误信息
moreInfo	string	是	无	更多信息

XYSDKFace

描述: 人脸识别信息
字段:

名称	类型	必填	默认值	描述
isLocal	boolean	是	无	是否为本地视频
calluri	string	是	无	calluri
participantId	number	是	无	用户id
type	XYSDKFaceType	是	无	人脸识别类型
seq	number	是	无	序列号
detailVec	XYSDKFaceDetailInfo	是	无	人脸识别位置信息

XYSDKFaceDetailInfo

描述: 人脸识别详细信息
字段:

名称	类型	必填	默认值	描述
faceID	number	是	无	人脸识别id
position	XYSDKFacePosition	是	无	人脸位置信息
userName	string	是	无	用户名
userNickName	string	是	无	用户昵称
userAge	string	是	无	年龄
userIdentifyCard	string	是	无	人脸标识信息
userTitle	string	是	无	标题
userPhone	string	是	无	电话号码
userStatus	number	是	无	用户状态

XYSDKFacePosition

描述: 人脸识别位置信息
字段:

名称	类型	必填	默认值	描述
faceId	number	是	无	人脸id
left	number	是	无	左间距
top	number	是	无	上间距
right	number	是	无	右间距
bottom	number	是	无	下间距

XYSDKFileDueData

描述: 文件到期数据
字段:

名称	类型	必填	默认值	描述
count	number	是	无	数量
cleanDays	number	是	无	清理天数
name	string	是	无	名称
popupNotice	boolean	是	无	是否弹出通知
updateTime	number	是	无	更新时间

XYSDKFileDueResult

描述: 文件到期结果
字段:

名称	类型	必填	默认值	描述
code	number	是	无	状态码
msg	string	是	无	消息
data	XYSDKFileDueData	是	无	文件到期数据

XYSDKFolderBasicInfoResult

描述: 文件夹基础信息

字段:

名称	类型	必填	默认值	描述
code	number	是	无	状态码
msg	string	是	无	消息
entrance	XYSDKEntranceData	是	无	入口数据
configs	XYSDKFolderConfigs	是	无	配置信息
enterpriseCurrent	XYSDKFolderEnterpriseCurrent	是	无	企业当前信息
crmFolderData	XYSDKCrmFolderData	是	无	CRM文件夹数据
vodFolderData	XYSDKVodFolderData	是	无	VOD文件夹数据

XYSDKFolderConfigs

描述: 文件夹配置信息

字段:

名称	类型	必填	默认值	描述
downloadInShareCenter	boolean	是	无	是否在共享中心下载
publicShare	boolean	是	无	是否公开共享
enterpriseShare	boolean	是	无	是否企业共享
allowVodShareEmailNotice	boolean	是	无	是否允许VOD共享邮件通知
allowFolderAuth	boolean	是	无	是否允许文件夹授权
authFlag	boolean	是	无	授权标志
vodRecycleCleanDays	number	是	无	VOD回收清理天数

XYSDKFolderDeleteResult

描述: 文件夹删除结果
字段:

名称	类型	必填	默认值	描述
code	number	是	无	状态码
msg	string	是	无	消息
userMessage	string	是	无	用户消息
developerMessage	string	是	无	开发者消息

XYSDKFolderEnterpriseCurrent

描述: 共享文件夹信息

字段:

名称	类型	必填	默认值	描述
id	string	是	无	ID
enterpriseId	string	是	无	企业ID
displayName	string	是	无	显示名称
publicId	string	是	无	公共ID

XYSDKFolderRenameResult

描述: 文件夹重命名结果
字段:

名称	类型	必填	默认值	描述
data	string	是	无	数据
code	number	是	无	状态码
msg	string	是	无	消息
success	boolean	是	无	是否成功
errorCode	string	是	无	错误码
userMessage	string	是	无	用户消息
developerMessage	string	是	无	开发者消息
moreInfo	string	是	无	更多信息
httpCode	number	是	无	HTTP状态码
httpData	string	是	无	HTTP数据

XYSDKGetErrorCodeResult

描述: 获取错误码文件回调结果
字段:

名称	类型	必填	默认值	描述
filePath	string	是	无	错误码文件存储地址

XYSDKGroupInfo

描述: 分组信息
字段:

名称	类型	必填	默认值	描述
groupType	number	是	无	分组类型
groupLeader	boolean	是	无	是否为分组管理员
groupName	string	是	无	分组名称

XYSDKGuideDataList

描述: 指南数据列表项
字段:

名称	类型	必填	默认值	描述
dataName	string	是	无	数据名称
dataUrl	string	是	无	数据URL
previewUrl	string	是	无	预览URL
day	string	是	无	日期
duration	string	是	无	时长

XYSDKGuideFolderResult

描述: 指南文件夹结果
字段:

名称	类型	必填	默认值	描述
code	number	是	无	状态码
msg	string	是	无	消息
page	XYSDKGuidePage	是	无	页面信息
version	string	是	无	版本号

XYSDKGuidePage

描述: 指南页面信息
字段:

名称	类型	必填	默认值	描述
pageIndex	number	是	无	页码
totalPages	number	是	无	总页数
pageSize	number	是	无	每页大小
totalRows	number	是	无	总行数
data	XYSDKGuideDataList[]	是	无	数据列表
startIndex	number	是	无	起始索引

XYSDKIMPermission

描述: im权限信息
字段:

名称	类型	必填	默认值	描述
imStatus	string	是	无	im状态
meetingId	string	是	无	会议id
newImStatus	string	是	无	新的im状态
waiterChatToHost	string	是	无	unuse

XYSDKInOutInfo

描述: 出入会信息
字段:

名称	类型	必填	默认值	描述
displayName	string	是	无	显示名称
action	string	是	无	in or out
extUserId	string	是	无	第三方用户id

XYSDKInteractiveToolCopyWritings

描述: 互动工文案具回调信息
字段:

名称	类型	必填	默认值	描述
indexNo	number	是	无	互动工具类型
content	string	是	无	文案内容

XYSDKInteractiveToolEvent

描述: 互动工具事件信息
字段:

名称	类型	必填	默认值	描述
eventType	XYSDKInteractiveToolEventType	是	无	事件类型
processType	XYSDKInteractiveToolProcessType	是	无	互动工具种类
endAuto	boolean	是	无	是否自动结束
voteType	number	是	无	互动工具类型
duration	number	是	无	倒计时时长
endUtcTime	BigInt	是	无	倒计时时间戳
startWebViewUrl	string	是	无	开始链接地址
resultWebViewUrl	string	是	无	结束链接地址
questionnaireId	string	是	无	互动工具id
meetingId	string	是	无	会议id
business	string	是	无	业务相关（答题、投票结果展示关闭场景 answerResultShow）

XYSDKInteractiveToolInfo

描述: 互动工具回调信息
字段:

名称	类型	必填	默认值	描述
isSupport	boolean	是	无	是否支持互动工具
writings	XYSDKInteractiveToolCopyWritings	是	无	文案信息
event	XYSDKInteractiveToolEvent	是	无	互动工具事件信息

XYSDKLanguage

描述: 同声传译语言信息
字段:

名称	类型	必填	默认值	描述
id	number	是	无	语言id
zh_CN	string	是	无	语言名称（中文）
en_US	string	是	无	语言名称（英文）

XYSDKLayoutReq

描述: 流信息请求
字段:

名称	类型	必填	默认值	描述
pageIndex	number	是	无	页码
maxViewCountPerPage	number	是	无	每页最大视图数
reqList	XYSDKViewReqInfo[]	是	无	请求列表

XYSDKLine

描述: UI use this export interface to send a line to SDK
字段:

名称	类型	必填	默认值	描述
weight	number	是	无	线条粗细
color	string	是	无	颜色，如"#121212ff" RGBA格式
calluri	string	是	无	[Annotation] 标识发送目标
uuid	string	是	无	[Whiteboard] 无用。[Annotation] 用于线条发送者(内容接收者)匹配反馈
points	XYSDKPoint[]	是	无	点集合
ended	boolean	是	无	是否结束
getAllLines	boolean	是	无	是否获取所有线条

XYSDKLiveDomainUrlResult

描述: 直播独立域名
字段:

名称	类型	必填	默认值	描述
liveDomainUrl	string	是	无	无

XYSDKLocalRecordBusinessInfo

描述: 本地录制业务信息
字段:

名称	类型	必填	默认值	描述
title	string	是	无	录制标题
speaker	string	是	无	录制者名称
confNum	string	是	无	会议号

XYSDKLocalRecordLayout

描述: 本地录制布局
字段:

名称	类型	必填	默认值	描述
canvasAspectHeight	number	是	无	画布宽高比
canvasAspectWidth	number	是	无	画布宽高比
elements	XYSDKLocalRecordLayoutElement[]	是	无	布局元素列表

XYSDKLocalRecordLayoutElement

描述: 本地录制布局元素
字段:

名称	类型	必填	默认值	描述
left	number	是	无	左边距
top	number	是	无	上边距
width	number	是	无	宽度
height	number	是	无	高度
isVideoReceived	boolean	是	无	是否接收到视频
isAudioMute	boolean	是	无	是否静音
displayName	string	是	无	显示名称
sourceInfo	XYSDKLocalRecordVideoSourceInfo	是	无	视频源信息

XYSDKLocalRecordStorePath

描述: 本地录制存储路径
字段:

名称	类型	必填	默认值	描述
localStorePath	string	是	无	本地存储路径
mobileStorePath	string	是	无	移动端存储路径

XYSDKLocalRecordVideoSource

描述: 视频流信息 for local, sourceId means deviceId, if empty string means builtin camara.channelId measn sceanId. for remote, sourceId means remote uri,channelId is useless
字段:

名称	类型	必填	默认值	描述
sourceId	string	是	无	sourceid
channelId	number	是	无	屏幕id
ssrc	number	是	无	同步源标识符

XYSDKLocalRecordVideoSourceInfo

描述: 视频信息
字段:

名称	类型	必填	默认值	描述
bLocalVideoSource	boolean	是	无	是否为本地视频
bContent	boolean	是	无	是否为共享

XYSDKLoginHistory

描述: 登录历史
字段:

名称	类型	必填	默认值	描述
deviceDisplayName	string	是	无	设备显示名称
platform	string	是	无	平台
manufacturer	string	是	无	制造商
model	string	是	无	型号
operationSystem	string	是	无	操作系统
loginTime	BigInt	是	无	登录时间

XYSDKLogUploadResult

描述: 上传日志结果回调
字段:

名称	类型	必填	默认值	描述
type	XYSDKLogType	是	无	日志类型
id	string	是	无	日志ID

XYSDKMediaDevInfo

描述: 媒体设备信息
字段:

名称	类型	必填	默认值	描述
devId	string	是	无	设备id
devName	string	是	无	设备名称
isSelected	boolean	是	无	是否选中
isDefault	boolean	是	无	是否是系统默认设备

XYSDKMediaDevParam

描述: 媒体设备参数
字段:

名称	类型	必填	默认值	描述
devType	XYSDKMediaDevType	是	无	设备类型
vidOrdinal	XYSDKVideoOrdinal	是	无	视频序号
devError	XYSDKMediaDevError	是	无	设备错误

XYSDKMediaFileEventArg

描述: 共享媒体事件参数
字段:

名称	类型	必填	默认值	描述
errorCode	XYSDKMediaFileErrorType	是	无	错误码
position	number	是	无	位置
duration	number	是	无	内容事件长度
videoWidth	number	是	无	视频宽度
videoHeight	number	是	无	视频长度
aspectRatioW	number	是	无	比例
aspectRatioH	number	是	无	比例
hasVideo	boolean	是	无	是否含有视频
hasAudio	boolean	是	无	是否含有音频

XYSDKMediaFileInfo

描述: 媒体文件信息
字段:

名称	类型	必填	默认值	描述
type	XYSDKMediaFileType	是	无	文件类型
width	number	是	无	宽度
height	number	是	无	高度

XYSDKMediaManualItem

描述: 媒体手动项
字段:

名称	类型	必填	默认值	描述
name	XYSDKMediaManualItemName	是	无	名称
type	XYSDKMediaManualItemType	是	无	类型

XYSDKMeetingCapacityInfo

描述: 会议室容量信息
字段:

名称	类型	必填	默认值	描述
attribute	number	是	无	企业归属属性，0-有企业 1-无企业
buyUrl	string	是	无	购买链接
capacity_CN	string	是	无	会议室容量-中文
capacity_TW	string	是	无	会议室容量-繁体
capacity_EN	string	是	无	会议室容量-英文

XYSDKMeetingConlictInfo

描述: 当前会议冲突的预约会议信息
字段:

名称	类型	必填	默认值	描述
meetingId	string	是	无	会议id
meetingNumber	string	是	无	会议号
displayName	string	是	无	会议名称

XYSDKMeetingControlConfigInfo

描述: 会控接口获取的主持人，分级会议室信息
字段:

名称	类型	必填	默认值	描述
isHost	boolean	是	无	是否为会议主持人
isBigConf	boolean	是	无	unused
noCtrPwd	boolean	是	无	unused

XYSDKMeetingControlMuteChangeParam

描述: 会控mute信息变化
字段:

名称	类型	必填	默认值	描述
toast	string[]	是	无	提示各个语言第一个为中文第二个为英文第三个为其他语言
isMuteCamera	boolean	是	无	是否关闭摄像头
isForceUnmuteCamera	boolean	是	无	是否强制打开摄像头

XYSDKMeetingRoomInfoForInstant

描述: kick-off conference info
字段:

名称	类型	必填	默认值	描述
inviteUrl	string	是	无	邀请链接
invokSchema	string	是	无	无
linkNumber	string	是	无	会议号
pstnNumber	string	是	无	pstn会议号
shareUrl	string	是	无	会议链接
voiceNumber	string	是	无	电话语音入会号码
userAvatar	string	是	无	会议发起者头像
userName	string	是	无	会议发起者名称
password	string	是	无	会议密码
displayName	string	是	无	会议名称

XYSDKMonitorInfo

描述: 显示器信息
字段:

名称	类型	必填	默认值	描述
monitorName	string	是	无	显示器名称
minitorRect	XYSDKRect	是	无	显示器区域

XYSDKMyCurrentFolder

描述: 我的当前文件夹信息
字段:

名称	类型	必填	默认值	描述
id	number	是	无	ID
externalId	string	是	无	外部ID
type	number	是	无	类型
displayName	string	是	无	显示名称
level	number	是	无	级别
parentId	number	是	无	父ID
containerType	number	是	无	容器类型
containerId	string	是	无	容器ID
createTimestamp	number	是	无	创建时间戳
cleanTime	number	是	无	清理时间
enterpriseId	string	是	无	企业ID

XYSDKMyFolderData

描述: 我的文件夹数据
字段:

名称	类型	必填	默认值	描述
list	XYSDKMyFolderList[]	是	无	文件夹列表
currentFolder	XYSDKMyCurrentFolder	是	无	当前文件夹
total	number	是	无	总数
size	number	是	无	大小
current	number	是	无	当前页
pages	number	是	无	总页数

XYSDKMyFolderInfo

描述: 我的文件夹信息
字段:

名称	类型	必填	默认值	描述
data	XYSDKMyFolderData	是	无	文件夹数据
code	number	是	无	状态码
msg	string	是	无	消息
success	boolean	是	无	是否成功
errorCode	string	是	无	错误码
userMessage	string	是	无	用户消息

XYSDKMyFolderInfoResult

描述: 我的文件夹信息结果
字段:

名称	类型	必填	默认值	描述
code	number	是	无	状态码
msg	string	是	无	消息

XYSDKMyFolderList

描述: 我的文件夹列表项
字段:

名称	类型	必填	默认值	描述
id	number	是	无	ID
favoriteId	number	是	无	收藏ID
author	string	是	无	作者
authorName	string	是	无	作者名称
containerId	string	是	无	容器ID
containerType	string	是	无	容器类型
externalId	string	是	无	外部ID
level	string	是	无	级别
parentId	string	是	无	父ID
fileId	number	是	无	文件ID
openToCircle	string	是	无	开放圈子
playCount	string	是	无	播放次数
publicId	string	是	无	公共ID
vodMetadataId	string	是	无	VOD元数据ID
cover	string	是	无	封面
cryptoKey	string	是	无	加密密钥
cryptoMode	string	是	无	加密模式
nemoId	string	是	无	Nemo ID
duration	number	是	无	时长
endTag	string	是	无	结束标签
endpointId	string	是	无	端点ID
endpointName	string	是	无	端点名称
liveId	string	是	无	直播ID
meetingRoomNumber	string	是	无	会议室号码
preview	string	是	无	预览
previewPicsCount	string	是	无	预览图片数量
rcUuid	string	是	无	RC UUID
removedOnNemo	string	是	无	在Nemo上移除
resolution	string	是	无	分辨率
seqId	string	是	无	序列ID
sessionId	string	是	无	会话ID
state	string	是	无	状态
thumbnail	string	是	无	缩略图
thumbnailOss	string	是	无	OSS缩略图
viewId	string	是	无	视图ID
transcriptionId	string	是	无	转录ID
transcriptionVer	number	是	无	转录版本
favoriteVodId	string	是	无	收藏VOD ID
fileSize	number	是	无	文件大小
createTime	number	是	无	创建时间
startTime	number	是	无	开始时间
endTime	number	是	无	结束时间
enterpriseId	string	是	无	企业ID
type	string	是	无	类型
userProfileId	string	是	无	用户配置文件ID
folderId	number	是	无	文件夹ID
displayName	string	是	无	显示名称
showType	string	是	无	显示类型
thumbnailUrl	string	是	无	缩略图URL
shared	boolean	是	无	是否共享
shareType	string	是	无	共享类型
coverUrl	string	是	无	封面URL
meetingRoomId	string	是	无	会议室ID
cleanTime	number	是	无	清理时间
cleanFlag	number	是	无	清理标志
cleanDay	number	是	无	清理天数
sitecode	string	是	无	站点代码
enableCluster	number	是	无	启用集群
vcmFileId	number	是	无	VCM文件ID

XYSDKNearExpiredVodNoticeInfo

描述: 过期文件提醒
字段:

名称	类型	必填	默认值	描述
name	string	是	无	名称
count	number	是	无	数量
cleanDays	number	是	无	清理天数
popupNotice	boolean	是	无	是否弹出提醒

XYSDKNemoFolderData

描述: 小鱼文件夹数量

字段:

名称	类型	必填	默认值	描述
nemoId	number	是	无	Nemo ID
count	number	是	无	数量

XYSDKNemosData

描述: 文件夹终端基础信息

字段:

名称	类型	必填	默认值	描述
id	number	是	无	ID
type	number	是	无	类型
userProfileID	number	是	无	用户配置文件ID
displayName	string	是	无	显示名称
deviceSN	string	是	无	设备序列号
securityKey	string	是	无	安全密钥
expirationTime	number	是	无	过期时间
presence	number	是	无	在线状态
config	string	是	无	配置
nemoNumber	number	是	无	Nemo号码
bindTimestamp	number	是	无	绑定时间戳
deviceModel	string	是	无	设备型号
avatar	string	是	无	头像
adminDisplayName	string	是	无	管理员显示名称
firstBindTime	number	是	无	首次绑定时间
autoBound	boolean	是	无	自动绑定状态
fingerprint	string	是	无	指纹
subType	number	是	无	子类型
category	string	是	无	类别
enterpriseId	string	是	无	企业ID
departmentId	string	是	无	部门ID
deptCode	string	是	无	部门代码
inUse	boolean	是	无	使用状态
hardwareSnUnique	string	是	无	硬件序列号唯一标识
online	boolean	是	无	在线状态
officeDevice	boolean	是	无	办公设备状态

XYSDKNemoVideoData

描述: Nemo视频数据
字段:

名称	类型	必填	默认值	描述
version	number	是	无	版本号
count	number	是	无	数量
startIndex	number	是	无	起始索引
data	XYSDKNemoVideoList[]	是	无	视频列表

XYSDKNemoVideoList

描述: Nemo视频列表项
字段:

名称	类型	必填	默认值	描述
id	number	是	无	ID
userProfileId	number	是	无	用户配置文件ID
recordingId	string	是	无	录制ID
seqId	number	是	无	序列ID
endTag	boolean	是	无	结束标签
fileName	string	是	无	文件名
startTime	number	是	无	开始时间
endTime	number	是	无	结束时间
duration	number	是	无	时长
thumbnail	string	是	无	缩略图
cover	string	是	无	封面
coverUrl	string	是	无	封面URL
thumbnailUrl	string	是	无	缩略图URL
innerThumbnailUrl	string	是	无	内部缩略图URL
author	number	是	无	作者
device	number	是	无	设备
type	number	是	无	类型
addRecordType	string	是	无	添加记录类型
state	number	是	无	状态
status	number	是	无	状态码
cryptoKey	string	是	无	加密密钥
cryptoMode	number	是	无	加密模式
fileSize	number	是	无	文件大小
arrivalTimestamp	number	是	无	到达时间戳
shared	boolean	是	无	是否共享
publicID	string	是	无	公共ID
sharedStatus	number	是	无	共享状态
shareType	number	是	无	共享类型
sharedFileName	string	是	无	共享文件名
displayName	string	是	无	显示名称
playCount	number	是	无	播放次数
downloadCount	number	是	无	下载次数
operator	number	是	无	操作者
timestamp	number	是	无	时间戳
openToCircle	boolean	是	无	是否开放到圈子
favoriteId	number	是	无	收藏ID
extraType	string	是	无	额外类型
extraContent	string	是	无	额外内容
cloudMeetingId	string	是	无	云会议ID
meetingId	string	是	无	会议ID
meetingRoomId	string	是	无	会议室ID
meetingRoomRecord	boolean	是	无	会议室录制
removedTime	number	是	无	移除时间
enterpriseId	string	是	无	企业ID
meetingName	string	是	无	会议名称
viewName	string	是	无	视图名称
uuid	string	是	无	UUID
eduRecordUuid	string	是	无	教育记录UUID
groupId	string	是	无	组ID
groupName	string	是	无	组名称
endpointId	string	是	无	端点ID
endpointName	string	是	无	端点名称
liveId	string	是	无	直播ID
nemoNumber	string	是	无	Nemo号码
nemoSubType	number	是	无	Nemo子类型
folderId	number	是	无	文件夹ID
resolution	string	是	无	分辨率
preview	string	是	无	预览
viewCount	number	是	无	查看次数
meetingRoomNumber	string	是	无	会议室号码
viewId	string	是	无	视图ID
scheduledId	string	是	无	计划ID
cleanTime	number	是	无	清理时间
cleanFlag	number	是	无	清理标志
cleanDay	number	是	无	清理天数
sitecode	string	是	无	站点代码
enableCluster	boolean	是	无	启用集群
authorId	string	是	无	作者ID
sdkAlias	string	是	无	SDK别名
transcriptionId	string	是	无	转录ID
transcriptionTxtFileUrl	string	是	无	转录文本文件URL
publishState	boolean	是	无	发布状态
signatureType	number	是	无	签名类型
signatureValue	string	是	无	签名值
multiRes	number	是	无	多分辨率
commonJson	string	是	无	通用JSON
firstDeptId	number	是	无	第一个部门ID
deptId	number	是	无	部门ID
resStatus	number	是	无	资源状态
fileId	number	是	无	文件ID
conferenceType	number	是	无	会议类型

XYSDKNemoVideoResult

描述: Nemo视频结果
字段:

名称	类型	必填	默认值	描述
data	XYSDKNemoVideoData	是	无	视频数据
code	number	是	无	状态码
msg	string	是	无	消息
success	boolean	是	无	是否成功
errorCode	string	是	无	错误码
userMessage	string	是	无	用户消息

XYSDKNetProxy

描述: 用于定义网络代理配置

字段:

名称	类型	必填	默认值	描述
hostAddress	string	是	无	host
port	number	是	无	端口
username	string	是	无	账号 only for SOCKS5 authentication
password	string	是	无	密码 only for SOCKS5 authentication

XYSDKNetTestResult

描述: 网络测试回调
字段:

名称	类型	必填	默认值	描述
recvQualityLevel	number	是	无	网络接收质量等级
sendQualityLevel	number	是	无	网络发送质量等级
jitterRecv	number	是	无	网络接收抖动
jitterSend	number	是	无	网络发送抖动
lostRecv	number	是	无	网络接收丢包
lostSend	number	是	无	网络发送丢包
missorderRecv	number	是	无	网络接收乱序
missorderSend	number	是	无	网络发送乱序
rttRecv	number	是	无	网络接收往返时间
rttSend	number	是	无	网络发送往返时间

XYSDKNetworkState

描述: 网络状态
字段:

名称	类型	必填	默认值	描述
connected	boolean	是	无	是否连接
localIp	string	是	无	本地IP地址

XYSDKNetworkStatistics

描述: 网络统计信息
字段:

名称	类型	必填	默认值	描述
rtt	number	是	无	往返时间 ms
rxDetectBw	number	是	无	下行带宽 kbps
rxJitter	number	是	无	下行抖动 ms
rxLost	number	是	无	下行丢包率
txDetectBw	number	是	无	上行带宽 kbps
txJitter	number	是	无	上行抖动 ms
txLost	number	是	无	上行丢包率

XYSDKNewRegisterResult

描述: 注册接口普回调
字段:

名称	类型	必填	默认值	描述
extErrorInfo	string	是	无	错误信息

XYSDKOnlySchemeMeetingInfo

描述: 会议设置仅预约会议相关
字段:

名称	类型	必填	默认值	描述
onlyScheduledCall	string	是	无	是否仅预约入会
disableUserUpdateOnlyScheduledCall	string	是	无	关闭用户设置仅预约入会

XYSDKOperateCallHistoryResult

描述: 通话记录操作回调信息
字段:

名称	类型	必填	默认值	描述
number	string	是	无	无
isDelete	boolean	是	无	无
isSuccess	boolean	是	无	无
isTop	boolean	是	无	无

XYSDKOrganizationInfo

描述: 组织信息
字段:

名称	类型	必填	默认值	描述
deptId	number	是	无	部门ID
isLoadMG	boolean	是	无	是否加载管理组
departments	XYSDKDepartmentInfo \| undefined	是	无	部门信息
groups	XYSDKAddressBookGroupInfo[]	是	无	群组信息列表
meetingRooms	XYSDKAddressBookMeetingRoomInfo[]	是	无	会议室信息列表
isHidePhone	boolean	是	无	是否隐藏电话
displayOrder	XYAddressBookDisplayOrder	是	无	显示顺序
isFilterRule	string	是	无	过滤规则
enterpriseId	string	是	无	企业ID

XYSDKOrganizationInfoResult

描述: 组织信息结果
字段:

名称	类型	必填	默认值	描述
info	string	是	无	信息
status	number	是	无	状态
data	XYSDKOrganizationInfo	是	无	组织信息数据

XYSDKPaintLineParam

描述: 白板和标注线条信息
字段:

名称	类型	必填	默认值	描述
sequece	number	是	无	线的序列号
weight	number	是	无	线的粗细
color	string	是	无	线的颜色
sourceCallUri	string	是	无	线目标发送设备calluri
targetCallUri	string	是	无	线的原始发出设备calluri
uuid	string	是	无	唯一校验码
points	XYSDKPaintPoint[]	是	无	各点合集
ended	boolean	是	无	是否是每条线的最后一条信息

XYSDKPaintPoint

描述: 白板和标注点信息
字段:

名称	类型	必填	默认值	描述
x	number	是	无	x坐标
y	number	是	无	y坐标

XYSDKPoint

描述: 点
字段:

名称	类型	必填	默认值	描述
x	number	是	无	x坐标
y	number	是	无	y坐标

XYSDKRecordInfo

描述: 录制信息
字段:

名称	类型	必填	默认值	描述
recordMode	string	是	无	录制模式

XYSDKRect

描述: 矩形区域
字段:

名称	类型	必填	默认值	描述
x	number	是	无	x坐标
y	number	是	无	y坐标
width	number	是	无	宽度
height	number	是	无	高度

XYSDKRemoteNetworkParam

描述: 远程网络参数
字段:

名称	类型	必填	默认值	描述
calluri	string	是	无	呼叫URI
networkLevel	number	是	无	网络等级

XYSDKRenameParam

描述: 重命名参数
字段:

名称	类型	必填	默认值	描述
id	string	是	无	ID
userProfileId	number	是	无	用户配置文件ID
inputName	string	是	无	输入名称
enterpriseShareCenterId	string	是	无	企业共享中心ID
shareScope	number	是	无	共享范围
favoriteVodId	number	是	无	收藏VOD ID

XYSDKResponseResult

描述: 请求响应体结构
字段:

名称	类型	必填	默认值	描述
code	number	是	无	状态码
retStr	string	是	无	返回字符串

XYSDKRestApiResult

描述: unuse
字段:

名称	类型	必填	默认值	描述
errorCode	XYSDKError	是	无	错误码
errorString	string	是	无	错误信息

XYSDKRosterElement

描述: 参会者信息
字段:

名称	类型	必填	默认值	描述
callUri	string	是	无	参会者标志, 如：123456@DESK
displayName	string	是	无	显示名称
extUserId	string	是	无	三方用户ID，同用户登录注册时提供的一样
Alias	string	是	无	别名
isAudioMute	boolean	是	无	是否关闭音频
isVideoMute	boolean	是	无	是否关闭视频

XYSDKRosterInfo

描述: 参会人员详细信息
字段:

名称	类型	必填	默认值	描述
addParticipants	XYSDKRosterElement[]	是	无	增加的参会方列表，全量时也包含全部参会方
changeParticipants	XYSDKRosterElement[]	是	无	有状态变化的参会方，增量时使用
delParticipants	string[]	是	无	删除的参会方（callUri），增量时使用
rosterType	XYSDKRosterType	是	无	参会人员类型，全量还是增量
totalEpNum	number	是	无	总参会人数

XYSDKRouteListResult

描述: 网络探测列表
字段:

名称	类型	必填	默认值	描述
siteList	XYSDKRouteSite[]	是	无	路由线路列表
currentSitePathId	string	是	无	当前选择路由线路id

XYSDKRouteSite

描述: 网络探测数据
字段:

名称	类型	必填	默认值	描述
pathList	XYSDKRouteSitePath[]	是	无	路径列表
displayName	string	是	无	路由名称
enterpriseId	string	是	无	"default"：自有线路，""：公共线路

XYSDKRouteSitePath

描述: 网络探测信息
字段:

名称	类型	必填	默认值	描述
sitePathId	string	是	无	pathId
networkType	number	是	无	1：外网 0：内网

XYSDKScheduleLiveInfo

描述: 直播信息
字段:

名称	类型	必填	默认值	描述
liveId	string	是	无	无
logoUrl	string	是	无	无
viewUrl	string	是	无	无

XYSDKScheduleMeetingInfo

描述: 日程信息
字段:

名称	类型	必填	默认值	描述
startTime	BigInt	是	无	开始时间
endTime	BigInt	是	无	结束时间
title	string	是	无	标题
conferenceNumber	string	是	无	会议号
id	string	是	无	会议id
ownerName	string	是	无	会议创建者名称
scheduleId	string	是	无	日程id
enterpriseId	string	是	无	企业id
location	string	是	无	无
owner	number	是	无	无
ownerDepartmentId	number	是	无	无
type	number	是	无	无
meetingStatus	number	是	无	无
extras	XYSDKScheduleLiveInfo	是	无	无
timeStr	string	是	无	无

XYSDKScheduleMeetingResult

描述: 日程列表
字段:

名称	类型	必填	默认值	描述
code	number	是	无	无
msg	string	是	无	无
scheduleList	XYSDKScheduleMeetingInfo[]	是	无	无

XYSDKServerConfig

描述: serverconfig接口回调信息,H5,及反向代理
字段:

名称	类型	必填	默认值	描述
confMgmtUrl	string	是	无	主持会议H5地址
confMgmtMemebersUrl	string	是	无	会控H5地址
pcScheduledMeetingUrl	string	是	无	我的会议H5地址
pcContactUrl	string	是	无	联系人H5地址
pcFolderUrl	string	是	无	文件夹H5地址
pcclientLiveEntryUrl	string	是	无	直播H5地址
pcMeetingDetailUrl	string	是	无	预约会议H5地址
clientImUrl	string	是	无	im H5地址
clientImWsUrl	string	是	无	im ws地址
callCenterUrl	string	是	无	CCC呼叫H5地址
sidebarMeetingControlUrl	string	是	无	侧边栏会控H5地址
webServerUrl	string	是	无	互动工具&聊天H5地址中的h参数
messageCenter	string	是	无	消息中心
meetingInviteUrl	string	是	无	会中邀请通讯录成员地址
appFeedbackUrl	string	是	无	应用反馈地址
pstnOutNumbers	string	是	无	PSTN外呼号码
appResourceUrl	string	是	无	企业资源
appCombinationUrl	string	是	无	企业合并
appResourcePayUrl	string	是	无	企业资源付费
createEntpIndex	string	是	无	创建企业
createEntpAuth	string	是	无	企业认证
monitorIndex	string	是	无	监控
appNoAuthorityUrl	string	是	无	未认证
nativeLivePageUrl	string	是	无	观看直播
servicePolicyUrl	string	是	无	服务协议
servicePolicyUrlEn	string	是	无	服务协议英文
childrenPrivacyPolicyUrl	string	是	无	儿童隐私协议
tpSharingInfoListUrl	string	是	无	分享信息
tpSdkDirectoryUrl	string	是	无	三方SDK
personalInfoCollectListUrl	string	是	无	个人信息采集清单
privacyPolicyUrl	string	是	无	隐私协议
privacyPolicyUrlEn	string	是	无	隐私协议英文
privacySecurityUrl	string	是	无	隐私安全H5页面
serviceLine	string	是	无	服务热线
logServer	string	是	无	Log Server 服务域名

XYSDKSessionInfo

描述: 会话信息
字段:

名称	类型	必填	默认值	描述
sessionId	number	是	无	会话id
sessionType	XYSDKAVSessionType	是	无	0 people, 1 共享
isAtxMute	boolean	是	无	关闭音频发送
isArxMute	boolean	是	无	关闭音频接收
isVtxMute	boolean	是	无	关闭视频发送
isVrxMute	boolean	是	无	关闭视频接受
endpointCount	number	是	无	参会终端数量

XYSDKShareData

描述: 共享数据
字段:

名称	类型	必填	默认值	描述
version	number	是	无	版本号
count	number	是	无	数量
startIndex	number	是	无	起始索引
data	XYSDKShareFolderList[]	是	无	共享文件夹列表

XYSDKShareFolderList

描述: 共享文件夹列表项
字段:

名称	类型	必填	默认值	描述
displayName	string	是	无	显示名称
description	string	是	无	描述
author	number	是	无	作者ID
profilePicture	string	是	无	头像
createTime	number	是	无	创建时间
id	string	是	无	ID
authorName	string	是	无	作者名称
originTime	number	是	无	原始时间
vodDuration	number	是	无	VOD时长
shareItemType	number	是	无	共享项目类型
enterpriseShareCenterId	string	是	无	企业共享中心ID
meetingRoomNumber	string	是	无	会议室号码
favoriteVodId	number	是	无	收藏VOD ID
vodMetadataId	number	是	无	VOD元数据ID
thirdFileUid	string	是	无	第三方文件UID
authorType	number	是	无	作者类型
shareScope	number	是	无	共享范围
nemoNumber	string	是	无	Nemo号码
thumbnailUrl	string	是	无	缩略图URL
thumbnail	string	是	无	缩略图
shareFolderId	string	是	无	共享文件夹ID
playCountShareFolder	number	是	无	共享文件夹播放次数
playCountShare	number	是	无	共享播放次数
downloadCountShare	number	是	无	共享下载次数
shareTranscription	number	是	无	共享转录
transcriptionId	string	是	无	转录ID
transcriptionVer	string	是	无	转录版本
dir	boolean	是	无	是否为目录

XYSDKShareFolderResult

描述: 共享文件夹结果
字段:

名称	类型	必填	默认值	描述
data	XYSDKShareData	是	无	共享数据
code	number	是	无	状态码
msg	string	是	无	消息
success	boolean	是	无	是否成功
errorCode	string	是	无	错误码
userMessage	string	是	无	用户消息

XYSDKSpeakersInfoPut

描述: 麦克风输入信息
字段:

名称	类型	必填	默认值	描述
energyAverage	number	是	无	平均能量
callUri	string	是	无	calluri
participantId	number	是	无	用户在会中id标识
endpointName	string	是	无	终端名称
endpointAlias	string	是	无	终端别名

XYSDKSSOInfo

描述: 用于定义SSO登录信息

字段:

名称	类型	必填	默认值	描述
domain	string	是	无	域名
returnUrl	string	是	无	SSO登录跳转地址
enterpriseId	string	是	无	企业id
enterpriseMail	string	是	无	企业邮箱
certificate	string	是	无	证书
hostOperationType	number	是	无	SSO登录类型 1为应用内打开其他为web打开

XYSDKStatistics

描述: 呼叫中统计信息
字段:

名称	类型	必填	默认值	描述
people	XYSDKAVSessionStatistics	是	无	与会人媒体统计信息
content	XYSDKAVSessionStatistics	是	无	共享内容媒体统计信息
network	XYSDKNetworkStatistics	是	无	网络状况统计
encrypt	string	是	无	加密方式

XYSDKSubmitSignResult

描述: 提交签到回调信息
字段:

名称	类型	必填	默认值	描述
status	string	是	无	状态信息

XYSDKSyncMuteStatus

描述: 媒体状态同步
字段:

名称	类型	必填	默认值	描述
type	number	是	无	状态类型
status	boolean	是	无	状态

XYSDKTheLatestMeetingResult

描述: 最新预约会议回调信息
字段:

名称	类型	必填	默认值	描述
title	string	是	无	会议标题
owner	string	是	无	会议所属者
conferenceNumber	string	是	无	会议号
id	string	是	无	会议id
startTime	BigInt	是	无	会议开始时间
endTime	BigInt	是	无	会议结束时间

XYSDKThirdPlatformInfo

描述: 用于定义三方公司信息

字段:

名称	类型	必填	默认值	描述
platformCode	string	是	无	平台码
platformName	string	是	无	平台名称
image	string	是	无	平台图片
url	string	是	无	平台跳转地址

XYSDKThirdPlatformsResult

描述: 获取第三方登录公司回调信息
字段:

名称	类型	必填	默认值	描述
status	string	是	无	状态码是"10200"表示成功
data	XYSDKThirdPlatformInfo	是	无	三方公司信息列表

XYSDKThirdPlayerResult

描述: 第三方播放器结果
字段:

名称	类型	必填	默认值	描述
code	number	是	无	状态码
msg	string	是	无	消息
data	string	是	无	数据

XYSDKTokenLoginParam

描述: 用于定义token登陆参数

字段:

名称	类型	必填	默认值	描述
loginPath	string	是	无	登录地址
loginToken	string	是	无	登录token
withMcuDetect	boolean	是	无	是否进行网络探测
loginType	string	是	无	登录类型

XYSDKTranlationSource

描述: 同声传译信息
字段:

名称	类型	必填	默认值	描述
type	XYSDKTranslateType	是	无	同声传译类型
meetingId	string	是	无	会议id
callUri	string	是	无	会议calluri
languages	XYSDKLanguage[]	是	无	语言列表
disableTranslatorChannel	boolean	是	无	是否将语音信息复制到原声通道一份
languageConfig	XYSDKTranslationConfig	是	无	配置信息
translator	XYSDKTranslator	是	无	翻译员信息
languagesChanged	boolean	是	无	相对上一次是否语言发生了变化
isTranslator	boolean	是	无	是否为翻译员

XYSDKTranslationConfig

描述: 同声传译配置信息
字段:

名称	类型	必填	默认值	描述
conferenceNo	string	是	无	会议号
meetingId	string	是	无	会议id
language	number	是	无	语言id
originalEnable	boolean	是	无	是否开启原音
zh_CN	string	是	无	语言名称（中文）
en_US	string	是	无	语言名称（英文）

XYSDKTranslationLanguageConfigResult

描述: 同声传译通道变化接口回调信息
字段:

名称	类型	必填	默认值	描述
languageId	number	是	无	语言通道id

XYSDKTranslator

描述: 翻译信息
字段:

名称	类型	必填	默认值	描述
from	number	是	无	翻译的原始语言id
to	number	是	无	翻译的目标语言id

XYSDKUICustomizationInfo

描述: 用户配置信息
字段:

名称	类型	必填	默认值	描述
customerExperienceNemo	number	是	无	配置188188
customerServiceNemo	number	是	无	视频客服
customerServicePhone	string	是	无	电话客服
customizedEnterpriseLogo4Desktop	string	是	无	自定义企业logo
customizedEnterpriseLogo	string	是	无	自定义企业logo
customizedEnterpriseName	string	是	无	自定义企业名称
enableChangeMail	boolean	是	无	能否修改邮箱
enableChangeName	boolean	是	无	能否修改用户名
isForbidChangeName	boolean	是	无	是否禁止修改名称
enableChangePassword	boolean	是	无	能否修改密码
enableCreateLive	boolean	是	无	能否创建直播
enableCreateMeeting	boolean	是	无	能否创建会议
enableHrRecord	boolean	是	无	能否开启高清录制
enableInfinitePageFlip	boolean	是	无	能否无限翻页
enableLive	boolean	是	无	是否显示直播
enableNettoolUdp	boolean	是	无	是否显示网络调试工具
enableShareCenter	boolean	是	无	是否显示桌面共享
enableShowDesktopSharing	boolean	是	无	是否显示桌面共享
enableWindowSizeFollowup	boolean	是	无	是否启用窗口大小跟随
enableLocalRecording	boolean	是	无	是否显示本地录制
officialSite	string	是	无	官方网站
showApChannel	boolean	是	无	是否显示AP通道
showAttendee	boolean	是	无	是否显示参会者
showCalendar	boolean	是	无	是否显示日程
showEnableSitePath	boolean	是	无	是否显示mcu路径的配置项
showFaceDetect	boolean	是	无	是否显示人脸识别
showHostMeeting	boolean	是	无	是否显示主持会议
showImageShare	boolean	是	无	是否显示图片共享
showInviteCall	boolean	是	无	是否显示邀请通话
showInviteMeeting	boolean	是	无	是否显示发起会议
showJoinMeeting	boolean	是	无	是否显示加入会议
showLive	boolean	是	无	是否显示直播
showMailbox	boolean	是	无	是否显示邮箱
showPassword	boolean	是	无	是否显示密码
showRecordInCall	boolean	是	无	是否显示云端录制
showRecording	boolean	是	无	是否显示云端录制
showScheduleMeeting	boolean	是	无	是否显示预约会议
showShareCenter	boolean	是	无	是否显示共享中心
showSharedFolder	boolean	是	无	是否显示共享文件夹
showUserName	boolean	是	无	是否显示用户名
showWhiteboard	boolean	是	无	是否显示白板
customerServiceLicense	boolean	是	无	是否显示隐私政策
blackList	XYSDKBlackList	是	无	黑名单列表
lowPerfList	XYSDKBlackList	是	无	低性能列表
virtualBgImageList	XYSDKVirtualBgImageList	是	无	虚拟背景配置
showOperateGuide	boolean	是	无	是否显示操作指南
showMarketingVideo	boolean	是	无	拓客文件夹显示

XYSDKUIDisplayChanged

描述: 企业后台推送UI项目的显示与隐藏
字段:

名称	类型	必填	默认值	描述
type	string	是	无	类型
enable	boolean	是	无	是否启用

XYSDKUnityLayoutLayoutConfig

描述: 用于定义统一layout布局配置

字段:

名称	类型	必填	默认值	描述
maxRecvNum	number	是	0	传0
updateSize	boolean	是	true	是否更新尺寸
screenInfos	XYSDKUnityLayoutScreenInfo[]	是	无	屏幕信息传一个
initLayoutModes	XYSDKUnityLayoutMode[]	是	无	模版信息, 传全部类型
pad	boolean	是	无	是否pad
audioGalleryConfig	XYSDKUnityLayoutTemplateAudioGalleryConfig	是	无	音频对称屏配置
audioSpeakerConfig	XYSDKUnityLayoutTemplateAudioSpeakerConfig	是	无	音频首页配置
audioSmallConfig	XYSDKUnityLayoutTemplateAudioSmallConfig	是	无	音频小窗口配置
videoConfig	XYSDKUnityLayoutTemplateVideoConfig	是	无	视频窗口配置

XYSDKUnityLayoutPosition

描述: 用于定义点坐标信息

字段:

名称	类型	必填	默认值	描述
x	number	是	无	x点 0 ~ 1
y	number	是	无	y点坐标
z	number	是	无	叠加层级, 暂不支持
w	number	是	无	宽度
h	number	是	无	高度

XYSDKUnityLayoutRequest

描述: 用于定义统一layout请流模版

字段:

名称	类型	必填	默认值	描述
windowId	string	是	无	window id 请传main
layoutMode	XYSDKUnityLayoutMode	是	无	布局模式, 第一页使用Speaker模式, 其他页使用Page模式, 如果锁定画面请使用Locked模式, 并传入forceUid(取值回流中uniqueId字段), 自定义请流模版请使用UiTemplate, 并传入viewData数据, 在会中不需要显示layout时, 可以使用SoftEmpty模式, 减少相关性能消耗
pageIndex	number	是	-1	0表示非对称布局，1表示对称第一屏
maxViewCountPerPage	number	是	无	每一屏最大请流数量
viewId	number	是	无	移动端为0
localContent	boolean	是	无	本地共享独立回显
onlyContent	boolean	是	无	仅共享屏幕入会
forceUid	string	是	无	force layout uid
multipleSharedCount	number	是	无	多路content支持数量, 最大4
templateId	string	是	无	自定义请流模版id
viewData	XYSDKUnityLayoutView[]	是	无	自定义请流数据

XYSDKUnityLayoutScreenInfo

描述: 用于定义统一layout窗口尺寸信息

字段:

名称	类型	必填	默认值	描述
screenId	string	是	无	屏幕id (传main)
screenWidth	number	是	无	评估宽度
screenHeigh	number	是	无	屏幕高度
maxDecoderNum	number	是	0	传0
maxViewCountPerPage	number	是	0	传0
layout	XYSDKUnityLayoutRequest	是	无	默认为speaker request

XYSDKUnityLayoutTemplateAudioGalleryConfig

描述: 用于定义统一layout音频对称屏配置

字段:

名称	类型	必填	默认值	描述
viewW	number	是	无	窗口宽 (建议108)
viewH	number	是	无	窗口高 (建议108)
lineSpace	number	是	无	窗口行间距 (建议30)
columnSpace	number	是	无	窗口列间距 (建议0)
landscapeLineSpace	number	是	无	横屏窗口行间距 (建议8)
landscapeColumnSpace	number	是	无	横屏窗口列间距 (建议60)

XYSDKUnityLayoutTemplateAudioSmallConfig

描述: 用于定义音频悬浮小窗口信息

字段:

名称	类型	必填	默认值	描述
viewW	number	是	无	窗口宽 (建议100)
viewH	number	是	无	窗口高 (建议100)
rightMargin	number	是	无	右间距 (建议10)
topMargin	number	是	无	顶部间距 (建议56)
landscapeLeftMargin	number	是	无	横屏左间距 (建议10)
landscapeBottomMargin	number	是	无	横屏底部间距 (建议10)

XYSDKUnityLayoutTemplateAudioSpeakerConfig

描述: 用于定义音频扬声器配置

字段:

名称	类型	必填	默认值	描述
asViewW	number	是	无	as 大窗口宽 (建议236)
asViewH	number	是	无	as 大窗口高 (建议184)
viewW	number	是	无	小窗口宽 (建议108)
viewH	number	是	无	小窗口高 (建议108)
viewColumnSpace_twoItem	number	是	无	两个小窗口时间距 (建议30)
viewLineSpace	number	是	无	小窗口行间距 (30)
viewColumnSpace	number	是	无	窗口列间距 (建议0)
landscapeViewLineSpace	number	是	无	横屏小窗口行间距 (建议30)
landscapeViewColumnSpace	number	是	无	横屏小窗口列间距 (建议0)
viewOppositeASOffset	number	是	无	小窗口相对as间距 (建议110)
landscapeViewOppositeASOffset	number	是	无	横屏小窗口相对as间距 (建议50)

XYSDKUnityLayoutTemplateVideoConfig

描述: 用于定义视频窗口配置

字段:

名称	类型	必填	默认值	描述
density	number	是	1	倍屏因子
viewLineSpace	number	是	无	窗口行间距 (建议2)
viewColumnSpace	number	是	无	窗口列间距(建议2)
landscapeSymmetryViewLeftMargin	number	是	无	横屏左间距 (建议0)
landscapeSymmetryViewRightMargin	number	是	无	横屏右间距 (建议0)
smallViewBottomMargin	number	是	无	小窗口底部间距 (建议5)
smallViewLeftMargin	number	是	无	小窗口左间距 (建议5)
smallViewRightMargin	number	是	无	小窗口右间距 (建议5)
smallViewColumnSpace	number	是	无	小窗口列间距 (建议5)

XYSDKUnityLayoutView

描述: 用于定义自定义请流信息

字段:

名称	类型	必填	默认值	描述
viewId	number	是	无	递增ID
margin	XYSDKUnityLayoutViewMargin	是	无	上下左右间距
landscapeMargin	XYSDKUnityLayoutViewMargin	是	无	横屏上下左右间距
position	XYSDKUnityLayoutPosition	是	无	竖屏坐标 z为0时为比例尺寸, 底层会根据窗口大小计算尺寸, 不为0时为真实尺寸需要UI自己计算
landscapePosition	XYSDKUnityLayoutPosition	是	无	横屏坐标 z为0时为比例尺寸, 底层会根据窗口大小计算尺寸, 不为0时为真实尺寸需要UI自己计算
audioOnlyPosition	XYSDKUnityLayoutPosition	是	无	语音模式竖屏坐标暂不支持自定义
audioOnlyLandscapePosition	XYSDKUnityLayoutPosition	是	无	语音模式横屏坐标暂不支持自定义
flag	XYSDKUnityLayoutFlag	是	无	布局标志
resolution	number	是	无	分辨率 0: 90p, 1:180p, 2:360p, 3:720p, 4:1080p, 5:4K
quality	number	是	无	质量 0: low, 1: normal, 2: high
callUri	string	是	无	呼叫URI

XYSDKUnityLayoutViewMargin

描述: 用于定义间距信息

字段:

名称	类型	必填	默认值	描述
left	number	是	无	左边距
top	number	是	无	上边距
right	number	是	无	右边距
bottom	number	是	无	下边距

XYSDKUpdateProfileResult

描述: 更新用户信息回调
字段:

名称	类型	必填	默认值	描述
type	XYSDKUserProfileType	是	无	用户信息更新类型
profilePicture	string	是	无	头像地址

XYSDKUpgradeCheckResult

描述: 版本信息检查回调
字段:

名称	类型	必填	默认值	描述
ss_app_name	string	是	无	app安装包名称
platform	string	是	无	平台名称
versionName	string	是	无	版本名称
releaseNote	string	是	无	版本注释
md5	string	是	无	安装包MD5
sha256	string	是	无	安装包SHA256
folder	string	是	无	安装包下载地址
versionCode	number	是	无	大版本号
devRevision	number	是	无	小版本号
minSupportVersion	number	是	无	最小支持版本

XYSDKVideoData

描述: 视频数据
字段:

名称	类型	必填	默认值	描述
isContent	boolean	是	无	是否为内容
width	number	是	无	宽度
height	number	是	无	高度
stride	number	是	无	步长
format	XYSDKVideoFormat	是	无	格式
dataPtr	Uint8Array	是	无	视频数据
timeStamp	BigInt	是	无	时间戳(毫秒)
cropX	number	是	无	裁剪起始X坐标
cropY	number	是	无	裁剪起始Y坐标
cropWidth	number	是	无	裁剪宽度
cropHeight	number	是	无	裁剪高度

XYSDKVideoDenoiserOptions

描述: 视频降噪选项
字段:

名称	类型	必填	默认值	描述
mode	XYSDKVideoDenoiserModel	是	无	降噪模式
level	number	是	无	降噪等级

XYSDKVideoFrame

描述: 视频帧信息
字段:

名称	类型	必填	默认值	描述
buffer	Uint8Array	是	无	渲染数据
bufLen	number	是	无	数据长度
width	number	是	无	视频帧宽度
height	number	是	无	视频帧高度
sarWidth	number	是	无	除去黑边高度
sarHeight	number	是	无	除去黑边宽度
rotation	number	是	无	方向
flipping	boolean	是	无	是否镜像

XYSDKVideoLowLightEnhanceOptions

描述: 视频低光增强选项
字段:

名称	类型	必填	默认值	描述
mode	XYSDKLowLightEnhanceModel	是	无	低光增强模式
level	number	是	无	增强等级

XYSDKVideoPlayerData

描述: 视频播放数据
字段:

名称	类型	必填	默认值	描述
playUrl	string	是	无	播放URL
innerPlayUrl	string	是	无	内部播放URL
m3u8Url	string	是	无	M3U8 URL
innerM3u8Url	string	是	无	内部M3U8 URL
message	string	是	无	消息
thumbnailUrl	string	是	无	缩略图URL
resolution	string	是	无	分辨率
resolutions	XYSDKVideoPlayerResolutions[]	是	无	分辨率列表

XYSDKVideoPlayerInfo

描述: 视频播放信息
字段:

名称	类型	必填	默认值	描述
data	XYSDKVideoPlayerData	是	无	视频播放数据
code	number	是	无	状态码
msg	string	是	无	消息
success	boolean	是	无	是否成功
errorCode	number	是	无	错误码
userMessage	string	是	无	用户消息

XYSDKVideoPlayerResolutions

描述: 视频播放分辨率
字段:

名称	类型	必填	默认值	描述
resolution	string	是	无	分辨率
innerUrl	string	是	无	内部URL
outerUrl	string	是	无	外部URL

XYSDKVideoPlayerResult

描述: 视频播放结果
字段:

名称	类型	必填	默认值	描述
code	number	是	无	状态码
msg	string	是	无	消息

XYSDKVideoProfile

描述: 视频配置信息
字段:

名称	类型	必填	默认值	描述
maxResPvtx	XYSDKVideoResolution	是	无	最大发送(编码)分辨率
maxResPvrx	XYSDKVideoResolution	是	无	最大接收(解码)分辨率
maxFpsPvtx	XYSDKVideoFrameRate	是	无	最大发送(编码)帧率
maxFpsPvrx	XYSDKVideoFrameRate	是	无	最大接收(解码)帧率

XYSDKVideoStatistics

描述: 视频统计信息
字段:

名称	类型	必填	默认值	描述
codecType	string	是	无	编码类型
displayName	string	是	无	显示名称
actBw	number	是	无	实际带宽
frameRate	number	是	无	帧率
resolution	string	是	无	分辨率

XYSDKVideoStreamInfo

描述: 视频流信息
字段:

名称	类型	必填	默认值	描述
muteReason	XYSDKMuteReason	是	无	关闭原因
videoState	XYSDKVideoState	是	无	视频状态
videoSourceId	string	是	无	sourece id
displayName	string	是	无	显示名称
userNumber	string	是	无	用户号
extUserId	string	是	无	三方用户ID，同用户登录注册时提供的一样
callUri	string	是	无	用户calluri
alias	string	是	无	别名
exDeviceId	string	是	无	设备id
audioMute	boolean	是	无	是否静音
isContent	boolean	是	无	是否为共享
isActiveSpeaker	boolean	是	无	是否当前正在讲话
feccOri	number	是	无	遥控摄像头能力
pid	number	是	无	参会人id
videoWidth	number	是	无	视频宽度
videoHeight	number	是	无	视频高度
oriWidth	number	是	无	原始视频宽度
oriHeight	number	是	无	原始视频高度
uniqueId	string	是	无	唯一标识, force窗口使用
flag	XYSDKUnityLayoutFlag	是	无	视频窗口标志
viewId	number	是	无	视频窗口视图id
layoutMode	XYSDKUnityLayoutMode	是	无	布局模式
windowId	string	是	无	窗口唯一id
position	XYSDKVideoStreamPosition	是	无	竖屏视频窗口坐标, 如需自定义UI页面可使用自定义模版或者自行计算布局位置
landscapePosition	XYSDKVideoStreamPosition	是	无	横屏视频窗口坐标
audioOnlyPosition	XYSDKVideoStreamPosition	是	无	语音模式竖屏坐标
audioOnlyLandscapePosition	XYSDKVideoStreamPosition	是	无	语音模式横盘坐标

XYSDKVideoStreamPosition

描述: 视频流坐标
字段:

名称	类型	必填	默认值	描述
x	number	是	无	x坐标
y	number	是	无	y坐标
z	number	是	无	z坐标
w	number	是	无	宽度
h	number	是	无	高度

XYSDKViewReqInfo

描述: 请求流模板
字段:

名称	类型	必填	默认值	描述
pageIndex	number	是	无	页码
isContent	boolean	是	无	是否为共享
reqFaceDetect	boolean	是	无	是否请求人脸检测
exDeviceID	string	是	无	设备ID
callUri	string	是	无	用户calluri
resolution	XYSDKResolution	是	无	分辨率
quality	XYSDKQuality	是	无	质量
isExtend	boolean	是	无	是否扩展

XYSDKVirtualBgImageList

描述: 虚拟背景配置
字段:

名称	类型	必填	默认值	描述
images	string[]	是	无	配置图片列表
initValue	boolean	是	无	是否为默认配置

XYSDKVodFolderData

描述: 我的文件夹，共享文件夹数量

字段:

名称	类型	必填	默认值	描述
version	number	是	无	版本
userFolderFileCount	number	是	无	用户文件夹文件数量
shareFolderFileCount	number	是	无	共享文件夹文件数量
closeToCleanVodCount	number	是	无	接近清理的VOD数量
nemosFolder	XYSDKNemoFolderData[]	是	无	Nemo文件夹数据列表

XYSDKWatermarkInfo

描述: 会中水印信息
字段:

名称	类型	必填	默认值	描述
watermark	string	是	无	水印
watermarkRange	XYSDKWatermarkRange	是	无	水印叠加范围

XYSDKWhiteBoardInfo

描述: 白板信息
字段:

名称	类型	必填	默认值	描述
ownerName	string	是	无	白板发起人名称
ownerUri	string	是	无	白板发起uri

XYSDKWSMsg

描述: ws信息
字段:

名称	类型	必填	默认值	描述
type	XYSDKWSMsgType	是	无	ws信息类型
data	string	是	无	ws信息内容

XYSensitiveWordsInfo

描述: 敏感词信息回调
字段:

名称	类型	必填	默认值	描述
sensitiveWords	string[]	是	无	敏感词列表

2025-05-20 14:48:56

导出PDF文档