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))

Advanced LiveKit egress room

By default, Spatius publishes the avatar into the same LiveKit room as the agent. For specialized routing setups, pass livekit_room_name to publish the avatar into a different room:

await avatar.start(
    session,
    room=ctx.room,
    livekit_room_name="avatar-output-room",
)

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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for livekit_plugins_spatius-1.6.4rc1.tar.gz
Algorithm Hash digest
SHA256 ac62d1e782c483b4b354aec2768da4c3b36be712ef3994cbd801c8e96ccee624
MD5 7c0a569ed290741a7ebe5e26f477d836
BLAKE2b-256 9130a6cf749f7ae30d5ee79bbe972beea8017245a458a1c39ad820355bc480a4

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for livekit_plugins_spatius-1.6.4rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 e88892e9b8fecc4ea2a11cadae6f3bc57cd9570996a69702d938d371c121cfdf
MD5 5bf8c50cfa58b6a5e774f50d8b147fb1
BLAKE2b-256 6b7387b9ec6eb063e1726cd0a3d94c63488f554c37358fb5b583278e5a701e63

See more details on using hashes here.

Provenance

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