streamlit-nightly 1.33.1.dev20240422__py2.py3-none-any.whl → 1.33.1.dev20240423__py2.py3-none-any.whl

streamlit/elements/media.py

@@ -30,6 +30,8 @@ from streamlit.proto.Audio_pb2 import Audio as AudioProto
 from streamlit.proto.Video_pb2 import Video as VideoProto
 from streamlit.runtime import caching
 from streamlit.runtime.metrics_util import gather_metrics
+from streamlit.runtime.scriptrunner import get_script_run_ctx
+from streamlit.runtime.state.common import compute_widget_id
 from streamlit.time_util import time_to_seconds
 
 if TYPE_CHECKING:
@@ -69,6 +71,7 @@ class MediaMixin:
         sample_rate: int | None = None,
         end_time: MediaTime | None = None,
         loop: bool = False,
+        autoplay: bool = False,
     ) -> DeltaGenerator:
         """Display an audio player.
 
@@ -118,6 +121,11 @@ class MediaMixin:
               e.g. ``timedelta(seconds=70)``.
         loop: bool
             Whether the audio should loop playback.
+        autoplay: bool
+            Whether the audio should start playing automatically.
+            Browsers will not autoplay audio files if the user has not interacted with
+            the page yet, for example by clicking on the page while it loads.
+            Defaults to False.
 
         Examples
         --------
@@ -183,6 +191,7 @@ class MediaMixin:
             sample_rate,
             end_time,
             loop,
+            autoplay,
         )
         return self.dg._enqueue("audio", audio_proto)
 
@@ -196,6 +205,8 @@ class MediaMixin:
         subtitles: SubtitleData = None,
         end_time: MediaTime | None = None,
         loop: bool = False,
+        autoplay: bool = False,
+        muted: bool = False,
     ) -> DeltaGenerator:
         """Display a video player.
 
@@ -263,6 +274,15 @@ class MediaMixin:
               e.g. ``timedelta(seconds=70)``.
         loop: bool
             Whether the video should loop playback.
+        autoplay: bool
+            Whether the video should start playing automatically.
+            Browsers will not autoplay video files if the user has not interacted with
+            the page yet, for example by clicking on the page while it loads.
+            To enable autoplay without user interaction, you can set muted=True.
+            Defaults to False.
+        muted: bool
+            Whether the video should play with the audio silenced. This can be used to
+            enable autoplay without user interaction. Defaults to False.
 
         Example
         -------
@@ -314,7 +334,6 @@ class MediaMixin:
            for more information.
 
         """
-
         start_time, end_time = _parse_start_time_end_time(start_time, end_time)
 
         video_proto = VideoProto()
@@ -328,6 +347,8 @@ class MediaMixin:
             subtitles,
             end_time,
             loop,
+            autoplay,
+            muted,
         )
         return self.dg._enqueue("video", video_proto)
 
@@ -434,6 +455,8 @@ def marshall_video(
     subtitles: SubtitleData = None,
     end_time: int | None = None,
     loop: bool = False,
+    autoplay: bool = False,
+    muted: bool = False,
 ) -> None:
     """Marshalls a video proto, using url processors as needed.
 
