组件
视频

Gradio 新手？从这里开始：入门

上传按钮

EventData

视频

gradio.Video(···)

import gradio as gr with gr.Blocks() as demo: gr.Video() demo.launch()

描述

创建一个视频组件，可用于上传/录制视频（作为输入）或显示视频（作为输出）。为了使视频能在浏览器中播放，它必须具有兼容的容器和编解码器组合。允许的组合是带有 h264 编解码器的 .mp4、带有 theora 编解码器的 .ogg 和带有 vp9 编解码器的 .webm。如果组件检测到输出视频无法在浏览器中播放，它将尝试将其转换为可播放的 mp4 视频。如果转换失败，将返回原始视频。

行为

作为输入组件: 将上传的视频作为 `str` 文件路径或 URL 传递，其扩展名可通过 `format` 进行修改。

您的函数应接受以下类型之一

def predict(
	value: str | None
)
	...

作为输出组件: 需要一个 `str` 或 `pathlib.Path` 类型的视频文件路径以供显示，或者是一个 `Tuple[str | pathlib.Path, str | pathlib.Path | None]`，其中第一个元素是视频文件路径，第二个元素是可选的字幕文件路径。

您的函数应返回以下类型之一

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

初始化

🔗

value: str | Path | tuple[str | Path, str | Path | None] | Callable | None

默认值 = None

Video 组件将采用的默认值的路径或 URL。也可以是包含（视频文件路径，字幕文件路径）的元组。如果提供了字幕文件，它应该是 .srt 或 .vtt 类型。也可以是可调用对象，在这种情况下，每当应用程序加载时，该函数将被调用以设置组件的初始值。

🔗

format: str | None

默认值 = None

保存视频的文件扩展名，例如“avi”或“mp4”。此参数适用于两种情况：当此组件用作输入时，用于确定将用户提供的视频转换为哪种文件格式；当此组件用作输出时，用于确定返回给用户的视频格式。如果为 None，则不进行文件格式转换，视频保持原样。使用“mp4”以确保浏览器可播放性。

🔗

sources: list[Literal['upload', 'webcam']] | Literal['upload', 'webcam'] | None

默认值 = None

视频允许的源列表。“upload”创建一个用户可以放置视频文件的框，“webcam”允许用户从其网络摄像头录制视频。如果为 None，则默认使用两者 ["upload", "webcam"]。

🔗

height: int | str | None

默认值 = None

组件的高度，如果传入数字则以像素为单位，如果传入字符串则以 CSS 单位表示。这不会影响预处理的视频文件，但会影响显示的视频。

🔗

width: int | str | None

默认值 = None

组件的宽度，如果传入数字则以像素为单位，如果传入字符串则以 CSS 单位表示。这不会影响预处理的视频文件，但会影响显示的视频。

🔗

label: str | I18nData | None

默认值 = None

此组件的标签。显示在组件上方，如果此组件有示例表格，则也用作标题。如果为 None 并在 `gr.Interface` 中使用，则标签将是此组件所分配参数的名称。

🔗

every: Timer | float | None

默认值 = None

如果 `value` 是一个函数，则持续调用 `value` 以重新计算（否则无效）。可以提供一个 Timer，其滴答声会重置 `value`，或者一个浮点数，提供重置 Timer 的常规间隔。

🔗

inputs: Component | list[Component] | set[Component] | None

默认值 = None

用作输入以计算 `value` 的组件，如果 `value` 是一个函数（否则无效）。每当输入改变时，`value` 都会重新计算。

🔗

show_label: bool | None

默认值 = None

如果为 True，将显示标签。

🔗

container: bool

默认值 = True

如果为 True，将把组件放置在一个容器中——在边框周围提供一些额外的填充。

🔗

scale: int | None

默认值 = None

相对于相邻组件的相对大小。例如，如果组件 A 和 B 在一行中，A 的 scale=2，B 的 scale=1，那么 A 将是 B 的两倍宽。应为整数。scale 适用于行，以及在 fill_height=True 的 Blocks 中的顶级组件。

🔗

min_width: int

默认值 = 160

最小像素宽度，如果屏幕空间不足以满足此值则会换行。如果某个 scale 值导致此组件宽度小于 min_width，则将首先遵循 min_width 参数。

