gradio-doctestvideo

gradio_doctestvideo

Python library for easily interacting with trained machine learning models

Installation

pip install gradio_doctestvideo

Usage

import gradio as gr
from gradio_doctestvideo import DocTestVideo


example = DocTestVideo().example_inputs()

demo = gr.Interface(
    lambda x:x,
    DocTestVideo(),  # interactive version of your component
    DocTestVideo(),  # static version of your component
    # examples=[[example]],  # uncomment this line to view the "example version" of your component
)


if __name__ == "__main__":
    demo.launch()

DocTestVideo

Initialization

name	type	default	description
value	str | Path | tuple[str | Path, str | Path | None] | Callable | None	None	A path or URL for the default value that DocTestVideo component is going to take. Can also be a tuple consisting of (video filepath, subtitle filepath). If a subtitle file is provided, it should be of type .srt or .vtt. Or can be callable, in which case the function will be called whenever the app loads to set the initial value of the component.
format	str | None	None	Format of video format to be returned by component, such as 'avi' or 'mp4'. Use 'mp4' to ensure browser playability. If set to None, video will keep uploaded format.
sources	list[Literal["upload", "webcam"]] | None	None	A list of sources permitted for video. "upload" creates a box where user can drop an video file, "webcam" allows user to record a video from their webcam. If None, defaults to ["upload, "webcam"].
height	int | str | None	None	The height of the displayed video, specified in pixels if a number is passed, or in CSS units if a string is passed.
width	int | str | None	None	The width of the displayed video, specified in pixels if a number is passed, or in CSS units if a string is passed.
label	str | None	None	The label for this component. Appears above the component 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 is assigned to.
every	float | None	None	If `value` is a callable, run the function 'every' number of seconds while the client connection is open. Has no effect otherwise. Queue must be enabled. The event can be accessed (e.g. to cancel it) via this component's .load_event attribute.
show_label	bool | None	None	if True, will display label.
container	bool	True	If True, will place the component in a container - providing some extra padding around the border.
scale	int | None	None	relative width compared to adjacent Components in a Row. For example, if Component A has scale=2, and Component B has scale=1, A will be twice as wide as B. Should be an integer.
min_width	int	160	minimum pixel width, will wrap if not sufficient screen space to satisfy this value. If a certain scale value results in this Component being narrower than min_width, the min_width parameter will be respected first.
interactive	bool | None	None	if True, will allow users to upload a video; if False, can only be used to display videos. If not provided, this is inferred based on whether the component is used as an input or output.
visible	bool	True	If False, component will be hidden.
elem_id	str | None	None	An optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles.
elem_classes	list[str] | str | None	None	An optional list of strings that are assigned as the classes of this component in the HTML DOM. Can be used for targeting CSS styles.
render	bool	True	If False, component will not render be rendered in the Blocks context. Should be used if the intention is to assign event listeners now but render the component later.
mirror_webcam	bool	True	If True webcam will be mirrored. Default is True.
include_audio	bool | None	None	Whether the component should record/retain the audio track for a video. By default, audio is excluded for webcam videos and included for uploaded videos.
autoplay	bool	False	Whether to automatically play the video when the component is used as an output. Note: browsers will not autoplay video files if the user has not interacted with the page yet.
show_share_button	bool | None	None	If True, will show a share icon in the corner of the component that allows user to share outputs to Hugging Face Spaces Discussions. If False, icon does not appear. If set to None (default behavior), then the icon appears if this Gradio app is launched on Spaces, but not otherwise.
min_length	int | None	None	The minimum length of video (in seconds) that the user can pass into the prediction function. If None, there is no minimum length.
max_length	int | None	None	The maximum length of video (in seconds) that the user can pass into the prediction function. If None, there is no maximum length.

Events

name	description
change	Triggered when the value of the DocTestVideo changes either because of user input (e.g. a user types in a textbox) OR because of a function update (e.g. an image receives a value from the output of an event trigger). See .input() for a listener that is only triggered by user input.
clear	This listener is triggered when the user clears the DocTestVideo using the X button for the component.
start_recording	This listener is triggered when the user starts recording with the DocTestVideo.
stop_recording	This listener is triggered when the user stops recording with the DocTestVideo.
stop	This listener is triggered when the user reaches the end of the media playing in the DocTestVideo.
play	This listener is triggered when the user plays the media in the DocTestVideo.
pause	This listener is triggered when the media in the DocTestVideo stops for any reason.
end	This listener is triggered when the user reaches the end of the media playing in the DocTestVideo.
upload	This listener is triggered when the user uploads a file into the DocTestVideo.

User function

def predict(
    value: str | None
) -> str | Path | tuple[str | Path, str | Path | None] | None:
    return value