Quick Start
SPAvatarKit is a real-time virtual avatar rendering SDK based on 3D Gaussian Splatting, supporting audio-driven animation rendering and high-quality 3D rendering.Get Started
5-minute quick integration guide to add digital human capabilities to your application.
Integration Modes
The SDK supports two integration modes, configured viadrivingServiceMode in AvatarKit.initialize():
- SDK Mode (Default): SDK handles WebSocket communication automatically. Send audio data via
AvatarController.send(), and the SDK receives animation data from backend automatically. - Host Mode: Host application manages its own network/data fetching. Host application provides both audio and animation data, SDK only handles synchronized playback.
Core Features
High Performance Rendering
Based on the latest point cloud rendering technology, providing high-quality 3D virtual avatars
Audio-Driven Real-Time Animation
Users provide audio data, SDK handles receiving animation data and rendering
WebGPU/WebGL Dual Backend
Automatically selects the best rendering backend for compatibility
WASM High-Performance Computing
Uses C++ compiled WebAssembly modules for geometric calculations
TypeScript Support
Complete type definitions and IntelliSense
Technical Specifications
| Item | Specification |
|---|---|
| Platform Support | Web Browsers |
| Development Language | TypeScript 5.0+ / JavaScript (ES2020+) |
| Browser Support | Chrome 90+, Firefox 90+, Safari 14+, Edge 90+ |
| Mobile Support | iOS 14+, Android 8+ |
| Rendering Backend | WebGPU (Preferred) / WebGL (Fallback) |
| Package Manager | npm / yarn / pnpm |
| Minimum Node.js | 18.0+ |
Integration Methods
npm
yarn
pnpm
Development Guide
API Reference
Complete API documentation and code examples
Practice Demos
Complete demo projects in vanilla, Vue, and React
FAQ
Common integration and runtime questions
Version Information
1.0.0 (2025-01-31)
View complete version update notes