# yoseenir-web-sdk

**Repository Path**: polarbird/yoseenir-web-sdk

## Basic Information

- **Project Name**: yoseenir-web-sdk
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-04-21
- **Last Updated**: 2025-04-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# @yoseenir/web-sdk 

[![NPM version](https://img.shields.io/npm/v/%40yoseenir%2Fweb-sdk?style=flat)](https://www.npmjs.com/package/@yoseenir/web-sdk) 
[![NPM downloads](https://img.shields.io/npm/dm/%40yoseenir%2Fweb-sdk?style=flat)](https://www.npmjs.com/package/@yoseenir/web-sdk) 
[![License](https://img.shields.io/npm/l/%40yoseenir%2Fweb-sdk)](https://gitee.com/polarbird/yoseenir-web-sdk/blob/master/LICENSE) 
![Node Current](https://img.shields.io/node/v/%40yoseenir%2Fweb-sdk)

"@yoseenir/web-sdk" 是格物优信发布的 Web 端 SDK，用于在现代Web浏览器中实现无插件访问格物优信的热像仪产品。

## 目录结构
```
├── LICENSE
├── README.md
├── dist        # SDK 发布包
│   ├── yoseenir-web-sdk.js
│   ├── yoseenir-web-sdk.umd.cjs
├── types        # SDK 类型定义文件
│   ├── index.d.ts
├── example       # 示例代码文件夹
├── index.html    # vite es示例入口页面
└── package.json
```

## 说明
- 本SDK使用TypeScript编写，提供了完整的类型定义文件，方便开发者进行类型检查和代码补全。
- 本SDK仅支持在现代Web浏览器中使用，包括Chrome, Edge, Firefox等，不支持IE浏览器。
- 本SDK提供了ES和UMD两种使用方式。
- 本SDK主要使用WebSocket协议与热像仪进行数据通信。
- 本SDK使用WebRTC协议实现热像仪的视频流传输，发布时内置了webrtc-adapter进行WebRTC的兼容处理。如果您的项目中已经使用了WebRTC，可能会导致WebRTC的兼容性问题，您可以考虑直接使用本sdk的源代码自行封装。


## 安装
```bash
pnpm install @yoseenir/web-sdk
```

## 使用
yoseenir-web-sdk 支持 ES 和 UMD 两种使用方式。

### UMD 引入
参考 example/demo-umd.html中的使用方式。
```js
<script type="application/javascript" src="https://unpkg.com/@yoseenir/web-sdk"></script>
<script>
  const sdk = YoseenirWebSDK

  const client = new sdk.client()
  const resp = new sdk.protocols.xmsghead()
```

### ES 引入
参考 example/demo-es.ts中的使用方式。
```js
import * as sdk from '@yoseenir/web-sdk'
const client = new sdk.client()
const resp = new sdk.protocols.xmsghead()
```
要运行demo-es示例项目，需要在终端中执行以下命令使用Vite启动项目。
```bash
pnpm install
pnpm dev
```