@@ -467,12 +490,22 @@ def marshall_video(
             The time at which this element should stop playing
     loop: bool
         Whether the video should loop playback.
+    autoplay: bool
+        Whether the video should start playing automatically.
+        Browsers will not autoplay video files if the user has not interacted with
+        the page yet, for example by clicking on the page while it loads.
+        To enable autoplay without user interaction, you can set muted=True.
+        Defaults to False.
+    muted: bool
+        Whether the video should play with the audio silenced. This can be used to
+        enable autoplay without user interaction. Defaults to False.
     """
 
     if start_time < 0 or (end_time is not None and end_time <= start_time):
         raise StreamlitAPIException("Invalid start_time and end_time combination.")
 
     proto.start_time = start_time
+    proto.muted = muted
 
     if end_time is not None:
         proto.end_time = end_time
@@ -531,6 +564,23 @@ def marshall_video(
                     f"Failed to process the provided subtitle: {label}"
                 ) from original_err
 
+    if autoplay:
+        ctx = get_script_run_ctx()
+        proto.autoplay = autoplay
+        id = compute_widget_id(
+            "video",
+            url=proto.url,
+            mimetype=mimetype,
+            start_time=start_time,
+            end_time=end_time,
+            loop=loop,
+            autoplay=autoplay,
+            muted=muted,
+            page=ctx.page_script_hash if ctx else None,
+        )
+
+        proto.id = id
+
 
 def _parse_start_time_end_time(
     start_time: MediaTime, end_time: MediaTime | None
@@ -647,6 +697,7 @@ def marshall_audio(
     sample_rate: int | None = None,
     end_time: int | None = None,
     loop: bool = False,
+    autoplay: bool = False,
 ) -> None:
     """Marshalls an audio proto, using data and url processors as needed.
 
@@ -670,6 +721,9 @@ def marshall_audio(
         The time at which this element should stop playing
     loop: bool
         Whether the audio should loop playback.
+    autoplay : bool
+        Whether the audio should start playing automatically.
+        Browsers will not autoplay audio files if the user has not interacted with the page yet.
     """
 
     proto.start_time = start_time
@@ -685,3 +739,19 @@ def marshall_audio(
     else:
         data = _maybe_convert_to_wav_bytes(data, sample_rate)
         _marshall_av_media(coordinates, proto, data, mimetype)
+
+    if autoplay:
+        ctx = get_script_run_ctx()
+        proto.autoplay = autoplay
+        id = compute_widget_id(
+            "audio",
+            url=proto.url,
+            mimetype=mimetype,
+            start_time=start_time,
+            sample_rate=sample_rate,
+            end_time=end_time,
+            loop=loop,
+            autoplay=autoplay,
+            page=ctx.page_script_hash if ctx else None,
+        )
+        proto.id = id

streamlit/proto/Audio_pb2.py

@@ -13,7 +13,7 @@ _sym_db = _symbol_database.Default()
 
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x1bstreamlit/proto/Audio.proto\"h\n\x05\x41udio\x12\x0b\n\x03url\x18\x05 \x01(\t\x12\x12\n\nstart_time\x18\x03 \x01(\x05\x12\x10\n\x08\x65nd_time\x18\x06 \x01(\x05\x12\x0c\n\x04loop\x18\x07 \x01(\x08J\x04\x08\x01\x10\x02J\x04\x08\x02\x10\x03J\x04\x08\x04\x10\x05R\x04\x64\x61taR\x06\x66ormatB*\n\x1c\x63om.snowflake.apps.streamlitB\nAudioProtob\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x1bstreamlit/proto/Audio.proto\"\x86\x01\n\x05\x41udio\x12\x0b\n\x03url\x18\x05 \x01(\t\x12\x12\n\nstart_time\x18\x03 \x01(\x05\x12\x10\n\x08\x65nd_time\x18\x06 \x01(\x05\x12\x0c\n\x04loop\x18\x07 \x01(\x08\x12\x10\n\x08\x61utoplay\x18\x08 \x01(\x08\x12\n\n\x02id\x18\t \x01(\tJ\x04\x08\x01\x10\x02J\x04\x08\x02\x10\x03J\x04\x08\x04\x10\x05R\x04\x64\x61taR\x06\x66ormatB*\n\x1c\x63om.snowflake.apps.streamlitB\nAudioProtob\x06proto3')
 
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
 _builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'streamlit.proto.Audio_pb2', globals())
@@ -21,6 +21,6 @@ if _descriptor._USE_C_DESCRIPTORS == False:
 
   DESCRIPTOR._options = None
   DESCRIPTOR._serialized_options = b'\n\034com.snowflake.apps.streamlitB\nAudioProto'
-  _AUDIO._serialized_start=31
-  _AUDIO._serialized_end=135
+  _AUDIO._serialized_start=32
+  _AUDIO._serialized_end=166
 # @@protoc_insertion_point(module_scope)

streamlit/proto/Audio_pb2.pyi

@@ -35,6 +35,8 @@ class Audio(google.protobuf.message.Message):
     START_TIME_FIELD_NUMBER: builtins.int
     END_TIME_FIELD_NUMBER: builtins.int
     LOOP_FIELD_NUMBER: builtins.int
+    AUTOPLAY_FIELD_NUMBER: builtins.int
+    ID_FIELD_NUMBER: builtins.int
     url: builtins.str
     start_time: builtins.int
     """The currentTime attribute of the HTML <audio> tag's <source> subtag."""
@@ -42,6 +44,8 @@ class Audio(google.protobuf.message.Message):
     """The time at which the audio should stop playing. If not specified, plays to the end."""
     loop: builtins.bool
     """Indicates whether the audio should start over from the beginning once it ends."""
+    autoplay: builtins.bool
+    id: builtins.str
     def __init__(
         self,
         *,
@@ -49,7 +53,9 @@ class Audio(google.protobuf.message.Message):
         start_time: builtins.int = ...,
         end_time: builtins.int = ...,
         loop: builtins.bool = ...,
+        autoplay: builtins.bool = ...,
+        id: builtins.str = ...,
     ) -> None: ...
-    def ClearField(self, field_name: typing_extensions.Literal["end_time", b"end_time", "loop", b"loop", "start_time", b"start_time", "url", b"url"]) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["autoplay", b"autoplay", "end_time", b"end_time", "id", b"id", "loop", b"loop", "start_time", b"start_time", "url", b"url"]) -> None: ...
 
 global___Audio = Audio

streamlit/proto/Video_pb2.py

@@ -13,7 +13,7 @@ _sym_db = _symbol_database.Default()
 
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x1bstreamlit/proto/Video.proto\"+\n\rSubtitleTrack\x12\r\n\x05label\x18\x01 \x01(\t\x12\x0b\n\x03url\x18\x02 \x01(\t\"\xda\x01\n\x05Video\x12\x0b\n\x03url\x18\x06 \x01(\t\x12\x12\n\nstart_time\x18\x03 \x01(\x05\x12\x19\n\x04type\x18\x05 \x01(\x0e\x32\x0b.Video.Type\x12!\n\tsubtitles\x18\x07 \x03(\x0b\x32\x0e.SubtitleTrack\x12\x10\n\x08\x65nd_time\x18\x08 \x01(\x05\x12\x0c\n\x04loop\x18\t \x01(\x08\"2\n\x04Type\x12\n\n\x06UNUSED\x10\x00\x12\n\n\x06NATIVE\x10\x01\x12\x12\n\x0eYOUTUBE_IFRAME\x10\x02J\x04\x08\x01\x10\x02J\x04\x08\x02\x10\x03J\x04\x08\x04\x10\x05R\x06\x66ormatR\x04\x64\x61taB*\n\x1c\x63om.snowflake.apps.streamlitB\nVideoProtob\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x1bstreamlit/proto/Video.proto\"+\n\rSubtitleTrack\x12\r\n\x05label\x18\x01 \x01(\t\x12\x0b\n\x03url\x18\x02 \x01(\t\"\x87\x02\n\x05Video\x12\x0b\n\x03url\x18\x06 \x01(\t\x12\x12\n\nstart_time\x18\x03 \x01(\x05\x12\x19\n\x04type\x18\x05 \x01(\x0e\x32\x0b.Video.Type\x12!\n\tsubtitles\x18\x07 \x03(\x0b\x32\x0e.SubtitleTrack\x12\x10\n\x08\x65nd_time\x18\x08 \x01(\x05\x12\x0c\n\x04loop\x18\t \x01(\x08\x12\x10\n\x08\x61utoplay\x18\n \x01(\x08\x12\r\n\x05muted\x18\x0b \x01(\x08\x12\n\n\x02id\x18\x0c \x01(\t\"2\n\x04Type\x12\n\n\x06UNUSED\x10\x00\x12\n\n\x06NATIVE\x10\x01\x12\x12\n\x0eYOUTUBE_IFRAME\x10\x02J\x04\x08\x01\x10\x02J\x04\x08\x02\x10\x03J\x04\x08\x04\x10\x05R\x06\x66ormatR\x04\x64\x61taB*\n\x1c\x63om.snowflake.apps.streamlitB\nVideoProtob\x06proto3')
 
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
 _builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'streamlit.proto.Video_pb2', globals())
