主入口（HwICSUiSdk）

activeInteractionMode

(static) activeInteractionMode(): Promise<InteractionModeResult>

【功能说明】

获取当前生效的交互模式（语音问答/文本问答）。

【请求参数】

无。

【返回参数】

【代码示例】

const { result, interactionMode } = await HwICSUiSdk.activeInteractionMode();

addEventListeners

(static) addEventListeners(eventMap: EventMap): void

【功能说明】

设置事件回调。

【请求参数】

【返回参数】

无

【代码示例】

HwICSUiSdk.addEventListeners({
  error: (icsError) => {
    console.error('icsError', icsError);
  },
  jobInfoChange: (jobInfo) => {
    console.info('jobInfoChange', jobInfo);
  } 
});

changeLanguage

(static) changeLanguage(param: ChangeParam): Promise<UiSdkResult>

【功能说明】

设置交互任务语言。

【请求参数】

【返回参数】

请参见表27。

【代码示例】

const { result } = await HwICSUiSdk.changeLanguage({
  langCode: 'zh_CN',
});

checkBrowserSupport

(static) checkBrowserSupport(): Promise<boolean>

【功能说明】

检查当前浏览器是否支持运行SDK。

【请求参数】

无

【返回参数】

Promise<boolean>：当前浏览器是否支持运行SDK。

【代码示例】

1
2
3
4
5
6

const result = await HwICSUiSdk.checkBrowserSupport();
if (result) {
  // 支持
} else {
  // 不支持
}

create

(static) create(param: CreateParam): Promise<void>

【功能说明】

通过获取的任务链接和一次性鉴权码，创建智能交互任务。

【请求参数】

'{"client_id":"2134","city":"city","enable_intent_interrupt":"1","extra_json_param":"{\\"param1\\":\\"value1\\",\\"param2\\":\\"value2\\"}"}'

【返回参数】

无

【代码示例】

HwICSUiSdk.create({
  serverAddress: 'serverAddress',
  onceCode: 'onceCode',
  robotId: 'robotId',
  containerId: 'ics-root',
  logLevel: 'debug',
  config: {
    enableCaption: true,
    enableChatBtn: false
  },
  eventListeners: {
    error: (error) => {
      console.error('sdk error', {
        message: error.message,
        code: error.code,
      }, error);
    }
  }
});

destroy

(static) destroy(): Promise<void>

【功能说明】

销毁交互任务。

【请求参数】

无

【返回参数】

无

【代码示例】

HwICSUiSdk.destroy();

getJobInfo

(static) getJobInfo(): Promise<JobInfo>

【功能说明】

获取交互任务信息。

【请求参数】

无

【返回参数】

【代码示例】

const jobInfo = await HwICSUiSdk.getJobInfo();

getLanguageInfo

(static) getLanguageInfo(): Promise<LanguageResult>

【功能说明】

获取交互任务多语言信息。如需实现多语言能力，需要在后台创建智能交互活动页面，配置多种语言，目前支持中文和英文两种语言。

【请求参数】

无

【返回参数】

【代码示例】

const languageResult = await HwICSUiSdk.getLanguageInfo();

initResourcePath

(static) initResourcePath(param: ResourcePath): Promise<void>

【功能说明】

初始化语音唤醒资源，不使用语音唤醒能力则忽略该接口。

• 3.0.1版本之后的websdk包中有如下两个资源文件，如果不使用语音唤醒，可忽略这两个文件。
  • wasmData.js：语音唤醒的算法资源文件。
  • modelData.js：语音唤醒的模型资源文件。
• 4.0.0版本及之后的websdk支持worker线程开启语音唤醒能力，可通过useWorker参数启用。
• SDK内置默认唤醒模型，支持定制唤醒词，并更新本地模型，详见Web语音唤醒。

【请求参数】

【返回参数】

无。

【代码示例】

await HwICSUiSdk.initResourcePath({
  wasmPath: 'wasmData.js',
  dataPath: 'modelData.js',
  initModel: true,
});

interactionModeSwitch

(static) interactionModeSwitch(param: InteractionModeParam): Promise<InteractionModeResult>

【功能说明】

切换交互模式（语音问答/文本问答）。

【请求参数】

【返回参数】

见：表2

【代码示例】

const { result } = await HwICSUiSdk.interactionModeSwitch({ interactionMode: 'AUDIO' });

interruptSpeaking

(static) interruptSpeaking(): Promise<UISdkResult>

【功能说明】

中断数字人讲话。

【请求参数】

无

【返回参数】

请参见表27。

【代码示例】

const { result } = await HwICSUiSdk.interruptSpeaking();

muteRemoteAudio

(static) muteRemoteAudio(): Promise<boolean>

【功能说明】

数字人静音。

【请求参数】

无

【返回参数】

Promise<boolean>：数字人静音是否成功。

【代码示例】

const result = await HwICSUiSdk.muteRemoteAudio();

playRemoteVideo

(static) playRemoteVideo(): Promise<UISdkResult>

【功能说明】

播放数字人音视频。跟开关参数“autoPlayRemoteVideo”配合使用，当create接口中参数config的autoPlayRemoteVideo属性设置为false，则需要调用该接口主动播放数字人音视频。

【请求参数】

无

【返回参数】

请参见表27。

【代码示例】

const { result } = await HwICSUiSdk.playRemoteVideo();

