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.17rc1.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.17rc1-py3-none-any.whl (9.4 kB view details)

Uploaded Python 3

File details

Details for the file livekit_plugins_spatius-1.5.17rc1.tar.gz.

File metadata

File hashes

Hashes for livekit_plugins_spatius-1.5.17rc1.tar.gz
Algorithm Hash digest
SHA256 eab84e75903013943bfc02a7e0c19282871479dfe7e9cf9b8bd24a7f8b64b94c
MD5 dd31e4c40db5cb4b738f11ba26dea9e7
BLAKE2b-256 a64de632de4f9da1ea370e4147dbe0c905314f7ae9b049b7ada08ddc1124451d

See more details on using hashes here.

Provenance

The following attestation bundles were made for livekit_plugins_spatius-1.5.17rc1.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.17rc1-py3-none-any.whl.

File metadata

File hashes

Hashes for livekit_plugins_spatius-1.5.17rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 88787ca127639bfb32ff60b1536fe7ab59b6c2096c3aa9d11a7a368cfe0d40b3
MD5 db9dcba552e112fd80804756cfd7c043
BLAKE2b-256 4f86506691bf88fe01bdf133f3fbb2c5dbbe40eb1e8e55b402a16c2f698c7779

See more details on using hashes here.

Provenance

The following attestation bundles were made for livekit_plugins_spatius-1.5.17rc1-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