类型定义

小鱼易连Web SDK包含详细的TypeScript类型定义，以便开发者能够在您的TypeScript项目中轻松使用；

导入类型

通过主模块导入TypeScript相关的Class、Interface、Enum、Type等类型定义，举例如下：

import { XYRTCClient, VideoAudioTrack,  IClientConfig, DEVICE_KIND, ... } from '@xylink/xy-rtc-sdk';

提示

兼容项中，标记“-”或空值，则代表所有版本都支持此功能

Class

类	描述
XYRTCClient	客户端`XYRTCClient`模块，包含所有核心对外的方法类，详细接口和事件参见：XYRTCClient
VideoAudioTrack	VideoAudioTrack轨道模块，包含所有摄像头、麦克风、设备相关轨道的方法类，详细接口和事件见：VideoAudioTrack
ContentTrack	ContentTrack轨道模块，包含所有共享内容轨道的方法类，详细接口和事件见：ContentTrack
Logger	Logger模块，包含所有日志方法类，详细接口见：Logger

Enum

Web SDK所有的枚举类型定义如下：

AutoMute

会议室麦克风状态

Key	值	描述
SMART	0	智能静音
ALL	1	全部静音
NOT	2	不静音
FORCE	3	强制静音

AutoState

自动轮询多画面状态

Key	值	描述
NORMAL	NORMAL	画面正常
NO_JOINED	NO_JOINED	未入会
VIDEO_MUTE	VIDEO_MUTE	视频暂停
NOT_FOUND	NOT_FOUND	未符合条件的终端
NULL	NULL	画面为空

ChairManReason

主画面来源

Key	值	描述
NONE	''	默认：主会场模式
MAIN_VENUE	mainVenue	主会场模式
FOCUS_MODE	focusMode	焦点模式

CoChair

是否是联席主持人

Key	值	描述
NONE	none	默认值
ON	on	是联席主持人
OFF	off	不是联席主持人

ConferenceMode

会议模式

Key	值	描述
DIALOG	dialog	对话模式
NORMAL	normal	非对话模式

EnableRename

是否有改名权限

Key	值	描述
ON	on	是
OFF	off	否

EVENT_TYPE

签到/投票业务状态

Key	值	描述
VOTE_SIGNATURE_START	VOTE_SIGNATURE_START	开始签到
VOTE_SIGNATURE_STOP	VOTE_SIGNATURE_STOP	签到结束

Host

是否是主持人

Key	值	描述
NONE	none	默认值
ON	on	是主持人
OFF	off	不是主持人

LayoutAvatarType

Layout头像类型

Key	值	描述
NONE	-1	无头像
TEXT	0	名称头像
IMAGE	1	人物头像

LayoutOrientationType

移动端布局方向

Key	值	描述
NONE	-1	默认布局(PC)
MOBILE_HORIZONTAL	0	移动端横屏布局
MOBILE_VERTICAL	1	移动端竖屏布局

MEETING_DIRECTION

会议上行和下行方向

Key	值	描述
DOWNLINK	DOWNLINK	PEOPLE+CONTENT下行方向
UPLINK	UPLINK	PEOPLE+CONTENT上行方向
ALL	ALL	上行+下行方向
PEOPLE_DOWNLINK	PEOPLE_DOWNLINK	PEOPLE下行方向
PEOPLE_UPLINK	PEOPLE_UPLINK	PEOPLE上行方向
CONTENT_DOWNLINK	CONTENT_DOWNLINK	CONTENT下行方向
CONTENT_UPLINK	CONTENT_UPLINK	CONTENT上行方向

NetworkQualityLevel

网络质量信号等级

Key	值	描述
Bad	1	非常差，视频大概率卡顿模糊，建议用户更新网络环境
Poor	2	差，视频可能卡顿模糊，建议用户更新网络环境
Good	3	一般，视频质量一般
Excellent	4	很好，通话质量正常

OperateType

视频/音频操作状态

Key	值	描述
MUTE_AUDIO	muteAudio	关闭麦克风
UNMUTE_AUDIO	unmuteAudio	开启麦克风
MUTE_VIDEO	muteVideo	关闭摄像头
UNMUTE_VIDEO	unmuteVideo	开启摄像头

PROCESS_TYPE

互动工具业务类型：签到答题投票评价

Key	值	描述
CHECK_IN	CHECK_IN	签到

RecordingState

录制状态

Key	值	描述
RECORD_STATE_IDLE	RECORD_STATE_IDLE	停止录制成功
RECORD_STATE_STARTING	RECORD_STATE_STARTING	开启录制
RECORD_STATE_STARTED	RECORD_STATE_STARTED	开启录制成功
RECORD_STATE_STOPING	RECORD_STATE_STOPING	停止录制

StreamFrameRate

帧率枚举列表

Key	值	描述
FR30	30	30帧率
FR15	15	15帧率
FR8	8	8帧率

StreamResolution

分辨率枚举列表

Key	值	描述
RS90	90	160*90
RS180	180	320*180
RS360	360	640*360
RS720	720	1280*720
RS1080	1080	1920*1080

StreamResolutionLevel

分辨率等级枚举列表

Key	值	描述
LEVEL90	0	160*90
LEVEL180	1	320*180
LEVEL360	2	640*360
LEVEL720	3	1280*720
LEVEL720	4	1920*1080

StreamType

自定义流类型

Key	值	描述
CONTENT	CONTENT	共享内容流
PREVIEW	PREVIEW	本地预览流
PIPELINE	PIPELINE	建立通道流
REMOTE	REMOTE	推送远端画面流

VideoQuality

视频质量等级

Key	值	描述
LOW	0	低画面质量，帧率会自动降低到15帧接收
NORMAL	1	普通画面质量，会基于带宽信息自动在30/15帧切换
HIGH	2	高画面质量，会优先匹配高帧率高分辨率画面

VOTE_TYPE

签到业务类型

Key	值	描述
SIGN_IN	2	签到

WatermarkRange

水印范围

Key	值	描述
CONTENT	"0"	共享内容叠加水印
ALL	"1"	视频和共享内容叠加水印

XYClientEventKey

SDK客户端事件Key枚举

