接口概览

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 的自定义样式

• 代码示例

 <script>
  /** 实例化UISDK 需要https或http协议 */
  var uisdk = new UISDK({
    /** dom节点id */
    id: 'root',
    /** 渲染样式 取值：default none customize */
    type:'default',
    /** 自定义样式 */
    setting:{}
  });
</script>

• 全量参数

<script>
  /** 实例化UISDK 需要https或http协议 */
  var uisdk = new UISDK({
    /** dom节点id */
    id: 'root',
    /** 渲染样式 取值：default none customize */
    type:'customize',
    /** 自定义样式 */
    setting: {
      /** 头部工具栏 */
      topBar: {
          /** 头部显示的样式 取值：default none customize */
          type: 'customize',
          /** logo background 值 */
          logoUrl: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
          /** logo链接地址 */
          logoLink: '/portal',
          /** 头部标题 */
          appTitle: '摩云视讯',
          /** 头部标题链接 */
          appTitleLink: '/portal',
          /** 是否显示用户信息 */
          showUserInfo: true,
          /** 用户默认头像 src值 */
          userDefaulteIcon: 'https://127.0.0.1/portal/static/images/avator.png?v=1',
          /** 是否显示设置按钮 */
          showSettings: true,
          /** 设置按钮图标 background属性值 */
          settingIcon: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
          /** 设置按钮hover图标 background属性值 */
          settingIconHover: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
          /** 是否显示退出按钮 */
          showExit: true,
          /** 退出按钮图标 background属性值 */
          exitIcon: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
          /** 退出按钮hover图标 background属性值 */
          exitIconHover: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
          /** 是否显示会议标题 */
          showMeetingTitle: true,
          /** 是否显示加入会议时间 */
          showJoinTime: true,
          /** 网络状态图标 background属性值 */
          networkUrl: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat"
      }
      /** 版权声明页 */
      detail: {
          /** 版权声明页 取值：default none customize */
          type: 'customize',
          /** logo地址 */
          logoUrl: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat", //  logo地址
          /** logo宽度 */
          logoWidth: '',
          /** 系统名称 */
          systemModeAbbr: '',
          /** 版权公司 */
          companyName: '',
          /** 版权信息 */
          companyDomainName: '',
          /** 版本号 */
          version: '',
          /** 网站地址 */
          address: '',
      },
      /** 主体视频区 */
      page: {
          /** 主体视频区 取值：default none customize */
          type: "customize",
          /** 非会议中无显示内容时默认摄像头图片 */
          logoIcon:
              "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
          /** 非会议中无显示内容时默认摄像头图片宽度 需带单位 */
          logoWidth: "", // logo宽度 需带单位
          /** 非会议中无显示内容时默认摄像头图片高度 需带单位 */
          logoHeight: "", // logo高度 需带单位
      },
      /** 会议列表 */
      roomList: {
          /** 会议列表 取值：default none customize */
          type: "customize",
          /** 会议列表标题 */
          title: "会议室",
          /** 虚拟会议室图标 */
          virtualIcon:
              "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
          /** 正在召开会议室图标 */
          inuseIcon:
              "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
          /** 预约会议室图标 */
          appointIcon:
              "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
          /** 是否显示搜索框 */
          showSearch: false,
          /** 搜索按钮图标 */
          searchBtnIcon:
              "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
          /** 搜索悬浮时按钮图标 */
          searchBtnIconHover:
              "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
          /** 搜索框提示文字 */
          searchPlaceholder: "搜索会议名称/会议号码/发起人",
          /** 是否显示创建会议按钮 */
          showCreate: false, 
          /** 创建会议链接 */
          createUrl: "", 
      },
      /** 开发环境服务配置 生产不需要*/
      serve: {
          /** 服务配置 取值：default customize */
          type: 'customize',
          /** 域名 */
          hostname:location.hostname,
          /** 端口 */
          port:location.port,
          /** 协议 */
          protocol:'https',
          /** 登录路径  若type为customize，请输入携带协议的绝对路径 */
          loginUrl: location.protocol + '//' + location.host,
          /** 门户路径  若type为customize，请输入携带协议的绝对路径 */
          homeUrl:location.protocol + '//' + location.host
      },
      /** 底部工具栏 */
      toolBar: {
         /** 底部工具栏 取值：none default customize */
        type: 'customize',
        /** 麦克风 */
        microphone: {
            type: 'customize',
            /** 麦克风启用状态图标 */
            icon: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 音量1图标  */
            icon1: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 音量2图标  */
            icon2: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 音量3图标  */
            icon3: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 音量4图标  */
            icon4: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 音量5图标  */
            icon5: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 音量6图标  */
            icon6: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 音量7图标  */
            icon7: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 音量8图标  */
            icon8: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 音量9图标  */
            icon9: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 音量10图标  */
            icon10: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 麦克风悬停状态图标  */
            iconHover:"url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 麦克风禁用状态图标  */
            disableIcon: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 麦克风禁用悬停状态图标  */
            disableIconHover:"url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 麦克风异常状态图标  */
            errorIcon: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 麦克风异常悬停状态图标  */
            errorIconHover: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 麦克风按钮文字  */
            label: '麦克风',
        },
        /** 扬声器 */
        loudspeaker: {
            type: 'customize',
            /** 扬声器启用状态图标  */
            icon: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 扬声器悬停状态图标  */
            iconHover: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 扬声器禁用状态图标  */
            disableIcon: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 扬声器禁用悬停状态图标  */
            disableIconHover: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 扬声器按钮文字  */
            label: '',
        },
        /** 摄像头 */
        camera: {
            type: 'customize',
            /** 摄像头启用状态图标  */
            icon: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 摄像头悬停状态图标  */
            iconHover: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 摄像头禁用状态图标  */
            disableIcon: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 摄像头禁用悬停状态图标  */
            disableIconHover: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 摄像头异常状态图标  */
            errorIcon: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 摄像头异常悬停状态图标  */
            errorIconHover: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 摄像头按钮文字  */
            label: '',
        },
        /** 终端列表 */
        terminalList: {
            type: 'customize',
            /** 终端列表按钮图标  */
            icon: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 终端列表按钮悬停图标  */
            iconHover: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 终端列表按钮文字  */
            title: '与会方', // 标题
            /** 终端列表与会方头像  */
            avatar: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 终端列表管理方头像  */
            chairmanIcon: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 终端列表发言方头像  */
            speakerIcon: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 终端列表VIP头像  */
            vipIcon: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 终端列表设置管理方头像  */
            setChairmanIcon: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 终端列表静音图标  */
            MuteIcon: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 终端列表取消静音图标  */
            MuteOnIcon: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 终端列表文字  */
            label: '',
        },
        /** 邀请 */
        inviteInfo: {
            type: 'customize',
            /** 邀请信息按钮图标  */
            icon: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 邀请信息按钮悬停图标  */
            iconHover: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 邀请信息按钮文字  */
            label: "",
        }
        /** 共享 */
        share: {
            type: 'customize',
            /** 未分享状态图标  */
            icon: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 未分享状态悬停图标  */
            iconHover: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 分享状态图标  */
            shareIcon: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 分享状态悬停图标  */
            shareIconHover: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 分享按钮文字  */
            label: '',
        }
        /** 退出 */
        exit: {
            type: 'customize',
            /** 退出按钮图标  */
            icon: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 退出按钮悬停图标  */
            iconHover: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 退出按钮文字  */
            label: '',
        }
        /** 全屏 */
        fullScreen: {
            type: 'customize',
            /** 未全屏状态图标  */
            icon: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 未全屏状态悬停图标  */
            iconHover: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 全屏状态图标  */
            fullScreenIcon: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 全屏状态悬停图标  */
            fullScreenIconHover: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
            /** 全屏按钮文字  */
            label: '',
        }
        /** 设备 */
        device: {
          type: 'customize',
          /** 设备按钮图标  */
          icon: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
          /** 设备按钮悬停图标  */
          iconHover: "url('https://127.0.0.1/portal/static/images/avator.png?v=1') no-repeat",
          /** 设备按钮文字  */
          label: '',
        }
      }
    }
  });
</script>