liveavatar-platform-rtc 1.0.0__py3-none-any.whl

liveavatar_platform_rtc-1.0.0.dist-info/METADATA

@@ -0,0 +1,170 @@
+Metadata-Version: 2.4
+Name: liveavatar-platform-rtc
+Version: 1.0.0
+Summary: Live Avatar Platform RTC Python SDK — agent SDK for LiveKit-based real-time digital human
+Author: Live Avatar Team
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: asr,avatar,digital-human,live-avatar,livekit,rtc,tts
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.25
+Requires-Dist: livekit>=1.0
+Requires-Dist: numpy>=1.24
+Provides-Extra: dev
+Requires-Dist: black; extra == 'dev'
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-asyncio; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Requires-Dist: twine; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Live Avatar Platform RTC Python SDK
+
+[中文文档](README.zh.md)
+
+Backend agent SDK for Live Avatar **Platform RTC** mode. Your application owns
+ASR, LLM, and TTS. The SDK connects that pipeline to the platform LiveKit room:
+user audio arrives as PCM frames, and your TTS PCM frames drive avatar speech.
+There is no platform-TTS or text-input compatibility API in this package.
+
+**Version 1.0.0** — breaking Platform RTC Agent API for developer-owned
+ASR/LLM/TTS pipelines.
+
+## Install
+
+```bash
+pip install liveavatar-platform-rtc
+```
+
+Python 3.10 or newer is required.
+
+## Development install
+
+```bash
+pip install -e ".[dev]"
+```
+
+## Minimal agent
+
+```python
+import asyncio
+import os
+from liveavatar_rtc import AudioFrame, PlatformRTCClient
+
+client = PlatformRTCClient(
+    api_key=os.environ["LIVEAVATAR_API_KEY"],
+    avatar_id=os.environ["LIVEAVATAR_AVATAR_ID"],
+    input_sample_rate=16000,
+    output_sample_rate=24000,
+)
+
+async with client as session:
+    print(session.frontend_connection)  # distribute to your frontend
+    pipeline_input: asyncio.Queue[AudioFrame] = asyncio.Queue()
+
+    @session.on("user_audio_frame")
+    async def on_user_audio(frame: AudioFrame) -> None:
+        # Feed your ASR/Omni model, then publish your own TTS frames.
+        await pipeline_input.put(frame)
+
+    await session.wait_for_user(timeout=30)
+    await session.wait_for_scene_ready(timeout=30)
+    await asyncio.Event().wait()
+```
+
+See [`examples/basic_agent.py`](examples/basic_agent.py) for a syntactically
+runnable, provider-free pipeline skeleton. It connects and consumes user audio,
+but intentionally produces no avatar speech until real developer ASR, LLM, and
+TTS are integrated; it prints this warning at startup.
+
+For the full Platform RTC protocol model, see [`PROTOCOL.md`](PROTOCOL.md).
+
+## Connection and readiness stages
+
+1. `await client.connect()` (or enter the context manager) starts the platform
+   session and connects the backend agent to LiveKit.
+2. Send `session.frontend_connection` to the frontend. It contains only the
+   user's `user_token` and `sfu_url`; never send the API key or agent token.
+3. `await session.wait_for_user()` waits for that frontend user to join.
+4. `await session.wait_for_scene_ready()` waits for the coordinator's
+   `scene.ready` event. Start avatar output after this stage.
+
+The observable flags are `is_agent_connected`, `is_user_joined`,
+`is_user_audio_subscribed`, `is_scene_ready`, `is_closing`, and `is_closed`.
+Wait methods raise `SessionWaitTimeoutError` on timeout and
+`SessionClosedError` if the session closes first.
+
+## Developer-owned audio pipeline
+
+The SDK emits `user_audio_frame` with mono PCM16 resampled to
+`input_sample_rate` (16 kHz by default), ready for developer-owned ASR or an
+omni model. Your LLM and TTS remain entirely in your backend.
+
+Publish TTS with `await session.publish_audio(frame)` or stream an async
+iterable with `await session.publish_audio_stream(frames)`. Output must be mono
+PCM16 at the negotiated output rate. The recommended and client default rate is
+24 kHz. A session-start response may override `output_sample_rate`; the SDK
+validates against that server-selected rate. LiveKit, not application code,
+owns real-time playout buffering and Opus encoding.
+
+```python
+async def tts_frames():
+    async for pcm in my_streaming_tts():
+        yield AudioFrame.from_pcm(pcm, sample_rate=24000)
+
+await session.publish_audio_stream(tts_frames())
+```
+
+Only one output stream may be active. `await session.interrupt(request_id)`
+cancels it, clears queued playout, sends `control.interrupt`, and emits the
+local `interrupted` hook. Use that hook to cancel your LLM/TTS provider too.
+
+## Events and protocol hooks
+
+Register handlers with `@session.on(event_name)`. Common SDK events are
+`USER_AUDIO_FRAME`, `USER_JOINED`, `USER_LEFT`, `SCENE_READY`,
+`SESSION_STATE`, `SESSION_CLOSING`, `DISCONNECTED`, `ERROR`, and
+`CUSTOM_EVENT`. Unknown data-channel envelopes are delivered as
+`CUSTOM_EVENT` without discarding their metadata.
+
+RTC Agent protocol packets are reliable LiveKit Data Channel messages without a
+required topic. The SDK dispatches by the JSON `event` field and does not filter
+incoming packets by topic. `DataChannelEvent.topic` is retained only for
+diagnostics when a participant supplies one.
+
+Developer ASR/VAD and application-specific observability integrations can use:
+
+```python
+await session.send_voice_start(request_id)
+await session.send_asr_partial(request_id, text, seq)
+await session.send_voice_finish(request_id)
+await session.send_asr_final(request_id, text)
+await session.send_custom_event("vendor.event", {"value": 1})
+```
+
+The RTC SDK does not provide `response.chunk` / `response.done` helpers. Avatar
+speech is driven by the developer-published LiveKit audio track, not by platform
+text TTS. If your application needs subtitles or diagnostics, send an explicit
+custom event that your own frontend or backend understands.
+
+Close with `await session.close()` or leave the client context manager. The
+context manager also stops the remote platform session.
+
+## Scope
+
+This package is only for Platform RTC agent backends. It transports PCM audio
+over LiveKit audio tracks and structured control events over the LiveKit data
+channel. Its public surface contains only the v2 Platform RTC agent API, without
+legacy compatibility aliases.