Key	值	描述	兼容
CANCEL_HANDUP	cancel-handup	清除举手事件	-
FOCUS_VIEW	focus-view	焦点画面事件	v4.0.0+
INTERACTIVE_TOOL_INFO	interactiveToolInfo	会控互动工具相关数据, 签到事件	-
MEETING_CONTROL	meeting-control	会控事件，包含麦克风静音/非静音、是否强制静音、主会场设备、对话模式等状态和信息	-
MEETING_CONTROL_VIDEO	meeting-control-video	会控上报开启/关闭摄像头事件	-
NOTIFICATION	notification	会控联席主持人/主持人/改名权限变更事件	-
ONHOLD	onhold	会控启用/关闭等候室事件	-
SUB_TITLE	sub-title	点名/滚动字幕事件	-
CALL_STATUS	call-status	会议呼叫状态事件	-
CONFERENCE_INFO	conference-info	云会议室信息	-
DISCONNECTED	disconnected	强制挂断会议消息，收到此消息时，需要进行退出会议操作	-
ENTERPRISE_CONFIG	enterprise-config	企业配置信息(头像配置、禁用语音转写英文翻译)	-
LAYOUT_STATE	layout-state	轮询状态事件	-
MEDIA_CHANGED_MIGRATE	media-changed-migrate	媒体迁会事件	-
USER_INFO	user-info	登录用户信息和个人云会议室信息数据	-
CONF_CHANGE_INFO	conf-change-info	会议人员数量/共享内容/主会场等发生变化事件	-
CONTENT	content	当前正在共享内容的参会者信息	-
CONTAINER_RESIZE	container-resize	自动布局-布局容器尺寸变化事件	-
FORCE_FULL_SCREEN	force-full-screen	自动布局-参会人员强制全屏显示事件	-
LAYOUT	layout	参会成员布局列表数据，包含参会者基本信息、位置、尺寸、旋转等数据（自定义布局不包含位置、尺寸、旋转数据）	-
PAGE_INFO	page-info	自动布局-分页数据	-
ROTATION_CHANGE	rotation-change	参会者视频画面旋转信息	-
SCREEN_INFO	screen-info	自动布局-布局容器尺寸和位置信息	-
TEMPLATE_MODE	template-mode	自动布局-当前布局模式	-
AUDIO_TR	audio-track	音频轨道Tracks数据	-
BULK_ROSTER	bulkRoster	订阅Roster事件（参会者数据）	-
IN_OUT_REMINDER	in-out-reminder	参会者出入会事件	-
NETWORK_LEVEL	networkLevel	本地端网络质量等级	-
NETWORK_PARAMETER	networkParameter	远端参会者网络等级	-
PARTICIPANTS_COUNT	participants-count	会议总人数事件	-
ROSTER	roster	参会者列表事件（仅上报前20路，包含本地数据）	-
SPEAKER_INFO	speaker-info	语音激励人员信息	-
SPEAKERS_INFO	speakers-info	实时讲话人信息（最多3三路数据）	-
TRANSLATION_CONTENT	translation-content	通话字幕内容	-
VIDEO_TRACK	video-track	视频轨道事件	-
AUDIO_STATUS	audio-status	本地麦克风状态事件	-
VIDEO_STATUS	video-status	本地摄像头状态事件	-
MULTI_GROUP_INFO	multi-group-info	多分组通道信息事件	-
START_MONITOR_REPORT	start-monitor-report	调度成功事件	-
RECORDING_STATE_CHANGED	recording-state-changed	本地录制结果上报事件	-
RECORD_STATUS_NOTIFICATION	record-status-notification	上报远端录制状态	-
RECORD_PERMISSION	record-permission	录制权限事件	-
CUSTOM_MESSAGE_RECV	custom-message-recv	接收自定义消息事件	-
ERROR	error	错误事件	-
MEETING_STATS	meeting-stats	会议质量数据，包含接收/发送方的分辨率、带宽、码率、帧率、丢包等调试数据	-
PLAY_FAILED	play-failed	播放音视频失败事件	-

XYLayoutState

Layout布局画面状态

Key	值	描述
MUTE	MUTE	视频暂停
REQUEST	REQUEST	视频请求中
NORMAL	NORMAL	视频正常
AUDIO_TEL	AUDIO_TEL	电话入会
AUDIO_ONLY	AUDIO_ONLY	仅音频入会模式
AUDIO_CONTENT	AUDIO_CONTENT	仅音频共享
ANSWER_PHONE	ANSWER_PHONE	接听电话中

XYDisplaySurface

分享内容时默认选择的分享Tab类型

Key	值	描述
BROWSER	browser	浏览器标签
MONITOR	monitor	屏幕
WINDOW	window	应用

XYDisplaySwitch

分享功能开关控制

Key	值	描述
EXCLUDE	exclude	排除功能
INCLUDE	include	包含功能

DEVICE_KIND

设备类型

Key	值	描述
AUDIOINPUT	audioInput	麦克风设备
AUDIOOUTPUT	audioOutput	扬声器设备
VIDEOINPUT	videoInput	摄像头设备

PermissionType

采集权限状态

Key	值	描述
GRANTED	granted	已授权
DENIED	denied	已拒绝
PROMPT	prompt	询问中
UNKNOWN	unknown	未知
FAILED	failed	失败

PushType

推流类型

Key	值	描述
CONTENT	CONTENT	创建发送共享内容管道
PIPE	PIPE	创建推送管道
VIDEO	VIDEO	创建发送视频管道
AUDIO	AUDIO	创建发送音频管道
VIDEO_AUDIO	VIDEO_AUDIO	创建音频/视频发送管道
VIDEO_AUDIO_PIPE	VIDEO_AUDIO_PIPE	创建音频/视频/仅接收内容管道

Type

IClientLayout

画面布局模式

值	描述
AUTO	自动布局，按照宫格/演讲者布局模式返回画面数据
CUSTOM	自定义布局，上报基础数据，业务自行处理参会者请流，位置和尺寸计算

IFacingMode

摄像头方向

值	描述
FRONT	前置摄像头
BACK	后置摄像头

IFeatureConfigKey

SDK功能控制开关的key

值	描述
keyof IFeatureConfig	详细见所有IFeatureConfig的key值

IMCVideoEvent

会控开启/关闭摄像头消息、Toast提示消息

值	描述
XYControlVideoQuery	会控推送开启/关闭摄像头消息体
XYUnMuteVideoQueryToast	主持会议端收到远端开启摄像头结果的提示消息体

IMode

布局模式类型

值	描述
SPEAKER	演讲者模式，即 1大N小画面模式
GALLERY	画廊模式，即宫格布局
MULTI_PIC_CONTENT_HIGH_PRIORITY	缩略视图, Content是大窗口
MULTI_PIC_ACTIVE_HIGH_PRIORITY	缩略共享, ActiveSpeaker是大窗口
TWO_PIC_PIP	共享视图, 画中画模式(picture in picture)
CONTENT_ONLY	共享全视图, 只显示Content
TWO_PIC_SYMMETRIC	共享+演讲, 对称显示content和speaker(side by side)

IMuteSpeaker

是否禁止收听

值	描述
keep	保持上次的状态
on	禁止收听
off	取消禁止收听

IVideoAudioType

视频/音频状态

值	描述
muteAudio	关闭麦克风
muteVideo	关闭摄像头
unmuteAudio	开启麦克风
unmuteVideo	开启摄像头

TCommand

媒体轮询多画面状态

值	描述
0	开始
1	停止
2	暂停
3	恢复

