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.8rc1.tar.gz (9.8 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.8rc1-py3-none-any.whl (9.1 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for livekit_plugins_spatius-1.5.8rc1.tar.gz
Algorithm Hash digest
SHA256 88ae17f010189fc6b11823dcff8131e7dbfbf567e441f9e03620dba784c2ec17
MD5 3f45b13075f3a2a5a4d124da2e2bcc17
BLAKE2b-256 527564d2bc95e7c32547058cc068af4c062b84180b30a8e42d0350f5b5c9163f

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for livekit_plugins_spatius-1.5.8rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 29baefa8b087732684ed182463e9f3c378c58f9c8ddf9af9c929e68532b94b5c
MD5 0433540fedf662aecf8b111fe259935b
BLAKE2b-256 192e1ebf47cb4a468f9e5f8944b39b5900dd951b0a103dbaa0a78787c1b62d48

See more details on using hashes here.

Provenance

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