Use keyword args for data track options

Author: ladvoc

examples/data_tracks/publisher.py

@@ -33,7 +33,7 @@ async def main(room: rtc.Room):
     await room.connect(URL, TOKEN)
     logger.info("connected to room %s", room.name)
 
-    track = await room.local_participant.publish_data_track({"name": "my_sensor_data"})
+    track = await room.local_participant.publish_data_track(name="my_sensor_data")
     await push_frames(track)
 
 

livekit-rtc/livekit/rtc/__init__.py

@@ -114,7 +114,6 @@
     DataTrackSubscription,
     DataTrackFrame,
     DataTrackInfo,
-    DataTrackOptions,
     PushFrameError,
     SubscribeDataTrackError,
 )
@@ -201,7 +200,6 @@
     "DataTrackSubscription",
     "DataTrackFrame",
     "DataTrackInfo",
-    "DataTrackOptions",
     "PushFrameError",
     "SubscribeDataTrackError",
     "__version__",

livekit-rtc/livekit/rtc/data_track.py

@@ -16,7 +16,7 @@
 
 import time
 from dataclasses import dataclass
-from typing import AsyncIterator, Optional, TypedDict
+from typing import AsyncIterator, Optional
 
 from ._ffi_client import FfiClient, FfiHandle
 from ._proto import ffi_pb2 as proto_ffi
@@ -62,16 +62,6 @@ class DataTrackInfo:
     """Whether or not frames sent on the track use end-to-end encryption."""
 
 
-class DataTrackOptions(TypedDict):
-    """Options for publishing a data track."""
-
-    name: str
-    """The track name is used to identify the track to other participants.
-
-    Must not be empty and must be unique per publisher.
-    """
-
-
 @dataclass
 class DataTrackFrame:
     """A frame published on a data track, consisting of a payload and optional metadata."""

livekit-rtc/livekit/rtc/participant.py

@@ -53,7 +53,7 @@
     ByteStreamInfo,
     STREAM_CHUNK_SIZE,
 )
-from .data_track import LocalDataTrack, DataTrackOptions
+from .data_track import LocalDataTrack
 from ._proto import data_track_pb2 as proto_data_track
 
 
@@ -676,12 +676,14 @@ async def send_file(
 
     async def publish_data_track(
         self,
-        options: DataTrackOptions,
+        *,
+        name: str,
     ) -> LocalDataTrack:
         """Publishes a data track.
 
         Args:
-            options: Options for publishing the data track.
+            name: The track name used to identify the track to other participants.
+                Must not be empty and must be unique per publisher.
 
         Returns:
             The published data track. Use :meth:`LocalDataTrack.try_push` to
@@ -690,7 +692,7 @@ async def publish_data_track(
         Raises:
             PublishDataTrackError: If there is an error publishing the data track.
         """
-        proto_opts = proto_data_track.DataTrackOptions(name=options["name"])
+        proto_opts = proto_data_track.DataTrackOptions(name=name)
 
         req = proto_ffi.FfiRequest()
         req.publish_data_track.local_participant_handle = self._ffi_handle.handle

tests/rtc/test_e2e.py

@@ -477,7 +477,7 @@ def on_data_track_unpublished(sid: str):
         await subscriber_room.connect(url, subscriber_token)
         await publisher_room.connect(url, publisher_token)
 
-        local_track = await publisher_room.local_participant.publish_data_track({"name": TRACK_NAME})
+        local_track = await publisher_room.local_participant.publish_data_track(name=TRACK_NAME)
         assert local_track.info.sid is not None
         assert local_track.info.name == TRACK_NAME
         assert local_track.is_published()