@@ -24,7 +24,7 @@ if _descriptor._USE_C_DESCRIPTORS == False:
   _SUBTITLETRACK._serialized_start=31
   _SUBTITLETRACK._serialized_end=74
   _VIDEO._serialized_start=77
-  _VIDEO._serialized_end=295
-  _VIDEO_TYPE._serialized_start=213
-  _VIDEO_TYPE._serialized_end=263
+  _VIDEO._serialized_end=340
+  _VIDEO_TYPE._serialized_start=258
+  _VIDEO_TYPE._serialized_end=308
 # @@protoc_insertion_point(module_scope)

streamlit/proto/Video_pb2.pyi

@@ -76,6 +76,9 @@ class Video(google.protobuf.message.Message):
     SUBTITLES_FIELD_NUMBER: builtins.int
     END_TIME_FIELD_NUMBER: builtins.int
     LOOP_FIELD_NUMBER: builtins.int
+    AUTOPLAY_FIELD_NUMBER: builtins.int
+    MUTED_FIELD_NUMBER: builtins.int
+    ID_FIELD_NUMBER: builtins.int
     url: builtins.str
     """A url pointing to a video file"""
     start_time: builtins.int
@@ -89,6 +92,9 @@ class Video(google.protobuf.message.Message):
     """The time at which the video should stop playing. If not specified, plays to the end."""
     loop: builtins.bool
     """Indicates whether the video should start over from the beginning once it ends."""
