Démarrage

Copiez un prompt de configuration avec les étapes d'installation et le guide Markdown complet pour ce plugin.

        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.

Installer

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

Importer

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

API Présentation

`getThumbnail`

Générer une image de miniature à partir d'un fichier vidéo à une position de temps spécifique.

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);

Référence de type

`VideoThumbnailsOptions`

Options pour la génération d'une image de miniature de vidéo.

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`

Résultat de la génération de l'image de miniature.

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;
}

Source Of Truth

Cette page est générée à partir du plugin’s src/definitions.tsRe-run the sync when the public API changes upstream.