livekit-plugins-did 1.5.3__tar.gz

livekit_plugins_did-1.5.3/.gitignore

@@ -0,0 +1,179 @@
+**/.vscode
+**/.DS_Store
+
+# 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_did-1.5.3/PKG-INFO

@@ -0,0 +1,57 @@
+Metadata-Version: 2.4
+Name: livekit-plugins-did
+Version: 1.5.3
+Summary: Agent Framework plugin for D-ID 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: ai,audio,avatar,d-id,livekit,realtime,video,voice,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: livekit-agents>=1.5.3
+Description-Content-Type: text/markdown
+
+# D-ID plugin for LiveKit Agents
+
+Support for the [D-ID](https://d-id.com/) virtual avatar.
+
+See the [D-ID integration docs](https://docs.livekit.io/agents/models/avatar/plugins/did/) for more information.
+
+## Installation
+
+```bash
+pip install livekit-plugins-did
+```
+
+## Pre-requisites
+
+You'll need an API key from D-ID. It can be set as an environment variable: `DID_API_KEY`
+
+## Supported avatars
+
+This plugin only supports **v4 avatars** (type: `expressive`). Earlier avatar versions are not compatible. See the [D-ID Create Agent API](https://docs.d-id.com/reference/createagent) for details on creating a compatible agent.
+
+Example — creating an expressive agent via the D-ID API:
+```bash
+curl -X POST https://api.d-id.com/agents \
+  -H "Authorization: Basic <YOUR_API_KEY>" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "presenter": {
+      "type": "expressive",
+      "presenter_id": "public_mia_elegant@avt_TJ0Tq5"
+    },
+    "preview_name": "My Expressive Agent"
+  }'
+```
+
+Use the agent ID from the response as the `agent_id` parameter in the plugin.

livekit_plugins_did-1.5.3/README.md

@@ -0,0 +1,35 @@
+# D-ID plugin for LiveKit Agents
+
+Support for the [D-ID](https://d-id.com/) virtual avatar.
+
+See the [D-ID integration docs](https://docs.livekit.io/agents/models/avatar/plugins/did/) for more information.
+
+## Installation
+
+```bash
+pip install livekit-plugins-did
+```
+
+## Pre-requisites
+
+You'll need an API key from D-ID. It can be set as an environment variable: `DID_API_KEY`
+
+## Supported avatars
+
+This plugin only supports **v4 avatars** (type: `expressive`). Earlier avatar versions are not compatible. See the [D-ID Create Agent API](https://docs.d-id.com/reference/createagent) for details on creating a compatible agent.
+
+Example — creating an expressive agent via the D-ID API:
+```bash
+curl -X POST https://api.d-id.com/agents \
+  -H "Authorization: Basic <YOUR_API_KEY>" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "presenter": {
+      "type": "expressive",
+      "presenter_id": "public_mia_elegant@avt_TJ0Tq5"
+    },
+    "preview_name": "My Expressive Agent"
+  }'
+```
+
+Use the agent ID from the response as the `agent_id` parameter in the plugin.

livekit_plugins_did-1.5.3/livekit/plugins/did/__init__.py

@@ -0,0 +1,42 @@
+# Copyright 2025 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.
+
+"""D-ID virtual avatar plugin for LiveKit Agents
+
+See https://docs.livekit.io/agents/integrations/avatar/did/ for more information.
+"""
+
+from .avatar import AvatarSession
+from .errors import DIDException
+from .types import AudioConfig
+from .version import __version__
+
+__all__ = [
+    "AudioConfig",
+    "AvatarSession",
+    "DIDException",
+    "__version__",
+]
+
+from livekit.agents import Plugin
+
+from .log import logger
+
+
+class DIDPlugin(Plugin):
+    def __init__(self) -> None:
+        super().__init__(__name__, __version__, __package__, logger)
+
+
+Plugin.register_plugin(DIDPlugin())

livekit_plugins_did-1.5.3/livekit/plugins/did/api.py

@@ -0,0 +1,92 @@
+import asyncio
+import os
+from typing import Any
+
+import aiohttp
+
+from livekit.agents import (
+    DEFAULT_API_CONNECT_OPTIONS,
+    NOT_GIVEN,
+    APIConnectionError,
+    APIConnectOptions,
+    APIStatusError,
+    NotGivenOr,
+    utils,
+)
+
+from .errors import DIDException
+from .log import logger
+
+DEFAULT_API_URL = "https://api.d-id.com"
+
+
+class DIDAPI:
+    def __init__(
+        self,
+        api_key: NotGivenOr[str] = NOT_GIVEN,
+        api_url: NotGivenOr[str] = NOT_GIVEN,
+        *,
+        conn_options: APIConnectOptions = DEFAULT_API_CONNECT_OPTIONS,
+        session: aiohttp.ClientSession | None = None,
+    ) -> None:
+        did_api_key = api_key if utils.is_given(api_key) else os.getenv("DID_API_KEY")
+        if not did_api_key:
+            raise DIDException("DID_API_KEY must be set")
+        self._api_key = did_api_key
+
+        self._api_url = api_url if utils.is_given(api_url) else DEFAULT_API_URL
+        self._conn_options = conn_options
+        self._session = session or aiohttp.ClientSession()
+
+    async def join_session(
+        self,
+        *,
+        agent_id: str,
+        transport: dict[str, Any],
+        audio_config: dict[str, Any],
+    ) -> str:
+        """Dispatch a D-ID avatar worker into the room.
+
+        Returns the session id.
+        """
+        payload: dict[str, Any] = {
+            "transport": transport,
+            "audio_config": audio_config,
+        }
+        response_data = await self._post(f"v2/agents/{agent_id}/sessions/join", payload)
+        return response_data["id"]  # type: ignore
+
+    async def _post(self, endpoint: str, payload: dict[str, Any]) -> dict[str, Any]:
+        url = f"{self._api_url}/{endpoint}"
+        num_attempts = self._conn_options.max_retry + 1
+        for attempt in range(num_attempts):
+            try:
+                async with self._session.post(
+                    url,
+                    headers={
+                        "Content-Type": "application/json",
+                        "Authorization": f"Basic {self._api_key}",
+                    },
+                    json=payload,
+                    timeout=aiohttp.ClientTimeout(sock_connect=self._conn_options.timeout),
+                ) as response:
+                    if not response.ok:
+                        text = await response.text()
+                        raise APIStatusError(
+                            "D-ID API error",
+                            status_code=response.status,
+                            body=text,
+                        )
+                    return await response.json()  # type: ignore
+            except APIStatusError:
+                raise
+            except (aiohttp.ClientError, asyncio.TimeoutError) as e:
+                logger.warning(
+                    f"D-ID API request failed (attempt {attempt + 1}/{num_attempts})",
+                    extra={"error": str(e)},
+                )
+                if attempt == num_attempts - 1:
+                    raise APIConnectionError(f"Failed to connect to D-ID API at {url}") from e
+                await asyncio.sleep(self._conn_options.retry_interval)
+
+        raise APIConnectionError(f"Failed to connect to D-ID API at {url}")

livekit_plugins_did-1.5.3/livekit/plugins/did/avatar.py

@@ -0,0 +1,126 @@
+from __future__ import annotations
+
+import os
+
+import aiohttp
+
+from livekit import api, rtc
+from livekit.agents import (
+    DEFAULT_API_CONNECT_OPTIONS,
+    NOT_GIVEN,
+    AgentSession,
+    APIConnectOptions,
+    NotGivenOr,
+    get_job_context,
+    utils,
+)
+from livekit.agents.voice.avatar import DataStreamAudioOutput
+from livekit.agents.voice.room_io import ATTRIBUTE_PUBLISH_ON_BEHALF
+
+from .api import DIDAPI
+from .errors import DIDException
+from .log import logger
+from .types import AudioConfig
+
+_AVATAR_AGENT_IDENTITY = "d-id-avatar-agent"
+_AVATAR_AGENT_NAME = "d-id-avatar-agent"
+
+
+class AvatarSession:
+    """A D-ID avatar session"""
+
+    def __init__(
+        self,
+        *,
+        agent_id: str,
+        api_url: NotGivenOr[str] = NOT_GIVEN,
+        api_key: NotGivenOr[str] = NOT_GIVEN,
+        audio_config: AudioConfig | None = None,
+        avatar_participant_identity: NotGivenOr[str] = NOT_GIVEN,
+        avatar_participant_name: NotGivenOr[str] = NOT_GIVEN,
+        conn_options: APIConnectOptions = DEFAULT_API_CONNECT_OPTIONS,
+    ) -> None:
+        self._http_session: aiohttp.ClientSession | None = None
+        self._conn_options = conn_options
+        self._agent_id = agent_id
+        self._audio_config = audio_config or AudioConfig()
+        self.session_id: str | None = None
+
+        self._api = DIDAPI(
+            api_url=api_url,
+            api_key=api_key,
+            conn_options=conn_options,
+            session=self._ensure_http_session(),
+        )
+
+        self._avatar_participant_identity = (
+            avatar_participant_identity
+            if utils.is_given(avatar_participant_identity)
+            else _AVATAR_AGENT_IDENTITY
+        )
+        self._avatar_participant_name = (
+            avatar_participant_name
+            if utils.is_given(avatar_participant_name)
+            else _AVATAR_AGENT_NAME
+        )
+
+    def _ensure_http_session(self) -> aiohttp.ClientSession:
+        if self._http_session is None:
+            self._http_session = utils.http_context.http_session()
+
+        return self._http_session
+
+    async def start(
+        self,
+        agent_session: AgentSession,
+        room: rtc.Room,
+        *,
+        livekit_url: NotGivenOr[str] = NOT_GIVEN,
+        livekit_api_key: NotGivenOr[str] = NOT_GIVEN,
+        livekit_api_secret: NotGivenOr[str] = NOT_GIVEN,
+    ) -> None:
+        _livekit_url = livekit_url if utils.is_given(livekit_url) else os.getenv("LIVEKIT_URL")
+        _livekit_api_key = (
+            livekit_api_key if utils.is_given(livekit_api_key) else os.getenv("LIVEKIT_API_KEY")
+        )
+        _livekit_api_secret = (
+            livekit_api_secret
+            if utils.is_given(livekit_api_secret)
+            else os.getenv("LIVEKIT_API_SECRET")
+        )
+        if not _livekit_url or not _livekit_api_key or not _livekit_api_secret:
+            raise DIDException(
+                "livekit_url, livekit_api_key, and livekit_api_secret must be set "
+                "by arguments or environment variables"
+            )
+
+        job_ctx = get_job_context()
+        local_participant_identity = job_ctx.local_participant_identity
+        livekit_token = (
+            api.AccessToken(api_key=_livekit_api_key, api_secret=_livekit_api_secret)
+            .with_kind("agent")
+            .with_identity(self._avatar_participant_identity)
+            .with_name(self._avatar_participant_name)
+            .with_grants(api.VideoGrants(room_join=True, room=room.name))
+            .with_attributes({ATTRIBUTE_PUBLISH_ON_BEHALF: local_participant_identity})
+            .to_jwt()
+        )
+
+        logger.debug("starting avatar session")
+        self.session_id = await self._api.join_session(
+            agent_id=self._agent_id,
+            transport={
+                "provider": "livekit",
+                "server_url": _livekit_url,
+                "token": livekit_token,
+                "room_name": room.name,
+            },
+            audio_config={"sample_rate": self._audio_config.sample_rate},
+        )
+
+        agent_session.output.audio = DataStreamAudioOutput(
+            room=room,
+            destination_identity=self._avatar_participant_identity,
+            sample_rate=self._audio_config.sample_rate,
+            wait_remote_track=rtc.TrackKind.KIND_VIDEO,
+        )

livekit_plugins_did-1.5.3/livekit/plugins/did/errors.py

@@ -0,0 +1,4 @@
+class DIDException(Exception):
+    """Custom exception for D-ID API errors."""
+
+    pass

livekit_plugins_did-1.5.3/livekit/plugins/did/log.py

@@ -0,0 +1,3 @@
+import logging
+
+logger = logging.getLogger("livekit.plugins.did")

livekit_plugins_did-1.5.3/livekit/plugins/did/types.py

@@ -0,0 +1,14 @@
+from dataclasses import dataclass
+
+DEFAULT_SAMPLE_RATE = 24000
+
+
+@dataclass
+class AudioConfig:
+    """Configuration for the audio sent to the D-ID avatar.
+
+    Attributes:
+        sample_rate: Sample rate in Hz. Supported values: 16000, 24000, 48000.
+    """
+
+    sample_rate: int = DEFAULT_SAMPLE_RATE

livekit_plugins_did-1.5.3/livekit/plugins/did/version.py

@@ -0,0 +1,15 @@
+# Copyright 2025 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.
+
+__version__ = "1.5.3"

livekit_plugins_did-1.5.3/pyproject.toml

@@ -0,0 +1,38 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "livekit-plugins-did"
+dynamic = ["version"]
+description = "Agent Framework plugin for D-ID avatar"
+readme = "README.md"
+license = "Apache-2.0"
+requires-python = ">=3.10.0"
+authors = [{ name = "LiveKit", email = "support@livekit.io" }]
+keywords = ["voice", "ai", "realtime", "audio", "video", "avatar", "d-id", "livekit", "webrtc"]
+classifiers = [
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Topic :: Multimedia :: Sound/Audio",
+    "Topic :: Multimedia :: Video",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3 :: Only",
+]
+dependencies = ["livekit-agents>=1.5.3"]
+
+[project.urls]
+Documentation = "https://docs.livekit.io"
+Website = "https://livekit.io/"
+Source = "https://github.com/livekit/agents"
+
+[tool.hatch.version]
+path = "livekit/plugins/did/version.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["livekit"]
+
+[tool.hatch.build.targets.sdist]
+include = ["/livekit"]