接口概览

UISDK接口

UISDK接口导出类命名UISDK

类名	初始化	描述
UISDK	new UISDK(config)	初始化UISDK实例

config

参数	类型	是否必填	默认值	描述
id	string	是	--	添加dom节点的id ，UISDK加载在这个dom节点中。
type	string	否	default	UISDK的整体样式， 取值： default：UISDK默认样式 none：只显示视频区样式 customize：自定义UISDK样式
setting	object	否	--	UISDK的自定义样式

setting

参数	类型	是否必填	默认值	描述
topBar	object	否	--	头部工具栏
detail	object	否	--	版权声明页
page	object	否	--	主体视频区
roomList	object	否	--	会议列表
toolBar	object	否	--	底部工具栏
serve	object	否	--	连接服务器配置

topBar

参数	类型	是否必填	默认值	描述
type	string	否	default	头部显示的样式 取值： default：UISDK默认样式 none：不显示此区域 customize：自定义头部样式，若设置此值，其他参数必填
logoUrl	string	否	--	logo图片 background属性值
logoLink	string	否	--	logo链接地址
appTitle	string	否	--	头部标题
appTitleLink	string	否	--	头部标题链接
showUserInfo	boolean	否	false	是否显示用户信息
userDefaulteIcon	string	否	--	用户默认头像 src值
showSettings	boolean	否	false	是否显示设置按钮
settingIcon	string	否	--	设置按钮图标 background属性值
settingIconHover	string	否	--	设置按钮hover图标 background属性值
showExit	boolean	否	false	是否显示退出按钮
exitIcon	string	否	--	退出按钮图标 background属性值
exitIconHover	string	否	--	退出按钮hover图标 background属性值
showMeetingTitle	boolean	否	false	是否显示会议标题
showJoinTime	boolean	否	false	是否显示加入时间
networkUrl	string	否	--	网络状态图标 background属性值

detail

参数	类型	是否必填	默认值	描述
type	string	否	default	版权声明区域 取值： default：默认样式 none：不显示此区域 customize：自定义版权声明区域，若设置此值，其他参数必填
logoUrl	string	否	--	logo图片 background属性值
logoWidth	string	否	--	logo宽度
systemModeAbbr	string	否	--	系统名称
companyName	string	否	--	公司名称
companyDomainName	string	否	--	版权信息
version	string	否	--	版本号
address	string	否	--	地址

page

参数	类型	是否必填	默认值	描述
type	string	否	default	主体视频区 取值： default：默认样式 customize：自定义视频区，若设置此值，其他参数必填
logoIcon	string	否	--	非会议中无显示内容时默认摄像头 background属性值
logoWidth	string	否	--	非会议中无显示内容时默认摄像头图片宽度 需要携带单位
logoHeight	string	否	--	非会议中无显示内容时默认摄像头图片高度 需要携带单位

roomList

参数	类型	是否必填	默认值	描述
type	string	否	default	会议列表 取值： default：默认样式 none：不显示此区域 customize：自定义会议列表，若设置此值，其他参数必填
title	string	否	会议室	会议列表标题
virtualIcon	string	否	--	虚拟会议室图标 background属性值
inuseIcon	string	否	--	正在召开会议室图标 background属性值
appointIcon	string	否	--	预约会议室图标 background属性值
showSearch	boolean	否	true	是否显示搜索框
searchBtnIcon	string	否	--	搜索按钮 background属性值
searchBtnIconHover	string	否	--	搜索悬浮时按钮 background属性值
searchPlaceholder	string	否	搜索会议名称/会议号码/发起人	搜索框提示文字
showCreate	boolean	否	true	是否显示创建会议按钮
createUrl	string	否(showCreate为真是必填)	--	创建会议链接

toolBar

参数	类型	是否必填	默认值	描述
type	string	否	default	底部工具栏 取值： default：默认样式 none：不显示此区域 customize：自定义底部工具栏，若设置此值，其他参数必填
microphone	object	否	--	麦克风
loudspeaker	object	否	--	扬声器
camera	object	否	--	摄像头
terminalList	object	否	--	终端列表
inviteInfo	object	否	--	邀请信息
share	object	否	--	共享
exit	object	否	--	退出
fullScreen	object	否	--	全屏
device	object	否	--	设备

serve

参数	类型	是否必填	默认值	描述
type	string	是	default	服务配置，主要用于开发环境 取值： default：默认内容 customize：自定义初始化配置，若设置此值，其他参数必填
hostname	string	否	location.hostname	域名
hostname	port	否	location.port	端口
protocol	string	否	https	协议
loginUrl	string	否	/portal/login	登录路径 若type为customize，请输入携带协议的绝对路径
homeUrl	string	否	/portal/home	门户路径 若type为customize，请输入携带协议的绝对路径

microphone

参数	类型	是否必填	默认值	描述
type	string	否	default	底部工具栏麦克风按钮 取值： default：默认样式 none：不显示此区域 customize：自定义麦克风按钮，若设置此值，其他参数必填
icon	string	否	--	麦克风启用状态图标 background属性值
icon1	string	否	--	音量1图标 background属性值
icon2	string	否	--	音量2图标 background属性值
icon3	string	否	--	音量3图标 background属性值
icon4	string	否	--	音量4图标 background属性值
icon5	string	否	--	音量5图标 background属性值
icon6	string	否	--	音量6图标 background属性值
icon7	string	否	--	音量7图标 background属性值
icon8	string	否	--	音量8图标 background属性值
icon9	string	否	--	音量9图标 background属性值
iconHover	string	否	--	麦克风悬停状态图标 background属性值
disableIcon	string	否	--	麦克风禁用状态图标 background属性值
disableIconHover	string	否	--	麦克风禁用悬停状态图标 background属性值
errorIcon	string	否	--	麦克风异常状态图标 background属性值
errorIconHover	string	否	--	麦克风异常悬停状态图标 background属性值
label	string	否	--	麦克风按钮文字，不设置或设置为空，不显示标签

