Skip to main content

Agent Framework plugin for Spatius avatars

Project description

LiveKit Agents Plugin for Spatius Avatar

LiveKit Agents plugin for Spatius avatar sessions. It forwards TTS audio from a LiveKit agent session to Spatius and lets the avatar publish synchronized audio/video back into the same room.

Installation

pip install livekit-plugins-spatius

Quick Start

Set credentials:

export SPATIUS_API_KEY=your-api-key
export SPATIUS_APP_ID=your-app-id
export SPATIUS_AVATAR_ID=your-avatar-id

export LIVEKIT_URL=wss://your-livekit-host
export LIVEKIT_API_KEY=your-livekit-api-key
export LIVEKIT_API_SECRET=your-livekit-api-secret

Use plugin in your LiveKit agent:

from livekit.agents import Agent, AgentSession, JobContext, WorkerOptions, cli
from livekit.plugins import spatius


class VoiceAssistant(Agent):
    def __init__(self) -> None:
        super().__init__(instructions="You are a helpful voice assistant.")


async def entrypoint(ctx: JobContext) -> None:
    await ctx.connect()

    session = AgentSession(
        vad=vad,
        stt=stt,
        llm=llm,
        tts=tts,
    )

    avatar = spatius.AvatarSession()
    await avatar.start(session, room=ctx.room)

    await session.start(agent=VoiceAssistant(), room=ctx.room)


if __name__ == "__main__":
    cli.run_app(WorkerOptions(entrypoint_fnc=entrypoint))

For detailed usage, see Spatius docs.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

livekit_plugins_spatius-1.5.15rc2.tar.gz (10.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

livekit_plugins_spatius-1.5.15rc2-py3-none-any.whl (9.4 kB view details)

Uploaded Python 3

File details

Details for the file livekit_plugins_spatius-1.5.15rc2.tar.gz.

File metadata

File hashes

Hashes for livekit_plugins_spatius-1.5.15rc2.tar.gz
Algorithm Hash digest
SHA256 61cc623eb813f7278bc543ef43ae4194501d93eb9451b93afb9983119d82deb6
MD5 a11813a1a11a31d582acd5b841543b08
BLAKE2b-256 4c2ea6b0be0353e1b7989934fafe6785a776eeb3986bdae05a7b0a079dc1f920

See more details on using hashes here.

Provenance

The following attestation bundles were made for livekit_plugins_spatius-1.5.15rc2.tar.gz:

Publisher: publish.yml on spatius-ai/livekit-plugins-spatius

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file livekit_plugins_spatius-1.5.15rc2-py3-none-any.whl.

File metadata

File hashes

Hashes for livekit_plugins_spatius-1.5.15rc2-py3-none-any.whl
Algorithm Hash digest
SHA256 9c074e46ac08a5a2f96dbb2572234a181cfbaaaa50f045676c9c9d0700d1e61d
MD5 0e8bc27df5d806a4b0947fc963ba0ec5
BLAKE2b-256 b75f55bd32f373a4d956d46b6a7acc640a62db035cfe660c04ecf8fd035d97a3

See more details on using hashes here.

Provenance

The following attestation bundles were made for livekit_plugins_spatius-1.5.15rc2-py3-none-any.whl:

Publisher: publish.yml on spatius-ai/livekit-plugins-spatius

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page