hawkeye-linker
v0.0.1
Published
鹰眼客户端连接组件
Readme
taa-linker
taa-client连接器
安装
npm install taa-linker
# 或
yarn add taa-linker
# 或
pnpm add taa-linker开发
# 安装依赖
pnpm install
# 开发模式
pnpm dev
# 构建
pnpm build组件
Linker
基于socket.io的服务器连接类,用于发送和接收数据。
实例化
1. 实例化并自动连接到服务器
import { TaaLinker } from 'taa-linker';
const socketIOUrl = 'ws://<host>:<port>';
const taaLinker = new TaaLinker({
url: socketIOUrl,
autoConnect: true
});2. 实例化并按需连接到服务器
import { TaaLinker } from 'taa-linker';
const socketIOUrl = 'ws://<host>:<port>';
const taaLinker = new TaaLinker({
url: socketIOUrl,
autoConnect: false,
});
taaLinker.connect();监听连接状态
taaLinker.onConnectStatusChanged((status: ConnectionStatus) => {
console.log('[taa-linker] 连接状态已更新: ', status);
});ConnectionStatus 枚举
| 值 | 描述 | |--------|------| | DISCONNECTED | 未连接 | | CONNECTING | 连接中 | | CONNECTED | 已连接 | | ERROR | 连接错误 |
监听客户端状态
taaLinker.onClientStatusChanged((state: ClientStatus) => {
console.log('[taa-linker] 客户端状态已更新: ', state);
});ClientStatus 枚举
| 值 | 描述 | |--------|------| | OFFLINE | 离线 | | IDLE | 空闲 | | OCCUPIED | 占用 |
拨打电话
const res = await TaaLinker.getCallTicket('https://ai-client-test.ciwork.cn', ticketOptions);
const token = res.data;
taaLinker.makeCall(callOptions, token)调整拨打电话界面呼出位置
taaLinker.makeCall(callOptions, token, {
placement: TaaClientPlacement.right,
})客户端显示位置
TaaClientPlacement枚举定义了客户端界面显示的位置:
| 值 | 描述 | |------|------| | left | 左侧显示 | | right | 右侧显示(默认) | | center | 居中显示 | | top | 顶部显示 | | bottom | 底部显示 | | topLeft | 左上角显示 | | topRight | 右上角显示 | | bottomLeft | 左下角显示 | | bottomRight | 右下角显示 |