loudspeaker

参数	类型	是否必填	默认值	描述
type	string	否	default	底部工具栏扬声器按钮 取值： default：默认样式 none：不显示此区域 customize：自定义扬声器按钮，若设置此值，其他参数必填
icon	string	否	--	扬声器启用状态图标 background属性值
iconHover	string	否	--	扬声器悬停状态图标 background属性值
disableIcon	string	否	--	扬声器禁用状态图标 background属性值
disableIconHover	string	否	--	扬声器禁用悬停状态图标 background属性值
label	string	否	--	扬声器按钮文字，不设置或设置为空，不显示标签

camera

参数	类型	是否必填	默认值	描述
type	string	否	default	底部工具栏摄像头按钮 取值： default：默认样式 none：不显示此区域 customize：自定义摄像头按钮，若设置此值，其他参数必填
icon	string	否	--	摄像头启用状态图标 background属性值
iconHover	string	否	--	摄像头悬停状态图标 background属性值
disableIcon	string	否	--	摄像头停用状态图标 background属性值
disableIconHover	string	否	--	摄像头停用悬停状态图标
errorIcon	string	否	--	摄像头异常状态图标 background属性值
errorIconHover	string	否	--	摄像头异常悬停状态图标 background属性值
label	string	否	--	摄像头按钮文字，不设置或设置为空，不显示标签

fullScreen

参数	类型	是否必填	默认值	描述
type	string	否	default	底部工具栏全屏按钮 取值： default：默认样式 none：不显示此区域 customize：自定义全屏按钮，若设置此值，其他参数必填
icon	string	否	--	未全屏图标 background属性值
iconHover	string	否	--	未全屏悬停状态图标 background属性值
fullScreenIcon	string	否	--	全屏状态图标 background属性值
fullScreenIconHover	string	否	--	全屏悬停状态图标 background属性值
label	string	否	--	全屏按钮文字，不设置或设置为空，不显示标签

share

参数	类型	是否必填	默认值	描述
type	string	否	default	底部工具栏共享桌面按钮 取值： default：默认样式 none：不显示此区域 customize：自定义共享按钮，若设置此值，其他参数必填
icon	string	否	--	共享状态图标 background属性值
iconHover	string	否	--	共享状态悬浮图标 background属性值
shareIcon	string	否	--	共享状态图标 background属性值
shareIconHover	string	否	--	共享状态悬浮图标 background属性值
label	string	否	--	共享按钮文字，不设置或设置为空，不显示标签

exit

参数	类型	是否必填	默认值	描述
type	string	否	default	底部工具栏退出按钮 取值： default：默认样式 none：不显示此区域 customize：自定义退出按钮，若设置此值，其他参数必填
icon	string	否	--	退出按钮图标 background属性值
iconHover	string	否	--	退出按钮悬浮图标 background属性值
label	string	否	--	退出按钮文字，不设置或设置为空，不显示标签

device

参数	类型	是否必填	默认值	描述
type	string	否	default	底部工具栏设备按钮 取值： default：默认样式 none：不显示此区域 customize：自定义设备按钮，若设置此值，其他参数必填
icon	string	否	--	设备按钮图标 background属性值
iconHover	string	否	--	设备按钮悬浮图标 background属性值
label	string	否	--	设备按钮文字，不设置或设置为空，不显示标签

inviteInfo

参数	类型	是否必填	默认值	描述
type	string	否	default	底部工具栏邀请信息按钮 取值： default：默认样式 none：不显示此区域 customize：自定义邀请信息按钮，若设置此值，其他参数必填
icon	string	否	--	邀请信息按钮图标 background属性值
iconHover	string	否	--	邀请信息按钮悬浮图标 background属性值
label	string	否	--	邀请信息按钮文字，不设置或设置为空，不显示标签

terminalList

参数	类型	是否必填	默认值	描述
type	string	否	default	底部工具栏终端列表按钮 取值： default：默认样式 none：不显示此区域 customize：自定义终端列表按钮，若设置此值，其他参数必填
icon	string	否	--	终端列表按钮图标 background属性值
iconHover	string	否	--	终端列表按钮悬浮图标 background属性值
label	string	否	--	终端列表按钮文字，不设置或设置为空，不显示标签
title	string	否	与会方	终端列表标题
avatar	string	否	--	终端列表头像 background属性值
chairmanIcon	string	否	--	终端列表管理方图标 background属性值
speakerIcon	string	否	--	终端列表发言方图标 background属性值
vipIcon	string	否	--	终端列表VIP图标 background属性值
setChairmanIcon	string	否	--	终端列表设置管理方图标 background属性值
MuteIcon	string	否	--	终端列表静音图标 background属性值
MuteOnIcon	string	否	--	终端列表静音图标 background属性值

注意

• 详情用法请参考快速集成 点此直达