组件
视频

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

UploadButton

EventData

视频

gradio.Video(···)

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

描述

创建一个视频组件，可以用于上传/录制视频（作为输入）或显示视频（作为输出）。为了使视频在浏览器中可播放，它必须具有兼容的容器和编解码器组合。.mp4 与 h264 编解码器、.ogg 与 theora 编解码器以及 .webm 与 vp9 编解码器是允许的组合。如果组件检测到输出视频在浏览器中不可播放，它将尝试将其转换为可播放的 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

视频组件将要采用的默认值的路径或 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 | 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 应用于行，以及 Blocks 中 fill_height=True 的顶级组件。

🔗

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 | None

默认值 = None

如果已分配，将用于在重新渲染时假定身份。在重新渲染中具有相同键的组件将保留其值。

🔗

mirror_webcam: bool

默认值 = True

如果为 True，网络摄像头将镜像。默认为 True。

🔗

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

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

🔗

watermark: str | Path | None

默认值 = None

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

🔗

webcam_constraints: dict[str, Any] | None

默认值 = None

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

快捷方式

类	Interface 字符串快捷方式	初始化
`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 时，将触发此监听器。
`Video.start_recording(fn, ···)`	当用户开始使用 Video 录制时，将触发此监听器。
`Video.stop_recording(fn, ···)`	当用户停止使用 Video 录制时，将触发此监听器。
`Video.stop(fn, ···)`	当用户到达 Video 中播放的媒体末尾时，将触发此监听器。
`Video.play(fn, ···)`	当用户播放 Video 中的媒体时，将触发此监听器。
`Video.pause(fn, ···)`	当 Video 中的媒体因任何原因停止时，将触发此监听器。
`Video.end(fn, ···)`	当用户到达 Video 中播放的媒体末尾时，将触发此监听器。
`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

在运行 'fn' 之前要运行的可选前端 js 方法。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。

🔗