TLocale

国际化语言

值	描述
en_US	英文
zh_CN	中文简体
zh_TW	中文繁体

TLocalLanguage

通话字幕-本地支持的语言

值	描述
English	英文
Chinese	中文

TLogLevel

日志等级

值	描述
INFO	所有的日志信息
DEBUG	调试信息
WARNING	警告信息
ERROR	错误信息
NONE	禁用输出日志信息

XYDeviceType

设备类型

值	描述
webrtc	WebRTC终端
soft	软件APP终端
hard	硬件终端
nemo	小鱼终端
tvbox	大型硬件终端
h323	H323终端
record	虚拟录制终端
bruce	大鱼终端
tel	手机终端
pstngw	PSTN终端
desk	桌面应用终端

Interface

AnalyserConfig

分析器配置

属性	类型	描述
fftSize	number	可选，执行快速傅里叶变换 (FFT) 以获得频域数据时使用的样本窗口大小，可选值：32/64/125/256/512/1024/2048
cardinalNumber	number	可选，转换0-128的基数，默认是1:1，配置128，如果将声量转为1:2效果，则配置为64，依此类推
prefix	string	分析器前缀

ContentTrackConfig

创建Content Track配置参数

属性	类型	描述	兼容
screenAudio	boolean	可选，是否启用共享时采集系统声音，默认是false，不采集	-
displaySurface	XYDisplaySurface	可选，分享内容的类型，选择：browser(浏览器标签)、monitor(屏幕)、window(应用)，默认是monitor屏幕兼容：Chrome/Edge: v107+	v4.0.0+
preferCurrentTab	boolean	可选，是否强制仅共享当前应用选项卡源，默认是false，不强制兼容：Chrome/Edge: v107+	v4.0.0+
monitorTypeSurfaces	XYDisplaySwitch	可选，共享屏幕时，选择是否排除“屏幕”源，默认是include，不排除，设置为exclude代表排除屏幕选项兼容：Chrome/Edge: v94+	v4.0.0+
selfBrowserSurface	XYDisplaySwitch	可选，共享屏幕时，选择是否排除当前应用选项卡，默认是include，不排除，设置为exclude代表排除当前应用选项卡兼容：Chrome/Edge: v119+	v4.0.0+
surfaceSwitching	XYDisplaySwitch	可选，共享屏幕时，选择是否允许浏览器标签之间提供控制器进行动态切换，默认是include，允许切换，设置为exclude代表不允许切换兼容：Chrome/Edge: v112+	v4.0.0+
systemAudio	XYDisplaySwitch	可选，共享屏幕时，是否允许开启采集系统源声音，默认是include，允许切换，设置为exclude代表不允许切换兼容：Chrome/Edge: v107+	v4.0.0+
controller	CaptureController	可选，共享屏幕时，指定CaptureController对象实例，可用于进一步操作捕获会话的行为，例如动态设置聚焦窗口行为兼容：Chrome/Edge: v105+	v4.0.0+
handleConfig	XYCaptureHandleConfig	可选，共享屏幕时，设置共享屏幕处理器配置兼容：Chrome/Edge:v109+	v4.0.0+

CopyWriting

互动工具业务涉及到弹窗和状态栏内容

属性	类型	描述
notifyContent	string	左上角状态栏文案
notifyLabel	string	左上角状态栏按钮内容比如签到按钮
dialogTitle	string	弹窗标题
dialogContent	string	弹窗主要内容黑体字部分
dialogSubContent	string	弹窗描述
dialogLabel	string	弹窗右下角按钮文案

ExternalTemplateConfig

模版额外配置

属性	类型	描述
id	string	templateId (模版名称_画面数量_第几个画面)
isPIP	boolean	是否在画中画
isRotate	boolean	是否要适配旋转
zIndex	number	层级
customStyle	Record<string, string \| number>	自定义样式
isMain	boolean	是否是大画面

IBulkRoster

参会者信息

属性	类型	描述
bulkRosterType	0 \| 1	全量roster类型，0表示全量数据，1表示增量数据
addRosterInfo	IRoster[]	增的roster信息当bulkRosterType是0的时候，此参数表示全量数据
changeRosterInfo	IRoster[]	变化的roster信息
deleteRosterInfo	{ participantId: number }[]	被删除的roster信息

IClientConfig

初始化XYClient配置参数

属性	类型	描述
clientId	string	必填，网关校验id
clientSecret	string	必填，网关密钥
extId	string	必填，企业ID
server	string	可选，服务器地址, IP/域名+端口（可选），如: cloudapi.xylink.com:443
layout	IClientLayout	可选，布局模式，默认值是：AUTO
container	XYClientContainer	可选，配置布局容器节点和偏移量
isSupportHybridCloud	boolean	可选，标识是否是混合云环境，默认值是false，代表不是混合云环境
debug	boolean	可选，是否接收所有参会者音视频状态数据，默认值是false，代表关闭调试模式
checkSSL	boolean	可选，是否需要检测SSL，默认值是true，代表启用检测SSL协议
plugin	any[]	可选，注册AI视频流插件，支持管道流方式多次接入
isThird	boolean	可选，忽略参数，默认是true

ICheckSystemRequirements

浏览器是否支持WebRTC能力检测结果

属性	类型	描述
result	boolean	是否支持WebRTC能力
detail	XYCheckSystemRequirementsDetail	浏览器能力详情

ICloudRoomConfig

个人云会议室信息

属性	类型	描述
meetingControlPassword	string	会控密码
meetingNumber	string	个人云会议室号码
password	string	入会密码
isMeetingOwner	boolean	是否是会议室Owner

IConfAuxProperties

会议室配置信息

属性	类型	描述
watermarkContent	string	叠加水印内容
watermarkRange	WatermarkRange	水印范围，共享、全局

IConference

获取的随机云会议室信息

属性	类型	描述
callUrl	string	云会议室callUri
conferenceNumberType	number	云会议室类型
deviceId	string	设备ID
displayName	string	云会议室名称
number	string	云会议室号

IConferenceConfig

会议室配置

属性	类型	描述
displayConfNo	boolean	是否显示会议号
subtitle	string	是否显示字幕 'true' \| 'false'

IConferenceInfo

会议号信息

属性	类型	描述
callNumber	string	最终进入的真实会议号
callUrl	string	呼叫号码真实url
deviceId	string	号码id
deviceType	string	号码类型
displayName	string	云会议号名称
number	string	呼叫的号码
numberType	string	会议号类型
confAuxProperties	IConfAuxProperties	会议配置
avatar	string	头像
inviteInfo	InviteInfo	会议分享信息，包含会议邀请链接、电话，WebRTC、终端等端的入会方式
meetingId	string	当前会议ID
config	IConferenceConfig	会议室配置
displayConfig	string	可见性配置
mpvc	string	点对点呼叫会议号
meetingControl	XYMeetingControl	会控信息

