streamlit-webrtc 0.55.0__py3-none-any.whl → 0.56.0__py3-none-any.whl

streamlit_webrtc/component.py

@@ -219,6 +219,7 @@ def compile_state(component_value) -> WebRtcStreamerState:
 def webrtc_streamer(
     key: str,
     mode: WebRtcMode = WebRtcMode.SENDRECV,
+    rtc_configuration: Optional[Union[Dict[str, Any], RTCConfiguration]] = None,
     server_rtc_configuration: Optional[Union[Dict[str, Any], RTCConfiguration]] = None,
     frontend_rtc_configuration: Optional[
         Union[Dict[str, Any], RTCConfiguration]
@@ -250,7 +251,6 @@ def webrtc_streamer(
     # Deprecated. Just for backward compatibility
     video_transformer_factory: None = None,
     async_transform: Optional[bool] = None,
-    rtc_configuration: Optional[Union[Dict[str, Any], RTCConfiguration]] = None,
 ) -> WebRtcStreamerContext:
     # XXX: We wanted something like `WebRtcStreamerContext[None, None]`
     # as the return value, but could not find a good solution
@@ -263,6 +263,7 @@ def webrtc_streamer(
 def webrtc_streamer(
     key: str,
     mode: WebRtcMode = WebRtcMode.SENDRECV,
+    rtc_configuration: Optional[Union[Dict[str, Any], RTCConfiguration]] = None,
     server_rtc_configuration: Optional[Union[Dict[str, Any], RTCConfiguration]] = None,
     frontend_rtc_configuration: Optional[
         Union[Dict[str, Any], RTCConfiguration]
@@ -294,7 +295,6 @@ def webrtc_streamer(
     # Deprecated. Just for backward compatibility
     video_transformer_factory: None = None,
     async_transform: Optional[bool] = None,
-    rtc_configuration: Optional[Union[Dict[str, Any], RTCConfiguration]] = None,
 ) -> WebRtcStreamerContext[VideoProcessorT, Any]:
     pass
 
@@ -303,6 +303,7 @@ def webrtc_streamer(
 def webrtc_streamer(
     key: str,
     mode: WebRtcMode = WebRtcMode.SENDRECV,
+    rtc_configuration: Optional[Union[Dict[str, Any], RTCConfiguration]] = None,
     server_rtc_configuration: Optional[Union[Dict[str, Any], RTCConfiguration]] = None,
     frontend_rtc_configuration: Optional[
         Union[Dict[str, Any], RTCConfiguration]
@@ -334,7 +335,6 @@ def webrtc_streamer(
     # Deprecated. Just for backward compatibility
     video_transformer_factory: None = None,
     async_transform: Optional[bool] = None,
-    rtc_configuration: Optional[Union[Dict[str, Any], RTCConfiguration]] = None,
 ) -> WebRtcStreamerContext[Any, AudioProcessorT]:
     pass
 
@@ -343,6 +343,7 @@ def webrtc_streamer(
 def webrtc_streamer(
     key: str,
     mode: WebRtcMode = WebRtcMode.SENDRECV,
+    rtc_configuration: Optional[Union[Dict[str, Any], RTCConfiguration]] = None,
     server_rtc_configuration: Optional[Union[Dict[str, Any], RTCConfiguration]] = None,
     frontend_rtc_configuration: Optional[
         Union[Dict[str, Any], RTCConfiguration]
@@ -374,7 +375,6 @@ def webrtc_streamer(
     # Deprecated. Just for backward compatibility
     video_transformer_factory: None = None,
     async_transform: Optional[bool] = None,
-    rtc_configuration: Optional[Union[Dict[str, Any], RTCConfiguration]] = None,
 ) -> WebRtcStreamerContext[VideoProcessorT, AudioProcessorT]:
     pass
 
@@ -382,6 +382,7 @@ def webrtc_streamer(
 def webrtc_streamer(
     key: str,
     mode: WebRtcMode = WebRtcMode.SENDRECV,
+    rtc_configuration: Optional[Union[Dict[str, Any], RTCConfiguration]] = None,
     server_rtc_configuration: Optional[Union[Dict[str, Any], RTCConfiguration]] = None,
     frontend_rtc_configuration: Optional[
         Union[Dict[str, Any], RTCConfiguration]
@@ -413,7 +414,6 @@ def webrtc_streamer(
     # Deprecated. Just for backward compatibility
     video_transformer_factory=None,
     async_transform: Optional[bool] = None,
-    rtc_configuration: Optional[Union[Dict[str, Any], RTCConfiguration]] = None,
 ) -> WebRtcStreamerContext[VideoProcessorT, AudioProcessorT]:
     # Backward compatibility
     if video_transformer_factory is not None:
@@ -434,14 +434,13 @@ def webrtc_streamer(
             stacklevel=2,
         )
         async_processing = async_transform
-    if rtc_configuration is not None:
-        warnings.warn(
-            "The argument rtc_configuration is deprecated. "
-            "Use frontend_rtc_configuration and server_rtc_configuration instead.\n",
-            DeprecationWarning,
-            stacklevel=2,
-        )
+
+    # `rtc_configuration` is a shorthand to configure both frontend and server.
+    # `frontend_rtc_configuration` or `server_rtc_configuration` are prioritized.
+    if frontend_rtc_configuration is None:
         frontend_rtc_configuration = rtc_configuration
+    if server_rtc_configuration is None:
+        server_rtc_configuration = rtc_configuration
 
     if media_stream_constraints is None:
         media_stream_constraints = DEFAULT_MEDIA_STREAM_CONSTRAINTS
@@ -475,11 +474,9 @@ def webrtc_streamer(
         context._frontend_rtc_configuration = {}
     if context._frontend_rtc_configuration.get("iceServers") is None:
         LOGGER.info(
-            "No iceServers found in the rtc_configuration for the frontend. Set the default value to use Google STUN server."
+            "frontend_rtc_configuration.iceServers is not set. Try to set it automatically."
         )
-        context._frontend_rtc_configuration["iceServers"] = [
-            {"urls": "stun:stun.l.google.com:19302"}
-        ]
+        context._frontend_rtc_configuration["iceServers"] = get_available_ice_servers()
 
     webrtc_worker = context._get_worker()
 
@@ -561,8 +558,10 @@ def webrtc_streamer(
         )
 
     sdp_offer = None
+    ice_candidates = None
     if component_value:
         sdp_offer = component_value.get("sdpOffer")
+        ice_candidates = component_value.get("iceCandidates")
 
     if not context.state.playing and not context.state.signalling:
         LOGGER.debug(
@@ -607,7 +606,6 @@ def webrtc_streamer(
             if server_rtc_configuration and isinstance(server_rtc_configuration, dict)
             else AiortcRTCConfiguration()
         )
-
         if aiortc_rtc_configuration.iceServers is None:
             LOGGER.info(
                 "rtc_configuration.iceServers is not set. Try to set it automatically."
@@ -638,9 +636,16 @@ def webrtc_streamer(
             sendback_audio=sendback_audio,
         )
         webrtc_worker.process_offer(sdp_offer["sdp"], sdp_offer["type"], timeout=None)
+
+        if ice_candidates:
+            webrtc_worker.set_ice_candidates_from_offerer(ice_candidates)
+
         context._set_worker(webrtc_worker)
         # Rerun to send the SDP answer to frontend
         rerun()
 
+    if webrtc_worker and ice_candidates:
+        webrtc_worker.set_ice_candidates_from_offerer(ice_candidates)
+
     context._set_worker(webrtc_worker)
     return context

streamlit_webrtc/credentials.py

@@ -86,19 +86,26 @@ def get_twilio_ice_servers(
 def get_available_ice_servers() -> List[RTCIceServer]:
     try:
         LOGGER.info("Try to use TURN server from Hugging Face.")
-        ice_servers = get_hf_ice_servers()
+        hf_turn_servers = get_hf_ice_servers()
         LOGGER.info("Successfully got TURN credentials from Hugging Face.")
+        LOGGER.info("Using TURN server from Hugging Face and STUN server from Google.")
+        ice_servers = hf_turn_servers + [
+            RTCIceServer(urls="stun:stun.l.google.com:19302"),
+        ]
         return ice_servers
     except Exception as e:
         LOGGER.info("Failed to get TURN credentials from Hugging Face: %s", e)
 
     try:
-        LOGGER.info("Try to use TURN server from Twilio.")
+        LOGGER.info("Try to use STUN/TURN server from Twilio.")
         ice_servers = get_twilio_ice_servers()
-        LOGGER.info("Successfully got TURN credentials from Twilio.")
+        LOGGER.info("Successfully got STUN/TURN credentials from Twilio.")
         return ice_servers
     except Exception as e:
         LOGGER.info("Failed to get TURN credentials from Twilio: %s", e)
 
+    # NOTE: aiortc anyway uses this STUN server by default if the ICE server config is not set.
+    # Ref: https://github.com/aiortc/aiortc/blob/3ff9bdd03f22bf511a8d304df30f29392338a070/src/aiortc/rtcicetransport.py#L204-L209
+    # We set the STUN server here as this will be used on the browser side as well.
     LOGGER.info("Use STUN server from Google.")
     return [RTCIceServer(urls="stun:stun.l.google.com:19302")]