Feature Matrix

April 13, 2026 · View on GitHub

Last updated: 2026-04-13

This file tracks the public plugin contract and the current platform support level for each capability.

Current public contract

Surface	Contract today	Notes
`getCapabilities()`	Resolves the runtime capability matrix on iOS, Android, and web	Use this to branch app behavior by supported feature set.
`getPluginVersion()`	Resolves `{ version: string }` on iOS, Android, and web	Web returns `"web"` as a platform marker.
`reencodeVideo(options)`	Resolves when the job is accepted by iOS and returns `{ jobId, status: "queued" }` when available	Android and web reject with `UNIMPLEMENTED`.
`convertImage(options)`	Resolves `{ outputPath, format }` on iOS and Android	Web rejects with `UNIMPLEMENTED`.
`convertAudio(options)`	Resolves `{ outputPath, format }` on iOS for `m4a` output	Android and web reject with `UNIMPLEMENTED`.
`progress` listener	Emits `{ jobId, progress, state, message?, outputPath? }`	`fileId` is kept as a compatibility alias for `jobId`.

Use these codes as the shared error vocabulary for JS consumers:

Code	Meaning	Current producers
`UNIMPLEMENTED`	The API is not implemented on the current platform	Android/web `reencodeVideo`, Android/web `convertAudio`, web `convertImage`
`UNAVAILABLE`	The API exists but cannot be used in the current environment	Reserved for future capabilities
`INVALID_ARGUMENT`	Caller input failed local validation	iOS media wrapper validation
`PLUGIN_NOT_INITIALIZED`	Native core could not be initialized	iOS native wrapper
`TRANSCODE_FAILED`	The media pipeline failed after acceptance or during setup	iOS native wrappers and Rust bridge

Capability	iOS	Android	Web	Test status
`getCapabilities`	✅	✅	✅	Covered by unit or contract tests on all platforms
`getPluginVersion`	✅	✅	✅	Covered by unit or contract tests on all platforms
`reencodeVideo` acceptance contract	✅	❌ `UNIMPLEMENTED`	❌ `UNIMPLEMENTED`	Covered for iOS helpers and web/Android unsupported behavior
`reencodeVideo` media execution	⚠️ Experimental	❌	❌	Wrapper contract covered; media regression fixtures still pending
`convertImage`	✅ `jpeg`/`png`	✅ `webp`/`jpeg`/`png`	❌ `UNIMPLEMENTED`	Covered by iOS native tests, Android unit tests, and Maestro flows
`convertAudio`	✅ `m4a`	❌ `UNIMPLEMENTED`	❌ `UNIMPLEMENTED`	Covered by iOS native tests plus web and Android unsupported tests
`progress` listener contract	✅	❌	❌	Covered by iOS helper tests
`probeMedia`	❌ Planned	❌ Planned	❌ Planned	Not started
`generateThumbnail`	❌ Planned	❌ Planned	❌ Planned	Not started
`extractAudio`	❌ Planned	❌ Planned	❌ Planned	Not started
`remux`	❌ Planned	❌ Planned	❌ Planned	Not started
`trim`	❌ Planned	❌ Planned	❌ Planned	Not started

iOS is still the reference platform for media work.
convertImage() does not depend on the Rust FFmpeg core and remains available even when reencodeVideo() is unavailable in SwiftPM builds.
convertAudio() currently relies on AVAssetExportSession on iOS and is limited to m4a output.
Android currently implements image conversion without the broader FFmpeg job pipeline.
getCapabilities() is the machine-readable source of truth for app-side feature gating.
Android and web should reject unsupported media APIs explicitly instead of failing implicitly.
Background continuation is not part of the current contract. The plugin currently guarantees queued background execution, not long-running background entitlement handling.