IConfMgmtUrl

会控地址

属性	类型	描述
pc	string	会控桌面端URL
member	string	参会者列表URL
side	string	侧边栏会控URL
mobile	string	会控APP端URL
professional	string	专业会控URL

IConfInfo

会议变动消息

属性	类型	描述
participantCount	number	当前会议参会者总人数，不包含共享内容设备数量,包含local
totalEpCount	number	当前会议参会者总人数，包含共享内容、指挥调度客户端等设备数量, 包含local
chairManUrl	string	当前主画面设备的callUrl，没有为''
contentUri	string	当前会议共享内容设别的callUrl，没有为''
actSpkUri	string	当前会议语音激励者的callUrl，没有为''
mediaGroupInfo	IMediaGroupInfo[]	多分组通人数信息，默认上报0和1分组，分别代表People通道和Content通道
onHoldCount	number	主画面对应的模式，默认是主会场模式
audioTxUnMuteEpCount	number	等候室人数
videoTxUnMuteEpCount	number	未静音人数
chairManReason	ChairManReason	未关闭摄像头人数

ICurrentPermission

当前麦克风/摄像头权限

属性	类型	描述
microphone	PermissionType	麦克风权限
camera	PermissionType	摄像头权限

ICustomMessageConfig

用户自定义消息

属性	类型	描述
toPid	number	消息的接收方pid，0表示广播消息、非0表示单点消息；
data	string	消息内容，可以被JSON序列化的字符串；因业务数据可能会传输图片，需要进行base64编码，消息最大长度限制：1MB

ICustomStreamTrack

自定义Track轨道对象

属性	类型	描述
status	string	Track的类型，local或者remote
data	RTCTrackEvent \| ICustomMediaStream	MediaStreamTrack数据
rest	{ streamId: string; trackId: string; track:MediaStreamTrack; }	从data中获取streamId、trackId和track数据，方便后续使用

IDeviceManagerChangeValue

设备变化后的最新列表数据和需要切换设备数据

属性	类型	描述
nextDevice	ISelectedDevice	自动切换的设备数据
detail	IDeviceList	最新设备列表数据，包含麦克风、扬声器、摄像头

IDeviceList

设备列表：麦克风、扬声器、摄像头

属性	类型	描述
audioInputList	IDeviceInfo[]	麦克风列表
audioOutputList	IDeviceInfo[]	扬声器列表
videoInputList	IDeviceInfo[]	摄像头列表

IDeviceInfo

设备信息

属性	类型	描述
isSelected	boolean	是否选中此设备
isDefault	boolean	是否是默认设备
key	string	设备唯一ID
deviceId	string	设备ID，切换设备时，需要使用此值
label	string	设备名称
groupId	string	设备分组
kind	DEVICE_KIND	设备类型

IEnterpriseConfig

企业配置信息

属性	类型	描述
userAvatarMode	LayoutAvatarType	头像配置 0：名称头像(默认), 1: 人物头像
disableTranscriptionEng	boolean	禁用语音转写英文翻译，默认false

IExportUserInfo

用户和对应个人云会议室信息数据

属性	类型	描述
cloudRoomInfo	ICloudRoomConfig	个人云会议室信息默认只保存了部分信息
extends ILoginInfo	ILoginInfo	SDK登录用户信息

IFailUriItem

调度uri列表项目

属性	类型	描述
uri	string	设备calluri
status	string	状态
message	string	消息

IFeatureConfig

SDK功能控制开关，是否启用某些功能的运行

属性	类型	描述
enableMeetingShout	boolean	是否启用会控喊话场景，会控喊话场景需要指定mediaGroupId分组通道信息才可以正常接收远端声音
enableV2States	boolean	是否启用小鱼数据上报功能，默认启用，设置为true
enableCheckRecordPermission	boolean	是否启用录制权限查询功能，默认不启用，设置为false
enableBandwidthSetting	boolean	是否启用管理平台带宽控制（双向）,是否可以请1080P的视频流，默认不启用，设置为false
enableMeetingInvite	boolean	是否启用查询小鱼会议邀请链接信息，默认不启用，设置为false
enableMeetingOwner	boolean	是否启用查询会议Owner信息，默认不启用，设置为false
enableAutoResizeLayout	boolean	是否启用自动布局下，当屏幕大小变化后计算最新的Layout数据，默认启用，设置为true
enableLowResolution	boolean	是否启用低性能模式，降低发送和接收端的分辨率和质量，默认不启用，设置为false
enableSpeakerInfo	boolean	是否启用推送实时讲话人信息，每秒2条消息推送，默认不启用，设置为false
enableLayoutAvatar	boolean	是否启用获取参会者头像，默认不启用，设置为false
enableMobileNotAuth	boolean	移动端是否支持无授权入会，默认设置为false
enableWatermarkContent	boolean	是否启用获取content水印内容，默认启用, 设置为true
enableHideLocalView	boolean	是否启用隐藏本地画面模式，默认不启用，设置为false

IGetConferenceParams

随机会议室参数

属性	类型	描述
id	string	userProfileId，默认是0
sk	string	SK，默认是空字符串
token	IToken	Token，默认是空字符串
autoMute	AutoMute	是否静音，0:智能静音 1:全部静音 2:不静音 3:强制静音

IGroupInfo

分组会议信息

属性	类型	描述
groupLeader	boolean	是否设置本终端为管理员 true:设置， false:取消
groupName	string	此名称显示至用户界面
groupType	number	是否进入讨论组 1:进入，0：退出

IInternals

质量统计数据

属性	类型	描述
bytesReceived	number	接收的字节总数
bytesReceivedSecond	number	每秒接收字节数
bytesSent	number	发送的字节总数
bytesSentSecond	number	每秒发送字节数
jitterSent	number	发送的抖动(ms)
jitterReceived	number	接受的抖动(ms)
audioSendJitter	number	音频发送抖动
roundTripTime	number	往返延时 (ms)
fractionLostSent	number	视频发送的丢包率
fractionLostReceived	number	视频接受的丢包率
mimeType	string	视频Codec类型
audioMimeType	string	音频Codec类型
timestamp	number	时间戳
receiver	{ [prop: string]: IReceiver; }	所有接收视频的列表数据
sender	{ [prop: string]: ISender; }	所有发送视频的列表数据
audioReceiver	{ [prop: string]: IReceiver; }	所有接收音频的列表数据
audioSender	{ [prop: string]: ISender; }	所有发送音频的列表数据
audioSendLost	number	音频发送的丢包率
audioRecvLost	number	音频接受的丢包率

ILayout

参会者布局详细数据

