はじめに

インストール

bun add @capgo/capacitor-ffmpeg
bunx cap sync

インポート

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

API オーバービュー

getCapabilities

現在のプラットフォームのマシン読み取り可能な能力マトリックスを返します。

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

await CapacitorFFmpeg.getCapabilities();

reencodeVideo

動画再エンコードジョブをキューに追加します。

iOSでは、ネイティブレイヤーがジョブを受け入れると、返されたPromiseが解決されます。 最終的な成功または失敗はリスナーを介して通知されます。 progress リスナー

AndroidとWebでは UNIMPLEMENTED.

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

await CapacitorFFmpeg.reencodeVideo({} as ReencodeVideoOptions);

convertImage

iOSでは

、 jpeg Androidでは .png, .webp, jpegCopy to clipboard .png. 現在のWebブラウザでは拒否されます UNIMPLEMENTED.

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

await CapacitorFFmpeg.convertImage({} as ConvertImageOptions);

convertAudio

音声ファイルを別のコンテナまたはエンコードに変換します。

iOSでは現在サポートされていますが m4a. AndroidとWebでは拒否されます UNIMPLEMENTED.

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

await CapacitorFFmpeg.convertAudio({} as ConvertAudioOptions);

型の参照

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

真実の源

このページはプラグインから生成されます src/definitions.ts. upstream の 公開 API が変更されたときに、再度 同期を実行してください。