集成SDK

npm install aliyun-auikit-aicall --save

SDK使用示例

// 引入SDK
import ARTCAICallEngine, { ARTCAICallErrorCode, ARTCAICallAgentState, AICallSubtitleData } from 'aliyun-auikit-aicall';

// 創建engine實例
const engine = new ARTCAICallEngine();

// 其他功能調用示例，請參考API說明

// 回調處理（僅示例不分核心的回調操作）
engine.on('errorOccurred', (code: ARTCAICallErrorCode) => {
  // 發生了錯誤
  engine.handup();
});

engine.on('callBegin', () => {
  // 通話開始
});

engine.on('callEnd', () => {
  // 通話結束
});

engine.on('agentStateChanged', (state: ARTCAICallAgentState) => {
  // 智能體狀態改變
});

engine.on('userSubtitleNotify', (subtitle: AICallSubtitleData) => {
  // 用戶提問被智能體識別結果的通知
});

engine.on('agentSubtitleNotify', (subtitle: AICallSubtitleData) => {
  // 智能體回答結果通知
});

engine.on('voiceIdChanged', (voiceId: string) => {
  // 當前通話的音色發生了改變
});

engine.on('voiceInterruptChanged', (enable: boolean) => {
  // 當前通話的語音打斷是否啟用
});

const userId = '';

// 從服務端獲取 agentInfo
const agentInfo = fetchAgentInfo();

try {
  // 啟動智能體后，開始通話
  engine.call(userId, agentInfo);
} catch (error) {}

// 結束通話
engine.handup();

API說明

屬性說明

API概覽

ARTCAICallEngine 詳情

call

開始通話

async call(userId: string, agentInfo: AICallAgentInfo, config?: AICallEngineConfig): Promise<void>>

參數詳情：

{
  //是否靜音麥克風
  muteMicrophone?: boolean;
  //視覺理解模式是否關閉攝像頭
  muteCamera?: boolean;
  //是否開啟按住說話
  enablePushToTalk?: boolean;
  //視覺理解模式 預覽視頻元素
  previewElement?: string | HTMLVideoElement;
  //視覺理解模式 攝像頭設置
  cameraConfig?: AICallCameraConfig;
}

handup

退出通話

async handup(): Promise<void>

setAgentView

設置智能體渲染視圖，及視圖模式

setAgentView(view: HTMLVideoElement | string): void

參數詳情：

interruptSpeaking

打斷智能體講話

async interruptSpeaking(): Promise<void>

enableVoiceInterrupt

開啟/關閉智能打斷

async enableVoiceInterrupt(enable: boolean): Promise<void>

參數詳情：

startPreview

設置本地預覽地址

startPreview(view: HTMLVideoElement | string): void

參數詳情：

muteLocalCamera

開關攝像頭推送

async muteLocalCamera(mute: boolean)

參數詳情：

switchCamera

切換攝像頭

async switchCamera(deviceId?: string)

參數詳情：

switchVoiceId

切換音色

async switchVoiceId(voiceId: string): Promise<void>

參數詳情：

mute

靜音/取消禁音麥克風

async mute(mute: boolean): Promise<void>

參數詳情：

getRTCInstance

獲取RTC引擎

getRTCInstance(): AliRtcEngine | undefined

destroy

釋放資源

async destroy()

ARTCAICallEngine事件詳情

errorOccurred

當前通話時發生了錯誤

參數詳情：

callBegin

通話開始

callEnd

通話結束

agentStateChanged

智能體狀態改變

參數詳情：

speakingVolumeChanged

音量變化通知

參數詳情：

userSubtitleNotify

用戶提問被智能體識別結果的通知

參數詳情：

agentSubtitleNotify

智能體回答結果通知

參數詳情：

voiceIdChanged

當前通話的音色發生了改變

參數詳情：

voiceInterruptChanged

當前通話的語音打斷是否啟用

參數詳情：

humanTakeoverWillStart

真人即將接管當前智能體

參數詳情：

onHumanTakeoverConnected

真人接管已經接通

參數詳情：