livekit-plugins-boson-avatar 1.8.5__tar.gz

livekit_plugins_boson_avatar-1.8.5/.gitignore

@@ -0,0 +1,180 @@
+**/.vscode
+**/.DS_Store
+.env
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# trunk
+.trunk/
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+node_modules
+
+credentials.json
+pyrightconfig.json
+docs/
+
+# Database files
+*.db
+
+
+# Examples for development
+examples/dev/*

livekit_plugins_boson_avatar-1.8.5/PKG-INFO

@@ -0,0 +1,140 @@
+Metadata-Version: 2.5
+Name: livekit-plugins-boson-avatar
+Version: 1.8.5
+Summary: Agent Framework plugin for Boson Higgs Audio-Driven Avatar
+Project-URL: Documentation, https://docs.livekit.io
+Project-URL: Website, https://livekit.io/
+Project-URL: Source, https://github.com/livekit/agents
+Author-email: LiveKit <support@livekit.io>
+License-Expression: Apache-2.0
+Keywords: agents,avatar,livekit,realtime,webrtc
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Topic :: Multimedia :: Sound/Audio
+Classifier: Topic :: Multimedia :: Video
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.10.0
+Requires-Dist: aiohttp>=3.10
+Requires-Dist: livekit-agents>=1.8.5
+Description-Content-Type: text/markdown
+
+# Boson Higgs Avatar plugin for LiveKit Agents
+
+Use Boson's Higgs Audio-Driven Avatar as the video output for a LiveKit voice
+agent. This is an Avatar plugin: it composes with your existing voice/LLM
+plugin and does not replace or fork it.
+
+The plugin has no dependency on Boson Voice, Boson Audio, or a particular TTS
+provider. Its input is the standard audio output of a LiveKit `AgentSession`,
+so it works with any TTS plugin, realtime model, or custom source that produces
+LiveKit audio frames. Only Avatar rendering and Avatar session lifecycle are
+Boson-specific.
+
+## Installation
+
+```shell
+pip install livekit-plugins-boson-avatar
+```
+
+Set the credentials used by your LiveKit Agent Worker:
+
+```shell
+export BOSON_API_KEY="..."
+export BOSON_AVATAR_API_URL="https://your-avatar-session-service.example/v1"
+export LIVEKIT_URL="wss://..."
+export LIVEKIT_API_KEY="..."
+export LIVEKIT_API_SECRET="..."
+```
+
+The plugin deliberately has no hard-coded provider endpoint. Your application
+or deployment environment supplies the base URL exposed by its Boson Avatar
+deployment/operator. The plugin appends `POST /sessions` when starting an
+Avatar and `DELETE /sessions/{id}` during cleanup, so do not include
+`/sessions` itself in `BOSON_AVATAR_API_URL`.
+
+Load the project-scoped Avatar catalog on your application server and use it
+to populate the face picker. The returned `avatar_id` is passed unchanged to
+`AvatarSession`; browser users never need to type or remember it:
+
+```python
+from livekit.plugins import boson_avatar
+
+
+async def avatar_options():
+    # Returns [AvatarInfo(avatar_id="...", name="...")]
+    return await boson_avatar.list_avatars()
+```
+
+This calls `GET {BOSON_AVATAR_API_URL}/avatars` with `BOSON_API_KEY`. Keep the
+key server-side and cache the result according to your application's needs.
+
+## Usage
+
+Create the voice `AgentSession` with the audio provider of your choice, then
+start the Avatar before starting the agent session:
+
+```python
+from livekit.agents import Agent, AgentSession, JobContext, inference
+from livekit.plugins import boson_avatar
+
+
+async def entrypoint(ctx: JobContext) -> None:
+    await ctx.connect()
+
+    session = AgentSession(
+        stt=inference.STT("deepgram/nova-3"),
+        llm=inference.LLM("openai/gpt-4.1-mini"),
+        tts=inference.TTS("cartesia/sonic-3"),
+    )
+    avatar = boson_avatar.AvatarSession(
+        avatar_id="your-avatar-id",
+    )
+
+    await avatar.start(session, room=ctx.room)
+    await session.start(
+        agent=Agent(instructions="You are a helpful assistant."),
+        room=ctx.room,
+    )
+```
+
+`BOSON_AVATAR_ID` can supply `avatar_id` instead. `AvatarSession` also accepts
+optional `width`, `height`, `max_duration_seconds`,
+`avatar_participant_identity`, `idempotency_key`, and `APIConnectOptions`.
+`max_duration_seconds` must be an integer from 1 through 14400.
+
+Inside a LiveKit Agent job, provider-session creation automatically derives a
+stable UUID idempotency key from the LiveKit job ID and Avatar session binding.
+If LiveKit redelivers that job after a worker crash, the plugin recovers the
+existing provider session instead of allocating another one. The standard
+model is one Avatar lifecycle per LiveKit job. If one job intentionally starts
+another Avatar after closing the first, pass a new explicit UUID
+`idempotency_key` for that lifecycle.
+
+The `avatar_id` is the value returned by `list_avatars()` behind the Avatar
+selected in your application; end users do not need to type or remember it.
+
+The plugin handles the provider API call, LiveKit participant token, PCM data
+stream routing, interruption buffer clears, and provider-session cleanup. A
+developer does not need to call Boson's Avatar REST API or combine voice and
+Avatar responses in an application server. The application server only needs
+its normal responsibility: create a LiveKit room and dispatch the Agent Worker.
+
+When started inside a LiveKit job, cleanup is registered automatically. When
+using the plugin in a standalone script or test, open LiveKit's HTTP context and
+close the Avatar explicitly:
+
+```python
+from livekit.agents import utils
+
+
+async with utils.http_context.open():
+    await avatar.start(session, room)
+    try:
+        # Run the standalone session.
+        ...
+    finally:
+        await avatar.aclose()
+```

livekit_plugins_boson_avatar-1.8.5/README.md

@@ -0,0 +1,117 @@
+# Boson Higgs Avatar plugin for LiveKit Agents
+
+Use Boson's Higgs Audio-Driven Avatar as the video output for a LiveKit voice
+agent. This is an Avatar plugin: it composes with your existing voice/LLM
+plugin and does not replace or fork it.
+
+The plugin has no dependency on Boson Voice, Boson Audio, or a particular TTS
+provider. Its input is the standard audio output of a LiveKit `AgentSession`,
+so it works with any TTS plugin, realtime model, or custom source that produces
+LiveKit audio frames. Only Avatar rendering and Avatar session lifecycle are
+Boson-specific.
+
+## Installation
+
+```shell
+pip install livekit-plugins-boson-avatar
+```
+
+Set the credentials used by your LiveKit Agent Worker:
+
+```shell
+export BOSON_API_KEY="..."
+export BOSON_AVATAR_API_URL="https://your-avatar-session-service.example/v1"
+export LIVEKIT_URL="wss://..."
+export LIVEKIT_API_KEY="..."
+export LIVEKIT_API_SECRET="..."
+```
+
+The plugin deliberately has no hard-coded provider endpoint. Your application
+or deployment environment supplies the base URL exposed by its Boson Avatar
+deployment/operator. The plugin appends `POST /sessions` when starting an
+Avatar and `DELETE /sessions/{id}` during cleanup, so do not include
+`/sessions` itself in `BOSON_AVATAR_API_URL`.
+
+Load the project-scoped Avatar catalog on your application server and use it
+to populate the face picker. The returned `avatar_id` is passed unchanged to
+`AvatarSession`; browser users never need to type or remember it:
+
+```python
+from livekit.plugins import boson_avatar
+
+
+async def avatar_options():
+    # Returns [AvatarInfo(avatar_id="...", name="...")]
+    return await boson_avatar.list_avatars()
+```
+
+This calls `GET {BOSON_AVATAR_API_URL}/avatars` with `BOSON_API_KEY`. Keep the
+key server-side and cache the result according to your application's needs.
+
+## Usage
+
+Create the voice `AgentSession` with the audio provider of your choice, then
+start the Avatar before starting the agent session:
+
+```python
+from livekit.agents import Agent, AgentSession, JobContext, inference
+from livekit.plugins import boson_avatar
+
+
+async def entrypoint(ctx: JobContext) -> None:
+    await ctx.connect()
+
+    session = AgentSession(
+        stt=inference.STT("deepgram/nova-3"),
+        llm=inference.LLM("openai/gpt-4.1-mini"),
+        tts=inference.TTS("cartesia/sonic-3"),
+    )
+    avatar = boson_avatar.AvatarSession(
+        avatar_id="your-avatar-id",
+    )
+
+    await avatar.start(session, room=ctx.room)
+    await session.start(
+        agent=Agent(instructions="You are a helpful assistant."),
+        room=ctx.room,
+    )
+```
+
+`BOSON_AVATAR_ID` can supply `avatar_id` instead. `AvatarSession` also accepts
+optional `width`, `height`, `max_duration_seconds`,
+`avatar_participant_identity`, `idempotency_key`, and `APIConnectOptions`.
+`max_duration_seconds` must be an integer from 1 through 14400.
+
+Inside a LiveKit Agent job, provider-session creation automatically derives a
+stable UUID idempotency key from the LiveKit job ID and Avatar session binding.
+If LiveKit redelivers that job after a worker crash, the plugin recovers the
+existing provider session instead of allocating another one. The standard
+model is one Avatar lifecycle per LiveKit job. If one job intentionally starts
+another Avatar after closing the first, pass a new explicit UUID
+`idempotency_key` for that lifecycle.
+
+The `avatar_id` is the value returned by `list_avatars()` behind the Avatar
+selected in your application; end users do not need to type or remember it.
+
+The plugin handles the provider API call, LiveKit participant token, PCM data
+stream routing, interruption buffer clears, and provider-session cleanup. A
+developer does not need to call Boson's Avatar REST API or combine voice and
+Avatar responses in an application server. The application server only needs
+its normal responsibility: create a LiveKit room and dispatch the Agent Worker.
+
+When started inside a LiveKit job, cleanup is registered automatically. When
+using the plugin in a standalone script or test, open LiveKit's HTTP context and
+close the Avatar explicitly:
+
+```python
+from livekit.agents import utils
+
+
+async with utils.http_context.open():
+    await avatar.start(session, room)
+    try:
+        # Run the standalone session.
+        ...
+    finally:
+        await avatar.aclose()
+```

livekit_plugins_boson_avatar-1.8.5/livekit/plugins/boson_avatar/__init__.py

@@ -0,0 +1,39 @@
+# Copyright 2026 LiveKit, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Boson Higgs Audio-Driven Avatar plugin for LiveKit Agents."""
+
+from livekit.agents import Plugin
+
+from .api import AvatarInfo, list_avatars
+from .avatar import AvatarSession
+from .errors import BosonAvatarException
+from .log import logger
+from .version import __version__
+
+__all__ = [
+    "AvatarInfo",
+    "AvatarSession",
+    "BosonAvatarException",
+    "__version__",
+    "list_avatars",
+]
+
+
+class BosonAvatarPlugin(Plugin):
+    def __init__(self) -> None:
+        super().__init__(__name__, __version__, __package__, logger)
+
+
+Plugin.register_plugin(BosonAvatarPlugin())