FlutterCompressPlatform class abstract

The interface that platform implementations of flutter_compress implement.

Kept federated-style so an alternate implementation (e.g. a future macOS or desktop backend) can be swapped in without touching the app-facing API.

Inheritance

• Object
• PlatformInterface
• FlutterCompressPlatform

Implementers

• FlutterCompressWeb
• MethodChannelFlutterCompress

Constructors

FlutterCompressPlatform()

Properties

hashCode → int

The hash code for this object.

no setter, inherited

progressStream → Stream<CompressionProgress>

Broadcast stream of progress events for all in-flight jobs.

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

cancel(String? id) → Future<void>

clearCache() → Future<void>

compress(String id, String path, VideoCompressConfig config, String? outputPath) → Future<VideoCompressResult>

Compress path using config. id identifies the job (for progress correlation and cancellation). When outputPath is non-null the encoded file is written there; otherwise it lands in the plugin cache.

compressImage(String path, ImageCompressConfig config, String? outputPath) → Future<ImageCompressResult>

estimate(String path, VideoCompressConfig config) → Future<CompressionEstimate>

getImageInfo(String path) → Future<ImageMeta>

getThumbnail(String path, {required int positionMs, required int quality, int? maxWidth}) → Future<String>

getVideoInfo(String path) → Future<VideoInfo>

isCompressing() → Future<bool>

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

saveToDownloads(String path, String? fileName) → Future<String>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Properties

instance ↔ FlutterCompressPlatform

getter/setter pair