+    autoplay: builtins.bool
+    muted: builtins.bool
+    id: builtins.str
     def __init__(
         self,
         *,
@@ -98,7 +104,10 @@ class Video(google.protobuf.message.Message):
         subtitles: collections.abc.Iterable[global___SubtitleTrack] | None = ...,
         end_time: builtins.int = ...,
         loop: builtins.bool = ...,
+        autoplay: builtins.bool = ...,
+        muted: builtins.bool = ...,
+        id: builtins.str = ...,
     ) -> None: ...
-    def ClearField(self, field_name: typing_extensions.Literal["end_time", b"end_time", "loop", b"loop", "start_time", b"start_time", "subtitles", b"subtitles", "type", b"type", "url", b"url"]) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["autoplay", b"autoplay", "end_time", b"end_time", "id", b"id", "loop", b"loop", "muted", b"muted", "start_time", b"start_time", "subtitles", b"subtitles", "type", b"type", "url", b"url"]) -> None: ...
 
 global___Video = Video

streamlit/static/asset-manifest.json

@@ -1,9 +1,9 @@
 {
   "files": {
     "main.css": "./static/css/main.bf304093.css",
-    "main.js": "./static/js/main.8fc4565f.js",
+    "main.js": "./static/js/main.d3201242.js",
     "static/js/9336.2d95d840.chunk.js": "./static/js/9336.2d95d840.chunk.js",
-    "static/js/9330.d29313d4.chunk.js": "./static/js/9330.d29313d4.chunk.js",
+    "static/js/9330.2b4c99e0.chunk.js": "./static/js/9330.2b4c99e0.chunk.js",
     "static/js/7217.d970c074.chunk.js": "./static/js/7217.d970c074.chunk.js",
     "static/js/3301.1d1b10bb.chunk.js": "./static/js/3301.1d1b10bb.chunk.js",
     "static/css/3092.95a45cfe.chunk.css": "./static/css/3092.95a45cfe.chunk.css",
@@ -19,7 +19,7 @@
     "static/js/2469.3e9c3ce9.chunk.js": "./static/js/2469.3e9c3ce9.chunk.js",
     "static/js/4113.1e7eff4d.chunk.js": "./static/js/4113.1e7eff4d.chunk.js",
     "static/js/1168.1d6408e6.chunk.js": "./static/js/1168.1d6408e6.chunk.js",
-    "static/js/178.b5384fd0.chunk.js": "./static/js/178.b5384fd0.chunk.js",
+    "static/js/178.7bea8c5d.chunk.js": "./static/js/178.7bea8c5d.chunk.js",
     "static/js/1792.b8efa879.chunk.js": "./static/js/1792.b8efa879.chunk.js",
     "static/js/3513.e3e7300a.chunk.js": "./static/js/3513.e3e7300a.chunk.js",
     "static/js/7602.6175e969.chunk.js": "./static/js/7602.6175e969.chunk.js",
@@ -152,6 +152,6 @@
   },
   "entrypoints": [
     "static/css/main.bf304093.css",
-    "static/js/main.8fc4565f.js"
+    "static/js/main.d3201242.js"
   ]
 }

