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.1rc1.tar.gz (10.2 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.1rc1-py3-none-any.whl (9.6 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for livekit_plugins_spatius-1.6.1rc1.tar.gz
Algorithm Hash digest
SHA256 166167f61de7a27d2a30cc77eb817dde84d87f7f29183d11f6237c96db860afc
MD5 99e825966bda110258b6a27e0e2d35a3
BLAKE2b-256 6d0944e71bd5c22b6d9b40ea40e529257b510aea6f176f68acb62e2ab105aac9

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for livekit_plugins_spatius-1.6.1rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 a7e4ed3d29e9b752a51baec7e2bcf9a8903afb51b4b8b6c8fc0d767f61354bde
MD5 1742de033b686d0fd2d522a68f47e5d3
BLAKE2b-256 e94b3a47d9534c1d3f7b6b36dbae45672a679617b7fccebe0675b51c7f828dd3

See more details on using hashes here.

Provenance

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