update egress comments

Author: davidzhao

livekit-api/livekit/api/__init__.py

@@ -36,6 +36,7 @@
 
 from .twirp_client import TwirpError, TwirpErrorCode
 from .livekit_api import LiveKitAPI
+from .sip_service import SIPError
 from .access_token import VideoGrants, SIPGrants, AccessToken, TokenVerifier
 from .webhook import WebhookReceiver
 from .version import __version__
@@ -52,4 +53,7 @@
     "AccessToken",
     "TokenVerifier",
     "WebhookReceiver",
+    "TwirpError",
+    "TwirpErrorCode",
+    "SIPError",
 ]

livekit-api/livekit/api/_service.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-from typing import Dict
 import aiohttp
 from abc import ABC
 from .twirp_client import TwirpClient
@@ -17,7 +16,7 @@ def __init__(self, session: aiohttp.ClientSession, host: str, api_key: str, api_
 
     def _auth_header(
         self, grants: VideoGrants | None, sip: SIPGrants | None = None
-    ) -> Dict[str, str]:
+    ) -> dict[str, str]:
         tok = AccessToken(self.api_key, self.api_secret)
         if grants:
             tok.with_grants(grants)

livekit-api/livekit/api/egress_service.py

@@ -37,6 +37,7 @@ def __init__(self, session: aiohttp.ClientSession, url: str, api_key: str, api_s
         super().__init__(session, url, api_key, api_secret)
 
     async def start_room_composite_egress(self, start: RoomCompositeEgressRequest) -> EgressInfo:
+        """Starts a composite recording of a room."""
         return await self._client.request(
             SVC,
             "StartRoomCompositeEgress",
@@ -46,6 +47,7 @@ async def start_room_composite_egress(self, start: RoomCompositeEgressRequest) -
         )
 
     async def start_web_egress(self, start: WebEgressRequest) -> EgressInfo:
+        """Starts a recording of a web page."""
         return await self._client.request(
             SVC,
             "StartWebEgress",
@@ -55,6 +57,7 @@ async def start_web_egress(self, start: WebEgressRequest) -> EgressInfo:
         )
 
     async def start_participant_egress(self, start: ParticipantEgressRequest) -> EgressInfo:
+        """Starts a recording of a participant."""
         return await self._client.request(
             SVC,
             "StartParticipantEgress",
@@ -64,6 +67,7 @@ async def start_participant_egress(self, start: ParticipantEgressRequest) -> Egr
         )
 
     async def start_track_composite_egress(self, start: TrackCompositeEgressRequest) -> EgressInfo:
+        """Starts a composite recording with audio and video tracks."""
         return await self._client.request(
             SVC,
             "StartTrackCompositeEgress",
@@ -73,6 +77,7 @@ async def start_track_composite_egress(self, start: TrackCompositeEgressRequest)
         )
 
     async def start_track_egress(self, start: TrackEgressRequest) -> EgressInfo:
+        """Starts a recording of a single track."""
         return await self._client.request(
             SVC,
             "StartTrackEgress",
@@ -82,6 +87,7 @@ async def start_track_egress(self, start: TrackEgressRequest) -> EgressInfo:
         )
 
     async def update_layout(self, update: UpdateLayoutRequest) -> EgressInfo:
+        """Updates the layout of a composite recording."""
         return await self._client.request(
             SVC,
             "UpdateLayout",
@@ -91,6 +97,7 @@ async def update_layout(self, update: UpdateLayoutRequest) -> EgressInfo:
         )
 
     async def update_stream(self, update: UpdateStreamRequest) -> EgressInfo:
+        """Updates the stream of a RoomComposite, Web, or Participant recording."""
         return await self._client.request(
             SVC,
             "UpdateStream",
@@ -100,6 +107,14 @@ async def update_stream(self, update: UpdateStreamRequest) -> EgressInfo:
         )
 
     async def list_egress(self, list: ListEgressRequest) -> ListEgressResponse:
+        """Lists all active egress and recently completed recordings.
+
+        Args:
+            list (ListEgressRequest): arg contains optional filters:
+                - room_name: str - List all egresses for a specific room
+                - egress_id: str - Only list egress with matching ID
+                - active: bool - Only list active egresses
+        """
         return await self._client.request(
             SVC,
             "ListEgress",
@@ -109,6 +124,7 @@ async def list_egress(self, list: ListEgressRequest) -> ListEgressResponse:
         )
 
     async def stop_egress(self, stop: StopEgressRequest) -> EgressInfo:
+        """Stops an active egress recording."""
         return await self._client.request(
             SVC,
             "StopEgress",

livekit-api/livekit/api/room_service.py

@@ -18,6 +18,8 @@
     UpdateRoomMetadataRequest,
     RemoveParticipantResponse,
     UpdateSubscriptionsResponse,
+    ForwardParticipantRequest,
+    ForwardParticipantResponse,
 )
 from livekit.protocol.models import Room, ParticipantInfo
 from ._service import Service
@@ -197,6 +199,24 @@ async def remove_participant(
             RemoveParticipantResponse,
         )
 
+    async def forward_participant(self, forward: ForwardParticipantRequest) -> None:
+        """Forwards a participant to a new room.
+
+        Args:
+            forward (ForwardParticipantRequest): arg containing:
+                - room: str - Room name
+                - identity: str - identity of Participant to forward
+                - destination_room: str - Destination room name
+        """
+        # currently nothing is returned
+        await self._client.request(
+            SVC,
+            "ForwardParticipant",
+            forward,
+            self._auth_header(VideoGrants(room_admin=True, room=forward.room)),
+            ForwardParticipantResponse,
+        )
+
     async def mute_published_track(
         self,
         update: MuteRoomTrackRequest,