livekit-plugins-hedra 1.3.12__py3-none-any.whl

livekit/plugins/hedra/__init__.py

@@ -0,0 +1,35 @@
+# Copyright 2023 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.
+
+
+from .avatar import AvatarSession, HedraException
+from .version import __version__
+
+__all__ = [
+    "HedraException",
+    "AvatarSession",
+    "__version__",
+]
+
+from livekit.agents import Plugin
+
+from .log import logger
+
+
+class HedraPlugin(Plugin):
+    def __init__(self) -> None:
+        super().__init__(__name__, __version__, __package__, logger)
+
+
+Plugin.register_plugin(HedraPlugin())

livekit/plugins/hedra/avatar.py

@@ -0,0 +1,159 @@
+from __future__ import annotations
+
+import asyncio
+import io
+import os
+
+import aiohttp
+from PIL.Image import Image
+
+from livekit import api, rtc
+from livekit.agents import (
+    DEFAULT_API_CONNECT_OPTIONS,
+    NOT_GIVEN,
+    AgentSession,
+    APIConnectionError,
+    APIConnectOptions,
+    APIStatusError,
+    NotGivenOr,
+    get_job_context,
+    utils,
+)
+from livekit.agents.voice.avatar import DataStreamAudioOutput
+from livekit.agents.voice.room_io import ATTRIBUTE_PUBLISH_ON_BEHALF
+
+from .log import logger
+
+DEFAULT_API_URL = "https://api.hedra.com/public/livekit/v1/session"
+SAMPLE_RATE = 16000
+_AVATAR_AGENT_IDENTITY = "hedra-avatar-agent"
+_AVATAR_AGENT_NAME = "hedra-avatar-agent"
+
+
+class HedraException(Exception):
+    """Exception for Hedra errors"""
+
+
+class AvatarSession:
+    """A Hedra avatar session"""
+
+    def __init__(
+        self,
+        *,
+        avatar_id: NotGivenOr[str | None] = NOT_GIVEN,
+        avatar_image: NotGivenOr[Image] = NOT_GIVEN,
+        api_url: NotGivenOr[str] = NOT_GIVEN,
+        api_key: NotGivenOr[str] = NOT_GIVEN,
+        avatar_participant_identity: NotGivenOr[str] = NOT_GIVEN,
+        avatar_participant_name: NotGivenOr[str] = NOT_GIVEN,
+        conn_options: APIConnectOptions = DEFAULT_API_CONNECT_OPTIONS,
+    ) -> None:
+        self._avatar_id = avatar_id
+        self._avatar_image = avatar_image
+        if not self._avatar_id and not self._avatar_image:
+            raise HedraException("avatar_id or avatar_image must be provided")
+
+        self._api_url = api_url or os.getenv("HEDRA_API_URL", DEFAULT_API_URL)
+        self._api_key = api_key or os.getenv("HEDRA_API_KEY")
+        if self._api_key is None:
+            raise HedraException(
+                "The api_key must be set either by passing api_key to the client or "
+                "by setting the HEDRA_API_KEY environment variable"
+            )
+
+        self._avatar_participant_identity = avatar_participant_identity or _AVATAR_AGENT_IDENTITY
+        self._avatar_participant_name = avatar_participant_name or _AVATAR_AGENT_NAME
+        self._http_session: aiohttp.ClientSession | None = None
+        self._conn_options = conn_options
+
+    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 or (os.getenv("LIVEKIT_URL") or NOT_GIVEN)
+        livekit_api_key = livekit_api_key or (os.getenv("LIVEKIT_API_KEY") or NOT_GIVEN)
+        livekit_api_secret = livekit_api_secret or (os.getenv("LIVEKIT_API_SECRET") or NOT_GIVEN)
+        if not livekit_url or not livekit_api_key or not livekit_api_secret:
+            raise HedraException(
+                "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))
+            # allow the avatar agent to publish audio and video on behalf of your local agent
+            .with_attributes({ATTRIBUTE_PUBLISH_ON_BEHALF: local_participant_identity})
+            .to_jwt()
+        )
+
+        logger.debug("starting avatar session")
+        await self._start_agent(livekit_url, livekit_token)
+
+        agent_session.output.audio = DataStreamAudioOutput(
+            room=room,
+            destination_identity=self._avatar_participant_identity,
+            wait_remote_track=rtc.TrackKind.KIND_VIDEO,
+            sample_rate=SAMPLE_RATE,
+        )
+
+    async def _start_agent(self, livekit_url: str, livekit_token: str) -> None:
+        assert self._api_key is not None
+        assert isinstance(self._api_url, str)
+
+        data = aiohttp.FormData({"livekit_url": livekit_url, "livekit_token": livekit_token})
+
+        if self._avatar_id:
+            data.add_field("avatar_id", self._avatar_id)
+
+        if self._avatar_image:
+            img_byte_arr = io.BytesIO()
+            self._avatar_image.save(img_byte_arr, format="JPEG", quality=95)
+            img_byte_arr.seek(0)
+            data.add_field(
+                "avatar_image", img_byte_arr, filename="avatar.jpg", content_type="image/jpeg"
+            )
+
+        for i in range(self._conn_options.max_retry):
+            try:
+                async with self._ensure_http_session().post(
+                    self._api_url,
+                    headers={
+                        "x-api-key": self._api_key,
+                    },
+                    data=data,
+                    timeout=aiohttp.ClientTimeout(sock_connect=self._conn_options.timeout),
+                ) as response:
+                    if not response.ok:
+                        text = await response.text()
+                        raise APIStatusError(
+                            "Server returned an error", status_code=response.status, body=text
+                        )
+                    return
+
+            except Exception as e:
+                if isinstance(e, APIConnectionError):
+                    logger.warning("failed to call hedra avatar api", extra={"error": str(e)})
+                else:
+                    logger.exception("failed to call hedra avatar api")
+
+                if i < self._conn_options.max_retry - 1:
+                    await asyncio.sleep(self._conn_options.retry_interval)
+
+        raise APIConnectionError("Failed to start Hedra Avatar Session after all retries")

