Getting Started

复制一个包含安装步骤和本插件的完整Markdown指南的设置提示。

        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.

安装

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

导入

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

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 在上游发生变化时，请重新同步。

继续从 Getting Started

如果您正在使用 Getting Started 来规划原生媒体和界面行为，连接它到使用 @capgo/capacitor-video-thumbnails 使用 @capgo/capacitor-video-thumbnails 原生能力的 Using @capgo/capacitor-video-thumbnails 中，为使用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的实现细节,