streamlit/static/index.html

@@ -1 +1 @@
-<!doctype html><html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width,initial-scale=1,shrink-to-fit=no"/><link rel="shortcut icon" href="./favicon.png"/><link rel="preload" href="./static/media/SourceSansPro-Regular.0d69e5ff5e92ac64a0c9.woff2" as="font" type="font/woff2" crossorigin><link rel="preload" href="./static/media/SourceSansPro-SemiBold.abed79cd0df1827e18cf.woff2" as="font" type="font/woff2" crossorigin><link rel="preload" href="./static/media/SourceSansPro-Bold.118dea98980e20a81ced.woff2" as="font" type="font/woff2" crossorigin><title>Streamlit</title><script>window.prerenderReady=!1</script><script defer="defer" src="./static/js/main.8fc4565f.js"></script><link href="./static/css/main.bf304093.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>
+<!doctype html><html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width,initial-scale=1,shrink-to-fit=no"/><link rel="shortcut icon" href="./favicon.png"/><link rel="preload" href="./static/media/SourceSansPro-Regular.0d69e5ff5e92ac64a0c9.woff2" as="font" type="font/woff2" crossorigin><link rel="preload" href="./static/media/SourceSansPro-SemiBold.abed79cd0df1827e18cf.woff2" as="font" type="font/woff2" crossorigin><link rel="preload" href="./static/media/SourceSansPro-Bold.118dea98980e20a81ced.woff2" as="font" type="font/woff2" crossorigin><title>Streamlit</title><script>window.prerenderReady=!1</script><script defer="defer" src="./static/js/main.d3201242.js"></script><link href="./static/css/main.bf304093.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>

