gradio-pianoroll 0.0.1__py3-none-any.whl → 0.0.2__py3-none-any.whl

gradio_pianoroll/pianoroll.pyi

@@ -6,12 +6,20 @@ class PianoRoll(Component):
     EVENTS = [
         Events.change,
         Events.input,
+        Events.play,
+        Events.pause,
+        Events.stop,
+        Events.clear,
     ]
 
     def __init__(
         self,
         value: dict | None = None,
         *,
+        audio_data: str | None = None,
+        curve_data: dict | None = None,
+        segment_data: list | None = None,
+        use_backend_audio: bool = False,
         label: str | I18nData | None = None,
         every: "Timer | float | None" = None,
         inputs: Component | Sequence[Component] | set[Component] | None = None,
@@ -31,6 +39,10 @@ class PianoRoll(Component):
         """
         Parameters:
             value: default MIDI notes data to provide in piano roll. If a function is provided, the function will be called each time the app loads to set the initial value of this component.
+            audio_data: 백엔드에서 전달받은 오디오 데이터 (base64 인코딩된 오디오 또는 URL)
+            curve_data: 백엔드에서 전달받은 선형 데이터 (피치 곡선, loudness 곡선 등)
+            segment_data: 백엔드에서 전달받은 구간 데이터 (발음 타이밍 등)
+            use_backend_audio: 백엔드 오디오를 사용할지 여부 (True시 프론트엔드 오디오 엔진 비활성화)
             label: the label for this component, displayed above the component if `show_label` is `True` and is also used as the header if there are a table of examples for this component. If None and used in a `gr.Interface`, the label will be the name of the parameter this component corresponds to.
             every: Continously calls `value` to recalculate it if `value` is a function (has no effect otherwise). Can provide a Timer whose tick resets `value`, or a float that provides the regular interval for the reset Timer.
             inputs: Components that are used as inputs to calculate `value` if `value` is a function (has no effect otherwise). `value` is recalculated any time the inputs change.
@@ -49,21 +61,65 @@ class PianoRoll(Component):
         """
         self.width = width
         self.height = height
+
+        # Default settings for flicks calculation
+        default_pixels_per_beat = 80
+        default_tempo = 120
+        default_sample_rate = 44100
+        default_ppqn = 480
+
+        default_notes = [
+            create_note_with_timing(generate_note_id(), 80, 80, 60, 100, "안녕",
+                                  default_pixels_per_beat, default_tempo, default_sample_rate, default_ppqn),      # 1st beat of measure 1
+            create_note_with_timing(generate_note_id(), 160, 160, 64, 90, "하세요",
+                                  default_pixels_per_beat, default_tempo, default_sample_rate, default_ppqn),    # 1st beat of measure 2
+            create_note_with_timing(generate_note_id(), 320, 80, 67, 95, "반가워요",
+                                  default_pixels_per_beat, default_tempo, default_sample_rate, default_ppqn)    # 1st beat of measure 3
+        ]
+
         if value is None:
             self.value = {
-                "notes": [],
-                "tempo": 120,
+                "notes": default_notes,
+                "tempo": default_tempo,
                 "timeSignature": { "numerator": 4, "denominator": 4 },
                 "editMode": "select",
-                "snapSetting": "1/4"
+                "snapSetting": "1/4",
+                "pixelsPerBeat": default_pixels_per_beat,
+                "sampleRate": default_sample_rate,
+                "ppqn": default_ppqn
             }
         else:
+            # Ensure all notes have IDs and flicks values, generate them if missing
+            if "notes" in value and value["notes"]:
+                pixels_per_beat = value.get("pixelsPerBeat", default_pixels_per_beat)
+                tempo = value.get("tempo", default_tempo)
+
+                for note in value["notes"]:
+                    if "id" not in note or not note["id"]:
+                        note["id"] = generate_note_id()
+
+                    # Add flicks values if missing
+                    if "startFlicks" not in note:
+                        note["startFlicks"] = pixels_to_flicks(note["start"], pixels_per_beat, tempo)
+                    if "durationFlicks" not in note:
+                        note["durationFlicks"] = pixels_to_flicks(note["duration"], pixels_per_beat, tempo)
+
             self.value = value
 
+        # 백엔드 데이터 속성들
+        self.audio_data = audio_data
+        self.curve_data = curve_data or {}
+        self.segment_data = segment_data or []
+        self.use_backend_audio = use_backend_audio
+
         self._attrs = {
             "width": width,
             "height": height,
             "value": self.value,
+            "audio_data": self.audio_data,
+            "curve_data": self.curve_data,
+            "segment_data": self.segment_data,
+            "use_backend_audio": self.use_backend_audio,
         }
 
         super().__init__(
@@ -101,50 +157,114 @@ class PianoRoll(Component):
         Returns:
             the data after postprocessing, sent to the frontend
         """
+        # Ensure all notes have IDs and all timing values when sending to frontend
+        if value and "notes" in value and value["notes"]:
+            pixels_per_beat = value.get("pixelsPerBeat", 80)
+            tempo = value.get("tempo", 120)
+            sample_rate = value.get("sampleRate", 44100)
+            ppqn = value.get("ppqn", 480)
+
+            for note in value["notes"]:
+                if "id" not in note or not note["id"]:
+                    note["id"] = generate_note_id()
+
+                # Add all timing values if missing
+                if "startFlicks" not in note or "startSeconds" not in note:
+                    start_timing = calculate_all_timing_data(note["start"], pixels_per_beat, tempo, sample_rate, ppqn)
+                    note.update({
+                        "startFlicks": start_timing['flicks'],
+                        "startSeconds": start_timing['seconds'],
+                        "startBeats": start_timing['beats'],
+                        "startTicks": start_timing['ticks'],
+                        "startSample": start_timing['samples']
+                    })
+
+                if "durationFlicks" not in note or "durationSeconds" not in note:
+                    duration_timing = calculate_all_timing_data(note["duration"], pixels_per_beat, tempo, sample_rate, ppqn)
+                    note.update({
+                        "durationFlicks": duration_timing['flicks'],
+                        "durationSeconds": duration_timing['seconds'],
+                        "durationBeats": duration_timing['beats'],
+                        "durationTicks": duration_timing['ticks'],
+                        "durationSamples": duration_timing['samples']
+                    })
+
+                # Calculate end time if missing
+                if "endSeconds" not in note:
+                    note["endSeconds"] = note.get("startSeconds", 0) + note.get("durationSeconds", 0)
+
+        # 백엔드 데이터 속성들도 함께 전달
+        if value and isinstance(value, dict):
+            # value에 이미 있는 백엔드 데이터를 우선하고, 없으면 컴포넌트 속성에서 가져옴
+            # 이렇게 하면 컴포넌트 인스턴스별로 독립적인 백엔드 설정이 가능함
+
+            if "audio_data" not in value or value["audio_data"] is None:
+                if hasattr(self, 'audio_data') and self.audio_data:
+                    value["audio_data"] = self.audio_data
+
+            if "curve_data" not in value or value["curve_data"] is None:
+                if hasattr(self, 'curve_data') and self.curve_data:
+                    value["curve_data"] = self.curve_data
+
+            if "segment_data" not in value or value["segment_data"] is None:
+                if hasattr(self, 'segment_data') and self.segment_data:
+                    value["segment_data"] = self.segment_data
+
+            if "use_backend_audio" not in value:
+                if hasattr(self, 'use_backend_audio'):
+                    value["use_backend_audio"] = self.use_backend_audio
+                else:
+                    value["use_backend_audio"] = False
+
+            # 디버깅용 로그 추가
+            print(f"🔊 [postprocess] Backend audio data processed:")
+            print(f"   - audio_data present: {bool(value.get('audio_data'))}")
+            print(f"   - use_backend_audio: {value.get('use_backend_audio', False)}")
+            print(f"   - curve_data present: {bool(value.get('curve_data'))}")
+            print(f"   - segment_data present: {bool(value.get('segment_data'))}")
+
         return value
 
     def example_payload(self):
+        pixels_per_beat = 80
+        tempo = 120
+        sample_rate = 44100
+        ppqn = 480
+
         return {
             "notes": [
-                {
-                    "id": "note-1",
-                    "start": 80,
-                    "duration": 80,
-                    "pitch": 60,
-                    "velocity": 100,
-                    "lyric": "안녕"
-                }
+                create_note_with_timing(generate_note_id(), 80, 80, 60, 100, "안녕",
+                                      pixels_per_beat, tempo, sample_rate, ppqn)
             ],
-            "tempo": 120,
+            "tempo": tempo,
             "timeSignature": { "numerator": 4, "denominator": 4 },
             "editMode": "select",
-            "snapSetting": "1/4"
+            "snapSetting": "1/4",
+            "pixelsPerBeat": pixels_per_beat,
+            "sampleRate": sample_rate,
+            "ppqn": ppqn
         }
 
     def example_value(self):
+        pixels_per_beat = 80
+        tempo = 120
+        sample_rate = 44100
+        ppqn = 480
+
         return {
             "notes": [
-                {
-                    "id": "note-1",
-                    "start": 80,
-                    "duration": 80,
-                    "pitch": 60,
-                    "velocity": 100,
-                    "lyric": "안녕"
-                },
-                {
-                    "id": "note-2",
-                    "start": 160,
-                    "duration": 160,
-                    "pitch": 64,
-                    "velocity": 90,
-                    "lyric": "하세요"
-                }
+                create_note_with_timing(generate_note_id(), 80, 80, 60, 100, "안녕",
+                                      pixels_per_beat, tempo, sample_rate, ppqn),
+                create_note_with_timing(generate_note_id(), 160, 160, 64, 90, "하세요",
+                                      pixels_per_beat, tempo, sample_rate, ppqn)
             ],
-            "tempo": 120,
+            "tempo": tempo,
             "timeSignature": { "numerator": 4, "denominator": 4 },
             "editMode": "select",
-            "snapSetting": "1/4"
+            "snapSetting": "1/4",
+            "pixelsPerBeat": pixels_per_beat,
+            "sampleRate": sample_rate,
+            "ppqn": ppqn
         }
 
     def api_info(self):
@@ -157,13 +277,26 @@ class PianoRoll(Component):
                         "type": "object",
                         "properties": {
                             "id": {"type": "string"},
-                            "start": {"type": "number"},
-                            "duration": {"type": "number"},
-                            "pitch": {"type": "number"},
-                            "velocity": {"type": "number"},
-                            "lyric": {"type": "string"}
+                            "start": {"type": "number", "description": "Start position in pixels"},
+                            "duration": {"type": "number", "description": "Duration in pixels"},
+                            "startFlicks": {"type": "number", "description": "Start position in flicks (precise timing)"},
+                            "durationFlicks": {"type": "number", "description": "Duration in flicks (precise timing)"},
+                            "startSeconds": {"type": "number", "description": "Start time in seconds (for audio processing)"},
+                            "durationSeconds": {"type": "number", "description": "Duration in seconds (for audio processing)"},
+                            "endSeconds": {"type": "number", "description": "End time in seconds (startSeconds + durationSeconds)"},
+                            "startBeats": {"type": "number", "description": "Start position in musical beats"},
+                            "durationBeats": {"type": "number", "description": "Duration in musical beats"},
+                            "startTicks": {"type": "integer", "description": "Start position in MIDI ticks"},
+                            "durationTicks": {"type": "integer", "description": "Duration in MIDI ticks"},
+                            "startSample": {"type": "integer", "description": "Start position in audio samples"},
+                            "durationSamples": {"type": "integer", "description": "Duration in audio samples"},
+                            "pitch": {"type": "number", "description": "MIDI pitch (0-127)"},
+                            "velocity": {"type": "number", "description": "MIDI velocity (0-127)"},
+                            "lyric": {"type": "string", "description": "Optional lyric text"}
                         },
-                        "required": ["id", "start", "duration", "pitch", "velocity"]
+                        "required": ["id", "start", "duration", "startFlicks", "durationFlicks",
+                                   "startSeconds", "durationSeconds", "endSeconds", "startBeats", "durationBeats",
+                                   "startTicks", "durationTicks", "startSample", "durationSamples", "pitch", "velocity"]
                     }
                 },
                 "tempo": {
@@ -185,11 +318,127 @@ class PianoRoll(Component):
                 "snapSetting": {
                     "type": "string",
                     "description": "Note snap setting"
+                },
+                "pixelsPerBeat": {
+                    "type": "number",
+                    "description": "Zoom level in pixels per beat"
+                },
+                "sampleRate": {
+                    "type": "integer",
+                    "description": "Audio sample rate (Hz) for sample-based timing calculations",
+                    "default": 44100
+                },
+                "ppqn": {
+                    "type": "integer",
+                    "description": "Pulses Per Quarter Note for MIDI tick calculations",
+                    "default": 480
+                },
+                # 백엔드 데이터 전달용 속성들
+                "audio_data": {
+                    "type": "string",
+                    "description": "Backend audio data (base64 encoded audio or URL)",
+                    "nullable": True
+                },
+                "curve_data": {
+                    "type": "object",
+                    "description": "Linear curve data (pitch curves, loudness curves, etc.)",
+                    "properties": {
+                        "pitch_curve": {
+                            "type": "array",
+                            "items": {"type": "number"},
+                            "description": "Pitch curve data points"
+                        },
+                        "loudness_curve": {
+                            "type": "array",
+                            "items": {"type": "number"},
+                            "description": "Loudness curve data points"
+                        },
+                        "formant_curves": {
+                            "type": "object",
+                            "description": "Formant frequency curves",
+                            "additionalProperties": {
+                                "type": "array",
+                                "items": {"type": "number"}
+                            }
+                        }
+                    },
+                    "additionalProperties": True,
+                    "nullable": True
+                },
+                "segment_data": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "properties": {
+                            "start": {"type": "number", "description": "Segment start time (seconds)"},
+                            "end": {"type": "number", "description": "Segment end time (seconds)"},
+                            "type": {"type": "string", "description": "Segment type (phoneme, syllable, word, etc.)"},
+                            "value": {"type": "string", "description": "Segment value/text"},
+                            "confidence": {"type": "number", "description": "Confidence score (0-1)", "minimum": 0, "maximum": 1}
+                        },
+                        "required": ["start", "end", "type", "value"]
+                    },
+                    "description": "Segmentation data (pronunciation timing, etc.)",
+                    "nullable": True
+                },
+                "use_backend_audio": {
+                    "type": "boolean",
+                    "description": "Whether to use backend audio (disables frontend audio engine when true)",
+                    "default": False
                 }
             },
             "required": ["notes", "tempo", "timeSignature", "editMode", "snapSetting"],
-            "description": "Piano roll data object containing notes array and settings"
+            "description": "Piano roll data object containing notes array, settings, and optional backend data"
         }
+
+    def update_backend_data(self, audio_data=None, curve_data=None, segment_data=None, use_backend_audio=None):
+        """
+        백엔드 데이터를 업데이트하는 메서드
+        """
+        if audio_data is not None:
+            self.audio_data = audio_data
+        if curve_data is not None:
+            self.curve_data = curve_data
+        if segment_data is not None:
+            self.segment_data = segment_data
+        if use_backend_audio is not None:
+            self.use_backend_audio = use_backend_audio
+
+        # _attrs도 업데이트
+        self._attrs.update({
+            "audio_data": self.audio_data,
+            "curve_data": self.curve_data,
+            "segment_data": self.segment_data,
+            "use_backend_audio": self.use_backend_audio,
+        })
+
+    def set_audio_data(self, audio_data: str):
+        """
+        오디오 데이터를 설정하는 메서드
+        """
+        self.audio_data = audio_data
+        self._attrs["audio_data"] = audio_data
+
+    def set_curve_data(self, curve_data: dict):
+        """
+        곡선 데이터를 설정하는 메서드 (피치 곡선, loudness 곡선 등)
+        """
+        self.curve_data = curve_data
+        self._attrs["curve_data"] = curve_data
+
+    def set_segment_data(self, segment_data: list):
+        """
+        구간 데이터를 설정하는 메서드 (발음 타이밍 등)
+        """
+        self.segment_data = segment_data
+        self._attrs["segment_data"] = segment_data
+
+    def enable_backend_audio(self, enable: bool = True):
+        """
+        백엔드 오디오 사용 여부를 설정하는 메서드
+        """
+        self.use_backend_audio = enable
+        self._attrs["use_backend_audio"] = enable
     from typing import Callable, Literal, Sequence, Any, TYPE_CHECKING
     from gradio.blocks import Block
     if TYPE_CHECKING:
@@ -290,3 +539,191 @@ class PianoRoll(Component):
         
         """
         ...
+    
+    def play(self,
+        fn: Callable[..., Any] | None = None,
+        inputs: Block | Sequence[Block] | set[Block] | None = None,
+        outputs: Block | Sequence[Block] | None = None,
+        api_name: str | None | Literal[False] = None,
+        scroll_to_output: bool = False,
+        show_progress: Literal["full", "minimal", "hidden"] = "full",
+        show_progress_on: Component | Sequence[Component] | None = None,
+        queue: bool | None = None,
+        batch: bool = False,
+        max_batch_size: int = 4,
+        preprocess: bool = True,
+        postprocess: bool = True,
+        cancels: dict[str, Any] | list[dict[str, Any]] | None = None,
+        every: Timer | float | None = None,
+        trigger_mode: Literal["once", "multiple", "always_last"] | None = None,
+        js: str | Literal[True] | None = None,
+        concurrency_limit: int | None | Literal["default"] = "default",
+        concurrency_id: str | None = None,
+        show_api: bool = True,
+    
+        ) -> Dependency:
+        """
+        Parameters:
+            fn: the function to call when this event is triggered. Often a machine learning model's prediction function. Each parameter of the function corresponds to one input component, and the function should return a single value or a tuple of values, with each element in the tuple corresponding to one output component.
+            inputs: list of gradio.components to use as inputs. If the function takes no inputs, this should be an empty list.
+            outputs: list of gradio.components to use as outputs. If the function returns no outputs, this should be an empty list.
+            api_name: defines how the endpoint appears in the API docs. Can be a string, None, or False. If False, the endpoint will not be exposed in the api docs. If set to None, will use the functions name as the endpoint route. If set to a string, the endpoint will be exposed in the api docs with the given name.
+            scroll_to_output: if True, will scroll to output component on completion
+            show_progress: how to show the progress animation while event is running: "full" shows a spinner which covers the output component area as well as a runtime display in the upper right corner, "minimal" only shows the runtime display, "hidden" shows no progress animation at all
+            show_progress_on: Component or list of components to show the progress animation on. If None, will show the progress animation on all of the output components.
+            queue: if True, will place the request on the queue, if the queue has been enabled. If False, will not put this event on the queue, even if the queue has been enabled. If None, will use the queue setting of the gradio app.
+            batch: if True, then the function should process a batch of inputs, meaning that it should accept a list of input values for each parameter. The lists should be of equal length (and be up to length `max_batch_size`). The function is then *required* to return a tuple of lists (even if there is only 1 output component), with each list in the tuple corresponding to one output component.
+            max_batch_size: maximum number of inputs to batch together if this is called from the queue (only relevant if batch=True)
+            preprocess: if False, will not run preprocessing of component data before running 'fn' (e.g. leaving it as a base64 string if this method is called with the `Image` component).
+            postprocess: if False, will not run postprocessing of component data before returning 'fn' output to the browser.
+            cancels: a list of other events to cancel when this listener is triggered. For example, setting cancels=[click_event] will cancel the click_event, where click_event is the return value of another components .click method. Functions that have not yet run (or generators that are iterating) will be cancelled, but functions that are currently running will be allowed to finish.
+            every: continously calls `value` to recalculate it if `value` is a function (has no effect otherwise). Can provide a Timer whose tick resets `value`, or a float that provides the regular interval for the reset Timer.
+            trigger_mode: if "once" (default for all events except `.change()`) would not allow any submissions while an event is pending. If set to "multiple", unlimited submissions are allowed while pending, and "always_last" (default for `.change()` and `.key_up()` events) would allow a second submission after the pending event is complete.
+            js: optional frontend js method to run before running 'fn'. Input arguments for js method are values of 'inputs' and 'outputs', return should be a list of values for output components.
+            concurrency_limit: if set, this is the maximum number of this event that can be running simultaneously. Can be set to None to mean no concurrency_limit (any number of this event can be running simultaneously). Set to "default" to use the default concurrency limit (defined by the `default_concurrency_limit` parameter in `Blocks.queue()`, which itself is 1 by default).
+            concurrency_id: if set, this is the id of the concurrency group. Events with the same concurrency_id will be limited by the lowest set concurrency_limit.
+            show_api: whether to show this event in the "view API" page of the Gradio app, or in the ".view_api()" method of the Gradio clients. Unlike setting api_name to False, setting show_api to False will still allow downstream apps as well as the Clients to use this event. If fn is None, show_api will automatically be set to False.
+        
+        """
+        ...
+    
+    def pause(self,
+        fn: Callable[..., Any] | None = None,
+        inputs: Block | Sequence[Block] | set[Block] | None = None,
+        outputs: Block | Sequence[Block] | None = None,
+        api_name: str | None | Literal[False] = None,
+        scroll_to_output: bool = False,
+        show_progress: Literal["full", "minimal", "hidden"] = "full",
+        show_progress_on: Component | Sequence[Component] | None = None,
+        queue: bool | None = None,
+        batch: bool = False,
+        max_batch_size: int = 4,
+        preprocess: bool = True,
+        postprocess: bool = True,
+        cancels: dict[str, Any] | list[dict[str, Any]] | None = None,
+        every: Timer | float | None = None,
+        trigger_mode: Literal["once", "multiple", "always_last"] | None = None,
+        js: str | Literal[True] | None = None,
+        concurrency_limit: int | None | Literal["default"] = "default",
+        concurrency_id: str | None = None,
+        show_api: bool = True,
+    
+        ) -> Dependency:
+        """
+        Parameters:
+            fn: the function to call when this event is triggered. Often a machine learning model's prediction function. Each parameter of the function corresponds to one input component, and the function should return a single value or a tuple of values, with each element in the tuple corresponding to one output component.
+            inputs: list of gradio.components to use as inputs. If the function takes no inputs, this should be an empty list.
+            outputs: list of gradio.components to use as outputs. If the function returns no outputs, this should be an empty list.
+            api_name: defines how the endpoint appears in the API docs. Can be a string, None, or False. If False, the endpoint will not be exposed in the api docs. If set to None, will use the functions name as the endpoint route. If set to a string, the endpoint will be exposed in the api docs with the given name.
+            scroll_to_output: if True, will scroll to output component on completion
+            show_progress: how to show the progress animation while event is running: "full" shows a spinner which covers the output component area as well as a runtime display in the upper right corner, "minimal" only shows the runtime display, "hidden" shows no progress animation at all
+            show_progress_on: Component or list of components to show the progress animation on. If None, will show the progress animation on all of the output components.
+            queue: if True, will place the request on the queue, if the queue has been enabled. If False, will not put this event on the queue, even if the queue has been enabled. If None, will use the queue setting of the gradio app.
+            batch: if True, then the function should process a batch of inputs, meaning that it should accept a list of input values for each parameter. The lists should be of equal length (and be up to length `max_batch_size`). The function is then *required* to return a tuple of lists (even if there is only 1 output component), with each list in the tuple corresponding to one output component.
+            max_batch_size: maximum number of inputs to batch together if this is called from the queue (only relevant if batch=True)
+            preprocess: if False, will not run preprocessing of component data before running 'fn' (e.g. leaving it as a base64 string if this method is called with the `Image` component).
+            postprocess: if False, will not run postprocessing of component data before returning 'fn' output to the browser.
+            cancels: a list of other events to cancel when this listener is triggered. For example, setting cancels=[click_event] will cancel the click_event, where click_event is the return value of another components .click method. Functions that have not yet run (or generators that are iterating) will be cancelled, but functions that are currently running will be allowed to finish.
+            every: continously calls `value` to recalculate it if `value` is a function (has no effect otherwise). Can provide a Timer whose tick resets `value`, or a float that provides the regular interval for the reset Timer.
+            trigger_mode: if "once" (default for all events except `.change()`) would not allow any submissions while an event is pending. If set to "multiple", unlimited submissions are allowed while pending, and "always_last" (default for `.change()` and `.key_up()` events) would allow a second submission after the pending event is complete.
+            js: optional frontend js method to run before running 'fn'. Input arguments for js method are values of 'inputs' and 'outputs', return should be a list of values for output components.
+            concurrency_limit: if set, this is the maximum number of this event that can be running simultaneously. Can be set to None to mean no concurrency_limit (any number of this event can be running simultaneously). Set to "default" to use the default concurrency limit (defined by the `default_concurrency_limit` parameter in `Blocks.queue()`, which itself is 1 by default).
+            concurrency_id: if set, this is the id of the concurrency group. Events with the same concurrency_id will be limited by the lowest set concurrency_limit.
+            show_api: whether to show this event in the "view API" page of the Gradio app, or in the ".view_api()" method of the Gradio clients. Unlike setting api_name to False, setting show_api to False will still allow downstream apps as well as the Clients to use this event. If fn is None, show_api will automatically be set to False.
+        
+        """
+        ...
+    
+    def stop(self,
+        fn: Callable[..., Any] | None = None,
+        inputs: Block | Sequence[Block] | set[Block] | None = None,
+        outputs: Block | Sequence[Block] | None = None,
+        api_name: str | None | Literal[False] = None,
+        scroll_to_output: bool = False,
+        show_progress: Literal["full", "minimal", "hidden"] = "full",
+        show_progress_on: Component | Sequence[Component] | None = None,
+        queue: bool | None = None,
+        batch: bool = False,
+        max_batch_size: int = 4,
+        preprocess: bool = True,
+        postprocess: bool = True,
+        cancels: dict[str, Any] | list[dict[str, Any]] | None = None,
+        every: Timer | float | None = None,
+        trigger_mode: Literal["once", "multiple", "always_last"] | None = None,
+        js: str | Literal[True] | None = None,
+        concurrency_limit: int | None | Literal["default"] = "default",
+        concurrency_id: str | None = None,
+        show_api: bool = True,
+    
+        ) -> Dependency:
+        """
+        Parameters:
+            fn: the function to call when this event is triggered. Often a machine learning model's prediction function. Each parameter of the function corresponds to one input component, and the function should return a single value or a tuple of values, with each element in the tuple corresponding to one output component.
+            inputs: list of gradio.components to use as inputs. If the function takes no inputs, this should be an empty list.
+            outputs: list of gradio.components to use as outputs. If the function returns no outputs, this should be an empty list.
+            api_name: defines how the endpoint appears in the API docs. Can be a string, None, or False. If False, the endpoint will not be exposed in the api docs. If set to None, will use the functions name as the endpoint route. If set to a string, the endpoint will be exposed in the api docs with the given name.
+            scroll_to_output: if True, will scroll to output component on completion
+            show_progress: how to show the progress animation while event is running: "full" shows a spinner which covers the output component area as well as a runtime display in the upper right corner, "minimal" only shows the runtime display, "hidden" shows no progress animation at all
+            show_progress_on: Component or list of components to show the progress animation on. If None, will show the progress animation on all of the output components.
+            queue: if True, will place the request on the queue, if the queue has been enabled. If False, will not put this event on the queue, even if the queue has been enabled. If None, will use the queue setting of the gradio app.
+            batch: if True, then the function should process a batch of inputs, meaning that it should accept a list of input values for each parameter. The lists should be of equal length (and be up to length `max_batch_size`). The function is then *required* to return a tuple of lists (even if there is only 1 output component), with each list in the tuple corresponding to one output component.
+            max_batch_size: maximum number of inputs to batch together if this is called from the queue (only relevant if batch=True)
+            preprocess: if False, will not run preprocessing of component data before running 'fn' (e.g. leaving it as a base64 string if this method is called with the `Image` component).
+            postprocess: if False, will not run postprocessing of component data before returning 'fn' output to the browser.
+            cancels: a list of other events to cancel when this listener is triggered. For example, setting cancels=[click_event] will cancel the click_event, where click_event is the return value of another components .click method. Functions that have not yet run (or generators that are iterating) will be cancelled, but functions that are currently running will be allowed to finish.
+            every: continously calls `value` to recalculate it if `value` is a function (has no effect otherwise). Can provide a Timer whose tick resets `value`, or a float that provides the regular interval for the reset Timer.
+            trigger_mode: if "once" (default for all events except `.change()`) would not allow any submissions while an event is pending. If set to "multiple", unlimited submissions are allowed while pending, and "always_last" (default for `.change()` and `.key_up()` events) would allow a second submission after the pending event is complete.
+            js: optional frontend js method to run before running 'fn'. Input arguments for js method are values of 'inputs' and 'outputs', return should be a list of values for output components.
+            concurrency_limit: if set, this is the maximum number of this event that can be running simultaneously. Can be set to None to mean no concurrency_limit (any number of this event can be running simultaneously). Set to "default" to use the default concurrency limit (defined by the `default_concurrency_limit` parameter in `Blocks.queue()`, which itself is 1 by default).
+            concurrency_id: if set, this is the id of the concurrency group. Events with the same concurrency_id will be limited by the lowest set concurrency_limit.
+            show_api: whether to show this event in the "view API" page of the Gradio app, or in the ".view_api()" method of the Gradio clients. Unlike setting api_name to False, setting show_api to False will still allow downstream apps as well as the Clients to use this event. If fn is None, show_api will automatically be set to False.
+        
+        """
+        ...
+    
+    def clear(self,
+        fn: Callable[..., Any] | None = None,
+        inputs: Block | Sequence[Block] | set[Block] | None = None,
+        outputs: Block | Sequence[Block] | None = None,
+        api_name: str | None | Literal[False] = None,
+        scroll_to_output: bool = False,
+        show_progress: Literal["full", "minimal", "hidden"] = "full",
+        show_progress_on: Component | Sequence[Component] | None = None,
+        queue: bool | None = None,
+        batch: bool = False,
+        max_batch_size: int = 4,
+        preprocess: bool = True,
+        postprocess: bool = True,
+        cancels: dict[str, Any] | list[dict[str, Any]] | None = None,
+        every: Timer | float | None = None,
+        trigger_mode: Literal["once", "multiple", "always_last"] | None = None,
+        js: str | Literal[True] | None = None,
+        concurrency_limit: int | None | Literal["default"] = "default",
+        concurrency_id: str | None = None,
+        show_api: bool = True,
+    
+        ) -> Dependency:
+        """
+        Parameters:
+            fn: the function to call when this event is triggered. Often a machine learning model's prediction function. Each parameter of the function corresponds to one input component, and the function should return a single value or a tuple of values, with each element in the tuple corresponding to one output component.
+            inputs: list of gradio.components to use as inputs. If the function takes no inputs, this should be an empty list.
+            outputs: list of gradio.components to use as outputs. If the function returns no outputs, this should be an empty list.
+            api_name: defines how the endpoint appears in the API docs. Can be a string, None, or False. If False, the endpoint will not be exposed in the api docs. If set to None, will use the functions name as the endpoint route. If set to a string, the endpoint will be exposed in the api docs with the given name.
+            scroll_to_output: if True, will scroll to output component on completion
+            show_progress: how to show the progress animation while event is running: "full" shows a spinner which covers the output component area as well as a runtime display in the upper right corner, "minimal" only shows the runtime display, "hidden" shows no progress animation at all
+            show_progress_on: Component or list of components to show the progress animation on. If None, will show the progress animation on all of the output components.
+            queue: if True, will place the request on the queue, if the queue has been enabled. If False, will not put this event on the queue, even if the queue has been enabled. If None, will use the queue setting of the gradio app.
+            batch: if True, then the function should process a batch of inputs, meaning that it should accept a list of input values for each parameter. The lists should be of equal length (and be up to length `max_batch_size`). The function is then *required* to return a tuple of lists (even if there is only 1 output component), with each list in the tuple corresponding to one output component.
+            max_batch_size: maximum number of inputs to batch together if this is called from the queue (only relevant if batch=True)
+            preprocess: if False, will not run preprocessing of component data before running 'fn' (e.g. leaving it as a base64 string if this method is called with the `Image` component).
+            postprocess: if False, will not run postprocessing of component data before returning 'fn' output to the browser.
+            cancels: a list of other events to cancel when this listener is triggered. For example, setting cancels=[click_event] will cancel the click_event, where click_event is the return value of another components .click method. Functions that have not yet run (or generators that are iterating) will be cancelled, but functions that are currently running will be allowed to finish.
+            every: continously calls `value` to recalculate it if `value` is a function (has no effect otherwise). Can provide a Timer whose tick resets `value`, or a float that provides the regular interval for the reset Timer.
+            trigger_mode: if "once" (default for all events except `.change()`) would not allow any submissions while an event is pending. If set to "multiple", unlimited submissions are allowed while pending, and "always_last" (default for `.change()` and `.key_up()` events) would allow a second submission after the pending event is complete.
+            js: optional frontend js method to run before running 'fn'. Input arguments for js method are values of 'inputs' and 'outputs', return should be a list of values for output components.
+            concurrency_limit: if set, this is the maximum number of this event that can be running simultaneously. Can be set to None to mean no concurrency_limit (any number of this event can be running simultaneously). Set to "default" to use the default concurrency limit (defined by the `default_concurrency_limit` parameter in `Blocks.queue()`, which itself is 1 by default).
+            concurrency_id: if set, this is the id of the concurrency group. Events with the same concurrency_id will be limited by the lowest set concurrency_limit.
+            show_api: whether to show this event in the "view API" page of the Gradio app, or in the ".view_api()" method of the Gradio clients. Unlike setting api_name to False, setting show_api to False will still allow downstream apps as well as the Clients to use this event. If fn is None, show_api will automatically be set to False.
+        
+        """
+        ...