1. 组件
  2. 视频

刚开始使用 Gradio？ 从这里开始： 入门指南

查看 发布历史

←

UploadButton

EventData

→

视频

gradio.Video(···)

描述

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

视频组件将采用的默认值的路径或 URL。也可以是可调用对象，在这种情况下，每当应用程序加载时都会调用该函数来设置组件的初始值。

🔗 
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，其 tick 会重置 `value`，或者提供一个 float 值来提供重置 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 在一个 Row 中，A 的 scale 为 2，B 的 scale 为 1，则 A 的宽度将是 B 的两倍。应为整数。scale 适用于 Rows，以及 Blocks 中 fill_height=True 的顶级组件。

🔗 
min_width: int
默认 = 160

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

🔗 
interactive: bool | None
默认 = None

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

🔗 
visible: bool | Literal['hidden']
默认 = True

如果为 False，则组件将隐藏。如果为“hidden”，则组件将视觉上隐藏并且不会在布局中占用空间，但仍存在于 DOM 中。

🔗 
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` 中，跨重渲染具有相同键的组件被视为同一个组件，而不是一个新组件。在 `preserved_by_key` 中设置的属性在重渲染时不会重置。

🔗 
preserved_by_key: list[str] | str | None
默认 = "value"

此组件构造函数中的参数列表。在 `gr.render()` 函数内部，如果一个组件使用相同的键进行重渲染，则这些（也是唯一的）参数将在 UI 中被保留（如果它们已被用户或事件监听器更改），而不是根据构造函数中提供的值进行重渲染。

🔗 
webcam_options: WebcamOptions | None
默认 = None

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

🔗 
include_audio: bool | None
默认 = None

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

🔗 
autoplay: bool
默认 = False

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

🔗 
buttons: list[Literal['download', 'share'] | Button] | None
默认 = None

组件右上角显示的按钮列表。有效选项是 "download"、"share" 或 gr.Button() 实例。"download" 按钮允许用户将视频保存到其设备。"share" 按钮允许用户通过 Hugging Face Spaces Discussions 分享视频。自定义 gr.Button() 实例将以其配置的图标和/或标签出现在工具栏中，单击它们将触发在按钮上注册的任何 .click() 事件。默认情况下，如果组件是交互式的，则不显示任何按钮；如果组件不是交互式的，则显示这两个按钮。

🔗 
loop: bool
默认 = False

如果为 True，视频到达末尾时将循环播放，并从头开始继续播放。

🔗 
streaming: bool
默认 = False

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

🔗 
watermark: WatermarkOptions | None
默认 = None

一个 `gr.WatermarkOptions` 实例，包含一个图像文件和位置，用作视频上的水印。图像不缩放，并显示在视频上的指定位置。图像的有效格式为：jpeg、png。

🔗 
subtitles: str | Path | list[dict[str, Any]] | None
默认 = None

视频的字幕文件（srt、vtt 或 json），或者格式为 [{"text": str, "timestamp": [start, end]}] 的字幕字典列表，其中时间戳以秒为单位。JSON 文件应包含一个字幕对象数组。

🔗 
playback_position: float
默认 = 0

起始播放位置（秒）。此值也会随着视频播放而更新，反映当前的播放位置。

快捷方式

快捷方式
gradio.Video
Interface String Shortcut "video"
初始化 使用默认值
gradio.PlayableVideo
Interface String Shortcut "playablevideo"
Initialization Uses format="mp4"

演示

事件监听器

描述

事件监听器允许您响应 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 中时触发此监听器。

Video.input(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
默认 = None

定义该端点在 API 文档中如何显示。可以是字符串或 None。如果设置为字符串，则该端点将在 API 文档中以给定名称显示。如果为 None（默认），则使用函数的名称作为 API 端点。

🔗 
api_description: str | None | Literal[False]
默认 = None

API 端点的描述。可以是字符串、None 或 False。如果设置为字符串，则该端点将在 API 文档中以给定描述显示。如果为 None，则使用函数的 docstring 作为 API 端点描述。如果为 False，则 API 文档中不会显示任何描述。

🔗 
scroll_to_output: bool
默认 = False

完成后是否滚动到输出组件

🔗 
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，表示没有并发限制（此事件可以同时运行任意数量）。设置为 "default" 可使用 `Blocks.queue()` 中的 `default_concurrency_limit` 参数定义的默认并发限制（该参数本身默认为 1）。

🔗 
concurrency_id: str | None
默认 = None

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

🔗 
api_visibility: Literal['public', 'private', 'undocumented']
默认 = "public"

控制此端点的可见性和可访问性。可以是 "public"（在 API 文档中显示并可由客户端调用）、"private"（在 API 文档中隐藏，不可由客户端调用）或 "undocumented"（在 API 文档中隐藏，但可由客户端通过 gr.load 调用）。如果 fn 为 None，则 api_visibility 将自动设置为 "private"。

🔗 
time_limit: int | None
默认 = None
🔗 
stream_every: float
默认 = 0.5
🔗 
key: int | str | tuple[int | str, ...] | None
默认 = None

此事件监听器的唯一键，用于 @gr.render()。如果设置，此值标识在重渲染时具有相同键的事件为相同的事件。

🔗 
validator: Callable | None
默认 = None

可选的验证函数，在主函数运行之前执行。如果提供，此函数将首先使用 queue=False 执行，只有在成功完成后才会调用主函数。验证器接收与主函数相同的输入，并应为每个输入值返回一个 `gr.validate()`。

辅助类

网络摄像头选项

gradio.WebcamOptions(···)

描述

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

初始化

参数
🔗 
mirror: bool
默认 = True

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

🔗 
constraints: dict[str, Any] | None
默认 = None

网络摄像头的约束字典。

is_video_correct_length

验证音频长度是否在指定的最小和最大长度（以秒为单位）内。您可以使用此方法来构建一个验证器，用于检查用户提供的音频是太短还是太长。

import gradio as gr
demo = gr.Interface(
    lambda x: x,
    inputs="video",
    outputs="video",
    validator=lambda video: gr.validators.is_video_correct_length(video, min_length=1, max_length=5)
)
demo.launch()

初始化

参数
🔗 
video: <class 'str'>

视频文件路径。

🔗 
min_length: float | None

视频的最小长度（秒）。如果为 None，则不执行最小长度检查。

🔗 
max_length: float | None

视频的最大长度（秒）。如果为 None，则不执行最大长度检查。

←

UploadButton

EventData

→
gradio