liveavatar_platform_rtc-1.0.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+liveavatar_rtc/__init__.py,sha256=yUNsjRkcWim0zYOraXK_KaKyi8IDk9lZP1uf40h3ygE,1523
+liveavatar_rtc/api_client.py,sha256=PMFQoWCQM6Ao40Qe4rW5Ho_Rq_vRapljnDiKZsFzAIc,2419
+liveavatar_rtc/client.py,sha256=jjZhRTUzKKnRykWm-kj73tBPitIS8R1JTxhU5ui65eU,6649
+liveavatar_rtc/errors.py,sha256=wJ8aBRlE1dwfEflG-0lS8ieEyGJAbsNecK_nRqdP6GE,649
+liveavatar_rtc/event_dispatcher.py,sha256=J_R3zZoYu_hsfZAf5EQC1tnvAw7SVH6m2KghPvFAHO8,1527
+liveavatar_rtc/livekit_manager.py,sha256=Vas9_IxBO4V7sWxwkD-R3vcEdcrVhSDfvMzLFCvTDHA,17465
+liveavatar_rtc/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+liveavatar_rtc/session.py,sha256=8sVbLnOdWugaaYhQ0-MYHt0I3fU-8AHRWJ-DWOlMnNE,11283
+liveavatar_rtc/types.py,sha256=mljBFetXZrBN0Jt_wWbq9qQ7t5gt3ERhf-c7Yaq-Vos,2491
+liveavatar_platform_rtc-1.0.0.dist-info/METADATA,sha256=jEfC5JC9-0czuGBax7HrU_uNKM22Q9BWm1yZ9AbkoRU,6634
+liveavatar_platform_rtc-1.0.0.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
+liveavatar_platform_rtc-1.0.0.dist-info/licenses/LICENSE,sha256=UOZ1F5fFDe3XXvG4oNnkL1-Ecun7zpHzRxjp-XsMeAo,11324
+liveavatar_platform_rtc-1.0.0.dist-info/RECORD,,

liveavatar_platform_rtc-1.0.0.dist-info/WHEEL

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

liveavatar_platform_rtc-1.0.0.dist-info/licenses/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.

liveavatar_rtc/__init__.py

