SimliClient is a WebRTC frontend client designed for real-time interaction with AI-powered facial recognition and avatar services. It enables developers to integrate live audio and video streaming capabilities into their web applications, specifically for scenarios involving AI-driven avatars or face-based interactions. The current stable version is 3.0.1. While a specific release cadence isn't explicitly stated, the package follows semantic versioning, with major version changes (like the jump to v3) indicating significant updates and potential breaking changes. Its primary differentiator is its focus on streamlining the integration of WebRTC with Simli's AI backend for facial analysis and avatar control, abstracting much of the low-level WebRTC API complexity for these specialized use cases.
npm install simli-clientVerified import paths — ran on the pinned version, not inferred.
This quickstart demonstrates how to initialize the SimliClient, set up event listeners for connection status, and establish a WebRTC connection. It includes an example of sending dummy audio data after connection and highlights secure API key handling.
Refer to the official SimliClient v3 documentation or migration guides (if available) for updated API usage and configuration. Adjust your code to conform to the new v3 interfaces.
Use environment variables, a backend API endpoint to proxy credentials, or a secure token exchange mechanism (e.g., JWTs) to provide these values to your client-side application at runtime without embedding them directly.
Ensure your Simli server infrastructure uses appropriate STUN/TURN servers to facilitate connection establishment across various network topologies. Provide clear error messages to users if connection fails due to network issues.
Always `await` the `Initialize` and `start` methods and handle any potential rejections (errors) gracefully. Ensure subsequent API calls are made only after the `connected` event has fired or after these promises resolve.
Change your import statement to `import { SimliClient } from 'simli-client';` for ES Module compatibility.Ensure `SimliClientConfig.apiKey` is set to a valid, non-empty API key provided by Simli. Double-check for typos.
Verify that `SimliClientConfig.serverUrl` is correct and accessible. Check firewall rules, network connectivity, and the status of your Simli backend server. Inspect console logs for more specific WebSocket or WebRTC errors.
Ensure your code runs in a browser environment or use a tool like JSDOM to mock browser APIs if running unit tests in Node.js. For server-side operations, SimliClient is not typically used directly.
No dependency data recorded yet.