🔗

interactive: bool | None

默认值 = None

如果为 True，将允许用户上传视频；如果为 False，则只能用于显示视频。如果未提供，则根据组件是用作输入还是输出进行推断。

🔗

visible: bool

默认值 = True

如果为 False，组件将被隐藏。

🔗

elem_id: str | None

默认值 = None

一个可选字符串，作为此组件在 HTML DOM 中的 ID。可用于定位 CSS 样式。

🔗

elem_classes: list[str] | str | None

默认值 = None

一个可选的字符串列表，作为此组件在 HTML DOM 中的类。可用于定位 CSS 样式。

🔗

render: bool

默认值 = True

如果为 False，组件将不会在 Blocks 上下文中渲染。如果目的是现在分配事件监听器但稍后渲染组件，则应使用此参数。

🔗

key: int | str | tuple[int | str, ...] | None

默认值 = None

在 gr.render 中，在重新渲染时具有相同 key 的组件被视为同一组件，而不是新组件。在 'preserved_by_key' 中设置的属性在重新渲染时不会重置。

🔗

preserved_by_key: list[str] | str | None

默认值 = "value"

此组件构造函数中的参数列表。在 gr.render() 函数中，如果一个组件以相同的 key 重新渲染，这些（且仅这些）参数将在 UI 中保留（如果它们已被用户或事件监听器更改），而不是根据构造函数中提供的值重新渲染。

🔗

mirror_webcam: bool | None

默认值 = None

🔗

webcam_options: WebcamOptions | None

默认值 = None

一个 `gr.WebcamOptions` 实例，允许开发人员为网络摄像头流指定自定义媒体约束。此参数提供了灵活性，可控制视频流的属性，例如移动设备上的分辨率和前置或后置摄像头。请参阅 demo/webcam_constraints

🔗

include_audio: bool | None

默认值 = None

组件是否应录制/保留视频的音轨。默认情况下，网络摄像头视频排除音频，上传视频包含音频。

🔗

autoplay: bool

默认值 = False

当组件用作输出时是否自动播放视频。注意：如果用户尚未与页面交互，浏览器将不会自动播放视频文件。

🔗

show_share_button: bool | None

默认值 = None

如果为 True，将在组件角落显示一个共享图标，允许用户将输出分享到 Hugging Face Spaces Discussions。如果为 False，则不显示图标。如果设置为 None（默认行为），则只有当此 Gradio 应用程序在 Spaces 上启动时，图标才会出现，否则不会。

🔗

show_download_button: bool | None

默认值 = None

如果为 True，将在组件角落显示一个下载图标，允许用户下载输出。如果为 False，则不显示图标。默认情况下，输出组件为 True，输入组件为 False。

🔗

min_length: int | None

默认值 = None

用户可以传递给预测函数的视频最小长度（秒）。如果为 None，则没有最小长度限制。

🔗

max_length: int | None

默认值 = None

用户可以传递给预测函数的视频最大长度（秒）。如果为 None，则没有最大长度限制。

🔗

loop: bool

默认值 = False

如果为 True，视频在播放到结尾时将循环并从头开始播放。

🔗

streaming: bool

默认值 = False

当设置为输出时，它会接收后端生成的视频分块，并将它们组合成一个流式视频输出。每个分块都应是使用 h.264 编码的 .ts 扩展名视频文件。Mp4 文件也接受，但它们将被转换为 h.264 编码。

🔗

watermark: str | Path | None

默认值 = None

一个图像文件，作为视频的水印。图像不缩放，显示在视频的右下角。图像的有效格式为：jpeg、png。

🔗

webcam_constraints: dict[str, Any] | None

默认值 = None

快捷方式

类	接口字符串快捷方式	初始化
`gradio.Video`	"video"	使用默认值
`gradio.PlayableVideo`	"playablevideo"	使用 format="mp4"

演示

import gradio as gr def video_identity(video): return video demo = gr.Interface(video_identity, gr.Video(), "playable_video", ) if __name__ == "__main__": demo.launch()

import gradio as gr

def video_identity(video):
    return video

demo = gr.Interface(video_identity,
                    gr.Video(),
                    "playable_video",
                    )

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