livekit/plugins/hedra/log.py

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

livekit/plugins/hedra/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.3.12"

livekit_plugins_hedra-1.3.12.dist-info/METADATA

@@ -0,0 +1,38 @@
+Metadata-Version: 2.4
+Name: livekit-plugins-hedra
+Version: 1.3.12
+Summary: Agent Framework plugin for Hedra 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,hedra,livekit,realtime,video,voice
+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.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Topic :: Multimedia :: Sound/Audio
+Classifier: Topic :: Multimedia :: Video
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.9.0
+Requires-Dist: livekit-agents>=1.3.12
+Description-Content-Type: text/markdown
+
+# Hedra plugin for LiveKit Agents
+
+Support for avatar generation and animation with [Hedra](https://hedra.ai/).
+
+See [https://docs.livekit.io/agents/integrations/avatar/hedra/](https://docs.livekit.io/agents/integrations/avatar/hedra/) for more information.
+
+## Installation
+
+```bash
+pip install livekit-plugins-hedra
+```
+
+## Pre-requisites
+
+You'll need an API key from Hedra. It can be set as an environment variable: `HEDRA_API_KEY`

livekit_plugins_hedra-1.3.12.dist-info/RECORD

@@ -0,0 +1,8 @@
+livekit/plugins/hedra/__init__.py,sha256=L8F2XyHfOLqeB6Y4iSvQNCUOW5KKIBw6HgF5MNCdvNY,969
+livekit/plugins/hedra/avatar.py,sha256=TcTaPSX-Gl-rqpfzfWIAVmlHknepexg6NWtv39rNEBg,6082
+livekit/plugins/hedra/log.py,sha256=vh-X7bs38yHVN8TNZcWVBvBcnALN-M_UGvWIgI6zi7k,68
+livekit/plugins/hedra/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+livekit/plugins/hedra/version.py,sha256=UoTDvF115mviqqMEpGToG4ItmCSiA1i3wTiugW1Dyw8,601
+livekit_plugins_hedra-1.3.12.dist-info/METADATA,sha256=FjBUJ9iHsXSa-upA7WIfD9IgP1LDrxRzfaYaXjqvUX4,1408
+livekit_plugins_hedra-1.3.12.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+livekit_plugins_hedra-1.3.12.dist-info/RECORD,,

livekit_plugins_hedra-1.3.12.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any