Premiers pas

Installer

Vous pouvez utiliser notre configuration assistée par IA pour installer le plugin. Ajoutez les skills Capgo à votre outil d'IA avec la commande suivante :

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

Utilisez ensuite le prompt suivant :

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

Si vous préférez la configuration manuelle, installez le plugin avec les commandes suivantes, puis suivez les instructions spécifiques à chaque plateforme ci-dessous :

npm install @capgo/capacitor-ffmpeg
npx cap sync

Importer

import { CapacitorFFmpeg } from '@capgo/capacitor-ffmpeg';

Démarrage rapide

import { CapacitorFFmpeg } from '@capgo/capacitor-ffmpeg';

const result = await CapacitorFFmpeg.getCapabilities();
console.log(result);

Exemple : reencodeVideo

import { CapacitorFFmpeg } from '@capgo/capacitor-ffmpeg';

const progressListener = await CapacitorFFmpeg.addListener('progress', ({ progress }) => {
  console.log('Encode progress', progress);
});

const job = await CapacitorFFmpeg.reencodeVideo({
  inputPath: 'path/to/file',
  outputPath: 'path/to/file',
  width: 1080,
  height: 1920,
});
// Job acceptance only; wait for progress/completion listeners before using the output file.
console.log(job);

await progressListener.remove();

Exemple : convertImage

import { CapacitorFFmpeg } from '@capgo/capacitor-ffmpeg';

const result = await CapacitorFFmpeg.convertImage({
  inputPath: 'path/to/file',
  outputPath: 'path/to/file',
  format: 'jpeg',
});
console.log(result);

Erreurs courantes

• Écouteurs : supprimez les handles lors du démontage des écrans.
• Sync native : exécutez npx cap sync après la mise à jour des plugins.
• Source de vérité: confiance src/definitions.ts dans le repo GitHub.

Aperçu de API

getCapabilities

Renvoie la matrice des capacités lisible par machine pour la plateforme actuelle.

import { CapacitorFFmpeg } from '@capgo/capacitor-ffmpeg';

const result = await CapacitorFFmpeg.getCapabilities();
console.log(result);

reencodeVideo

Mettre en file d'attente un job de réencodage vidéo.

Sur iOS, la promesse renvoyée se résout lorsque la couche native accepte la tâche. Le succès ou l'échec final est transmis via le progress listener.

Android et le web rejettent actuellement avec UNIMPLEMENTED.

import { CapacitorFFmpeg } from '@capgo/capacitor-ffmpeg';

const result = await CapacitorFFmpeg.reencodeVideo({
  inputPath: 'path/to/file',
  outputPath: 'path/to/file',
  width: 1080,
  height: 1920,
});
console.log(result);

convertImage

Convertit une image fixe dans un autre format.

iOS prend actuellement en charge jpeg et .png. Android prend actuellement en charge .webp, jpeg, et .png. Le web rejette actuellement avec UNIMPLEMENTED.

import { CapacitorFFmpeg } from '@capgo/capacitor-ffmpeg';

const result = await CapacitorFFmpeg.convertImage({
  inputPath: 'path/to/file',
  outputPath: 'path/to/file',
  format: 'webp',
});
console.log(result);

convertAudio

Convertissez l'audio dans un autre conteneur ou codec.

iOS prend actuellement en charge m4a. Android et le web rejettent actuellement avec UNIMPLEMENTED.

import { CapacitorFFmpeg } from '@capgo/capacitor-ffmpeg';

const result = await CapacitorFFmpeg.convertAudio({
  inputPath: 'path/to/file',
  outputPath: 'path/to/file',
  format: 'm4a',
});
console.log(result);

Référence de type

FFmpegCapabilitiesResult

export interface FFmpegCapabilitiesResult {
  platform: string;
  features: FFmpegCapabilitiesFeatures;
}

ReencodeVideoOptions

export interface ReencodeVideoOptions {
  inputPath: string;
  outputPath: string;
  width: number;
  height: number;
  bitrate?: number;
}

FFmpegAcceptedJob

export interface FFmpegAcceptedJob {
  jobId: string;
  status: 'queued';
}

ConvertImageOptions

export interface ConvertImageOptions {
  inputPath: string;
  outputPath: string;
  format: ImageOutputFormat;
  /**
   * Compression quality in the inclusive range `0.0..1.0`.
   *
   * Native platforms reject values outside that range.
   */
  quality?: number;
}

ConvertImageResult

export interface ConvertImageResult {
  outputPath: string;
  format: ImageOutputFormat;
}

ConvertAudioOptions

export interface ConvertAudioOptions {
  inputPath: string;
  outputPath: string;
  format: AudioOutputFormat;
}

ConvertAudioResult

export interface ConvertAudioResult {
  outputPath: string;
  format: AudioOutputFormat;
}

FFmpegProgressEvent

export interface FFmpegProgressEvent {
  jobId: string;
  /**
   * Normalized progress as a floating-point value in the inclusive range `0.0..1.0`.
   */
  progress: number;
  state: FFmpegProgressState;
  message?: string;
  outputPath?: string;
  /**
   * Legacy alias kept for compatibility while callers migrate to `jobId`.
   */
  fileId?: string;
}

PluginVersionResult

export interface PluginVersionResult {
  version: string;
}

FFmpegCapabilitiesFeatures

export interface FFmpegCapabilitiesFeatures {
  getPluginVersion: FFmpegCapability;
  getCapabilities: FFmpegCapability;
  reencodeVideo: FFmpegCapability;
  convertImage: FFmpegCapability;
  convertAudio?: FFmpegCapability;
  progressEvents: FFmpegCapability;
  probeMedia: FFmpegCapability;
  generateThumbnail: FFmpegCapability;
  extractAudio: FFmpegCapability;
  remux: FFmpegCapability;
  trim: FFmpegCapability;
}

ImageOutputFormat

export type ImageOutputFormat = '.webp' | 'jpeg' | '.png';

AudioOutputFormat

export type AudioOutputFormat = 'm4a';

Source de vérité

Cette page est générée à partir du src/definitions.ts. Relancez la synchronisation lorsque l’API public change en amont.

Continuer depuis Getting Started

Si vous utilisez Premiers pas pour planifier les opérations du dashboard et de API, connectez-l’à Utiliser @capgo/capacitor-ffmpeg pour la capacité native dans Utiliser @capgo/capacitor-ffmpeg, Aperçu de API pour les détails d'implémentation dans l'aperçu de API, Introduction pour les détails d'implémentation dans l'Introduction, Clés API pour les détails d'implémentation dans les clés API, et Appareils pour le détail d’implémentation dans Devices.