属性	类型	描述
id	string	Layout ID，布局唯一ID
roster	IRoster	参会者基本信息、状态信息，例如：用户名、麦克风/摄像头状态、是否是主会场等信息
state	XYLayoutState	当前参会者的画面状态信息
rotate	IRotateStyle \| null	当前参会者的旋转信息，用于设置video标签样式
rotationInfo	IRotationInfoTotalItem \| null	当前参会者的旋转信息
avatar	LayoutAvatar \| null	头像, 如未在setFeatureConfig配置相关参数，则返回null
positionStyle	XYPositionStyle	Layout成员布局位置样式
isMirror	boolean	是否是镜像画面
templateConfig	ExternalTemplateConfig	模版额外配置
position	number[]	位置坐标，分别是左，上，宽，高
positionInfo	XYPositionInfo	Layout成员布局位置分别是：宽、高
index	number	索引值
pollingState	AutoState	轮询多画面状态
pollingName	string	多画面名称
resolution	number	忽略, 2.0.2以前的版本自定义布局roster请流使用
quality	number	忽略, 2.0.2以前的版本自定义布局roster请流使用

ILoggerConfig

日志模块配置

属性	类型	描述
dbName	string	必填，数据库名称，默认值是XYRTC_LOG
tableName	string	必填，表名称，默认值是LOG
dbVersion	number	可选，数据库版本，默认值是1
tableCount	number	可选，表的数量，默认值是1
tableIndex	number	可选，当前表的索引，默认值是1
maxSize	number	可选，当前数据表最大存储长度，默认值是80000（8万条数据)
schema	string	可选，表字段，默认值是'++id,t,c'
detectTimer	number	可选，多久检测一次表的最大长度，单位ms，默认值是300000（5分钟）
deleteDBNames	string[]	可选，需要删除的历史数据库名，默认值是[]
isUpdateVersion	boolean	可选，是否需要更新表版本（历史表都将被删除，避免错误）
enableClearTable	boolean	可选，是否清理表, 默认值是true，代表重新初始化时清空当前数据表
scope	string	可选，配置日志Scope范围，例如配置为'APP'，则所有日志显示为：[16:14:24 490][INFO][APP]xxxx
clearOffset	number	可选，自动清理表数据的偏移值，正序排序，默认值是1000，即从1000位开始，1000+limit长度的数据进行自动清理操作
clearLimit	number	可选，自动清理表数据的数量限制，从offset开始，offset + limit长度为结束，默认值是11000

ILoginExtAccount

第三方登录用户信息/授权码登录信息

属性	类型	描述
displayName	string	必填，用户名称
extId	string	必填，企业id
extUserId	string	可选，三方用户ID
authCode	string	可选，授权码
tempUser	boolean	可选，是否是临时账号，默认是false，不是临时用户

ILoginInfo

SDK登录用户信息

属性	类型	描述
callUri	string	用户类型ID
securityKey	string	安全码
token	IToken	Token
id	number	用户ID
displayName	string	登录用户名
cellPhone	string	呼叫号码
extUserId	string	第三方用户ID
enterpriseId	string	企业ID

ILoginWidthAuthCode

三方账号统一认证登录-授权码登录信息

属性	类型	描述
extId	string	必填，企业id
extUserId	string	必填，用户id
displayName	string	必填，用户名
oauthCode	string	必填，授权码
channelId	string	必填，渠道id
isTempUser	boolean	可选，是否是临时账号，默认是false，不是临时用户

IMackCall

加入会议配置参数

属性	类型	描述
confNumber	string	必填，云会议号/终端号/手机号
password	string	可选，入会密码，没有则为空
displayName	string	可选，入会昵称，默认使用登录账号的用户名
muteAudio	boolean	可选，是否开启/关闭麦克风入会，默认值是false，开启麦克风
muteVideo	boolean	可选，是否开启/关闭摄像头入会，默认值是false，开启摄像头
__hideId	number \| string	可选，是否是隐身入会模式，默认值是空值，代表正常非隐身模式，需要开通权限后才能使用隐身模式
__monitorMode	string	可选，是否是巡课模式，默认值是空字符，MONITOR代表巡课模式

IMediaGroupInfo

多分组通道数据

属性	类型	描述
endpointCount	number	多分组通道人数
mediagroupid	number	多分组通道ID

IMeetingControl

会控回调信息

属性	类型	描述
callIndex	number	会议消息索引值
callerUri	string	呼叫者calluri
chairmanUri	string	主会场calluri
contentIsDisabled	boolean	是否禁用分享content
disableMute	boolean	是否强制静音
muteOperation	string	音频状态
commonJson	string	会控修改名称等
isMuteSpeaker	IMuteSpeaker	禁止收听
recordIsDisabled	boolean	录制权限
groupInfoList	IGroupInfo[]	分组会议信息
conferenceMode	ConferenceMode	会议模式
customizedLayout	string	轮询多画面控制Json字符串

IMonitorReport

调度成功和失败的设备列表数据

属性	类型	描述
uriList	IFailUriItem[]	调度成功的设备列表
failUriList	IFailUriItem[]	调度失败的设备列表

InteractiveToolInfo

会控互动工具相关数据, 签到等

属性	类型	描述
type	EVENT_TYPE	业务状态
voteType	VOTE_TYPE	业务类型，签到：2
questionnaireId	string	业务id
endAuto	false	是否自动结束（有倒计时），还是手动结束
duration	number	期限，比如签到剩余时间
endUtcTime	number	结束时间
meetingId	string	会议ID
processType	PROCESS_TYPE	互动工具业务类型：签到答题投票评价
displayResult	true	默认是true，无需关心
faceCheckInSupport	false	默认是false，无需关心
faceType	number	无需关心
supportFace	false	默认是false，无需关心
supportScan	true	默认是false，无需关心
url	string	签到url
urlProp	string	无需关心
webViewUrl	string	H5页面URL
webViewUrlProp	string	无需关心
copywriting	Copywriting	弹窗内容、左侧顶部状态栏内容

IPageInfo

自动布局，分页数据

属性	类型	描述
pageSize	number	每页显示多少人，最多可配置9画面
currentPage	number	当前页码
totalPage	number	总页数

INetworkParameter

远端网络质量信号等级

属性	类型	描述
fromCallUri	string	提供质量的callUri
fromPid	number	提供质量的pid
networkLevel	NetworkQualityLevel	提供质量的pid
toCallUri	string	发送给远端的CallUri

IReceiveCustomMessage

接收到自定义消息

属性	类型	描述
type	string	消息Type，0表示广播消息、非0表示单点消息
fromPid	number	消息的发送方pid
toPid	number	消息的接收方pid
data	string	消息内容，可以被JSON序列化的字符串

IReceiver

接收器 Receiver 统计数据

