livekit-api 1.2.0__tar.gz → 1.2.1__tar.gz

livekit_api-1.2.1/PKG-INFO

@@ -0,0 +1,59 @@
+Metadata-Version: 2.5
+Name: livekit-api
+Version: 1.2.1
+Summary: Python Server API for LiveKit
+Project-URL: Documentation, https://docs.livekit.io
+Project-URL: Website, https://livekit.io/
+Project-URL: Source, https://github.com/livekit/python-sdks/
+Author-email: LiveKit <support@livekit.io>
+License-Expression: Apache-2.0
+Keywords: audio,livekit,realtime,video,webrtc
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+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
+Classifier: Topic :: Multimedia :: Video
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.9.0
+Requires-Dist: aiohttp>=3.9.0
+Requires-Dist: livekit-protocol<2.0.0,>=1.1.25
+Requires-Dist: protobuf>=4
+Requires-Dist: pyjwt>=2.0.0
+Requires-Dist: types-protobuf>=4
+Description-Content-Type: text/markdown
+
+# LiveKit Server APIs
+
+Access LiveKit server APIs and generate access tokens.
+
+See https://docs.livekit.io/reference/server/server-apis for more information.
+
+## Authentication
+
+Every request to the server APIs is authenticated. `LiveKitAPI` supports two modes:
+
+- **API key & secret** — recommended for backend use. The SDK signs a short-lived token per request from your key and secret. Keep your API secret on the server; never ship it to a client.
+- **Access token** — for client-side use where the API secret must not be exposed. Pass a pre-signed [access token](https://docs.livekit.io/home/get-started/authentication/) that already carries the grants for the operations you'll perform; the SDK sends it verbatim.
+
+```python
+from livekit import api
+
+# API key & secret: set LIVEKIT_URL, LIVEKIT_API_KEY, and LIVEKIT_API_SECRET,
+# then construct with no arguments...
+lkapi = api.LiveKitAPI()
+
+# ...or pass any of them explicitly to override the corresponding env var:
+lkapi = api.LiveKitAPI("https://my.livekit.host", api_key="api-key", api_secret="api-secret")
+
+# Pre-signed access token (client-side): with LIVEKIT_URL set, pass just the token:
+lkapi = api.LiveKitAPI.with_token("a-pre-signed-token")
+```
+
+The url and credentials fall back to the `LIVEKIT_URL`, `LIVEKIT_API_KEY`, `LIVEKIT_API_SECRET`, and `LIVEKIT_TOKEN` environment variables. Values you pass explicitly take precedence; the environment variables are used only as a fallback for arguments you omit — an ambient `LIVEKIT_TOKEN`, for example, won't override an explicitly-provided API key and secret.
+

livekit_api-1.2.1/README.md

@@ -0,0 +1,29 @@
+# LiveKit Server APIs
+
+Access LiveKit server APIs and generate access tokens.
+
+See https://docs.livekit.io/reference/server/server-apis for more information.
+
+## Authentication
+
+Every request to the server APIs is authenticated. `LiveKitAPI` supports two modes:
+
+- **API key & secret** — recommended for backend use. The SDK signs a short-lived token per request from your key and secret. Keep your API secret on the server; never ship it to a client.
+- **Access token** — for client-side use where the API secret must not be exposed. Pass a pre-signed [access token](https://docs.livekit.io/home/get-started/authentication/) that already carries the grants for the operations you'll perform; the SDK sends it verbatim.
+
+```python
+from livekit import api
+
+# API key & secret: set LIVEKIT_URL, LIVEKIT_API_KEY, and LIVEKIT_API_SECRET,
+# then construct with no arguments...
+lkapi = api.LiveKitAPI()
+
+# ...or pass any of them explicitly to override the corresponding env var:
+lkapi = api.LiveKitAPI("https://my.livekit.host", api_key="api-key", api_secret="api-secret")
+
+# Pre-signed access token (client-side): with LIVEKIT_URL set, pass just the token:
+lkapi = api.LiveKitAPI.with_token("a-pre-signed-token")
+```
+
+The url and credentials fall back to the `LIVEKIT_URL`, `LIVEKIT_API_KEY`, `LIVEKIT_API_SECRET`, and `LIVEKIT_TOKEN` environment variables. Values you pass explicitly take precedence; the environment variables are used only as a fallback for arguments you omit — an ambient `LIVEKIT_TOKEN`, for example, won't override an explicitly-provided API key and secret.
+

{livekit_api-1.2.0 → livekit_api-1.2.1}/livekit/api/access_token.py

@@ -233,14 +233,26 @@ class TokenVerifier:
         if verify_signature and (not self.api_key or not self.api_secret):
             raise ValueError("api_key and api_secret must be set")
 
-        claims = jwt.decode(
-            token,
-            key=self.api_secret or "",
-            issuer=self.api_key or "",
-            algorithms=["HS256"],
-            leeway=self._leeway.total_seconds(),
-            options={"verify_signature": verify_signature},
-        )
+        # First-party minters always set exp. Without this, a hand-rolled token
+        # with a valid signature and no exp verifies forever (livekit/protocol#1706).
+        if verify_signature:
+            claims = jwt.decode(
+                token,
+                key=self.api_secret or "",
+                issuer=self.api_key or "",
+                algorithms=["HS256"],
+                leeway=self._leeway.total_seconds(),
+                options={"verify_signature": True, "require": ["exp"]},
+            )
+        else:
+            claims = jwt.decode(
+                token,
+                key=self.api_secret or "",
+                issuer=self.api_key or "",
+                algorithms=["HS256"],
+                leeway=self._leeway.total_seconds(),
+                options={"verify_signature": False},
+            )
         video_dict = claims.get("video", dict())
         video_dict = {camel_to_snake(k): v for k, v in video_dict.items()}
         video_dict = {k: v for k, v in video_dict.items() if k in VideoGrants.__dataclass_fields__}

{livekit_api-1.2.0 → livekit_api-1.2.1}/livekit/api/egress_service.py

@@ -9,6 +9,7 @@ from livekit.protocol.egress import (
     UpdateStreamRequest,
     ListEgressRequest,
     StopEgressRequest,
+    StartEgressRequest,
     EgressInfo,
     ListEgressResponse,
 )
@@ -93,6 +94,16 @@ class EgressService(Service):
             EgressInfo,
         )
 
+    async def start_egress(self, start: StartEgressRequest) -> EgressInfo:
+        """Starts an egress; the request's source and outputs determine the egress type."""
+        return await self._client.request(
+            SVC,
+            "StartEgress",
+            start,
+            self._auth_header(VideoGrants(room_record=True)),
+            EgressInfo,
+        )
+
     async def update_layout(self, update: UpdateLayoutRequest) -> EgressInfo:
         """Updates the layout of a composite recording."""
         return await self._client.request(

{livekit_api-1.2.0 → livekit_api-1.2.1}/livekit/api/sip_service.py

@@ -31,6 +31,7 @@ from livekit.protocol.sip import (
     DeleteSIPDispatchRuleRequest,
     CreateSIPParticipantRequest,
     TransferSIPParticipantRequest,
+    TransferSIPParticipantResponse,
     SIPParticipantInfo,
     SIPTransport,
     SIPMediaConfig,
@@ -832,8 +833,8 @@ class SipService(Service):
         transfer: TransferSIPParticipantRequest,
         *,
         timeout: Optional[float] = None,
-    ) -> SIPParticipantInfo:
-        """Transfer a SIP participant to a different room.
+    ) -> TransferSIPParticipantResponse:
+        """Transfer a SIP participant to another number or SIP endpoint.
 
         Args:
             transfer: Request containing transfer details
@@ -842,7 +843,10 @@ class SipService(Service):
                 longer timeout when unset.
 
         Returns:
-            Updated SIP participant information
+            The outcome of the transfer: its id, status, reason, and the SIP
+            status when the outcome came from a SIP response. A status other
+            than successful means the transfer did not complete, even when no
+            error was raised.
         """
         # Transferring a call dials a phone, which takes longer than a normal
         # call, so keep the request alive past ringing. Pin the ring window so the
@@ -861,7 +865,7 @@ class SipService(Service):
                     ),
                     sip=SIPGrants(call=True),
                 ),
-                SIPParticipantInfo,
+                TransferSIPParticipantResponse,
                 timeout=client_timeout,
             )
         except ServerError as e:

{livekit_api-1.2.0 → livekit_api-1.2.1}/livekit/api/twirp_client.py

@@ -14,6 +14,7 @@
 
 import asyncio
 import logging
+import uuid
 from typing import Dict, List, Optional, Type, TypeVar
 
 import aiohttp
@@ -37,6 +38,11 @@ logger = logging.getLogger("livekit")
 # Identifies the SDK and version to the server on every request.
 _USER_AGENT = f"livekit-server-sdk-python/{__version__}"
 
+# Carries a per-request idempotency key. The SDK's auto-retries (see _failover)
+# keep the same key across attempts, so the server can identify and deduplicate
+# repeated requests.
+REQUEST_ID_HEADER = "X-Livekit-Request-Id"
+
 # Shared across all clients in the process so the region list is fetched once.
 _REGION_CACHE = RegionCache()
 
@@ -207,6 +213,7 @@ class TwirpClient:
         headers["User-Agent"] = _USER_AGENT
         forward_headers = dict(headers)  # for the discovery fetch (no content-type yet)
         headers["Content-Type"] = "application/protobuf"
+        headers[REQUEST_ID_HEADER] = str(uuid.uuid4())
         serialized_data = data.SerializeToString()
 
         # The effective per-attempt timeout is the per-call override, or the

livekit_api-1.2.1/livekit/api/version.py

@@ -0,0 +1 @@
+__version__ = "1.2.1"

{livekit_api-1.2.0 → livekit_api-1.2.1}/pyproject.toml

@@ -32,7 +32,7 @@ dependencies = [
     "aiohttp>=3.9.0",
     "protobuf>=4",
     "types-protobuf>=4",
-    "livekit-protocol>=1.1.19,<2.0.0",
+    "livekit-protocol>=1.1.25,<2.0.0",
 ]
 
 [project.urls]

livekit_api-1.2.0/PKG-INFO

@@ -1,36 +0,0 @@
-Metadata-Version: 2.4
-Name: livekit-api
-Version: 1.2.0
-Summary: Python Server API for LiveKit
-Project-URL: Documentation, https://docs.livekit.io
-Project-URL: Website, https://livekit.io/
-Project-URL: Source, https://github.com/livekit/python-sdks/
-Author-email: LiveKit <support@livekit.io>
-License-Expression: Apache-2.0
-Keywords: audio,livekit,realtime,video,webrtc
-Classifier: Intended Audience :: Developers
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.9
-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
-Classifier: Topic :: Multimedia :: Video
-Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
-Requires-Python: >=3.9.0
-Requires-Dist: aiohttp>=3.9.0
-Requires-Dist: livekit-protocol<2.0.0,>=1.1.19
-Requires-Dist: protobuf>=4
-Requires-Dist: pyjwt>=2.0.0
-Requires-Dist: types-protobuf>=4
-Description-Content-Type: text/markdown
-
-# LiveKit Server APIs
-
-Access LiveKit server APIs and generate access tokens.
-
-See https://docs.livekit.io/reference/server/server-apis for more information.
-

livekit_api-1.2.0/README.md

@@ -1,6 +0,0 @@
-# LiveKit Server APIs
-
-Access LiveKit server APIs and generate access tokens.
-
-See https://docs.livekit.io/reference/server/server-apis for more information.
-

livekit_api-1.2.0/livekit/api/version.py

@@ -1 +0,0 @@
-__version__ = "1.2.0"