@@ -0,0 +1,73 @@
+from importlib.metadata import PackageNotFoundError, version
+
+from .errors import (
+    APIError,
+    AudioFormatError,
+    AudioPublishError,
+    DataChannelProtocolError,
+    RTCConnectionError,
+    RTCSDKError,
+    SessionClosedError,
+    SessionStartError,
+    SessionWaitTimeoutError,
+)
+from .client import PlatformRTCClient
+from .session import (
+    CUSTOM_EVENT,
+    DISCONNECTED,
+    ERROR,
+    IDLE_TRIGGER,
+    SCENE_READY,
+    SESSION_CLOSING,
+    SESSION_STATE,
+    USER_AUDIO_FRAME,
+    USER_AUDIO_TRACK_SUBSCRIBED,
+    USER_AUDIO_TRACK_UNSUBSCRIBED,
+    USER_JOINED,
+    USER_LEFT,
+    Session,
+)
+from .types import (
+    AudioFrame,
+    AudioTrackInfo,
+    DataChannelEvent,
+    FrontendConnection,
+    SessionInfo,
+)
+
+try:
+    __version__ = version("liveavatar-platform-rtc")
+except PackageNotFoundError:
+    __version__ = "0.0.0"
+
+__all__ = [
+    "__version__",
+    "RTCSDKError",
+    "APIError",
+    "SessionStartError",
+    "RTCConnectionError",
+    "SessionClosedError",
+    "SessionWaitTimeoutError",
+    "AudioFormatError",
+    "AudioPublishError",
+    "DataChannelProtocolError",
+    "FrontendConnection",
+    "SessionInfo",
+    "DataChannelEvent",
+    "AudioFrame",
+    "AudioTrackInfo",
+    "PlatformRTCClient",
+    "Session",
+    "SCENE_READY",
+    "SESSION_STATE",
+    "SESSION_CLOSING",
+    "IDLE_TRIGGER",
+    "ERROR",
+    "CUSTOM_EVENT",
+    "USER_AUDIO_FRAME",
+    "USER_AUDIO_TRACK_SUBSCRIBED",
+    "USER_AUDIO_TRACK_UNSUBSCRIBED",
+    "USER_JOINED",
+    "USER_LEFT",
+    "DISCONNECTED",
+]

liveavatar_rtc/api_client.py

@@ -0,0 +1,75 @@
+import httpx
+
+from .errors import APIError, SessionStartError
+from .types import SessionInfo
+
+
+class ApiClient:
+    """REST client for Live Avatar platform session management."""
+
+    def __init__(
+        self,
+        api_key: str,
+        base_url: str = "https://facemarket.ai/vih/dispatcher",
+        sandbox: bool = False,
+    ) -> None:
+        self._api_key = api_key
+        self._base_url = base_url.rstrip("/")
+        self._sandbox = sandbox
+        self._client = httpx.AsyncClient(timeout=httpx.Timeout(30.0))
+
+    async def aclose(self) -> None:
+        await self._client.aclose()
+
+    def _headers(self) -> dict[str, str]:
+        h = {
+            "Authorization": f"Bearer {self._api_key}",
+            "Content-Type": "application/json",
+        }
+        if self._sandbox:
+            h["X-Env-Sandbox"] = "true"
+        return h
+
+    async def start_session(self, avatar_id: str) -> SessionInfo:
+        resp = await self._client.post(
+            f"{self._base_url}/v1/session/start",
+            headers=self._headers(),
+            json={"avatarId": avatar_id, "mode": "rtcAgent"},
+        )
+        resp.raise_for_status()
+        payload: dict = resp.json()
+
+        if payload.get("code") != 0:
+            raise APIError(
+                payload.get("code"), payload.get("message", "unknown error")
+            )
+
+        data = payload.get("data") or {}
+        session_id = data.get("sessionId", "")
+        sfu_url = data.get("sfuUrl", "")
+        agent_token = data.get("agentToken", "")
+        if not session_id or not sfu_url or not agent_token:
+            raise SessionStartError(
+                "session response is missing sessionId, sfuUrl, or agentToken"
+            )
+
+        return SessionInfo(
+            session_id=session_id,
+            agent_token=agent_token,
+            user_token=data.get("userToken", ""),
+            sfu_url=sfu_url,
+            output_sample_rate=data.get("outputSampleRate"),
+        )
+
+    async def stop_session(self, session_id: str) -> None:
+        resp = await self._client.post(
+            f"{self._base_url}/v1/session/stop",
+            headers=self._headers(),
+            json={"sessionId": session_id},
+        )
+        resp.raise_for_status()
+        data: dict = resp.json()
+        if data.get("code") != 0:
+            raise APIError(
+                data.get("code", -1), data.get("message", "unknown error")
+            )