事件监听器

描述

事件监听器允许您响应用户与您在 Gradio Blocks 应用程序中定义的 UI 组件的交互。当用户与某个元素交互时，例如更改滑块值或上传图像，将调用一个函数。

支持的事件监听器

Video 组件支持以下事件监听器。每个事件监听器都接受相同的参数，这些参数列在下面的事件参数表中。

监听器	描述
`Video.change(fn, ···)`	当 Video 的值因用户输入（例如用户在文本框中输入）或函数更新（例如图像从事件触发器的输出接收值）而改变时触发。有关仅由用户输入触发的监听器，请参阅 `.input()`。
`Video.clear(fn, ···)`	当用户使用组件的清除按钮清除视频时，会触发此监听器。
`Video.start_recording(fn, ···)`	当用户开始使用 Video 进行录制时，会触发此监听器。
`Video.stop_recording(fn, ···)`	当用户停止使用 Video 进行录制时，会触发此监听器。
`Video.stop(fn, ···)`	当用户播放到视频媒体的末尾时，会触发此监听器。
`Video.play(fn, ···)`	当用户播放 Video 中的媒体时，会触发此监听器。
`Video.pause(fn, ···)`	当 Video 中的媒体因任何原因停止时，会触发此监听器。
`Video.end(fn, ···)`	当用户播放到视频媒体的末尾时，会触发此监听器。
`Video.upload(fn, ···)`	当用户将文件上传到 Video 中时，会触发此监听器。

事件参数

🔗

fn: Callable | None | Literal['decorator']

默认值 = "decorator"

此事件触发时要调用的函数。通常是机器学习模型的预测函数。函数的每个参数对应一个输入组件，函数应返回单个值或值的元组，其中元组中的每个元素对应一个输出组件。

🔗

inputs: Component | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | None

默认值 = None

要用作输入的 gradio.components 列表。如果函数不接受任何输入，则此参数应为空列表。

🔗

outputs: Component | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | None

默认值 = None

要用作输出的 gradio.components 列表。如果函数不返回任何输出，则此参数应为空列表。

🔗

api_name: str | None | Literal[False]

默认值 = None

定义端点在 API 文档中显示的方式。可以是字符串、None 或 False。如果设置为字符串，则端点将以给定名称在 API 文档中公开。如果为 None（默认），则函数名称将用作 API 端点。如果为 False，则端点将不会在 API 文档中公开，并且下游应用程序（包括那些 `gr.load` 此应用程序的）将无法使用此事件。

🔗

scroll_to_output: bool

默认值 = False

如果为 True，完成时将滚动到输出组件。

🔗

show_progress: Literal['full', 'minimal', 'hidden']

默认值 = "full"

事件运行时如何显示进度动画：“full”显示一个覆盖输出组件区域的旋转器以及右上角的运行时显示；“minimal”仅显示运行时显示；“hidden”完全不显示进度动画。

🔗

show_progress_on: Component | list[Component] | None

默认值 = None

显示进度动画的组件或组件列表。如果为 None，将在所有输出组件上显示进度动画。

🔗

queue: bool

默认值 = True

如果为 True，则在队列已启用时将请求放入队列。如果为 False，则即使队列已启用，也不会将此事件放入队列。如果为 None，则将使用 Gradio 应用程序的队列设置。

🔗

batch: bool

默认值 = False

如果为 True，则函数应处理一批输入，这意味着它应接受每个参数的输入值列表。这些列表的长度应相等（并且最多为 `max_batch_size` 长度）。然后，函数*必须*返回一个列表元组（即使只有一个输出组件），其中元组中的每个列表对应一个输出组件。

🔗

max_batch_size: int

默认值 = 4

如果从队列调用此函数，则要批量处理的最大输入数量（仅当 batch=True 时相关）。

🔗

preprocess: bool

默认值 = True

如果为 False，则在运行 'fn' 之前不会对组件数据进行预处理（例如，如果此方法与 `Image` 组件一起调用，则会将其保留为 base64 字符串）。

🔗

postprocess: bool

默认值 = True

如果为 False，则在将 'fn' 输出返回到浏览器之前，不会对组件数据进行后处理。

