更新时间:2024-11-26 GMT+08:00

快速入门

环境要求

Web SDK运行环境要求,如表1所示。

表1 环境要求

环境项

使用限制

开发工具

Microsoft Visual Studio Code、WebStorm或其他Web IDE开发工具。

语言

Javascript或Typescript。

编译环境

建议Node 17+。

编译工具

建议Webpack 5 + babel 7。

浏览器

浏览器使用限制,请参见表2

由于浏览器的安全策略限制,仅支持通过“https://域名”方式访问,否则无法正常加载运行智能交互WebSDK。

表2 浏览器适配详情

操作系统类型

浏览器类型

浏览器版本

Windows

Chrome浏览器

91+

Edge浏览器

80+

Android

移动版Chrome浏览器

91+

Ios

移动版Safari浏览器

17.3+

Mac

Safari浏览器

15.6+

表3 透明背景支持情况

操作系统类型

浏览器类型

浏览器版本

Windows

Chrome浏览器

94+

Edge浏览器

94+

Android

移动版Chrome浏览器

94+

Ios

移动版Safari浏览器

17.3+

Mac

Safari浏览器

16.4+

快速集成SDK

  1. 建议将下载的SDK压缩包放置在自己项目的“sdk”目录下。
  2. 在项目代码中引入“HwICSUiSdk”。

    • 如果通过<script>方式引入SDK,则通过访问HwICSUiSdk获取导出的模块:
      <script src='./sdk/HwICSUiSdk.js'></script>
    • 如果您直接引用华为WebRTC SDK静态JS文件,则通过以下方式访问:
      import { HwICSUiSdk } from './sdk/HwICSUiSdk'
    • 除以上JS文件引入之外,还需要引入CSS样式文件,可以直接通过link标签引入或者直接在项目中import:
      <link rel="stylesheet" href="./sdk/HwICSUiSdk.css">
      import './sdk/HwICSUiSdk.css'
      @import './sdk/HwICSUiSdk.css'

  3. 检测浏览器是否支持SDK。具体接口详情,请参见checkBrowserSupport

    1
    2
    3
    4
    5
    6
    const result = await HwICSUiSdk.checkBrowserSupport();
    if (result) {
      // 支持
    } else {
      // 不支持
    }
    

  4. 为页面添加容器元素,供智能交互任务使用。

    容器元素中需要包含id属性。
    1
    <div id="ics-sdk" style="width: 100vw;height: 100vh"></div>
    

  5. 创建智能交互任务。具体接口详情,请参见create

    1
    2
    3
    4
    5
    6
    HwICSUiSdk.create({
      serverAddress: 'metastudio-api.cn-north-4.myhuaweicloud.com',
      onceCode: 'aaa',
      robotId: 'aaa',
      containerId: 'ics-sdk',
    });