livekit-plugins-protoface 1.0.0__tar.gz

livekit_plugins_protoface-1.0.0/.gitignore

@@ -0,0 +1,10 @@
+.DS_Store
+.pytest_cache/
+.ruff_cache/
+.venv/
+.smoke-venv/
+__pycache__/
+*.egg-info/
+*.pyc
+dist/
+build/

livekit_plugins_protoface-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

livekit_plugins_protoface-1.0.0/PKG-INFO

@@ -0,0 +1,38 @@
+Metadata-Version: 2.4
+Name: livekit-plugins-protoface
+Version: 1.0.0
+Summary: Agent Framework plugin for Protoface avatar
+Project-URL: Documentation, https://docs.protoface.com
+Project-URL: Website, https://protoface.com/
+Project-URL: Source, https://github.com/protoface-ai/livekit-plugins-protoface
+Author-email: Protoface Team <info@protoface.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: ai,audio,avatar,livekit,protoface,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.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.6.1
+Description-Content-Type: text/markdown
+
+# Protoface plugin for LiveKit Agents
+
+Support for the [Protoface](https://protoface.com/) virtual avatar.
+
+See the [Protoface docs](https://docs.protoface.com/) for more information.
+
+## Installation
+
+```bash
+pip install livekit-plugins-protoface
+```
+
+## Pre-requisites
+
+You'll need an API key from Protoface. It can be set as an environment variable: `PROTOFACE_API_KEY`

livekit_plugins_protoface-1.0.0/README.md

@@ -0,0 +1,15 @@
+# Protoface plugin for LiveKit Agents
+
+Support for the [Protoface](https://protoface.com/) virtual avatar.
+
+See the [Protoface docs](https://docs.protoface.com/) for more information.
+
+## Installation
+
+```bash
+pip install livekit-plugins-protoface
+```
+
+## Pre-requisites
+
+You'll need an API key from Protoface. It can be set as an environment variable: `PROTOFACE_API_KEY`

livekit_plugins_protoface-1.0.0/livekit/plugins/protoface/__init__.py

@@ -0,0 +1,24 @@
+"""Protoface avatar plugin for LiveKit Agents."""
+
+from .avatar import DEFAULT_STOCK_AVATAR_ID, AvatarSession
+from .errors import ProtofaceException
+from .version import __version__
+
+__all__ = [
+    "DEFAULT_STOCK_AVATAR_ID",
+    "AvatarSession",
+    "ProtofaceException",
+    "__version__",
+]
+
+from livekit.agents import Plugin
+
+from .log import logger
+
+
+class ProtofacePlugin(Plugin):
+    def __init__(self) -> None:
+        super().__init__(__name__, __version__, __package__, logger)
+
+
+Plugin.register_plugin(ProtofacePlugin())

livekit_plugins_protoface-1.0.0/livekit/plugins/protoface/api.py

@@ -0,0 +1,199 @@
+from __future__ import annotations
+
+import asyncio
+import os
+from typing import Any
+
+import aiohttp
+
+from livekit.agents import (
+    DEFAULT_API_CONNECT_OPTIONS,
+    NOT_GIVEN,
+    APIConnectionError,
+    APIConnectOptions,
+    APIStatusError,
+    APITimeoutError,
+    NotGivenOr,
+    utils,
+)
+
+from .errors import ProtofaceException
+from .log import logger
+from .version import __version__
+
+DEFAULT_API_URL = "https://api.protoface.com"
+_USER_AGENT = f"livekit-plugins-protoface/{__version__}"
+
+
+class ProtofaceAPI:
+    """Async client for the Protoface session API."""
+
+    def __init__(
+        self,
+        *,
+        api_key: NotGivenOr[str | None] = NOT_GIVEN,
+        api_url: NotGivenOr[str | None] = NOT_GIVEN,
+        conn_options: APIConnectOptions = DEFAULT_API_CONNECT_OPTIONS,
+        session: aiohttp.ClientSession | None = None,
+    ) -> None:
+        """Create a Protoface API client.
+
+        Args:
+            api_key: Protoface API key. Defaults to the `PROTOFACE_API_KEY`
+                environment variable.
+            api_url: Protoface API base URL. Defaults to `PROTOFACE_API_URL` or
+                `https://api.protoface.com`.
+            conn_options: Timeout and retry settings for API calls.
+            session: Optional caller-owned HTTP session. When omitted, the
+                client uses LiveKit's shared HTTP session.
+
+        Raises:
+            ProtofaceException: If no API key is passed and `PROTOFACE_API_KEY`
+                is not set.
+        """
+        self._api_key = _resolve_optional_string(api_key, "PROTOFACE_API_KEY")
+        if not self._api_key:
+            raise ProtofaceException(
+                "api_key must be set by passing it to ProtofaceAPI or "
+                "setting the PROTOFACE_API_KEY environment variable"
+            )
+
+        api_url_value = _resolve_optional_string(api_url, "PROTOFACE_API_URL")
+        self._api_url = (api_url_value or DEFAULT_API_URL).rstrip("/")
+        self._conn_options = conn_options
+        self._session = session
+
+    async def start_session(
+        self,
+        *,
+        avatar_id: str,
+        transport: dict[str, Any],
+        max_duration_seconds: NotGivenOr[int | None] = NOT_GIVEN,
+    ) -> dict[str, Any]:
+        """Create a hosted Protoface avatar session.
+
+        Args:
+            avatar_id: Protoface avatar ID to render.
+            transport: Protoface transport configuration. The LiveKit Agents
+                plugin uses `audio_source="data_stream"`.
+            max_duration_seconds: Optional maximum session duration. Protoface
+                applies the lower of this value and the account plan limit.
+
+        Returns:
+            The decoded Protoface session object.
+
+        Raises:
+            APIConnectionError: If a retryable API or network error persists
+                after all retry attempts.
+            APIStatusError: If Protoface returns a non-retryable error response.
+        """
+        body: dict[str, Any] = {"avatar_id": avatar_id, "transport": transport}
+        if utils.is_given(max_duration_seconds) and max_duration_seconds is not None:
+            body["max_duration_seconds"] = max_duration_seconds
+
+        return await self._json("POST", "/v1/sessions", json=body)
+
+    async def end_session(self, session_id: str) -> dict[str, Any]:
+        """Request a graceful end for a hosted Protoface session.
+
+        Args:
+            session_id: Protoface session ID returned by `start_session()`.
+
+        Returns:
+            The decoded Protoface response body.
+
+        Raises:
+            APIConnectionError: If a retryable API or network error persists
+                after all retry attempts.
+            APIStatusError: If Protoface returns a non-retryable error response.
+        """
+        return await self._json("POST", f"/v1/sessions/{session_id}/end")
+
+    def _ensure_http_session(self) -> aiohttp.ClientSession:
+        if self._session is None:
+            self._session = utils.http_context.http_session()
+        return self._session
+
+    async def _json(
+        self,
+        method: str,
+        path: str,
+        *,
+        json: dict[str, Any] | None = None,
+        headers: dict[str, str] | None = None,
+    ) -> dict[str, Any]:
+        request_headers = {
+            "Authorization": f"Bearer {self._api_key}",
+            "User-Agent": _USER_AGENT,
+            "Accept": "application/json",
+            **(headers or {}),
+        }
+        url = f"{self._api_url}{path}"
+        error: Exception | None = None
+
+        for attempt in range(self._conn_options.max_retry + 1):
+            try:
+                async with self._ensure_http_session().request(
+                    method,
+                    url,
+                    json=json,
+                    headers=request_headers,
+                    timeout=aiohttp.ClientTimeout(total=self._conn_options.timeout),
+                ) as response:
+                    payload = await _read_payload(response)
+                    if response.ok:
+                        if not isinstance(payload, dict):
+                            raise APIStatusError(
+                                "Protoface API returned a non-object JSON response",
+                                status_code=response.status,
+                                body=payload,
+                                retryable=False,
+                            )
+                        return payload
+
+                    raise APIStatusError(
+                        "Protoface API returned an error",
+                        status_code=response.status,
+                        body=payload,
+                    )
+            except asyncio.TimeoutError as exc:
+                error = APITimeoutError()
+                error.__cause__ = exc
+            except aiohttp.ClientError as exc:
+                error = APIConnectionError()
+                error.__cause__ = exc
+            except APIStatusError as exc:
+                if not exc.retryable:
+                    raise
+                error = exc
+
+            if attempt == self._conn_options.max_retry:
+                break
+
+            logger.warning(
+                "protoface api request failed, retrying",
+                extra={"attempt": attempt + 1, "method": method, "path": path},
+            )
+            await asyncio.sleep(self._conn_options._interval_for_retry(attempt))
+
+        raise APIConnectionError("Failed to call Protoface API after all retries.") from error
+
+
+def _resolve_optional_string(value: NotGivenOr[str | None], env_name: str) -> str | None:
+    if utils.is_given(value) and value is not None:
+        return value
+    return os.getenv(env_name)
+
+
+async def _read_payload(response: aiohttp.ClientResponse) -> object:
+    text = await response.text()
+    if not text:
+        return {}
+
+    try:
+        return await response.json(content_type=None)
+    except ValueError:
+        return {"raw": text}
+
+
+__all__ = ["DEFAULT_API_URL", "ProtofaceAPI"]

livekit_plugins_protoface-1.0.0/livekit/plugins/protoface/avatar.py

@@ -0,0 +1,238 @@
+from __future__ import annotations
+
+import os
+from datetime import timedelta
+
+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 AvatarSession as BaseAvatarSession, DataStreamAudioOutput
+from livekit.agents.voice.room_io import ATTRIBUTE_PUBLISH_ON_BEHALF
+
+from .api import ProtofaceAPI
+from .errors import ProtofaceException
+from .log import logger
+
+DEFAULT_STOCK_AVATAR_ID = "av_stock_001"
+SAMPLE_RATE = 16000
+_AVATAR_AGENT_IDENTITY = "protoface-avatar-agent"
+_AVATAR_AGENT_NAME = "protoface-avatar-agent"
+_WORKER_TOKEN_TTL = timedelta(hours=1)
+
+
+class AvatarSession(BaseAvatarSession):
+    """A Protoface avatar session for LiveKit Agents."""
+
+    def __init__(
+        self,
+        *,
+        avatar_id: str = DEFAULT_STOCK_AVATAR_ID,
+        api_url: NotGivenOr[str | None] = NOT_GIVEN,
+        api_key: NotGivenOr[str | None] = NOT_GIVEN,
+        max_duration_seconds: NotGivenOr[int | None] = NOT_GIVEN,
+        avatar_participant_identity: NotGivenOr[str | None] = NOT_GIVEN,
+        avatar_participant_name: NotGivenOr[str | None] = NOT_GIVEN,
+        conn_options: APIConnectOptions = DEFAULT_API_CONNECT_OPTIONS,
+    ) -> None:
+        """Create a Protoface avatar session.
+
+        Args:
+            avatar_id: Protoface avatar ID to render. Defaults to the stable
+                stock avatar ID `av_stock_001`.
+            api_url: Protoface API base URL. Defaults to `PROTOFACE_API_URL` or
+                the public Protoface API.
+            api_key: Protoface API key. Defaults to `PROTOFACE_API_KEY`.
+            max_duration_seconds: Optional maximum session duration. Protoface
+                applies the lower of this value and the account plan limit.
+            avatar_participant_identity: LiveKit participant identity for the
+                avatar worker.
+            avatar_participant_name: Display name for the avatar participant.
+            conn_options: Timeout and retry options for Protoface API requests.
+
+        Raises:
+            ProtofaceException: If no API key is provided.
+        """
+        super().__init__()
+        self._avatar_id = avatar_id
+        self._max_duration_seconds = max_duration_seconds
+        self._avatar_participant_identity = _resolve_optional_string(
+            avatar_participant_identity,
+            _AVATAR_AGENT_IDENTITY,
+        )
+        self._avatar_participant_name = _resolve_optional_string(
+            avatar_participant_name,
+            _AVATAR_AGENT_NAME,
+        )
+        self._api = ProtofaceAPI(
+            api_key=api_key,
+            api_url=api_url,
+            conn_options=conn_options,
+        )
+        self._session_id: str | None = None
+
+    @property
+    def avatar_identity(self) -> str:
+        return self._avatar_participant_identity
+
+    @property
+    def provider(self) -> str:
+        return "protoface"
+
+    @property
+    def session_id(self) -> str | None:
+        """Protoface session ID after `start()` succeeds, otherwise `None`."""
+        return self._session_id
+
+    async def start(
+        self,
+        agent_session: AgentSession,
+        room: rtc.Room,
+        *,
+        livekit_url: NotGivenOr[str | None] = NOT_GIVEN,
+        livekit_api_key: NotGivenOr[str | None] = NOT_GIVEN,
+        livekit_api_secret: NotGivenOr[str | None] = NOT_GIVEN,
+    ) -> None:
+        """Start the Protoface session and connect it to the LiveKit room.
+
+        Args:
+            agent_session: LiveKit agent session whose audio output should be
+                routed through the avatar.
+            room: Connected LiveKit room for the agent job.
+            livekit_url: LiveKit server URL. Defaults to `LIVEKIT_URL`.
+            livekit_api_key: LiveKit API key. Defaults to `LIVEKIT_API_KEY`.
+            livekit_api_secret: LiveKit API secret. Defaults to
+                `LIVEKIT_API_SECRET`.
+
+        Raises:
+            RuntimeError: If the same `AvatarSession` is started more than once.
+            ProtofaceException: If required LiveKit credentials are missing or
+                Protoface returns an invalid session response.
+        """
+        if self._session_id is not None:
+            raise RuntimeError("AvatarSession.start() called twice; create a new AvatarSession.")
+
+        await super().start(agent_session, room)
+
+        livekit_url_value = _resolve_env_or_value(livekit_url, "LIVEKIT_URL")
+        livekit_api_key_value = _resolve_env_or_value(livekit_api_key, "LIVEKIT_API_KEY")
+        livekit_api_secret_value = _resolve_env_or_value(
+            livekit_api_secret,
+            "LIVEKIT_API_SECRET",
+        )
+        if not livekit_url_value or not livekit_api_key_value or not livekit_api_secret_value:
+            raise ProtofaceException(
+                "livekit_url, livekit_api_key, and livekit_api_secret must be set "
+                "by arguments or environment variables"
+            )
+
+        worker_token = self._mint_worker_token(
+            room=room,
+            livekit_api_key=livekit_api_key_value,
+            livekit_api_secret=livekit_api_secret_value,
+        )
+        session = await self._api.start_session(
+            avatar_id=self._avatar_id,
+            transport={
+                "type": "livekit",
+                "url": livekit_url_value,
+                "room_name": room.name,
+                "worker_token": worker_token,
+                "worker_identity": self._avatar_participant_identity,
+                "audio_source": "data_stream",
+            },
+            max_duration_seconds=self._max_duration_seconds,
+        )
+        session_id = session.get("id")
+        if not isinstance(session_id, str):
+            raise ProtofaceException("Protoface API response missing session id")
+
+        self._session_id = session_id
+        logger.debug(
+            "protoface session started",
+            extra={"session_id": self._session_id, "avatar_id": self._avatar_id},
+        )
+
+        agent_session.output.replace_audio_tail(
+            DataStreamAudioOutput(
+                room=room,
+                destination_identity=self._avatar_participant_identity,
+                sample_rate=SAMPLE_RATE,
+                wait_remote_track=rtc.TrackKind.KIND_VIDEO,
+                clear_buffer_timeout=None,
+            ),
+        )
+
+    async def aclose(self) -> None:
+        """End the Protoface session and release LiveKit avatar resources."""
+        session_id = self._session_id
+        self._session_id = None
+        try:
+            if session_id is not None:
+                try:
+                    await self._api.end_session(session_id)
+                except Exception:
+                    logger.warning(
+                        "failed to end protoface session",
+                        extra={"session_id": session_id},
+                        exc_info=True,
+                    )
+        finally:
+            await super().aclose()
+
+    def _mint_worker_token(
+        self,
+        *,
+        room: rtc.Room,
+        livekit_api_key: str,
+        livekit_api_secret: str,
+    ) -> str:
+        job_ctx = get_job_context(required=False)
+        if job_ctx is not None:
+            local_participant_identity = job_ctx.local_participant_identity
+        elif room.isconnected():
+            local_participant_identity = room.local_participant.identity
+        else:
+            raise ProtofaceException("failed to get local participant identity")
+
+        if not local_participant_identity:
+            raise ProtofaceException("failed to get local participant identity")
+
+        grants = api.VideoGrants(
+            room_join=True,
+            room=room.name,
+            can_publish=True,
+            can_subscribe=True,
+            can_publish_data=True,
+        )
+        return (
+            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(grants)
+            .with_attributes({ATTRIBUTE_PUBLISH_ON_BEHALF: local_participant_identity})
+            .with_ttl(_WORKER_TOKEN_TTL)
+            .to_jwt()
+        )
+
+
+def _resolve_optional_string(value: NotGivenOr[str | None], default: str) -> str:
+    if utils.is_given(value) and value:
+        return value
+    return default
+
+
+def _resolve_env_or_value(value: NotGivenOr[str | None], env_name: str) -> str | None:
+    if utils.is_given(value) and value is not None:
+        return value
+    return os.getenv(env_name)
+
+
+__all__ = ["DEFAULT_STOCK_AVATAR_ID", "AvatarSession"]

livekit_plugins_protoface-1.0.0/livekit/plugins/protoface/errors.py

@@ -0,0 +1,2 @@
+class ProtofaceException(Exception):
+    """Raised for Protoface configuration or protocol errors."""

livekit_plugins_protoface-1.0.0/livekit/plugins/protoface/log.py

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

livekit_plugins_protoface-1.0.0/livekit/plugins/protoface/py.typed

@@ -0,0 +1 @@
+

livekit_plugins_protoface-1.0.0/livekit/plugins/protoface/version.py

@@ -0,0 +1 @@
+__version__ = "1.0.0"

livekit_plugins_protoface-1.0.0/pyproject.toml

@@ -0,0 +1,42 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "livekit-plugins-protoface"
+dynamic = ["version"]
+description = "Agent Framework plugin for Protoface avatar"
+readme = "README.md"
+license = "Apache-2.0"
+requires-python = ">=3.10.0"
+authors = [{ name = "Protoface Team", email = "info@protoface.com" }]
+keywords = ["voice", "ai", "realtime", "audio", "video", "avatar", "livekit", "protoface"]
+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.6.1"]
+
+[project.urls]
+Documentation = "https://docs.protoface.com"
+Website = "https://protoface.com/"
+Source = "https://github.com/protoface-ai/livekit-plugins-protoface"
+
+[tool.hatch.version]
+path = "livekit/plugins/protoface/version.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["livekit"]
+
+[tool.hatch.build.targets.sdist]
+include = ["/livekit"]
+
+[tool.uv]
+exclude-newer = "7 days"
+exclude-newer-package = { livekit-agents = "0 days" }