Merge remote-tracking branch 'origin/main' into typester/audio-filter-plugin

Author: typester

.gitattributes

@@ -1,5 +1,6 @@
 **/*.dll filter=lfs diff=lfs merge=lfs -text
 **/*.so filter=lfs diff=lfs merge=lfs -text
 **/*.dylib filter=lfs diff=lfs merge=lfs -text
+**/*.jpg filter=lfs diff=lfs merge=lfs -text
 livekit-protocol/livekit/protocol/** linguist-generated=true
 livekit-rtc/livekit/rtc/_proto/** linguist-generated=true

.github/banner_dark.png

@@ -29,7 +29,7 @@ jobs:
         run: python -m pip install --upgrade mypy
 
       - name: Install packages
-        run: python -m pip install pytest ./livekit-api ./livekit-protocol ./livekit-rtc
+        run: python -m pip install pytest ./livekit-api ./livekit-protocol ./livekit-rtc pydantic
 
       - name: Check Types
         run: python -m mypy --install-type --non-interactive -p 'livekit-protocol' -p 'livekit-api' -p 'livekit-rtc'

.github/banner_light.png

@@ -23,5 +23,5 @@ jobs:
       - name: Run tests
         run: |
           python3 ./livekit-rtc/rust-sdks/download_ffi.py --output livekit-rtc/livekit/rtc/resources
-          pip3 install pytest ./livekit-protocol ./livekit-api ./livekit-rtc
+          pip3 install pytest ./livekit-protocol ./livekit-api ./livekit-rtc pydantic
           pytest . --ignore=livekit-rtc/rust-sdks

.github/workflows/check-types.yml

@@ -13,9 +13,7 @@
 # 📹🎙️🐍 Python SDK for LiveKit
 
 <!--BEGIN_DESCRIPTION-->
-
 Use this SDK to add realtime video, audio and data features to your Python app. By connecting to <a href="https://livekit.io/">LiveKit</a> Cloud or a self-hosted server, you can quickly build applications such as multi-modal AI, live streaming, or video calls with just a few lines of code.
-
 <!--END_DESCRIPTION-->
 
 This repo contains two packages
@@ -210,14 +208,13 @@ You may throw errors of the type `RpcError` with a string `message` in an RPC me
 Please join us on [Slack](https://livekit.io/join-slack) to get help from our devs / community members. We welcome your contributions(PRs) and details can be discussed there.
 
 <!--BEGIN_REPO_NAV-->
-
 <br/><table>
-
 <thead><tr><th colspan="2">LiveKit Ecosystem</th></tr></thead>
 <tbody>
-<tr><td>Realtime SDKs</td><td><a href="https://github.com/livekit/components-js">React Components</a> · <a href="https://github.com/livekit/client-sdk-js">Browser</a> · <a href="https://github.com/livekit/components-swift">Swift Components</a> · <a href="https://github.com/livekit/client-sdk-swift">iOS/macOS/visionOS</a> · <a href="https://github.com/livekit/client-sdk-android">Android</a> · <a href="https://github.com/livekit/client-sdk-flutter">Flutter</a> · <a href="https://github.com/livekit/client-sdk-react-native">React Native</a> · <a href="https://github.com/livekit/rust-sdks">Rust</a> · <a href="https://github.com/livekit/node-sdks">Node.js</a> · <b>Python</b> · <a href="https://github.com/livekit/client-sdk-unity-web">Unity (web)</a> · <a href="https://github.com/livekit/client-sdk-unity">Unity (beta)</a></td></tr><tr></tr>
-<tr><td>Server APIs</td><td><a href="https://github.com/livekit/node-sdks">Node.js</a> · <a href="https://github.com/livekit/server-sdk-go">Golang</a> · <a href="https://github.com/livekit/server-sdk-ruby">Ruby</a> · <a href="https://github.com/livekit/server-sdk-kotlin">Java/Kotlin</a> · <b>Python</b> · <a href="https://github.com/livekit/rust-sdks">Rust</a> · <a href="https://github.com/agence104/livekit-server-sdk-php">PHP (community)</a></td></tr><tr></tr>
-<tr><td>Agents Frameworks</td><td><a href="https://github.com/livekit/agents">Python</a> · <a href="https://github.com/livekit/agent-playground">Playground</a></td></tr><tr></tr>
+<tr><td>LiveKit SDKs</td><td><a href="https://github.com/livekit/client-sdk-js">Browser</a> · <a href="https://github.com/livekit/client-sdk-swift">iOS/macOS/visionOS</a> · <a href="https://github.com/livekit/client-sdk-android">Android</a> · <a href="https://github.com/livekit/client-sdk-flutter">Flutter</a> · <a href="https://github.com/livekit/client-sdk-react-native">React Native</a> · <a href="https://github.com/livekit/rust-sdks">Rust</a> · <a href="https://github.com/livekit/node-sdks">Node.js</a> · <b>Python</b> · <a href="https://github.com/livekit/client-sdk-unity">Unity</a> · <a href="https://github.com/livekit/client-sdk-unity-web">Unity (WebGL)</a></td></tr><tr></tr>
+<tr><td>Server APIs</td><td><a href="https://github.com/livekit/node-sdks">Node.js</a> · <a href="https://github.com/livekit/server-sdk-go">Golang</a> · <a href="https://github.com/livekit/server-sdk-ruby">Ruby</a> · <a href="https://github.com/livekit/server-sdk-kotlin">Java/Kotlin</a> · <b>Python</b> · <a href="https://github.com/livekit/rust-sdks">Rust</a> · <a href="https://github.com/agence104/livekit-server-sdk-php">PHP (community)</a> · <a href="https://github.com/pabloFuente/livekit-server-sdk-dotnet">.NET (community)</a></td></tr><tr></tr>
+<tr><td>UI Components</td><td><a href="https://github.com/livekit/components-js">React</a> · <a href="https://github.com/livekit/components-android">Android Compose</a> · <a href="https://github.com/livekit/components-swift">SwiftUI</a></td></tr><tr></tr>
+<tr><td>Agents Frameworks</td><td><a href="https://github.com/livekit/agents">Python</a> · <a href="https://github.com/livekit/agents-js">Node.js</a> · <a href="https://github.com/livekit/agent-playground">Playground</a></td></tr><tr></tr>
 <tr><td>Services</td><td><a href="https://github.com/livekit/livekit">LiveKit server</a> · <a href="https://github.com/livekit/egress">Egress</a> · <a href="https://github.com/livekit/ingress">Ingress</a> · <a href="https://github.com/livekit/sip">SIP</a></td></tr><tr></tr>
 <tr><td>Resources</td><td><a href="https://docs.livekit.io">Docs</a> · <a href="https://github.com/livekit-examples">Example apps</a> · <a href="https://livekit.io/cloud">Cloud</a> · <a href="https://docs.livekit.io/home/self-hosting/deployment">Self-hosting</a> · <a href="https://github.com/livekit/livekit-cli">CLI</a></td></tr>
 </tbody>

.github/workflows/tests.yml

@@ -0,0 +1,104 @@
+import os
+import logging
+import asyncio
+from signal import SIGINT, SIGTERM
+from livekit import rtc
+
+# Set the following environment variables with your own values
+TOKEN = os.environ.get("LIVEKIT_TOKEN")
+URL = os.environ.get("LIVEKIT_URL")
+
+
+async def main(room: rtc.Room):
+    logging.basicConfig(level=logging.INFO)
+    logger = logging.getLogger(__name__)
+
+    async def greetParticipant(identity: str):
+        text_writer = await room.local_participant.stream_text(
+            destination_identities=[identity], topic="chat"
+        )
+        for char in "Hi! Just a friendly message":
+            await text_writer.write(char)
+        await text_writer.aclose()
+
+        await room.local_participant.send_file(
+            "./green_tree_python.jpg",
+            destination_identities=[identity],
+            topic="files",
+        )
+
+    async def on_chat_message_received(
+        reader: rtc.TextStreamReader, participant_identity: str
+    ):
+        full_text = await reader.read_all()
+        logger.info(
+            "Received chat message from %s: '%s'", participant_identity, full_text
+        )
+
+    async def on_welcome_image_received(
+        reader: rtc.ByteStreamReader, participant_identity: str
+    ):
+        logger.info(
+            "Received image from %s: '%s'", participant_identity, reader.info["name"]
+        )
+        with open(reader.info["name"], mode="wb") as f:
+            async for chunk in reader:
+                f.write(chunk)
+
+            f.close()
+
+    @room.on("participant_connected")
+    def on_participant_connected(participant: rtc.RemoteParticipant):
+        logger.info(
+            "participant connected: %s %s", participant.sid, participant.identity
+        )
+        asyncio.create_task(greetParticipant(participant.identity))
+
+    room.set_text_stream_handler(
+        "chat",
+        lambda reader, participant_identity: asyncio.create_task(
+            on_chat_message_received(reader, participant_identity)
+        ),
+    )
+
+    room.set_byte_stream_handler(
+        "files",
+        lambda reader, participant_identity: asyncio.create_task(
+            on_welcome_image_received(reader, participant_identity)
+        ),
+    )
+
+    # By default, autosubscribe is enabled. The participant will be subscribed to
+    # all published tracks in the room
+    await room.connect(URL, TOKEN)
+    logger.info("connected to room %s", room.name)
+
+    for identity, participant in room.remote_participants.items():
+        logger.info("Sending a welcome message to %s", identity)
+        await greetParticipant(participant.identity)
+
+
+if __name__ == "__main__":
+    logging.basicConfig(
+        level=logging.INFO,
+        handlers=[
+            logging.FileHandler("data_stream_example.log"),
+            logging.StreamHandler(),
+        ],
+    )
+
+    loop = asyncio.get_event_loop()
+    room = rtc.Room(loop=loop)
+
+    async def cleanup():
+        await room.disconnect()
+        loop.stop()
+
+    asyncio.ensure_future(main(room))
+    for signal in [SIGINT, SIGTERM]:
+        loop.add_signal_handler(signal, lambda: asyncio.ensure_future(cleanup()))
+
+    try:
+        loop.run_forever()
+    finally:
+        loop.close()

README.md

@@ -52,6 +52,28 @@ async def main(room: rtc.Room):
 
     asyncio.ensure_future(draw_color_cycle(source))
 
+    # uncomment the below to test Track Subscription Permissions
+    # https://docs.livekit.io/home/client/tracks/publish/#subscription-permissions
+    # await asyncio.sleep(10)
+
+    # logging.info(
+    #     "setting track subscription permissions to False, no one can subscribe to the track"
+    # )
+    # room.local_participant.set_track_subscription_permissions(allow_all_participants=False)
+
+    # await asyncio.sleep(10)
+
+    # logging.info("allowing user to subscribe to the track")
+    # room.local_participant.set_track_subscription_permissions(
+    #     allow_all_participants=False,
+    #     participant_permissions=[
+    #         rtc.ParticipantTrackPermission(
+    #             participant_identity="allowed-user-identity",
+    #             allow_all=True,
+    #         )
+    #     ],
+    # )
+
 
 async def draw_color_cycle(source: rtc.VideoSource):
     argb_frame = bytearray(WIDTH * HEIGHT * 4)

examples/data-streams/data_streams.py

@@ -1,4 +1,5 @@
 import aiohttp
+from uuid import uuid4
 from livekit.protocol.room import (
     CreateRoomRequest,
     ListRoomsRequest,
@@ -288,6 +289,8 @@ async def send_data(self, send: SendDataRequest) -> SendDataResponse:
         Returns:
             SendDataResponse: Empty response object
         """
+
+        send.nonce = uuid4().bytes
         return await self._client.request(
             SVC,
             "SendData",