streamlit/static/static/js/178.7bea8c5d.chunk.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunk_streamlit_app=self.webpackChunk_streamlit_app||[]).push([[178],{178:(e,t,r)=>{r.r(t),r.d(t,{default:()=>l});var a=r(66845),n=r(16295),s=r(68785),i=r(40864);const d=528;function l(e){let{element:t,width:r,endpoints:l,elementMgr:o}=e;const u=(0,a.useRef)(null),{type:c,url:p,startTime:m,subtitles:f,endTime:h,loop:v,autoplay:y,muted:E}=t,T=(0,a.useMemo)((()=>{if(!t.id)return!0;const e=o.getElementState(t.id,"preventAutoplay");return e||o.setElementState(t.id,"preventAutoplay",!0),null!==e&&void 0!==e&&e}),[t.id,o]);(0,a.useEffect)((()=>{u.current&&(u.current.currentTime=m)}),[m]),(0,a.useEffect)((()=>{const e=u.current,r=()=>{e&&(e.currentTime=t.startTime)};return e&&e.addEventListener("loadedmetadata",r),()=>{e&&e.removeEventListener("loadedmetadata",r)}}),[t]),(0,a.useEffect)((()=>{const e=u.current;if(!e)return;let t=!1;const r=()=>{h>0&&e.currentTime>=h&&(v?(e.currentTime=m||0,e.play()):t||(t=!0,e.pause()))};return h>0&&e.addEventListener("timeupdate",r),()=>{e&&h>0&&e.removeEventListener("timeupdate",r)}}),[h,v,m]),(0,a.useEffect)((()=>{const e=u.current;if(!e)return;const t=()=>{v&&(e.currentTime=m||0,e.play())};return e.addEventListener("ended",t),()=>{e&&e.removeEventListener("ended",t)}}),[v,m]);const g=e=>{const{startTime:r,endTime:a,loop:n,autoplay:s,muted:i}=t,d=new URL(e);if(r&&!isNaN(r)&&d.searchParams.append("start",r.toString()),a&&!isNaN(a)&&d.searchParams.append("end",a.toString()),n){d.searchParams.append("loop","1");const e=d.pathname.split("/").pop();e&&d.searchParams.append("playlist",e)}return s&&d.searchParams.append("autoplay","1"),i&&d.searchParams.append("mute","1"),d.toString()};if(c===n.nk.Type.YOUTUBE_IFRAME){const e=0!==r?.75*r:d;return(0,i.jsx)("iframe",{"data-testid":"stVideo",title:p,src:g(p),width:r,height:e,style:{colorScheme:"normal"},frameBorder:"0",allow:"autoplay; encrypted-media",allowFullScreen:!0})}return(0,i.jsx)("video",{"data-testid":"stVideo",ref:u,controls:!0,muted:E,autoPlay:y&&!T,src:l.buildMediaURL(p),className:"stVideo",style:{width:r,height:0===r?d:void 0},crossOrigin:s.td&&f.length>0?"anonymous":void 0,children:f&&f.map(((e,t)=>(0,i.jsx)("track",{kind:"captions",src:l.buildMediaURL(e.url),label:e.label,default:0===t},t)))})}}}]);

streamlit/static/static/js/9330.2b4c99e0.chunk.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunk_streamlit_app=self.webpackChunk_streamlit_app||[]).push([[9330],{69330:(e,t,r)=>{r.r(t),r.d(t,{default:()=>a});var n=r(66845),u=r(40864);function a(e){let{element:t,width:r,endpoints:a,elementMgr:s}=e;const i=(0,n.useRef)(null),{startTime:d,endTime:c,loop:l,autoplay:o}=t,m=(0,n.useMemo)((()=>{if(!t.id)return!0;const e=s.getElementState(t.id,"preventAutoplay");return e||s.setElementState(t.id,"preventAutoplay",!0),null!==e&&void 0!==e&&e}),[t.id,s]);(0,n.useEffect)((()=>{i.current&&(i.current.currentTime=d)}),[d]),(0,n.useEffect)((()=>{const e=i.current,r=()=>{e&&(e.currentTime=t.startTime)};return e&&e.addEventListener("loadedmetadata",r),()=>{e&&e.removeEventListener("loadedmetadata",r)}}),[t]),(0,n.useEffect)((()=>{const e=i.current;if(!e)return;let t=!1;const r=()=>{c>0&&e.currentTime>=c&&(l?(e.currentTime=d||0,e.play()):t||(t=!0,e.pause()))};return c>0&&e.addEventListener("timeupdate",r),()=>{e&&c>0&&e.removeEventListener("timeupdate",r)}}),[c,l,d]),(0,n.useEffect)((()=>{const e=i.current;if(!e)return;const t=()=>{l&&(e.currentTime=d||0,e.play())};return e.addEventListener("ended",t),()=>{e&&e.removeEventListener("ended",t)}}),[l,d]);const p=a.buildMediaURL(t.url);return(0,u.jsx)("audio",{"data-testid":"stAudio",id:"audio",ref:i,controls:!0,autoPlay:o&&!m,src:p,className:"stAudio",style:{width:r}})}}}]);