属性	类型	描述
bytesReceived	number	接收总量
bytesReceivedSecond	number	每秒接收数据，俗称码率
frameHeight	number	解码帧的height
frameWidth	number	解码帧的width
framesDecoded	number	frame编码量
framesDecodedSecond	number	每秒frame编码量
framesReceived	number	frame接收量
framesReceivedSecond	number	每秒frame接收量
isContent	boolean	是否是分享content
isSupport	boolean	忽略
jitterBufferDelay	number	音频样本或视频帧从接收到退出抖动缓冲区所花费的时间总和，以秒为单位
keyFramesDecoded	number	代表关键帧的总数
nackCount	number	计算此接收器发送的否定确认（NACK）数据包的总数
name	string	与会者昵称
packetsReceived	number	此传输上收到的数据包总数
packetsReceivedSecond	number	此传输上每秒收到的数据包数量
packetsLost	number	此传输上丢失的数据包总数
packetsLostSecond	number	此传输上每秒丢失的数据包数量
pliCount	number	接收器发送的图片丢失指示（PLI）数据包的总数
timestamp	number	时间戳
type	string	与会者Type
expResolution	number	当前通道期望流分辨率
status	string	状态
framesPerSecond	number	此接收器解码的帧的 QP 值的总和
framesDropped	number	丢弃的帧数，由于网络问题、解码器缓冲区溢出或其他原因而丢弃的帧的数量
ssrc	string	同步源 (ssrc)
jitter	number	视频接收抖动
endpointId	string	参会者的callUri
participantId	number	participantId
mimeType	string	编码器类型
audioLevel	number	音频音量大小
insertedSamplesForDeceleration	number	减速的插入样本数，用于音频流，同步音频流和视频流（或其他参考时间），插入的音频样本的数量。插入样本会导致播放速度减慢
insertedSamplesForDecelerationSecond	number	每秒用于减速的插入样本数
totalSamplesReceived	number	接收到的总样本数，开始到现在接收到的音频样本的总数量，用于评估接收数据的总体规模
totalSamplesReceivedSecond	number	每秒接收到的样本总数
removedSamplesForAcceleration	number	加速的移除样本数，同步音频流和视频流（或其他参考时间），移除的音频样本的数量。移除样本会导致播放速度加快
removedSamplesForAccelerationSecond	number	每秒用于加速的移除样本数
ExpectWidth	number	当前通道期望宽度
ExpectHeight	number	当前通道期望高度

IRecordInfo

录制相关信息

属性	类型	描述
recordSessionId	string	sessionId

IRecordingStateChanged

本地录制结果上报

属性	类型	描述
reason	string	成功STATE:200
state	RecordingState	录制状态
recordInfo	IRecordInfo	录制相关信息
isRecorded	boolean	忽略
controlUri	string	忽略
reasonText	string	忽略

IRecordPermission

录制权限

属性	类型	描述
authorize	boolean	权限
recordingUrl	string	云会议室URI
developerMessage	string	云会议室的所属用户名称
errorCode	number	错误码
userMessage	string	错误信息

IRecordStatusNotification

远端录制状态上报

属性	类型	描述
isStart	boolean	是否已经存在录制 true:存在录制；false:不存在录制
uri	string	录制的displayName,即callUri的名称，当是" "时，取会议室名称
callUri	string	录制终端callUri
callerUri	string	ignore
status	string	录制状态 RECORDING_STATE_PAUSED(录制暂停),RECORDING_STATE_ACTING(录制恢复)
isLocal	boolean	是否是local开启的录制
recordInfo	IRecordInfo	录制相关信息

IReminder

对外出入会通知消息

属性	类型	描述
displayName	string	参会者名称
action	'in' \| 'out'	参会者动作，可选：'in' \| 'out'，in代表加入会议，out代表离开会议
userId	string	参会者userId

IReturnResult

结果体内容

属性	类型	描述
code	string	错误码，详细见：错误码
msg	string	错误码描述
detail	any	数据内容

IReqInfo

配置画面数据

属性	类型	描述
calluri	string	可选，默认给""值，设备URI字段，如果未指定则按照优先级自动填充画面
resolution	StreamResolutionLevel	必填，指定画面分辨率
quality	VideoQuality	必填，指定视频质量，建议people画面使用0或者1，content画面使用2
mediagroupid	0 ｜ 1	必填，可选：0｜1，指定设备的类型，0代表people画面，1代表content共享画面

IRoster

参会者的基本信息，包含基本信息，设备信息，画面信息等

属性	类型	描述
key	string	内部Key，包含参会者endpointId、多分组通道信息，由一定规则生成；
deviceType	XYDeviceType	设备类型
endpointId	string	设备ID
displayName	string	参会者名称
mediagroupid	number	参会者画面类型，0：people画面，1：共享内容画面
participantId	number	参会者人员临时ID，迁会之后此ID会发生变化
audioTxMute	boolean	参会者麦克风状态，true：开启，false：关闭
videoTxMute	boolean	参会者摄像头状态，true：开启，false：关闭
isForceFullScreen	boolean	参会者是否是主画面
isFocusScreen	boolean	参会者是否是焦点画面
videoMuteReason	number	视频关闭原因
isContent	boolean	参会者画面类型，同mediagroupid，true：是共享内容画面，false：people画面
isActiveSpeaker	boolean	参会者是否是语音激励，即当前会中说话声音最大的一个人
isLocal	boolean	是否是Local设备
audioRxMute	boolean	ignore
videoRxMute	boolean	ignore
onHold	boolean	ignore
isLastAdd	boolean	ignore
isPolling	boolean	ignore

IRotationInfoTotalItem

缓存content+people的屏幕旋转信息数据

属性	类型	描述
mediagroupid	number	画面类型：people/content
id	string	用户id
height	number	高度
width	number	宽度
participantId	number	用户pid
rotation	number	旋转角度，0 \| 1 不需要旋转，2 顺时针旋转180度，3 顺时针旋转270度

IRotateStyle

Video元素旋转样式

属性	类型	描述
transform?	string	Video元素选转角度：rotateZ(${n}deg)
width?	string	Video元素选转角度：rotateZ(${n}deg)
height?	string	Video元素的高：${n}px

IScreenInfo

自动布局模式下，Layout布局容器信息

属性	类型	描述
width	number	减掉偏移左右值的Container容器宽
height	number	减掉偏移上下值的Container容器高
rateWidth	number	基于width配合 Layout Rate 计算得到的Layout Container容器宽
rateHeight	number	基于height配合 Layout Rate 计算得到的Layout Container容器高

ISelectedDevice

当前已选择设备信息

属性	类型	描述
audioInput	IDeviceInfo \| null	麦克风列表设备
videoInput	IDeviceInfo \| null	摄像头列表设备
audioOutput	IDeviceInfo \| null	扬声器列表设备

ISender

发送器 Sender 统计数据

