Einstieg

Installieren

bun add @capgo/capacitor-ffmpeg
bunx cap sync

Importieren

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

API Übersicht

getCapabilities

Ruft die maschinenlesbare Fähigkeitsmatrix für die aktuelle Plattform ab.

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

await CapacitorFFmpeg.getCapabilities();

reencodeVideo

Ein Video-Re-Encoding-Job in der Warteschlange einrichten.

Bei iOS löst sich der zurückgegebene Promise, wenn die native Layer den Job akzeptiert hat. Der endgültige Erfolg oder Misserfolg wird über den "listener" übermittelt. progress Android und Web lehnen derzeit mit ab.

Zur Zwischenablage kopieren UNIMPLEMENTED.

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

await CapacitorFFmpeg.reencodeVideo({} as ReencodeVideoOptions);

convertImage

iOS unterstützt derzeit

und. jpeg Android unterstützt derzeit .png, und .webp, jpegCopy to clipboard .png. Web wird derzeit mit einer Fehlermeldung abgelehnt UNIMPLEMENTED.

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

await CapacitorFFmpeg.convertImage({} as ConvertImageOptions);

convertAudio

Konvertieren Sie Audio in einen anderen Container oder Codec.

iOS unterstützt derzeit m4a. Android und Web werden derzeit mit einer Fehlermeldung abgelehnt UNIMPLEMENTED.

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

await CapacitorFFmpeg.convertAudio({} as ConvertAudioOptions);

Typenreferenz

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

Quelle der Wahrheit

Diese Seite wurde aus dem Plugin generiert src/definitions.ts. Re-run die Synchronisierung, wenn die öffentliche API sich im Hintergrund ändert.