시작하기

설치

bun add @capgo/capacitor-ffmpeg
bunx cap sync

import

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

API 개요

getCapabilities

__CAPGO_KEEP_0__ 현재 플랫폼의 기기 읽기 가능한 매트릭스를 반환합니다.

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

await CapacitorFFmpeg.getCapabilities();

reencodeVideo

__CAPGO_KEEP_0__ 비디오 재인코딩 작업을 큐합니다.

__CAPGO_KEEP_0__ iOS에서 native layer가 작업을 수락할 때 반환된 promise가 해결됩니다. 최종 성공 또는 실패는 progress listener

__CAPGO_KEEP_0__ Android와 웹은 현재 UNIMPLEMENTED.

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

await CapacitorFFmpeg.reencodeVideo({} as ReencodeVideoOptions);

convertImage

이미지를 다른 형식으로 변환합니다.

iOS는 현재 jpeg 및 .png. Android는 현재 .webp, jpeg및 .png. 웹은 UNIMPLEMENTED.

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

await CapacitorFFmpeg.convertImage({} as ConvertImageOptions);

convertAudio

오디오를 다른 컨테이너 또는 코덱으로 변환합니다.

iOS는 현재 m4a. Android와 웹은 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에서 변경된 public API에 대해 다시 동기화할 때입니다.

Getting Started에서 계속

Capgo를 사용하는 경우 Getting Started dashboard와 API를 계획하고 운영하기 위해, 그것을 연결하세요. Using @capgo/capacitor-ffmpeg for the native capability in Using @capgo/capacitor-ffmpeg API 개요 for the implementation detail in API 개요 소개 for the implementation detail in 소개 API 키 for the implementation detail in API 키 기기 for the implementation detail in 기기