属性	类型	描述
bytesSent	number	此RTCIceTransport上发送的有效负载字节总数
bytesSentSecond	number	每秒发送有效负载字节数
frameHeight	number	编码帧的高度
frameWidth	number	编码帧的宽度
framesEncoded	number	此RTP媒体流成功编码的帧总数
framesEncodedSecond	number	每秒成功编码的帧数
framesSent	number	此RTP流上发送的帧总数
framesSentSecond	number	每秒发送的帧数
hugeFramesSent	number	此RTP流发送的huge帧的总数
status	string	忽略
keyFramesEncoded	number	此RTP媒体流编码的关键帧总数
packetsSent	number	此传输发送的数据包总数
packetsSentSecond	number	此传输每秒发送的数据包数
timestamp	number	时间戳
type	StreamType	发送器类型
expBandwidth	number	期望带宽
resolution	StreamResolution	分辨率
pliCount	number	计算此发送方收到的图片丢失指示 (PLI) 数据包的总数
firCount	number	接收方已向发送方发送的完整帧内请求 (FIR) 数据包的数量
nackCount	number	计算此发送方收到的否定确认 (NACK) 数据包的总数
ssrc	string	SSRC
mimeType	string	编码器类型
audioLevel	number	音量大小
packetsLost	number	丢包总数
packetsLostSecond	number	丢包率
isContent	boolean	是否是分享content
jitter	number	抖动
roundTripTime	number	往返延时

ISpeakerInfo

语音激励消息

属性	类型	描述
endpointId	string	语音激励者的callUrl信息，类似："xxx@BRUCE"
pid	number	语音激励者的用户id

ISubTitleContent

会控字幕消息内容，包含内容、字体、背景等

属性	类型	描述
content	string	字幕内容
i18nKey	string	字幕内容国际化语言key
fontFamily	string	字体
fontRGB	string	字体色
scroll	"1" \| "0"	是否滚动，"1"代表滚动字幕，"0"代表固定字幕
action	"push" \| "cancel" \| string	动作，"push"代表显示字幕；"cancel"代表取消字幕
location	'top' \| 'middle' \| 'bottom'	位置'top' \| 'middle' \| 'bottom'，分别代表上、中、下位置
fontSize	'small' \| 'middle' \| 'big'	位置'small' \| 'middle' \| 'big'，分别代表小、中、大号字体
backgroundAlpha	string	背景色
scrollSpeed	string	滚动速度
backgroundRGB	string	背景色

IToken

网关Token信息

属性	类型	描述
access_token	string	Token信息
signSecret	string	当前签名
refresh_token	string	可选，刷新Token信息
domain	string	可选，域名
expires_in	number	可选，失效时间
openid	string	可选，OpenID
scope	string	可选，范围
token_type	string	可选，Token类型

ITranslationContent

通话字幕内容

属性	类型	描述
pid	number	当前说话的终端
src	string	原文
target	string	译文
seTime	number	发送时间
startTime	number	开始时间
endTime	number	结束时间
isEnd	boolean	一句话是否结束
isActive	boolean	活跃标志,收三路，同时只有一路active
url	string	终端CallURI
dn	string	显示名称
meetingId	string	会议号
srcLang	string	原语言，zh表示中文，en表示英文
targetLang	string	译文语言，zh表示中文，en表示英文

IVideoControlResult

上报会控控制开启/关闭摄像头结果

属性	类型	描述
agree	boolean	是否同意开启/关闭摄像头
reason	string	操作解释 no.camera.permission：终端未授权App摄像头权限 reject.unmute.video：参会人拒绝开启摄像头 voice.mode：终端在语音模式 driving.mode：终端在驾驶模式 ''：同意为空即可
requestId	string	终端收到的muteVideoQuery/unMuteVideoQuery消息中的requestId

IVideoProfile

视频配置

属性	类型	描述
maxResolution	StreamResolution	视频最大分辨率
maxFrameRate	StreamFrameRate	视频最大帧率

InviteInfo

会议邀请信息

属性	类型	描述
displayName	string	会议室名称
inEnterprise	boolean	所属会议号是否在企业中
inviteAppUrl	string	微信邀请链接
inviteUrl	string	云会议室邀请链接
invokSchema	string	小鱼客户端Scheme获取地址
linkNumber	string	电话入会号码
mobileWebrtcVisibleSetting	boolean	移动端是否显示WebRTC入会
number	string	会议号
password	string	入会密码
pstnNumber	string	电话呼叫号码
shareUrl	string	邀请链接详情页地址
userAvatar	string	管理员头像
userName	string	管理员名称
userProfileId	string	用户ID
voiceNumber	string	电话呼叫时的会议号
webrtcSetting	boolean	PC端是否显示WebRTC入会
webrtcUrl	string	WebRTC入会地址

LayoutAvatar

参会者头像

属性	类型	描述
type	LayoutAvatarType	头像类型，名称头像、人物头像
value	string	内容

LayoutConfig

布局相关配置

属性	类型	描述
isForceSharedLayout	boolean	可选，本地共享布局是否强制宫格布局
localSharedMaxViewCount	number	可选，本地共享时显示的最大画面数量

LayoutState

Layout状态，当前仅支持上报轮询多画面状态

属性	类型	描述
isPolling	boolean	是否增在轮询中，true代表正在轮询中，false代表结束/暂停轮询状态

LocalViewParams

本地视频渲染参数

属性	类型	描述
isMirror	boolean	是否镜像显示

LoginTokenInfo

无登录模式，配置已登录的用户和网关信息

属性	类型	描述
clientId	string	网关校验id
clientSecret	string	网关密钥
extends IToken	IToken	网关Token信息

LoginXYAccountParams

三方用户统一认证登录 - 小鱼账号登录参数

属性	类型	描述
account	string	必填，用户账号
password	string	必填，用户密码
countryCode	string	可选，国家码：默认+86
extId	string	必填，企业ID

LoginExtTokenParams

三方用户统一认证登录 - Token登录

属性	类型	描述
authCode	string	必填，登录码
extId	string	可选，企业ID

XYUnMuteVideoQueryToast

主持会议端收到远端开启摄像头结果的提示消息体

属性	类型	描述
key	XYVideoQueryType	消息key，值为：toast
value	XYUnMuteVideoQueryToastValue	消息详细内容

XYnMuteVideoQueryToastValue

主持端得到远端开启摄像头结果的提示消息体

属性	类型	描述
message	string	消息体，需要解析，详细内容如下： no.camera.permission: 终端未授权App摄像头权限 reject.unmute.video: 参会人拒绝开启摄像头 voice.mode: 终端在语音模式 driving.mode: 终端在驾驶模式 unmute.video.timeout: 超时
di	string	终端的deviceUri
dn	string	终端的名称
extends videoQueryBase	XYVideoQueryBase	会控开关摄像头事件基础消息体

PeopleTrackConfig

创建自定义Track配置参数

