open-index/open-npm huggingface dataset:
npm package: @like465420404/cloud-render-sdk
Description: 云渲染SDK - 提供Unity WebRTC通信管理能力
Latest version: 1.0.0

# Cloud Render SDK

基于 WebRTC 的云渲染 SDK，用于 Unity 应用的远程渲染和实时交互。

## 安装

```bash
npm install cloud-render-sdk
```

## 使用方法

```javascript
import { CloudEditorSDK } from 'cloud-render-sdk'

// 初始化SDK
const sdk = new CloudEditorSDK({
  tcgMount: 'tcg-container', // TCG应用挂载DOM ID
  tcgAppId: 12345, // TCG应用ID
  tcgProjectId: 'project-id', // TCG项目ID
  wsUrl: 'wss://example.com/ws', // WebSocket服务器地址
  userId: 'user-id', // 用户ID
  serviceHost: 'https://example.com/api', // StartProject的地址
  localDebugging: false, // 是否本地调试模式
})

// 监听Unity渲染就绪事件
sdk.onUnityRenderReady = (content) => {
  console.log('Unity渲染就绪', content)
}

// 监听模板变换更新事件
sdk.onTemplateTransformUpdate = (content) => {
  console.log('模板变换更新', content)
}

// 销毁SDK实例
async function cleanUp() {
  await sdk.destroy()
}
```

## API 文档

### 构造函数

```typescript
constructor(options: SDKOptions)
```

#### SDKOptions 接口

```typescript
interface SDKOptions {
  tcgMount: string // TCG应用挂载DOMID
  tcgAppId: number // TCG应用ID
  tcgProjectId: string // TCG项目ID
  wsUrl: string // WebSocket服务器地址
  userId: string // 用户ID
  serviceHost: string // StartProject的地址
  localDebugging?: boolean // 是否本地调试模式
  wsTopicName?: string // 本地调试模式时有效
}
```

### 事件处理

- `onUnityRenderReady`: Unity 渲染就绪时触发
- `onTemplateTransformUpdate`: 模板变换更新时触发
- `onTemplateSelectToggle`: 模板选择切换时触发
- `onError`: 发生错误时触发
- `onQueueStatus`: 排队状态更新时触发

### 方法

- `TemplateTransformUpdate(content)`: 更新模板变换
- `EditorInitializeStart(content)`: 开始编辑器初始化
- `TemplateAdd(content)`: 添加模板
- `TemplateDelete(content)`: 删除模板
- `TemplateUpdate(content)`: 更新模板
- `TemplateHide(content)`: 隐藏模板
- `TemplateShow(content)`: 显示模板
- `TemplateSelectToggle(content)`: 切换模板选择状态
- `getTemplateInfoByUuid(content)`: 通过 UUID 获取模板信息
- `getEditorAllData(content)`: 获取编辑器所有数据
- `updateRemoteSolution()`: 更新远程解决方案
- `getRemoteSolution()`: 获取远程解决方案
- `destroy()`: 销毁 SDK 实例

### content 协议

https://alidocs.dingtalk.com/i/nodes/R1zknDm0WR3AklNXfZm9GwozVBQEx5rG?utm_scene=person_space