support for track subscription permissions (#354)

Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Ben Cherry <[email protected]>

Author: 3 people

examples/publish_hue.py

@@ -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)

livekit-rtc/livekit/rtc/__init__.py

@@ -27,7 +27,12 @@
     TrackPublishOptions,
     VideoEncoding,
 )
-from ._proto.track_pb2 import StreamState, TrackKind, TrackSource
+from ._proto.track_pb2 import (
+    StreamState,
+    TrackKind,
+    TrackSource,
+    ParticipantTrackPermission,
+)
 from ._proto.video_frame_pb2 import VideoBufferType, VideoCodec, VideoRotation
 from .audio_frame import AudioFrame
 from .audio_source import AudioSource
@@ -97,6 +102,7 @@
     "StreamState",
     "TrackKind",
     "TrackSource",
+    "ParticipantTrackPermission",
     "VideoBufferType",
     "VideoRotation",
     "stats",

livekit-rtc/livekit/rtc/participant.py

@@ -31,6 +31,9 @@
 from ._proto.room_pb2 import (
     TranscriptionSegment as ProtoTranscriptionSegment,
 )
+from ._proto.track_pb2 import (
+    ParticipantTrackPermission,
+)
 from ._utils import BroadcastQueue, split_utf8
 from .track import LocalTrack
 from .track_publication import (
@@ -398,6 +401,34 @@ def unregister_rpc_method(self, method: str) -> None:
 
         FfiClient.instance.request(req)
 
+    def set_track_subscription_permissions(
+        self,
+        *,
+        allow_all_participants: bool,
+        participant_permissions: Optional[List[ParticipantTrackPermission]] = None,
+    ) -> None:
+        """
+        Set the track subscription permissions for the local participant.
+
+        Args:
+            allow_all_participants (bool): Whether to allow all participants to subscribe to this participant's tracks.
+            participant_permissions (List[ParticipantTrackPermission]): Participant-specific track subscription permissions, ignored if `allow_all_participants` is True.
+        """
+        if participant_permissions is None:
+            participant_permissions = []
+
+        req = proto_ffi.FfiRequest()
+        req.set_track_subscription_permissions.local_participant_handle = (
+            self._ffi_handle.handle
+        )
+        req.set_track_subscription_permissions.all_participants_allowed = (
+            allow_all_participants
+        )
+        req.set_track_subscription_permissions.permissions.extend(
+            participant_permissions
+        )
+        FfiClient.instance.request(req)
+
     async def _handle_rpc_method_invocation(
         self,
         invocation_id: int,