属性	类型	描述
audioInputId	string	可选，麦克风设备ID
audioOutputId	string	可选，扬声器设备ID
videoInputId	string	可选，摄像头设备ID
muteAudio	boolean	可选，是否开启/关闭麦克风入会，默认是false，开启麦克风
muteVideo	boolean	可选，是否开启/关闭摄像头入会，默认是false，开启摄像头
videoTrack	MediaStreamTrack \| null	可选，自定义摄像头MediaStreamTrack数据，默认是null
audioTrack	MediaStreamTrack \| null	可选，自定义麦克风MediaStreamTrack数据，默认是null

ResizeData

元素尺寸数据

属性	类型	描述
width	number	布局容器元素的宽度
height	number	布局容器元素的高度
element	HTMLElement \| null	布局容器元素

SnapshotParams

截图参数

属性	类型	描述
id	string	参会者Layout ID
imageType	string	图片格式，默认'image/png'
compressLevel	number	图片质量，0-1，默认值是0.92

SnapshotResult

截图结果

属性	类型	描述
dataURL	string	图片数据，Base64字符串
width	number	图片宽度
height	number	图片高度

SpeakersInfoItem

讲话者信息

属性	类型	描述
alias	string	别名ID
name	string	讲话者名称
pid	number	用户ID
endpointId	string	用户标识ID
trackId	string	媒体网关分配的轨道ID（对应的是将-ad-转化为-st-之后的stream数据）
isLocal	boolean	是否是Local设备
level	number	音量等级
id	string	参会者Roster ID，通过roster数据获取

SwitchDeviceConfig

切换设备方法额外配置

属性	值	描述
isDefault	boolean	可选，是否是系统默认设备，如果指定默认设备，则DeviceId可以提供空值
allowSpecifiedId	boolean	可选，是否需要记录当前设备ID信息，默认内部的切换设备行为不需要记录，仅用户主动触发才会强制记录当前的设备ID信息

XYCaptureHandleConfig

采集处理器配置

属性	类型	描述
handle	string	必填，处理器HandleID，不超过 1024 个字符的字符串
exposeOrigin	boolean	可选，是否允许捕获来源应用，设置为true，则捕获的 Web 应用的来源可能会向捕获的SDK应用公开
permittedOrigins	string[]	可选，设置观察源，默认是['*']，即可以看到所有观察源，如果需要指定观察源，则设置为对应的域名地址

XYCheckNumberParams

会议号和密码参数

属性	类型	描述
confNumber	string	必填，会议号
password	string	可选，会议入会密码
__hideId	string \| number	可选，隐身ID

XYCheckSystemRequirementsDetail

浏览器是否支持WebRTC能力详情

属性	类型	描述
isSupportRTC	boolean	是否支持RTCPeerConnection
isSupportWebsocket	boolean	是否支持Websocket
isSupportH264	boolean	是否支持H264编解码器能力
isSupportAddTransceiver	boolean	是否支持addTransceiver API
isSupportAddtrack	boolean	是否支持addTrack API
isSupportUserMedia	boolean	是否支持访问用户摄像头和麦克风的getUserMedia API

XYClientContainer

布局容器节点和偏移量

属性	类型	描述
elementId	string	可选，容器节点，布局需要包裹在此容器节点元素里面显示，并使用此元素的信息计算布局的尺寸和位置
offset	number[]	可选，自动布局容器偏移量, [上下左右]，单位：px

XYControlVideoQuery

会控推送开启/关闭摄像头消息体

属性	类型	描述
key	XYVideoQueryType	消息key，值为：'unMuteVideoQuery' \| 'muteVideoQuery'
value	XYVideoQueryBase	消息详细内容

XYElectronSource

Electron选择分享应用/屏幕资源

属性	类型	描述
appIcon	any	资源icon
display_id	string	显示id
id	string	资源id
name	string	应用名称/屏幕名称
thumbnail	any	thumbnail type is NativeImage

XYLocatorConfig

内外网探测配置项

属性	类型	描述
extId	string	企业ID
clientId	string	客户端应用Id
clientSecret	string	客户端应用Secret
httpServer	string	默认是探测服务器域名

XYMeetingControl

会控相关信息

属性	类型	描述
isHost	boolean	是否是主持人
isBigConf	boolean	是否是分级会议
noCtrPwd	boolean	是否无会控密码

XYMeetingDeviceStatus

本地麦克风或摄像头实时状态

属性	类型	描述
status	OperateType	设备状态

XYMediaGrps

多分组通道信息

属性	类型	描述
id	string	多分组通道
calluri	string	指定设备ID

XYMonitorEvent

调度事件结果数据

属性	类型	描述
monitorInfo	IMonitorReport	调度结果数据

XYMultiGroupInfo

多分组通道消息

属性	类型	描述
endpointId	string	设备ID
mediagrps	XYMediaGrps[]	多分组通道信息

XYNotification

联席主持人/主持人/改名权限等消息

属性	类型	描述
subType	number	消息类型
content	XYNotificationContent	消息详细内容
requestId	string	消息ID

XYNotificationContent

属性	类型	描述
coChair	CoChair	可选，是否是联席主持人
host	Host	可选，是否是主持人
enableRename	EnableRename	可选，是否有改名权限
meetingId	string	可选，会议ID

XYPositionInfo

Layout成员布局位置

属性	类型	描述
width	number	当前画面的宽度
height	number	当前画面的高度

XYServerInfo

服务器地址

属性	类型	描述
httpServer	string	可选，WebRTC网关服务器地址
wssServer	string	可选，WebRTC网关WebSocket服务器地址
logServer	string	可选，日志服务器地址

XYSpeakersInfo

实时讲话人消息体

属性	类型	描述
speakersInfo	SpeakersInfoItem[]	讲话者信息

XYSupportedCodec

可支持的编解码

属性	类型	描述
video	string[]	视频支持的编解码器
audio	string[]	音频支持的编解码器

XYPlayFailedInfo

音视频播放异常信息

属性	类型	描述
type	'video' \| 'audio'	媒体类型
key	string	关键ID信息，可能是layoutId或者streamId
error	any	详细错误信息

XYPositionStyle

Layout成员布局位置样式，分别是：左、上、宽、高

属性	类型	描述
left	string	当前画面距离左的像素位置
top	string	当前画面距离上的像素位置
width	string	当前画面宽度，单位px
height	string	当前画面高度，单位px

XYVideoQueryType

会控开关摄像头三个事件类型

值	描述
unMuteVideoQuery	会控请求打开摄像头
muteVideoQuery	会控请求关闭摄像头
toast	主持会议的客户端收到的成功和失败提醒

XYVideoQueryBase

会控开关摄像头事件基础消息体

属性	值	描述
confUri	string	会议号
encryption	string	加密信息
force	boolean	是否强制开启摄像头
meetingId	string	会议ID
requestId	string	事件ID
uri	string	事件接收侧用户ID

2024-07-18 10:35:08

导出PDF文档