Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.spatius.ai/llms.txt

Use this file to discover all available pages before exploring further.

The Client SDK side of Backend Mode Integration renders encoded messages from your backend. The client does not connect directly to Motion Server. Instead, it receives audio and motion messages over your chosen transport and feeds them into AvatarKit.

​
Responsibilities

Client SDK responsibilityDescription
Initialize AvatarKitConfigure the client with App ID, avatar, region, and the Backend Mode client setting for your SDK.
Connect to your backendJoin your WebSocket, RTC room, or other downstream transport.
Consume encoded messagesReceive audio and motion messages generated by the Server SDK.
Render locallyFeed messages into AvatarKit with yieldAudioData() and yieldFramesData().
Do not call start() and send() for the Backend Mode client path. Those are Direct Mode methods. Backend Mode clients receive messages from your backend and call the yield* methods.

​
Next steps

Web SDK reference

Backend Mode client methods such as yieldAudioData() and yieldFramesData().

iOS SDK reference

iOS AvatarKit API reference.

Android SDK reference

Android AvatarKit API reference.

Flutter SDK reference

Flutter Backend Mode input and rendering API.

Browse all demos

Every runnable demo by platform and integration path.