🔗

cancels: dict[str, Any] | list[dict[str, Any]] | None

默认值 = None

当此监听器触发时要取消的其他事件列表。例如，设置 cancels=[click_event] 将取消 click_event，其中 click_event 是另一个组件的 .click 方法的返回值。尚未运行的函数（或正在迭代的生成器）将被取消，但正在运行的函数将允许完成。

🔗

trigger_mode: Literal['once', 'multiple', 'always_last'] | None

默认值 = None

如果为“once”（除 `.change()` 之外所有事件的默认值），则在事件待处理时不允许任何提交。如果设置为“multiple”，则在待处理时允许无限次提交；“always_last”（`.change()` 和 `.key_up()` 事件的默认值）则允许在待处理事件完成后进行第二次提交。

🔗

js: str | Literal[True] | None

默认值 = None

可选的前端 js 方法，在运行 'fn' 之前执行。js 方法的输入参数是 'inputs' 和 'outputs' 的值，返回值应是输出组件的值列表。

🔗

concurrency_limit: int | None | Literal['default']

默认值 = "default"

如果设置，这是此事件可以同时运行的最大数量。可以设置为 None 表示没有 concurrency_limit（此事件可以同时运行任意数量）。设置为“default”以使用默认并发限制（由 `Blocks.queue()` 中的 `default_concurrency_limit` 参数定义，其默认值为 1）。

🔗

concurrency_id: str | None

默认值 = None

如果设置，这是并发组的 ID。具有相同 concurrency_id 的事件将受到最低设置的 concurrency_limit 的限制。

🔗

show_api: bool

默认值 = True

是否在 Gradio 应用程序的“查看 API”页面或 Gradio 客户端的“.view_api()”方法中显示此事件。与将 api_name 设置为 False 不同，将 show_api 设置为 False 仍将允许下游应用程序和客户端使用此事件。如果 fn 为 None，show_api 将自动设置为 False。

🔗

time_limit: int | None

默认值 = None

🔗

stream_every: float

默认值 = 0.5

🔗

like_user_message: bool

默认值 = False

🔗

key: int | str | tuple[int | str, ...] | None

默认值 = None

此事件监听器在 @gr.render() 中使用的唯一 key。如果设置，当 key 相同的情况下，此值将标识在重新渲染时事件是否相同。

辅助类

网络摄像头选项

gradio.WebcamOptions(···)

描述

一个数据类，用于指定 ImageEditor 组件中网络摄像头工具的选项。此类的实例可以传递给 `gr.ImageEditor` 的 `webcam_options` 参数。

初始化

🔗

mirror: bool

默认值 = True

如果为 True，网络摄像头将镜像显示。

🔗

constraints: dict[str, Any] | None

默认值 = None

网络摄像头的约束字典。

←

上传按钮

EventData

→

视频

描述

行为

作为输入组件: 将上传的视频作为 str 文件路径或 URL 传递，其扩展名可通过 format 进行修改。

您的函数应接受以下类型之一

作为输出组件: 需要一个 str 或 pathlib.Path 类型的视频文件路径以供显示，或者是一个 Tuple[str | pathlib.Path, str | pathlib.Path | None]，其中第一个元素是视频文件路径，第二个元素是可选的字幕文件路径。

您的函数应返回以下类型之一

初始化

快捷方式

演示

事件监听器

描述

支持的事件监听器

事件参数

辅助类

网络摄像头选项

描述

一个数据类，用于指定 ImageEditor 组件中网络摄像头工具的选项。此类的实例可以传递给 gr.ImageEditor 的 webcam_options 参数。

初始化

作为输入组件: 将上传的视频作为 `str` 文件路径或 URL 传递，其扩展名可通过 `format` 进行修改。

作为输出组件: 需要一个 `str` 或 `pathlib.Path` 类型的视频文件路径以供显示，或者是一个 `Tuple[str | pathlib.Path, str | pathlib.Path | None]`，其中第一个元素是视频文件路径，第二个元素是可选的字幕文件路径。

一个数据类，用于指定 ImageEditor 组件中网络摄像头工具的选项。此类的实例可以传递给 `gr.ImageEditor` 的 `webcam_options` 参数。