快速入门

复制包含安装步骤和该插件完整 Markdown 指南的配置 prompt。

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-video-thumbnails`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/video-thumbnails/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

安装

你可以使用我们的 AI 辅助设置来安装插件。使用以下命令将 Capgo skills 添加到你的 AI 工具中：

bunx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

然后使用以下 prompt：

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-video-thumbnails` plugin in my project.

如果你更想手动设置，请运行以下命令安装插件，并按照下方各平台的说明操作：

bun add @capgo/capacitor-video-thumbnails
bunx cap sync

导入

import { CapgoVideoThumbnails } from '@capgo/capacitor-video-thumbnails';

快速入门

import { CapgoVideoThumbnails } from '@capgo/capacitor-video-thumbnails';

const result = await CapgoVideoThumbnails.getThumbnail({
  sourceUri: 'file:///path/to/video.mp4',
  time: 5000,
  quality: 0.8
});
console.log('Thumbnail URI:', result.uri);
console.log('Dimensions:', result.width, 'x', result.height);

常见坑点

原生同步：运行 bunx cap sync 在插件升级后。
唯一可信来源：信任 src/definitions.ts 在 GitHub 仓库中。

API 概览

`getThumbnail`

从视频文件中指定的时间点生成缩略图。

import { CapgoVideoThumbnails } from '@capgo/capacitor-video-thumbnails';

const result = await CapgoVideoThumbnails.getThumbnail({
  sourceUri: 'file:///path/to/video.mp4',
  time: 5000,
  quality: 0.8
});
console.log('Thumbnail URI:', result.uri);
console.log('Dimensions:', result.width, 'x', result.height);

类型参考

`VideoThumbnailsOptions`

生成视频缩略图的选项。

export interface VideoThumbnailsOptions {
  /**
   * The URI of the video file. Can be a local file path or a remote URL.
   * For local files, use file:// protocol or absolute path.
   * For remote files, use http:// or https:// protocol.
   */
  sourceUri: string;

  /**
   * The time position in milliseconds from which to extract the thumbnail.
   * Defaults to 0 (first frame).
   */
  time?: number;

  /**
   * Quality of the generated image, from 0.0 (lowest) to 1.0 (highest).
   * Defaults to 1.0.
   */
  quality?: number;

  /**
   * HTTP headers to include when fetching remote video URIs.
   * Only applicable for remote URLs.
   */
  headers?: Record<string, string>;
}

`VideoThumbnailsResult`

缩略图生成结果。

export interface VideoThumbnailsResult {
  /**
   * The local URI path to the generated thumbnail image.
   * This can be used directly in img tags or Image components.
   */
  uri: string;

  /**
   * Width of the generated thumbnail in pixels.
   */
  width: number;

  /**
   * Height of the generated thumbnail in pixels.
   */
  height: number;
}

单一事实来源

本页面由插件的 src/definitions.ts生成。当上游的公共 API 发生变化时，请重新运行 sync。

从入门指南继续

如果你正在使用 快速入门 来规划原生媒体和界面行为，并将其与使用 @capgo/capacitor-video-thumbnails 在“使用 @capgo/capacitor-video-thumbnails”中实现原生能力，使用 @capgo/capacitor-live-activities 用于使用 @capgo/capacitor-live-activities 时的原生能力， @capgo/capacitor-live-activities 在 @capgo/capacitor-live-activities 中的实现细节，使用 @capgo/capacitor-video-player 有关使用 @capgo/capacitor-video-player 时的原生能力，以及 @capgo/capacitor-video-player 关于 @capgo/capacitor-video-player. 中的实现细节