sendDrivenText

(static) sendDrivenText(param: TextDrivenParam): Promise<ChatResult>

【功能说明】

发送智能交互数字人主动播报的文本信息。

注意：主动播报结束时的最后一次调用，一定要传“isLast:true”参数，否则数字人讲话结束时无法及时收到speakingStop通知。

【请求参数】

【返回参数】

请参见表25。

【代码示例】

const { result } = await HwICSUiSdk.sendDrivenText({ text: '你好', isLast: true });

sendTextQuestion

(static) sendTextQuestion(param: TextQuestionParam): Promise<TextQuestionResult>

【功能说明】

发送问题文本。

【请求参数】

【返回参数】

【代码示例】

const { result } = await HwICSUiSdk.sendTextQuestion({ text: '你是谁' });

setConfig

(static) setConfig(config: ConfigMap): void

【功能说明】

设置配置项，用于控制是否显示字幕或交互按钮。

【请求参数】

【返回参数】

无

【代码示例】

HwICSUiSdk.setConfig({
  enableCaption: true,
  enableChatBtn: false,
  enableHotIssues: false,
  enableWeakErrorInfo: true,
});

setLogLevel

(static) setLogLevel(logLevel: 'debug' | 'info' | 'warn' | 'error' | 'none'): void

【功能说明】

设置输出日志的级别。

【请求参数】

【返回参数】

无

【代码示例】

HwICSUiSdk.setLogLevel('warn');

setThirdPartyConfig

(static) setThirdPartyConfig(param: ThirdPartyParam): Promise<void>

【功能说明】

设置第三方配置。支持通过配置接入声影降噪设备。声影降噪设备上的多模态app开启的前提下，可以通过该接口与多模态app建立websocket连接，进而实现人脸唤醒、定向拾音以及拾音降噪等增强能力。

声影降噪设备目前支持分体式和瓦力两种类型。

【请求参数】

【返回参数】

无

// 启用声影分体式降噪设备配置
await HwICSUiSdk.setThirdPartyConfig({
  uHan: {
    enable: true,
    showVideoUi: true,
    host: `127.0.0.1:10001`,
    sleepDelay: 10000, 
  },
});

// 启用自定义音频输入
await HwICSUiSdk.setThirdPartyConfig({
  customRecord: {
    enable: true
  },
});

startChat

(static) startChat(param?: ChatParam): Promise<ChatResult>

【功能说明】

开始对话。

【请求参数】

【返回参数】

【代码示例】

const { result } = await HwICSUiSdk.startChat({ interactionMode: 'AUDIO' });

startSpeak

(static) startSpeak(): Promise<UISdkResult>

【功能说明】

开始说话（注：接口已重命名为startUserSpeak，请直接切换至新接口）。

【请求参数】

无

【返回参数】

请参见表27。

【代码示例】

const { result } = await HwICSUiSdk.startSpeak();

startStreamRecord

(static) startStreamRecord(): Promise<void>

【功能说明】

开始录制用户讲话声音。

须知：使用此功能需要先在MetaStudio控制台”对话记录”功能模块配置对应的obs桶后才能下载查看，详见保存智能交互对话记录。

【请求参数】

无

【返回参数】

无

【代码示例】

await HwICSUiSdk.startStreamRecord();

startUserSpeak

(static) startUserSpeak(param?: Param): Promise<UISdkResult>

【功能说明】

用户开始提问。

【请求参数】

【返回参数】

【代码示例】

const { result } = await HwICSUiSdk.startUserSpeak({ preCheckPermissions: false });

stopChat

(static) stopChat(): Promise<ChatResult>

【功能说明】

结束对话。

【请求参数】

无

【返回参数】

请参见表25。

【代码示例】

const { result } = await HwICSUiSdk.stopChat();

stopSpeak

(static) stopSpeak(): Promise<UISdkResult>

【功能说明】

停止说话（注：接口已重命名为stopUserSpeak，请直接切换至新接口）。

【请求参数】

无

【返回参数】

请参见表27。

【代码示例】

const { result } = await HwICSUiSdk.stopSpeak();

stopStreamRecord

(static) stopStreamRecord(): Promise<void>

【功能说明】

结束录制用户讲话声音，并弹框提示或自动保存pcm格式录音文件。

【请求参数】

无

【返回参数】

无

【代码示例】

await HwICSUiSdk.stopStreamRecord();

stopUserSpeak

(static) stopUserSpeak(): Promise<UISdkResult>

【功能说明】

用户停止提问（注：此处只是停止ASR接收用户语音，对话仍处于激活态）。

【请求参数】

无

【返回参数】

请参见表27。

【代码示例】

const { result } = await HwICSUiSdk.stopUserSpeak();

unmuteRemoteAudio

(static) unmuteRemoteAudio(): Promise<boolean>

【功能说明】

数字人取消静音。

【请求参数】

无

【返回参数】

Promise<boolean>：数字人取消静音是否成功。

【代码示例】

const result = await HwICSUiSdk.unmuteRemoteAudio();

sendCustomLocalAudio

(static) sendCustomLocalAudio(audioData: AudioData): Promise<void>

【功能说明】

发送自定义音频数据。

【请求参数】

【返回参数】

无。

const result = await HwICSUiSdk.sendCustomLocalAudio(
  {
    base64Data: ''
  }
);