描述: SDK 配置项
版本: 3.3.0
说明: 本条对应新版的 XYConfigs
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
cloudServer | XYString | 否 | "" | 云服务地址, 私有云地址非标端口需要带端口 i.e. private.cloud.com:9443, 123.123.123.123:9773 | |
openapiServer | XYString | 否 | "" | 开放平台地址 | |
openapiToken | XYString | 否 | "" | 开放平台口令 | |
logFolder | XYString | 否 | "" | 日志路径 | |
extId | XYString | 否 | "" | 企业id | |
clientId | XYString | 否 | "" | 应用clientId | |
clientSecret | XYString | 否 | "" | 应用clientSecret | |
sysType | SDKSoftSysType | 否 | - | 终端类型(会根据终端类型做性能优化) | |
enablePushVideo | bool | 否 | true | 使能SDK主动回调裸流给用户 | |
enableBulkRoster | bool | 否 | false | 暂未使用 | |
mediaDumpPath | XYString | 否 | - | dump调试文件路径 |
描述: 登录后的用户信息
版本: 3.3.0
说明: 本条对应新版的 XYAccountInfo
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
callUri | XYString | 否 | "" | 终端标志，小鱼后台给登陆账号分配的唯一呼叫号码，如：123456@DESK， 123456为小鱼系统ID，DESK为终端类型 | |
displayName | XYString | 否 | "" | 用户名称 | 备注 |
extUserId | XYString | 否 | "" | 三方用户ID，同用户登录注册时提供的一样 | |
userId | long | 否 | 0 | 小鱼系统用户ID | |
deviceId | long | 否 | 0 | 软终端无需关注 | |
XYString | 否 | "" | 邮箱 | ||
peerNumber | XYString | 否 | "" | 用于点对点呼叫号码 |
描述: 会议信息
版本: 3.3.0
说明: 本条对应新版的 XYCallInfo
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
callMode | int | 否 | - | 会议模式 | |
remoteUri | XYString | 否 | - | 远端URI | |
remoteName | XYString | 否 | - | 远端名称 | 备注 |
remoteNumber | XYString | 否 | - | 远端号码 | |
remoteAlias | XYString | 否 | - | 远端别名 | |
remoteType | XYString | 否 | - | 远端类型 |
描述: 呼叫状态信息
版本: 3.3.0
说明: 本条对应新版的 XYCallStateInfo
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
callState | SDKCallState | 否 | CallState_Disconnected | 呼叫状态 | |
sdkError | XYString | 否 | "" | SDK错误信息 | |
disconnectReason | XYString | 否 | "" | 断开原因 | |
meetingNumber | XYString | 否 | "" | 会议号码 | |
numberType | XYString | 否 | "" | 号码类型 | |
displayName | XYString | 否 | "" | 显示名称 | 备注 |
isOnhold | bool | 否 | false | 是否保持 | |
onHoldCount | uint32_t | 否 | 0 | 保持次数 | |
waitingReason | XYString | 否 | "" | 等待原因 |
描述: 呼叫中的远端的视频流信息
版本: 3.3.0
说明: 本条对应新版的 XYVideoStreamInfo
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
sourceId | XYString | 否 | - | 视频源ID | |
displayName | XYString | 否 | - | 显示名称 | 备注 |
userNumber | XYString | 否 | - | 用户号码 | |
extUserId | XYString | 否 | - | 三方用户ID，同用户登录注册时提供的一样 | |
callUri | XYString | 否 | - | 呼叫URI | |
dt | SDKEPDeviceType | 否 | - | 设备类型 | |
Alias | XYString | 否 | - | 别名 | |
videoWidth | uint32_t | 否 | - | 视频宽度 | |
videoHeight | uint32_t | 否 | - | 视频高度 | |
oriWidth | uint32_t | 否 | - | 原始宽度 | |
oriHeight | uint32_t | 否 | - | 原始高度 | |
exDeviceId | XYString | 否 | - | 扩展设备ID | |
audioMute | bool | 否 | - | 音频静音 | |
isContent | bool | 否 | - | 是否为内容共享 | |
isActiveSpeaker | bool | 否 | - | 是否为活跃发言者 | |
feccOri | uint32_t | 否 | - | 远端摄像头所具备的能力 | |
renderWnd | void* | 否 | - | 渲染窗口 | |
pid | int | 否 | - | 进程ID |
描述: 会议参会信息
版本: 3.3.0
说明: 本条对应新版的 XYConfInfo
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
actSpkUri | XYString | 否 | "" | 当前发言者 | |
chairManUrl | XYString | 否 | "" | 主会场 | |
participantCount | uint32_t | 否 | - | 参会人数 | |
contentPartCount | uint32_t | 否 | - | 内容分享数量 | |
displayableEpCount | uint32_t | 否 | - | 参会人数除去hide, onhold, contentonly |
描述: 参会方信息
版本: 3.3.0
说明: 本条对应新版的 XYRosterElement
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
callUri | XYString | 否 | - | 参会者标志, 如：123456@DESK | |
displayName | XYString | 否 | - | 显示名称 | 备注 |
extUserId | XYString | 否 | - | 三方用户ID，同用户登录注册时提供的一样 | |
Alias | XYString | 否 | - | 别名 | |
isAudioMute | bool | 否 | - | 音频是否静音 | |
isVideoMute | bool | 否 | - | 视频是否静音 |
描述: 参会人员详细信息
版本: 3.3.0
说明: 本条对应新版的 XYRosterInfo
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
addParticipants | XYArray | 否 | - | 增加的参会方列表， 全量时也包含全部参会方 | |
changeParticipants | XYArray | 否 | - | 有状态变化的参会方，增量时使用 | |
delParticipants | XYArray | 否 | - | 删除的参会方（callUri），增量时使用 | |
rosterType | SDKRosterType | 否 | - | 参会人员类型，全量还是增量 | |
totalEpNum | uint32_t | 否 | - | 总参会人数 |
描述: 视频帧信息
版本: 3.3.0
说明: 本条对应新版的 XYVideoFrame
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
width | uint32_t | 否 | 0 | 视频帧宽度 | |
height | uint32_t | 否 | 0 | 视频帧高度 | |
yStride | uint32_t | 否 | 0 | Y分量步长 | |
uStride | uint32_t | 否 | 0 | U分量步长 | |
vStride | uint32_t | 否 | 0 | V分量步长 | |
yBuffer | uint8_t* | 否 | nullptr | Y分量数据 | |
uBuffer | uint8_t* | 否 | nullptr | U分量数据 | |
vBuffer | uint8_t* | 否 | nullptr | V分量数据 | |
rotation | uint32_t | 否 | 0 | 旋转角度 | |
timestamp | uint64_t | 否 | 0 | 时间戳 |
描述: 视频配置
版本: 3.3.0
说明: 本条对应新版的 XYVideoProfile
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
maxResPvtx | SDKVideoResolution | 否 | - | 最大发送(编码)分辨率 | |
maxResPvrx | SDKVideoResolution | 否 | - | 最大接收(解码)分辨率 | |
maxFpsPvtx | SDKVideoFrameRate | 否 | - | 最大发送(编码)帧率 | |
maxFpsPvrx | SDKVideoFrameRate | 否 | - | 最大接收(解码)帧率 |
描述: 视图请求信息
版本: 3.3.0
说明: 本条对应新版的 XYViewReqInfo
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
isContent | bool | 否 | - | 是否为内容共享 | |
callUri | XYString | 否 | "" | 如果不指定， SDK将按照内部机制自动填充 | |
reqFaceDetect | bool | 否 | false | set if request face location | |
exDeviceID | XYString | 否 | "" | 扩展设备ID | |
resolution | SDKVideoResolution | 否 | - | 请流分辨率 | |
quality | SDKVideoQuality | 否 | - | 清流质量 |
描述: 自定义布局请求
版本: 3.3.0
说明: 本条对应新版的 XYLayoutReq
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
pageIndex | int | 否 | 0 | 0表示非对称布局，1表示对称第一屏 | |
maxViewCountPerPage | int | 否 | - | 每一屏最大清流数量 | |
uiShowLocalWhenPageMode | bool | 否 | true | 页面模式时是否显示本地视频 | |
reqList | XYArray | 否 | - | 清流列表 |
描述: 矩形区域
版本: 3.3.0
说明: 本条对应新版的 XYRect
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
x | float | 否 | - | 左上角x坐标 | |
y | float | 否 | - | 左上角y坐标 | |
width | float | 否 | - | 宽度 | |
height | float | 否 | - | 高度 |
描述: 显示器信息
版本: 3.3.0
说明: 本条对应新版的 XYMonitorInfo
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
monitorName | XYString | 否 | - | 显示器名称 | 备注 |
minitorRect | SDKRect | 否 | - | 显示器矩形区域 |
描述: 网络统计信息
版本: 3.3.0
说明: 本条对应新版的 XYNetworkStatistics
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
rtt | int | 否 | - | 往返时间 ms | |
rxDetectBw | int | 否 | - | 下行带宽 kbps | |
rxJitter | int | 否 | - | 下行抖动 ms | |
rxLost | int | 否 | - | 下行丢包率 | |
txDetectBw | int | 否 | - | 上行带宽 kbps | |
txJitter | int | 否 | - | 上行抖动 ms | |
txLost | int | 否 | - | 上行丢包率 |
描述: 视频统计信息
版本: 3.3.0
说明: 本条对应新版的 XYVideoStatistics
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
codecType | XYString | 否 | - | 编码类型 | |
displayName | XYString | 否 | - | 显示名称 | 备注 |
actBw | int | 否 | - | 实际带宽 | |
frameRate | int | 否 | - | 帧率 | |
resolution | XYString | 否 | - | 分辨率 |
描述: 音频统计信息
版本: 3.3.0
说明: 本条对应新版的 XYAudioStatistics
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
codecType | XYString | 否 | - | 编码类型 | |
displayName | XYString | 否 | - | 显示名称 | 备注 |
actBw | int | 否 | - | 实际带宽 |
描述: 音视频会话统计信息
版本: 3.3.0
说明: 本条对应新版的 XYAVSessionStatistics
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
audioRxInfo | XYArray | 否 | - | 下行音频统计数据 | |
audioTxInfo | XYArray | 否 | - | 上行音频统计数据 | |
videoRxInfo | XYArray | 否 | - | 下行视频统计数据 | |
videoTxInfo | XYArray | 否 | - | 上行视频统计数据 |
描述: 呼叫中统计信息
版本: 3.3.0
说明: 本条对应新版的 XYStatistics
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
people | SDKAVSessionStatistics | 否 | - | 与会人媒体统计信息 | |
content | SDKAVSessionStatistics | 否 | - | 共享内容媒体统计信息 | |
network | SDKNetworkStatistics | 否 | - | 网络状况统计 | |
encrypt | XYString | 否 | - | 加密信息 |
描述: 详细统计信息
版本: 3.3.0
说明: 本条对应新版的 XYDetailStatistics
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
staDBA | XYString | 否 | - | 下行音频统计 | |
staETC | XYString | 否 | - | 编码类型统计 | |
staARX | XYString | 否 | - | 下行音频接收统计 | |
staATX | XYString | 否 | - | 上行音频发送统计 | |
staVTX | XYString | 否 | - | 上行视频发送统计 | |
staVRX | XYString | 否 | - | 下行视频接收统计 | |
staRoster | XYString | 否 | - | 参会人员统计 | |
staCARX | XYString | 否 | - | 下行内容音频接收统计 | |
staCATX | XYString | 否 | - | 上行内容音频发送统计 | |
staCVTX | XYString | 否 | - | 上行内容视频发送统计 | |
staCVRX | XYString | 否 | - | 下行内容视频接收统计 |
描述: 媒体设备信息
版本: 3.3.0
说明: 本条对应新版的 XYMediaDevInfo
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
devId | XYString | 否 | - | 设备ID | |
devName | XYString | 否 | - | 设备名称 | 备注 |
isSelected | bool | 否 | - | 是否被选中 | |
isDefault | bool | 否 | - | 是否为默认设备 |
描述: 会议管理信息
版本: 3.3.0
说明: 本条对应新版的 XYConfMgmtInfo
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
chirmanUri | XYString | 否 | - | 主席URI | |
confMgmtUrl | XYString | 否 | - | 会议管理URL | |
muteSpk | XYString | 否 | - | on(mute speaker) | off(unmute speaker) |
muteMic | XYString | 否 | - | mute | unmute |
rename | XYString | 否 | - | 当前终端被会控改名(本次会议中有效) | |
disableMute | bool | 否 | - | 是否禁用静音 | |
disableRecord | bool | 否 | - | true: 录制不可用 -> (比如会议室无录制权限, 或者别人已经在录制中了) | |
disableContent | bool | 否 | - | 暂未使用 | |
disableWhiteboard | bool | 否 | - | 是否禁用白板 |
描述: 远端音频能量信息
版本: 3.3.0
说明: 本条对应新版的 XYAudioMeterInfo
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
callUri | XYString | 否 | - | 参会者标记(123456@DESK) | |
energy | int | 否 | - | 声音能量(0-100) | |
pid | uint32_t | 否 | - | 进程ID |
描述: 服务器配置
版本: 3.3.0
说明: 本条对应新版的 XYServerConfig
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
confMgmtUrl | XYString | 否 | - | 会议管理URL | |
pstnOutNumbers | XYString | 否 | - | PSTN外呼号码 | |
pcScheduledMeetingUrl | XYString | 否 | - | PC端预约会议URL | |
serviceLine | XYString | 否 | - | 服务热线 | |
pcContactUrl | XYString | 否 | - | PC端联系人URL | |
pcFolderUrl | XYString | 否 | - | PC端文件夹URL |
描述: REST API结果
版本: 3.3.0
说明: 本条对应新版的 XYRestApiResult
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
code | XYString | 否 | - | 返回码 | |
body | XYString | 否 | - | 返回内容 |
描述: 会议字幕
版本: 3.3.0
说明: 本条对应新版的 XYConfCaption
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
action | XYString | 否 | - | 动作 | |
content | XYString | 否 | - | 内容 | |
location | XYString | 否 | - | 位置 | |
scroll | bool | 否 | - | 是否滚动 | |
fontSize | XYString | 否 | - | 字体大小 | |
backgroundAlpha | XYString | 否 | - | 背景透明度 | |
backgroundRGB | XYString | 否 | - | 背景RGB值 | |
fontRGB | XYString | 否 | - | 字体RGB值 | |
scrollSpeed | XYString | 否 | - | 滚动速度 | |
fontFamily | XYString | 否 | - | 字体系列 |
描述: 进出会议信息
版本: 3.3.0
说明: 本条对应新版的 XYInOutInfo
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
displayName | XYString | 否 | - | 显示名称 | 备注 |
action | XYString | 否 | - | 动作 in or out | |
extUserId | XYString | 否 | - | 三方用户ID |
描述: 代理网络地址
版本: 3.3.0
说明: 本条对应新版的 XYNetProxy
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
hostAddress | XYString | 否 | "" | 主机地址 | |
port | int | 否 | 0 | 端口号 | |
username | XYString | 否 | "" | 用户名，仅用于SOCKS5认证 | |
password | XYString | 否 | "" | 密码，仅用于SOCKS5认证 |
描述: 录制业务信息
版本: 3.3.0
说明: 本条对应新版的 XYLocalRecordBusinessInfo
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
title | XYString | 否 | - | 标题 | |
speaker | XYString | 否 | - | 发言者 | |
confNum | XYString | 否 | - | 会议号码 |
描述: 视频源
版本: 3.3.0
说明: 本条对应新版的 XYLocalRecordVideoSource
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
sourceId | XYString | 否 | - | 对于本地，sourceId表示设备ID，如果为空字符串表示内置摄像头。channelId表示场景ID。对于远端，sourceId表示远端URI，channelId无用 | |
channelId | int | 否 | - | 通道ID |
描述: 视频源信息
版本: 3.3.0
说明: 本条对应新版的 XYLocalRecordVideoSourceInfo
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
sourceId | XYString | 否 | - | 继承自SDKVideoSource | |
channelId | int | 否 | - | 继承自SDKVideoSource | |
bLocalVideoSource | bool | 否 | - | 是否为本地视频源 | |
bContent | bool | 否 | - | 是否为内容共享 |
描述: 录制布局元素
版本: 3.3.0
说明: 本条对应新版的 XYLocalRecordLayoutElement
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
sourceInfo | SDKVideoSourceInfo | 否 | - | 视频源信息 | |
displayName | XYString | 否 | "" | 显示名称 | 备注 |
isVideoReceived | bool | 否 | - | 是否接收到视频 | |
isAudioMute | bool | 否 | - | 音频是否静音 | |
left | float | 否 | - | 左边距，均为在canvas中的比例 | |
top | float | 否 | - | 上边距，均为在canvas中的比例 | |
width | float | 否 | - | 宽度，均为在canvas中的比例 | |
height | float | 否 | - | 高度，均为在canvas中的比例 |
描述: 录制布局
版本: 3.3.0
说明: 本条对应新版的 XYLocalRecording（该结构体在新版本中暂无链接）
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
canvasAspectWidth | int | 否 | - | 整个画布的比例长宽。16:9, 4:3等 | |
canvasAspectHeight | int | 否 | - | 整个画布的比例长宽。16:9, 4:3等 | |
elements | XYArray | 否 | - | 布局元素列表 |
描述: 录制文件路径
版本: 3.3.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
localStorePath | XYString | 是 | - | 本地存储路径 | |
mobileStorePath | XYString | 否 | "" | 移动端存储路径 |
描述: 本地录制
版本: 3.3.0
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
id | int | 否 | - | 数据库记录ID | |
fileSize | uint64_t | 否 | - | 文件大小 | |
sequenceId | int | 否 | - | 序列ID | |
needUpload | int | 否 | - | 是否需要上传 | |
isLastFile | int | 否 | - | 是否为最后一个文件 | |
eventId | XYString | 否 | - | 事件ID，classId或meetingId | |
title | XYString | 否 | - | 标题 | |
speaker | XYString | 否 | - | 发言者 | |
confNumber | XYString | 否 | - | 会议号码 | |
recordingId | XYString | 否 | - | 录制ID | |
recordingFiles | XYString | 否 | - | 录制文件 | |
timeStamp | long long | 否 | - | 时间戳 |
描述: 人脸位置
版本: 3.3.0
说明: 本条对应新版的 XYFacePosition
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
faceId | int32_t | 否 | - | 人脸ID | |
left | uint16_t | 否 | - | 左边界 | |
top | uint16_t | 否 | - | 上边界 | |
right | uint16_t | 否 | - | 右边界 | |
bottom | uint16_t | 否 | - | 下边界 |
描述: AI参数
版本: 3.3.0
说明: 本条对应新版的 XYFace
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
isLocal | bool | 否 | - | 是否为本地 | |
calluri | XYString | 否 | - | 呼叫URI | |
participantId | uint32_t | 否 | - | 参与者ID | |
type | uint8_t | 否 | - | 类型 | |
seq | uint8_t | 否 | - | 序列号 | |
positionArr | XYArray | 否 | - | 位置数组 |
描述: HTTP请求
版本: 3.3.0
说明: 本条对应新版的 XYHttpRequest（在新版本中无对应链接）
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
what | int | 否 | -1 | 请求标识 | |
method | SDKHttpMethod | 否 | - | HTTP方法 | |
requestUrl | XYString | 否 | "" | 请求URL | |
requestBody | XYString | 否 | "" | 请求体 |
描述: HTTP响应
版本: 3.3.0
说明: 此结构体在新版本中已移除
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
what | int | 否 | - | 响应标识 | |
response | XYString | 否 | - | 响应内容 |
描述: 扩展连接参数
版本: 3.3.0
说明: 本条对应新版的 XYExConnParam
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
connType | SDKExConnectionType | 否 | - | 连接类型 | |
moduleType | SDKExModuleType | 否 | - | 模块类型 | |
serverIP | XYString | 否 | - | 服务器IP | |
serverPort | uint16_t | 否 | - | 服务器端口 | |
maxDataLength | size_t | 否 | - | 最大数据长度 | |
readInterval | uint32_t | 否 | - | 读取间隔 | |
name | XYString | 否 | - | 名称 | 备注 |
keepAliveInterval | uint32_t | 否 | - | 保活间隔 | |
keepAliveTimeout | uint32_t | 否 | - | 保活超时 |
描述: 扩展认证连接参数
版本: 3.3.0
说明: 本条对应新版的 XYExAuthedConnParam
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
connType | SDKExConnectionType | 否 | - | 继承自SDKExConnParam | |
moduleType | SDKExModuleType | 否 | - | 继承自SDKExConnParam | |
serverIP | XYString | 否 | - | 继承自SDKExConnParam | |
serverPort | uint16_t | 否 | - | 继承自SDKExConnParam | |
maxDataLength | size_t | 否 | - | 继承自SDKExConnParam | |
readInterval | uint32_t | 否 | - | 继承自SDKExConnParam | |
name | XYString | 否 | - | 继承自SDKExConnParam | |
keepAliveInterval | uint32_t | 否 | - | 继承自SDKExConnParam | |
keepAliveTimeout | uint32_t | 否 | - | 继承自SDKExConnParam | |
deviceID | XYString | 否 | - | 设备ID | |
localIP | XYString | 否 | - | 本地IP | |
authTimeout | uint32_t | 否 | - | 认证超时 |
描述: 扩展主控参数
版本: 3.3.0
说明: 本条对应新版的 XYExMasterParam
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
connType | SDKExConnectionType | 否 | - | 继承自SDKExAuthedConnParam | |
moduleType | SDKExModuleType | 否 | - | 继承自SDKExAuthedConnParam | |
serverIP | XYString | 否 | - | 继承自SDKExAuthedConnParam | |
serverPort | uint16_t | 否 | - | 继承自SDKExAuthedConnParam | |
maxDataLength | size_t | 否 | - | 继承自SDKExAuthedConnParam | |
readInterval | uint32_t | 否 | - | 继承自SDKExAuthedConnParam | |
name | XYString | 否 | - | 继承自SDKExAuthedConnParam | |
keepAliveInterval | uint32_t | 否 | - | 继承自SDKExAuthedConnParam | |
keepAliveTimeout | uint32_t | 否 | - | 继承自SDKExAuthedConnParam | |
deviceID | XYString | 否 | - | 继承自SDKExAuthedConnParam | |
localIP | XYString | 否 | - | 继承自SDKExAuthedConnParam | |
authTimeout | uint32_t | 否 | - | 继承自SDKExAuthedConnParam | |
serial | XYString | 否 | - | 序列号 |
描述: 扩展视频能力
版本: 3.3.0
说明: 本条对应新版的 XYExVideoCap
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
instanceLimit | unsigned int | 否 | 0 | 实例限制 | |
expendMap | float[ResolutionIndex_Count] | 否 | 0 | 扩展映射数组 |
描述: 扩展场景编码器能力
版本: 3.3.0
说明: 本条对应新版的 XYExSceneEncoderCap
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
instanceLimit | unsigned int | 否 | 0 | 继承自SDKExVideoCap | |
expendMap | float[ResolutionIndex_Count] | 否 | 0 | 继承自SDKExVideoCap | |
sceneId | SDKExCameraSceneID | 否 | CameraSceneID_Invalid | 场景ID | |
codecType | SDKExDevicePTCap | 否 | ExDevicePT_H264 | 编解码类型 | |
maxFrameRate | float | 否 | 30.0 | 最大帧率 |
描述: 扩展编码器能力
版本: 3.3.0
说明: 本条对应新版的 XYExEncoderCap
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
sceneNum | int | 否 | 0 | 场景数量 | |
sceneEncCaps | SDKExSceneEncoderCap[MAX_SCENE_COUNT_PER_CAMERA] | 否 | - | 场景编码能力数组 |
描述: 扩展麦克风通道
版本: 3.3.0
说明: 本条对应新版的 XYExMicChannel
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
channelID | uint32_t | 否 | 0 | 通道ID |
描述: 扩展麦克风能力
版本: 3.3.0
说明: 本条对应新版的 XYExMicCap
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
channelNums | int | 否 | 0 | 通道数量 | |
channelArr | SDKExMicChannel[MAX_CHANNEL_COUNT_PER_MICROPHONE] | 否 | - | 通道数组 |
描述: 扩展设备信息
版本: 3.3.0
说明: 本条对应新版的 XYExDeviceInfo
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
isLocal | bool | 否 | false | 是否为本地设备 | |
deviceID | std::string | 否 | "" | 设备ID | |
name | std::string | 否 | "" | 设备名称 | 备注 |
ip | std::string | 否 | "" | IP地址 | |
type | SDKExDeviceType | 否 | DeviceType_Unknown | 设备类型 | |
capType | SDKExCapType | 否 | CapType_Undefined | 能力类型 | |
version | std::string | 否 | "" | 版本 | |
model | std::string | 否 | "" | 型号 | |
productId | std::string | 否 | "" | 产品ID | |
hwVersion | std::string | 否 | "" | 硬件版本 | |
connType | SDKExConnectionType | 否 | ConnectionType_UnDefined | 连接类型 |
描述: 扩展能力信息
版本: 3.3.0
说明: 本条对应新版的 XYExCapInfo
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
encCap | SDKExEncoderCap | 否 | - | 编码能力 | |
decCap | SDKExVideoCap | 否 | - | 解码能力 | |
micCap | SDKExMicCap | 否 | - | 麦克风能力 | |
extraExpend | float | 否 | 0.0 | 额外扩展 |
描述: 扩展能力设备信息
版本: 3.3.0
说明: 本条对应新版的 XYExCapDeviceInfo
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
isLocal | bool | 否 | false | 继承自SDKExDeviceInfo | |
deviceID | std::string | 否 | "" | 继承自SDKExDeviceInfo | |
name | std::string | 否 | "" | 继承自SDKExDeviceInfo | |
ip | std::string | 否 | "" | 继承自SDKExDeviceInfo | |
type | SDKExDeviceType | 否 | DeviceType_Unknown | 继承自SDKExDeviceInfo | |
capType | SDKExCapType | 否 | CapType_Undefined | 继承自SDKExDeviceInfo | |
version | std::string | 否 | "" | 继承自SDKExDeviceInfo | |
model | std::string | 否 | "" | 继承自SDKExDeviceInfo | |
productId | std::string | 否 | "" | 继承自SDKExDeviceInfo | |
hwVersion | std::string | 否 | "" | 继承自SDKExDeviceInfo | |
connType | SDKExConnectionType | 否 | ConnectionType_UnDefined | 继承自SDKExDeviceInfo | |
encCap | SDKExEncoderCap | 否 | - | 继承自SDKExCapInfo | |
decCap | SDKExVideoCap | 否 | - | 继承自SDKExCapInfo | |
micCap | SDKExMicCap | 否 | - | 继承自SDKExCapInfo | |
extraExpend | float | 否 | 0.0 | 继承自SDKExCapInfo |
描述: 会议主持人
版本: 3.3.0
说明: 本条对应新版的 XYConferenceHost（在新版本中无对应链接）
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
meetingId | XYString | 否 | - | 会议ID | |
isHost | bool | 否 | - | 是否为主持人 | |
isOwner | bool | 否 | - | 是否为所有者 |
描述: 互动工具文案
版本: 3.3.0
说明: 本条对应新版的 XYInteractiveCopywriting（在新版本中无对应链接）
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
notifyContent | XYString | 否 | "" | 左边提示卡片文案 | |
notifyLabel | XYString | 否 | "" | 左边提示卡片标签 | |
dialogTitle | XYString | 否 | "" | 弹窗文案标题 | |
dialogContent | XYString | 否 | "" | 弹窗文案内容 | |
dialogSubContent | XYString | 否 | "" | 弹窗文案子内容 | |
dialogLabel | XYString | 否 | "" | 弹窗文案标签 |
描述: 互动工具信息
版本: 3.3.0
说明: 本条对应新版的 XYInteractiveToolInfo
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
eventType | SDKInteractiveToolEventType | 否 | - | 互动工具事件 | |
processType | SDKInteractiveToolProcessType | 否 | - | 互动工具类型 | |
endAuto | bool | 否 | false | 是否自动结束 | |
duration | int | 否 | 0 | 时长 | |
endUtcTime | long long | 否 | 0 | 结束时间 | |
webViewUrl | XYString | 否 | - | webViewUrl | |
questionnaireId | XYString | 否 | - | 问卷ID | |
meetingId | XYString | 否 | - | 会议ID | |
business | XYString | 否 | - | 业务类型 | |
copywriting | SDKInteractiveCopywriting | 否 | - | 参考文案 |
描述: 提交签到结果
版本: 3.3.0
说明: 本条对应新版的 XYSubmitSignResult
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
code | int | 否 | - | 返回码 | |
status | XYString | 否 | - | 状态 |
描述: 区域
版本: 3.3.0
说明: 本条对应新版的 XYRegion
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
x | int | 否 | 0 | 区域左上角点的X坐标 | |
y | int | 否 | 0 | 区域左上角点的Y坐标 | |
width | int | 否 | 0 | 区域宽度 | |
height | int | 否 | 0 | 区域高度 |
描述: 内容信息，用于startContentCapture函数作为参数
版本: 3.3.0
说明: 本条对应新版的 XYContentInfo
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
viewId | int64_t | 否 | 0 | 不使用 | |
withAudio | bool | 否 | false | 内容音频 | |
region | SDKRegion | 否 | - | 用于区域共享，全屏共享不需要这个 |
描述: AI字幕信息
版本: 3.3.0
说明: 本条对应新版的 XYAICaptionInfo
字段:
名称 | 类型 | 必填 | 默认值 | 描述 | 备注 |
src | XYString | 否 | - | 源语言 | |
target | XYString | 否 | - | 目标语言 | |
isEnd | bool | 否 | - | 是否结束 | |
isActive | bool | 否 | - | 是否激活 | |
srcLang | XYString | 否 | - | 源语言 | |
targetLang | XYString | 否 | - | 目标语言 | |
dn | XYString | 否 | - | 显示名称 | 备注 |
seTime | uint64_t | 否 | - | 开始时间 | |
endTime | uint64_t | 否 | - | 结束时间 | |
startTime | uint64_t | 否 | - | 开始时间 | |
url | XYString | 否 | - | URL | |
meetingId | XYString | 否 | - | 会议ID | |
pid | uint32_t | 否 | - | 进程ID |