Flutter Image Compress

https://pub.dev/packages/flutter_image_compress
Admin
A native image compression library for Flutter that works on Android, iOS, macOS, Web, and...
Tokens:75,852
Snippets:1,253
Trust Score:9.9
Update:4 months ago
Show doc for...
Tokens:
Raw
### Initial Setup and Image Compression Example

Source: https://pub.dev/packages/flutter_image_compress/versions/1.1.1/example

Demonstrates the initial setup for image compression and a basic example of compressing an image from assets. It also shows how to set native log output.

```dart
void main() {
  runApp(const MyApp());
  FlutterImageCompress.showNativeLog = true;
}
```

```dart
Future compressListExample() async {
  final data = await rootBundle.load('img/img.jpg');
  final memory = await testComporessList(data.buffer.asUint8List());
  safeSetState(() {
    provider = MemoryImage(memory);
  });
}
```

--------------------------------

### Full Example App Setup

Source: https://pub.dev/packages/flutter_image_compress/versions/0.1.3/example

This is the main application widget demonstrating image compression workflows. It includes buttons to trigger compression of file and asset images.

```dart
import 'package:flutter/material.dart';
import 'dart:async';
import 'dart:io';

import 'package:flutter/services.dart';
import 'package:flutter_image_compress/flutter_image_compress.dart';

// import 'package:path_provider/path_provider.dart';
// import 'package:image_picker/image_picker.dart';

void main() => runApp(new MyApp());

class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => new _MyAppState();
}

class _MyAppState extends State<MyApp> {
  @override
  void initState() {
    super.initState();
  }

  // Platform messages are asynchronous, so we initialize in an async method.
  Future<void> compress() async {
    var img = AssetImage("img/img.jpg");
    print("pre compress");
    var config = new ImageConfiguration();

    AssetBundleImageKey key = await img.obtainKey(config);
    final ByteData data = await key.bundle.load(key.name);

    var beforeCompress = data.lengthInBytes;
    print("beforeCompress = $beforeCompress");

    var result = 
        await FlutterImageCompress.compressWithList(data.buffer.asUint8List());

    print("after = ${result?.length ?? 0}");
  }

  ImageProvider provider;

  @override
  Widget build(BuildContext context) {
    return new MaterialApp(
      home: new Scaffold(
        appBar: new AppBar(
          title: const Text('Plugin example app'),
        ),
        body: new Center(
          child: Column(
            children: <Widget>[
              Image(
                image: provider ?? AssetImage("img/img.jpg"),
              ),
              FlatButton(
                child: Text('capture'),
                onPressed: _capture,
              ),
              FlatButton(
                child: Text('file image'),
                onPressed: getFileImage,
              ),
            ],
          ),
        ),
        floatingActionButton: FloatingActionButton(
          child: Icon(Icons.computer),
          onPressed: _capture,
        ),
      ),
    );
  }

  Future<Directory> getTemporaryDirectory() async {
    return Directory.current;
  }

  void _capture() async {
    var img = AssetImage("img/img.jpg");
    print("pre compress");
    var config = new ImageConfiguration();

    AssetBundleImageKey key = await img.obtainKey(config);
    final ByteData data = await key.bundle.load(key.name);
    var dir = await getTemporaryDirectory();

    File file = File("${dir.absolute.path}/test.png");
    file.writeAsBytesSync(data.buffer.asUint8List());

    List<int> list = await testCompressFile(file);
    ImageProvider provider = MemoryImage(list);
    this.provider = provider;
    setState(() {});
  }

  void getFileImage() async {
    var img = AssetImage("img/img.jpg");
    print("pre compress");
    var config = new ImageConfiguration();

    AssetBundleImageKey key = await img.obtainKey(config);
    final ByteData data = await key.bundle.load(key.name);
    var dir = await getTemporaryDirectory();

    File file = File("${dir.absolute.path}/test.png");
    file.writeAsBytesSync(data.buffer.asUint8List());

    var targetPath = dir.absolute.path + "/temp.png";
    var imgFile = await testCompressAndGetFile(file, targetPath);

    provider = FileImage(imgFile);
    setState(() {});
  }

  Future<List<int>> testCompressFile(File file) async {
    var result = await FlutterImageCompress.compressWithFile(
      file.absolute.path,
      minWidth: 2300,
      minHeight: 1500,
      quality: 94,
    );
    print(file.lengthSync());
    print(result.length);
    return result;
  }

  Future<File> testCompressAndGetFile(File file, String targetPath) async {
    var result = await FlutterImageCompress.compressAndGetFile(
        file.absolute.path, targetPath,
        quality: 88);

    print(file.lengthSync());
    print(result.lengthSync());

    return result;
  }

  Future<List<int>> testCompressAsset(String assetName) async {
    var list = await FlutterImageCompress.compressAssetImage(
      assetName,
      minHeight: 1920,
      minWidth: 1080,
      quality: 96,
    );

    return list;
  }

  Future<List<int>> testComporessList(List<int> list) async {
    var result = await FlutterImageCompress.compressWithList(
      list,
      minHeight: 1920,
      minWidth: 1080,
      quality: 96,
    );
    print(list.length);
    print(result.length);
    return result;
  }

  void writeToFile(List<int> list, String filePath) {
    var file = File(filePath);
    file.writeAsBytes(list, flush: true, mode: FileMode.write);
  }
}
```

--------------------------------

### Initial Image Compression Example

Source: https://pub.dev/packages/flutter_image_compress/versions/1.1.0/example

An initial example demonstrating basic image compression using a byte list. It logs the size before and after compression.

```dart
Future<void> compress() async {
    final img = AssetImage("img/img.jpg");
    print("pre compress");
    final config = new ImageConfiguration();

    AssetBundleImageKey key = await img.obtainKey(config);
    final ByteData data = await key.bundle.load(key.name);

    final beforeCompress = data.lengthInBytes;
    print("beforeCompress = $beforeCompress");

    final result = await FlutterImageCompress.compressWithList(data.buffer.asUint8List());

    print("after = ${result.length}");
  }
```

--------------------------------

### Compress and Get File Example

Source: https://pub.dev/packages/flutter_image_compress/versions/0.1.4/example

Compresses a file and saves the result to a specified target path. Returns the compressed file.

```dart
void getFileImage() async {
    var img = AssetImage("img/img.jpg");
    print("pre compress");
    var config = new ImageConfiguration();

    AssetBundleImageKey key = await img.obtainKey(config);
    final ByteData data = await key.bundle.load(key.name);
    var dir = await path_provider.getTemporaryDirectory();

    File file = File("${dir.absolute.path}/test.png");
    file.writeAsBytesSync(data.buffer.asUint8List());

    var targetPath = dir.absolute.path + "/temp.png";
    var imgFile = await testCompressAndGetFile(file, targetPath);

    provider = FileImage(imgFile);
    setState(() {});
  }
```

```dart
Future<File> testCompressAndGetFile(File file, String targetPath) async {
    print("testCompressAndGetFile");
    var result = await FlutterImageCompress.compressAndGetFile(
      file.absolute.path,
      targetPath,
      quality: 90,
      minWidth: 1024,
      minHeight: 1024,
      rotate: 90,
    );

    print(file.lengthSync());
    print(result.lengthSync());

    return result;
  }
```

--------------------------------

### Example pubspec.yaml Entry

Source: https://pub.dev/packages/flutter_image_compress/versions/0.1.1/install

This is an example of how the flutter_image_compress dependency will appear in your pubspec.yaml file after running the add command.

```yaml
dependencies:
  flutter_image_compress: ^0.1.1
```

--------------------------------

### Example pubspec.yaml Entry

Source: https://pub.dev/packages/flutter_image_compress/versions/0.1.2/install

This is an example of how the flutter_image_compress dependency will appear in your pubspec.yaml file after running the add command.

```yaml
dependencies:
  flutter_image_compress: ^0.1.2
```

--------------------------------

### Example pubspec.yaml Entry

Source: https://pub.dev/packages/flutter_image_compress_macos/versions/1.0.2/install

This is an example of how the flutter_image_compress_macos dependency will appear in your pubspec.yaml file after running the add command.

```yaml
dependencies:
  flutter_image_compress_macos: ^1.0.2
```

--------------------------------

### Example pubspec.yaml Entry

Source: https://pub.dev/packages/flutter_image_compress_macos/install

This is how the dependency will appear in your pubspec.yaml file after running the add command.

```yaml
dependencies:
  flutter_image_compress_macos: ^1.0.3
```

--------------------------------

### Compress and Get File Example Trigger

Source: https://pub.dev/packages/flutter_image_compress/versions/0.2.1/example

Starts the process of compressing an image file and obtaining a new file with rotation when the 'CompressAndGetFile and rotate 90' button is pressed.

```dart
getFileImage
```

--------------------------------

### Compress Image with Native Code

Source: https://pub.dev/packages/flutter_image_compress/versions/0.3.0/example

This example demonstrates how to compress an image using its byte list. It shows how to load an asset image, get its byte data, and then compress it using `compressWithList`. The native log can be enabled for debugging.

```dart
import 'dart:typed_data';
import 'dart:math' as math;
import 'package:flutter/material.dart';
import 'dart:async';
import 'dart:io';

import 'package:flutter/services.dart';
import 'package:flutter_image_compress/flutter_image_compress.dart';

import 'package:path_provider/path_provider.dart' as path_provider;
// import 'package:image_picker/image_picker.dart';

void main() {
  runApp(new MyApp());
  FlutterImageCompress.showNativeLog = true;
}

class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => new _MyAppState();
}

class _MyAppState extends State<MyApp> {
  @override
  void initState() {
    super.initState();
  }

  // Platform messages are asynchronous, so we initialize in an async method.
  Future<void> compress() async {
    var img = AssetImage("img/img.jpg");
    print("pre compress");
    var config = new ImageConfiguration();

    AssetBundleImageKey key = await img.obtainKey(config);
    final ByteData data = await key.bundle.load(key.name);

    var beforeCompress = data.lengthInBytes;
    print("beforeCompress = $beforeCompress");

    var result = 
        await FlutterImageCompress.compressWithList(data.buffer.asUint8List());

    print("after = ${result?.length ?? 0}");
  }

  ImageProvider provider;

  @override
  Widget build(BuildContext context) {
    return new MaterialApp(
      home: new Scaffold(
        appBar: new AppBar(
          title: const Text('Plugin example app'),
        ),
        body: new Center(
          child: Column(
            children: <Widget>[
              AspectRatio(
                child: Image(
                  image: provider ?? AssetImage("img/img.jpg"),
                  width: double.infinity,
                  fit: BoxFit.contain,
                ),
                aspectRatio: 1 / 1,
              ),
              FlatButton(
                child: Text('CompressFile and rotate 180'),
                onPressed: _testCompressFile,
              ),
              FlatButton(
                child: Text('CompressAndGetFile and rotate 90'),
                onPressed: getFileImage,
              ),
              FlatButton(
                child: Text('CompressAsset and rotate 135'),
                onPressed: () => testCompressAsset("img/img.jpg"),
              ),
              FlatButton(
                child: Text('CompressList and rotate 270'),
                onPressed: compressListExample,
              ),
            ],
          ),
        ),
        floatingActionButton: FloatingActionButton(
          child: Icon(Icons.computer),
          onPressed: () => setState(() => this.provider = null),
          tooltip: "show origin asset",
        ),
      ),
    );
  }

  Future<Directory> getTemporaryDirectory() async {
    return Directory.systemTemp;
  }

  void _testCompressFile() async {
    var img = AssetImage("img/img.jpg");
    print("pre compress");
    var config = new ImageConfiguration();

    AssetBundleImageKey key = await img.obtainKey(config);
    final ByteData data = await key.bundle.load(key.name);
    var dir = await path_provider.getTemporaryDirectory();
    print('dir = $dir');

    File file = File("${dir.absolute.path}/test.png");
    file.writeAsBytesSync(data.buffer.asUint8List());

    List<int> list = await testCompressFile(file);
    ImageProvider provider = MemoryImage(Uint8List.fromList(list));
    this.provider = provider;
    setState(() {});
  }

  void getFileImage() async {
    var img = AssetImage("img/img.jpg");
    print("pre compress");
    var config = new ImageConfiguration();

    AssetBundleImageKey key = await img.obtainKey(config);
    final ByteData data = await key.bundle.load(key.name);
    var dir = await path_provider.getTemporaryDirectory();

    File file = File("${dir.absolute.path}/test.png");
    file.writeAsBytesSync(data.buffer.asUint8List());

    var targetPath = dir.absolute.path + "/temp.png";
    var imgFile = await testCompressAndGetFile(file, targetPath);

    provider = FileImage(imgFile);
    setState(() {});
  }

  Future<List<int>> testCompressFile(File file) async {
    print("testCompressFile");
    var result = await FlutterImageCompress.compressWithFile(
      file.absolute.path,
      minWidth: 2300,
      minHeight: 1500,
      quality: 94,
      rotate: 180,
    );
    print(file.lengthSync());
    print(result.length);
    return result;
  }

  Future<File> testCompressAndGetFile(File file, String targetPath) async {
    print("testCompressAndGetFile");
    var result = await FlutterImageCompress.compressAndGetFile(
      file.absolute.path,
      targetPath,
      quality: 90,
      minWidth: 1024,
      minHeight: 1024,
      rotate: 90,
    );

    print(file.lengthSync());
    print(result.lengthSync());

```

--------------------------------

### Compress List Example

Source: https://pub.dev/packages/flutter_image_compress/versions/0.4.0/example

Initiates an example of compressing a list of image bytes. This function is called from the UI to trigger the compression process.

```dart
compressListExample() async {
  var img = AssetImage("img/img.jpg");
  print("pre compress");
  var config = new ImageConfiguration();

  AssetBundleImageKey key = await img.obtainKey(config);
  final ByteData data = await key.bundle.load(key.name);

  var beforeCompress = data.lengthInBytes;
  print("beforeCompress = $beforeCompress");

  var result = await FlutterImageCompress.compressWithList(data.buffer.asUint8List());

  print("after = ${result?.length ?? 0}");
}
```

--------------------------------

### Basic Image Compression Example

Source: https://pub.dev/packages/flutter_image_compress/versions/1.0.0/example

Demonstrates how to compress an image from an asset bundle using `compressWithList`. It logs the size before and after compression.

```dart
import 'dart:async';
import 'dart:io';
import 'dart:math' as math;
import 'dart:typed_data';

import 'package:flutter/material.dart';
import 'package:flutter/services.dart';
import 'package:flutter_image_compress/flutter_image_compress.dart';
import 'package:path_provider/path_provider.dart' as path_provider;

import 'const/resource.dart';
import 'time_logger.dart';
// import 'package:image_picker/image_picker.dart';

void main() {
  runApp(new MyApp());
  FlutterImageCompress.showNativeLog = true;
}

class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => new _MyAppState();
}

class _MyAppState extends State<MyApp> {
  @override
  void initState() {
    super.initState();
  }

  // Platform messages are asynchronous, so we initialize in an async method.
  Future<void> compress() async {
    final img = AssetImage("img/img.jpg");
    print("pre compress");
    final config = new ImageConfiguration();

    AssetBundleImageKey key = await img.obtainKey(config);
    final ByteData data = await key.bundle.load(key.name);

    final beforeCompress = data.lengthInBytes;
    print("beforeCompress = $beforeCompress");

    final result =
        await FlutterImageCompress.compressWithList(data.buffer.asUint8List());

    print("after = ${result.length}");
  }

  ImageProvider? provider;

  @override
  Widget build(BuildContext context) {
    return new MaterialApp(
      home: new Scaffold(
        appBar: new AppBar(
          title: const Text('Plugin example app'),
        ),
        body: ListView(
          children: <Widget>[
            AspectRatio(
              child: Image(
                image: provider ?? AssetImage("img/img.jpg"),
                width: double.infinity,
                fit: BoxFit.contain,
              ),
              aspectRatio: 1 / 1,
            ),
            TextButton(
              child: Text('CompressFile and rotate 180'),
              onPressed: _testCompressFile,
            ),
            TextButton(
              child: Text('CompressAndGetFile and rotate 90'),
              onPressed: getFileImage,
            ),
            TextButton(
              child: Text('CompressAsset and rotate 135'),
              onPressed: () => testCompressAsset("img/img.jpg"),
            ),
            TextButton(
              child: Text('CompressList and rotate 270'),
              onPressed: compressListExample,
            ),
            TextButton(
              child: Text('test compress auto angle'),
              onPressed: _compressAssetAndAutoRotate,
            ),
            TextButton(
              child: Text('Test png '),
              onPressed: _compressPngImage,
            ),
            TextButton(
              child: Text('Format transparent PNG'),
              onPressed: _compressTransPNG,
            ),
            TextButton(
              child: Text('Restore transparent PNG'),
              onPressed: _restoreTransPNG,
            ),
            TextButton(
              child: Text('Keep exif image'),
              onPressed: _compressImageAndKeepExif,
            ),
            TextButton(
              child: Text('Convert to heic format and print the file url'),
              onPressed: _compressHeicExample,
            ),
            TextButton(
              child: Text('Convert to webp format, Just support android'),
              onPressed: _compressAndroidWebpExample,
            ),
          ],
        ),
        floatingActionButton: FloatingActionButton(
          child: Icon(Icons.computer),
          onPressed: () => setState(() => this.provider = null),
          tooltip: "show origin asset",
        ),
      ),
    );
  }

  Future<Directory> getTemporaryDirectory() async {
    return Directory.systemTemp;
  }

  void _testCompressFile() async {
    final img = AssetImage("img/img.jpg");
    print("pre compress");
    final config = new ImageConfiguration();

    AssetBundleImageKey key = await img.obtainKey(config);
    final ByteData data = await key.bundle.load(key.name);
    final dir = await path_provider.getTemporaryDirectory();
    print('dir = $dir');

    File file = createFile("${dir.absolute.path}/test.png");
    file.writeAsBytesSync(data.buffer.asUint8List());

    final result = await testCompressFile(file);

    if (result == null) return;

    ImageProvider provider = MemoryImage(result);
    this.provider = provider;
    setState(() {});
  }

  File createFile(String path) {
    final file = File(path);
    if (!file.existsSync()) {
      file.createSync(recursive: true);
    }

    return file;
  }

  Future<String> getExampleFilePath() async {
    final img = AssetImage("img/img.jpg");
    print("pre compress");
    final config = new ImageConfiguration();

```

--------------------------------

### Compress HEIC Image

Source: https://pub.dev/packages/flutter_image_compress/versions/1.0.0/example

Initiates the compression of a HEIC image. This example shows the setup for compression and logging, with the actual compression logic likely following.

```dart
void _compressHeicExample() async {
  print("start compress");
  final logger = TimeLogger();
  logger.startRecoder();
  final tmpDir = (await getTemporaryDirectory()).path;
  final target = "$tmpDir/${DateTime.now().millisecondsSinceEpoch}.heic";
  final srcPath = await getExampleFilePath();
```

--------------------------------

### Compress Image List Example

Source: https://pub.dev/packages/flutter_image_compress/versions/0.2.1/example

Initiates an example of compressing an image from a list of bytes. This is a placeholder function that would typically call the actual compression logic.

```dart
compressListExample()
```

--------------------------------

### Example pubspec.yaml Entry

Source: https://pub.dev/packages/flutter_image_compress_common/versions/1.0.5/install

This is how the dependency will appear in your pubspec.yaml file after running the add command. It ensures the correct version is used.

```yaml
dependencies:
  flutter_image_compress_common: ^1.0.5
```

--------------------------------

### Compress Asset Example

Source: https://pub.dev/packages/flutter_image_compress/versions/0.1.4/example

Initiates the compression of an image asset. The actual compression logic is handled by a separate function.

```dart
Future testCompressAsset(String assetName) async {
    print("testCompressAsset");

```

--------------------------------

### Compress Image from Asset

Source: https://pub.dev/packages/flutter_image_compress/versions/0.2.0/example

Demonstrates how to compress an image loaded from assets. This example is a placeholder and requires further implementation.

```dart
Future testCompressAsset(String assetName) async {
  print("testCompressAsset");

```

--------------------------------

### Compress List Example from Asset

Source: https://pub.dev/packages/flutter_image_compress/versions/0.3.1/example

Demonstrates compressing an image loaded from assets using `compressWithList`. It first loads the asset data and then compresses it.

```dart
import 'dart:typed_data';
import 'package:flutter/material.dart';

Future<void> compressListExample() async {
  var img = AssetImage("img/img.jpg");
  var config = new ImageConfiguration();
  AssetBundleImageKey key = await img.obtainKey(config);
  final ByteData data = await key.bundle.load(key.name);

  var result = await FlutterImageCompress.compressWithList(
    data.buffer.asUint8List(),
    quality: 80,
    rotate: 270,
  );
  print("Compressed list size: ${result?.length ?? 0}");
}
```

--------------------------------

### Compress List Example

Source: https://pub.dev/packages/flutter_image_compress/versions/0.1.4/example

Triggers an example of compressing a list of image bytes. This is typically used for in-memory image data.

```dart
compressListExample() async {
    var img = AssetImage("img/img.jpg");
    print("pre compress");
    var config = new ImageConfiguration();

    AssetBundleImageKey key = await img.obtainKey(config);
    final ByteData data = await key.bundle.load(key.name);

    var beforeCompress = data.lengthInBytes;
    print("beforeCompress = $beforeCompress");

    var result = await FlutterImageCompress.compressWithList(data.buffer.asUint8List());

    print("after = ${result?.length ?? 0}");
  }
```

--------------------------------

### Compress Image List Example

Source: https://pub.dev/packages/flutter_image_compress/versions/0.6.0/example

Demonstrates compressing an image loaded from assets using a byte list. The compressed image is then displayed.

```dart
void compressListExample() async {
    var img = AssetImage("img/img.jpg");
    print("pre compress");
    var config = new ImageConfiguration();

    AssetBundleImageKey key = await img.obtainKey(config);
    final ByteData data = await key.bundle.load(key.name);

    var list = await testCompressBytes(data.buffer.asUint8List());
    provider = MemoryImage(Uint8List.fromList(list));
    setState(() {});
  }
```

--------------------------------

### Add flutter_image_compress to pubspec.yaml

Source: https://pub.dev/packages/flutter_image_compress/versions/0.1.3/install

This is an example of how the `flutter_image_compress` dependency will appear in your `pubspec.yaml` file after running the add command.

```yaml
dependencies:
  flutter_image_compress: ^0.1.3
```

--------------------------------

### Compress File Example Trigger

Source: https://pub.dev/packages/flutter_image_compress/versions/0.2.1/example

Initiates the compression of an image file with rotation when the 'CompressFile and rotate 180' button is pressed.

```dart
_testCompressFile
```

--------------------------------

### Compress File and Rotate Example

Source: https://pub.dev/packages/flutter_image_compress/versions/0.1.4/example

Compresses a file with specified dimensions, quality, and rotation. Saves the compressed data as a list of bytes.

```dart
void _testCompressFile() async {
    var img = AssetImage("img/img.jpg");
    print("pre compress");
    var config = new ImageConfiguration();

    AssetBundleImageKey key = await img.obtainKey(config);
    final ByteData data = await key.bundle.load(key.name);
    var dir = await path_provider.getTemporaryDirectory();
    print('dir = $dir');

    File file = File("${dir.absolute.path}/test.png");
    file.writeAsBytesSync(data.buffer.asUint8List());

    List<int> list = await testCompressFile(file);
    ImageProvider provider = MemoryImage(Uint8List.fromList(list));
    this.provider = provider;
    setState(() {});
  }
```

```dart
Future<List<int>> testCompressFile(File file) async {
    print("testCompressFile");
    var result = await FlutterImageCompress.compressWithFile(
      file.absolute.path,
      minWidth: 2300,
      minHeight: 1500,
      quality: 94,
      rotate: 180,
    );
    print(file.lengthSync());
    print(result.length);
    return result;
  }
```

--------------------------------

### Compress Asset Image

Source: https://pub.dev/packages/flutter_image_compress/versions/0.4.0/example

Compresses an image directly from the application's assets. This example demonstrates how to load an asset, compress it, and display the result.

```dart
Future<List<int>> testCompressAsset(String assetName) async {
  print("testCompressAsset");
  var result = await FlutterImageCompress.compressAssetImage(
    assetName,
    quality: 90,
    minWidth: 100,
    minHeight: 100,
    rotate: 135,
  );
  print(result.length);
  return result;
}
```

--------------------------------

### Compress Asset Example

Source: https://pub.dev/packages/flutter_image_compress/versions/0.2.1/example

Triggers the compression of an image from assets with a specified rotation. This function is called when the 'CompressAsset and rotate 135' button is pressed.

```dart
() => testCompressAsset("img/img.jpg")
```

--------------------------------

### Initialize Plugin and Run Example

Source: https://pub.dev/packages/flutter_image_compress/versions/0.5.1/example

This snippet shows the main entry point for the Flutter application and how to initialize the image compression plugin. It sets up the main application widget and enables native logging for the plugin.

```dart
import 'dart:typed_data';
import 'dart:math' as math;
import 'package:flutter/material.dart';
import 'dart:async';
import 'dart:io';

import 'package:flutter/services.dart';
import 'package:flutter_image_compress/flutter_image_compress.dart';
import 'package:flutter_image_compress_example/const/resource.dart';

import 'package:path_provider/path_provider.dart' as path_provider;
// import 'package:image_picker/image_picker.dart';

void main() {
  runApp(new MyApp());
  FlutterImageCompress.showNativeLog = true;
}

class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => new _MyAppState();
}

class _MyAppState extends State<MyApp> {
  @override
  void initState() {
    super.initState();
  }

  // Platform messages are asynchronous, so we initialize in an async method.
  Future<void> compress() async {
    var img = AssetImage("img/img.jpg");
    print("pre compress");
    var config = new ImageConfiguration();

    AssetBundleImageKey key = await img.obtainKey(config);
    final ByteData data = await key.bundle.load(key.name);

    var beforeCompress = data.lengthInBytes;
    print("beforeCompress = $beforeCompress");

    var result =
        await FlutterImageCompress.compressWithList(data.buffer.asUint8List());

    print("after = ${result?.length ?? 0}");
  }

  ImageProvider provider;

  @override
  Widget build(BuildContext context) {
    return new MaterialApp(
      home: new Scaffold(
        appApp: new AppBar(
          title: const Text('Plugin example app'),
        ),
        body: new Center(
          child: Column(
            children: <Widget>[
              AspectRatio(
                child: Image(
                  image: provider ?? AssetImage("img/img.jpg"),
                  width: double.infinity,
                  fit: BoxFit.contain,
                ),
                aspectRatio: 1 / 1,
              ),
              FlatButton(
                child: Text('CompressFile and rotate 180'),
                onPressed: _testCompressFile,
              ),
              FlatButton(
                child: Text('CompressAndGetFile and rotate 90'),
                onPressed: getFileImage,
              ),
              FlatButton(
                child: Text('CompressAsset and rotate 135'),
                onPressed: () => testCompressAsset("img/img.jpg"),
              ),
              FlatButton(
                child: Text('CompressList and rotate 270'),
                onPressed: compressListExample,
              ),
              FlatButton(
                child: Text('test compress auto angle'),
                onPressed: _compressAssetAndAutoRotate,
              )
            ],
          ),
        ),
        floatingActionButton: FloatingActionButton(
          child: Icon(Icons.computer),
          onPressed: () => setState(() => this.provider = null),
          tooltip: "show origin asset",
        ),
      ),
    );
  }

  Future<Directory> getTemporaryDirectory() async {
    return Directory.systemTemp;
  }

  void _testCompressFile() async {
    var img = AssetImage("img/img.jpg");
    print("pre compress");
    var config = new ImageConfiguration();

    AssetBundleImageKey key = await img.obtainKey(config);
    final ByteData data = await key.bundle.load(key.name);
    var dir = await path_provider.getTemporaryDirectory();
    print('dir = $dir');

    File file = File("${dir.absolute.path}/test.png");
    file.writeAsBytesSync(data.buffer.asUint8List());

    List<int> list = await testCompressFile(file);
    ImageProvider provider = MemoryImage(Uint8List.fromList(list));
    this.provider = provider;
    setState(() {});
  }

  void getFileImage() async {
    var img = AssetImage("img/img.jpg");
    print("pre compress");
    var config = new ImageConfiguration();

    AssetBundleImageKey key = await img.obtainKey(config);
    final ByteData data = await key.bundle.load(key.name);
    var dir = await path_provider.getTemporaryDirectory();

    File file = File("${dir.absolute.path}/test.png");
    file.writeAsBytesSync(data.buffer.asUint8List());

    var targetPath = dir.absolute.path + "/temp.png";
    var imgFile = await testCompressAndGetFile(file, targetPath);

    provider = FileImage(imgFile);
    setState(() {});
  }

  Future<List<int>> testCompressFile(File file) async {
    print("testCompressFile");
    var result = await FlutterImageCompress.compressWithFile(
      file.absolute.path,
      minWidth: 2300,
      minHeight: 1500,
      quality: 94,
      rotate: 180,
    );
    print(file.lengthSync());
    print(result.length);
    return result;
  }

  Future<File> testCompressAndGetFile(File file, String targetPath) async {
    print("testCompressAndGetFile");

```

--------------------------------

### Basic Image Compression Setup

Source: https://pub.dev/packages/flutter_image_compress/versions/1.0.0-nullsafety/example

Initializes the FlutterImageCompress plugin and sets up the main application widget. This snippet shows how to run the app and enable native logging for the compression process.

```dart
import 'dart:async';
import 'dart:io';
import 'dart:math' as math;
import 'dart:typed_data';

import 'package:flutter/material.dart';
import 'package:flutter/services.dart';
import 'package:flutter_image_compress/flutter_image_compress.dart';
import 'package:path_provider/path_provider.dart' as path_provider;

import 'const/resource.dart';
import 'time_logger.dart';
// import 'package:image_picker/image_picker.dart';

void main() {
  runApp(new MyApp());
  FlutterImageCompress.showNativeLog = true;
}

class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => new _MyAppState();
}

class _MyAppState extends State<MyApp> {
  @override
  void initState() {
    super.initState();
  }

  // Platform messages are asynchronous, so we initialize in an async method.
  Future<void> compress() async {
    final img = AssetImage("img/img.jpg");
    print("pre compress");
    final config = new ImageConfiguration();

    AssetBundleImageKey key = await img.obtainKey(config);
    final ByteData data = await key.bundle.load(key.name);

    final beforeCompress = data.lengthInBytes;
    print("beforeCompress = $beforeCompress");

    final result = 
        await FlutterImageCompress.compressWithList(data.buffer.asUint8List());

    print("after = ${result.length}");
  }

  ImageProvider? provider;

  @override
  Widget build(BuildContext context) {
    return new MaterialApp(
      home: new Scaffold(
        appBar: new AppBar(
          title: const Text('Plugin example app'),
        ),
        body: ListView(
          children: <Widget>[
            AspectRatio(
              child: Image(
                image: provider ?? AssetImage("img/img.jpg"),
                width: double.infinity,
                fit: BoxFit.contain,
              ),
              aspectRatio: 1 / 1,
            ),
            TextButton(
              child: Text('CompressFile and rotate 180'),
              onPressed: _testCompressFile,
            ),
            TextButton(
              child: Text('CompressAndGetFile and rotate 90'),
              onPressed: getFileImage,
            ),
            TextButton(
              child: Text('CompressAsset and rotate 135'),
              onPressed: () => testCompressAsset("img/img.jpg"),
            ),
            TextButton(
              child: Text('CompressList and rotate 270'),
              onPressed: compressListExample,
            ),
            TextButton(
              child: Text('test compress auto angle'),
              onPressed: _compressAssetAndAutoRotate,
            ),
            TextButton(
              child: Text('Test png '),
              onPressed: _compressPngImage,
            ),
            TextButton(
              child: Text('Format transparent PNG'),
              onPressed: _compressTransPNG,
            ),
            TextButton(
              child: Text('Restore transparent PNG'),
              onPressed: _restoreTransPNG,
            ),
            TextButton(
              child: Text('Keep exif image'),
              onPressed: _compressImageAndKeepExif,
            ),
            TextButton(
              child: Text('Convert to heic format and print the file url'),
              onPressed: _compressHeicExample,
            ),
            TextButton(
              child: Text('Convert to webp format, Just support android'),
              onPressed: _compressAndroidWebpExample,
            ),
          ],
        ),
        floatingActionButton: FloatingActionButton(
          child: Icon(Icons.computer),
          onPressed: () => setState(() => this.provider = null),
          tooltip: "show origin asset",
        ),
      ),
    );
  }

  Future<Directory> getTemporaryDirectory() async {
    return Directory.systemTemp;
  }

  void _testCompressFile() async {
    final img = AssetImage("img/img.jpg");
    print("pre compress");
    final config = new ImageConfiguration();

    AssetBundleImageKey key = await img.obtainKey(config);
    final ByteData data = await key.bundle.load(key.name);
    final dir = await path_provider.getTemporaryDirectory();
    print('dir = $dir');

    File file = createFile("${dir.absolute.path}/test.png");
    file.writeAsBytesSync(data.buffer.asUint8List());

    final result = await testCompressFile(file);

    if (result == null) return;

    ImageProvider provider = MemoryImage(result);
    this.provider = provider;
    setState(() {});
  }

  File createFile(String path) {
    final file = File(path);
    if (!file.existsSync()) {
      file.createSync(recursive: true);
    }

    return file;
  }

  Future<String> getExampleFilePath() async {
    final img = AssetImage("img/img.jpg");
    print("pre compress");
    final config = new ImageConfiguration();

```

--------------------------------

### Compress Image and Display in Image Widget

Source: https://pub.dev/packages/flutter_image_compress_common

Shows how to compress a file, convert the result to an ImageProvider, and use it within an Image widget. This example assumes the existence of a `testCompressFile` function and a `file` variable.

```dart
Future<Widget> _compressImage() async {
  List<int> image = await testCompressFile(file);
  ImageProvider provider = MemoryImage(Uint8List.fromList(image));
  imageWidget = Image(
    image: provider ?? AssetImage('img/img.jpg'),
  );
}
```

--------------------------------

### Restore Transparent PNG

Source: https://pub.dev/packages/flutter_image_compress/versions/0.6.0/example

This example appears to be a placeholder or a duplicate of the 'Format Image as Transparent PNG' example, as it uses the same code and comments.

```dart
Future _restoreTransPNG() async {
    var list = await testCompressAssetImage("img/img.jpg");
    var dir = await getTemporaryDirectory();
    var file = await File("${dir.absolute.path}/restore_png.png").writeAsBytes(list);
    var result = await FlutterImageCompress.compressFile(
      file.absolute.path,
      //autoCorrectionAngle: true,
      //degree: 180,
      //compressFormat: CompressFormat.jpeg,
      compressFormat: CompressFormat.png,
      //compressFormat: CompressFormat.webp,
      quality: 90,
    );
    provider = MemoryImage(result);
    setState(() {});
  }
```

--------------------------------

### Flutter Image Compress Usage Example

Source: https://pub.dev/packages/flutter_image_compress/versions/0.5.1

Provides examples of how to use the FlutterImageCompress class to compress images from various sources like files, assets, or raw byte lists. Ensure the 'flutter_image_compress' package is added to your pubspec.yaml.

```dart
import 'package:flutter_image_compress/flutter_image_compress.dart';

// ...

Future<List<int>> testCompressFile(File file) async {
  var result = await FlutterImageCompress.compressWithFile(
    file.absolute.path,
    minWidth: 2300,
    minHeight: 1500,
    quality: 94,
    rotate: 90,
  );
  print(file.lengthSync());
  print(result.length);
  return result;
}

Future<File> testCompressAndGetFile(File file, String targetPath) async {
  var result = await FlutterImageCompress.compressAndGetFile(
      file.absolute.path, targetPath,
      quality: 88,
      rotate: 180,
    );

  print(file.lengthSync());
  print(result.lengthSync());

  return result;
}

Future<List<int>> testCompressAsset(String assetName) async {
  var list = await FlutterImageCompress.compressAssetImage(
    assetName,
    minHeight: 1920,
    minWidth: 1080,
    quality: 96,
    rotate: 180,
  );

  return list;
}

Future<List<int>> testComporessList(List<int> list) async {
  var result = await FlutterImageCompress.compressWithList(
    list,
    minHeight: 1920,
    minWidth: 1080,
    quality: 96,
    rotate: 135,
  );
  print(list.length);
  print(result.length);
  return result;
}

```

--------------------------------

### Import flutter_image_compress_web in Dart

Source: https://pub.dev/packages/flutter_image_compress_web/install

Import the package into your Dart files to start using its functionalities.

```dart
import 'package:flutter_image_compress_web/flutter_image_compress_web.dart';
```

--------------------------------

### Import flutter_image_compress_platform_interface in Dart

Source: https://pub.dev/packages/flutter_image_compress_platform_interface/install

Import the package into your Dart files to start using its functionalities.

```dart
import 'package:flutter_image_compress_platform_interface/flutter_image_compress_platform_interface.dart';
```

--------------------------------

### Compress asset image and get Uint8List

Source: https://pub.dev/packages/flutter_image_compress_common

Compresses an image from the application assets and returns it as a Uint8List.

```dart
// 3. compress asset and get Uint8List.
Future<Uint8List> testCompressAsset(String assetName) async {
  var list = await FlutterImageCompress.compressAssetImage(
    assetName,
    minHeight: 1920,
    minWidth: 1080,
    quality: 96,
    rotate: 180,
  );

  return list;
}
```

--------------------------------

### Compress PNG Image

Source: https://pub.dev/packages/flutter_image_compress/versions/0.7.0/example

Compresses a PNG image. This example demonstrates basic compression of a PNG file.

```dart
Future<Uint8List> _compressPngImage() async {
    final img = AssetImage("img/img.jpg");
    print("pre compress");
    final config = new ImageConfiguration();

    AssetBundleImageKey key = await img.obtainKey(config);
    final ByteData data = await key.bundle.load(key.name);

    final result = await FlutterImageCompress.compressWithList(
      data.buffer.asUint8List(),
      format: CompressFormat.png,
      quality: 90,
    );
    print(result.length);
    return result;
  }
```

--------------------------------

### Compress List Example Trigger

Source: https://pub.dev/packages/flutter_image_compress/versions/0.2.1/example

Calls the compressListExample function when the 'CompressList and rotate 270' button is pressed, initiating image compression from a byte list with rotation.

```dart
compressListExample
```

--------------------------------

### Import necessary packages

Source: https://pub.dev/packages/flutter_image_compress/versions/0.6.5%2B1/example

Import the required libraries for image compression, file handling, and path providers.

```dart
import 'dart:async';
import 'dart:io';
import 'dart:math' as math;
import 'dart:typed_data';

import 'package:flutter/material.dart';
import 'package:flutter/services.dart';
import 'package:flutter_image_compress/flutter_image_compress.dart';
import 'package:path_provider/path_provider.dart' as path_provider;

import 'const/resource.dart';
import 'time_logger.dart';
// import 'package:image_picker/image_picker.dart';
```

--------------------------------

### Include Pica Library for Web Compression

Source: https://pub.dev/packages/flutter_image_compress_common

Shows how to include the Pica library via a CDN in your web/index.html file for image compression on the web. This is necessary because the web implementation uses Pica.

```html
<script src="https://cdn.jsdelivr.net/npm/pica@9.0.1/dist/pica.min.js" ></script>

<!-- or -->

<script src="https://unpkg.com/pica/dist/pica.min.js" ></script>
```

--------------------------------

### Compress file and get Uint8List

Source: https://pub.dev/packages/flutter_image_compress_common

Compresses a file and returns the result as a Uint8List. Useful for in-memory processing.

```dart
// 1. compress file and get Uint8List
Future<Uint8List> testCompressFile(File file) async {
  var result = await FlutterImageCompress.compressWithFile(
    file.absolute.path,
    minWidth: 2300,
    minHeight: 1500,
    quality: 94,
    rotate: 90,
  );
  print(file.lengthSync());
  print(result.length);
  return result;
}
```

--------------------------------

### Compress HEIC Image

Source: https://pub.dev/packages/flutter_image_compress/versions/0.6.4/example

Compresses an image into the HEIC format. This example demonstrates how to specify the `CompressFormat.heic` option for `compressAndGetFile`.

```dart
void _compressHeicExample() async {
    print("start compress");
    final tmpDir = (await getTemporaryDirectory()).path;
    final target = "$tmpDir/${DateTime.now().millisecondsSinceEpoch}.heic";
    final srcPath = await getExampleFilePath();
    final result = await FlutterImageCompress.compressAndGetFile(
      srcPath,
      target,
      format: CompressFormat.heic,
      quality: 90,
    );
    print("Compress heic success.");
    print("src, path = $srcPath length = ${File(srcPath).lengthSync()}");
    print(
        "Compress heic result path: ${result.absolute.path}, size: ${result.lengthSync()}");
  }
```

--------------------------------

### Main Entry Point for flutter_image_compress

Source: https://pub.dev/packages/flutter_image_compress/example

This is the main entry point for the flutter_image_compress package. It uses conditional imports to load the appropriate main function based on the target platform (web, IO).

```dart
import 'main/main_base.dart'
    if (dart.library.html) 'main/main_web.dart'
    if (dart.library.io) 'main/main_io.dart';

Future<void> main() async {
  await runMain();
}
```

--------------------------------

### Compress Image to WEBP on Android

Source: https://pub.dev/packages/flutter_image_compress/versions/0.6.5/example

Demonstrates how to compress an image to WEBP format with specified dimensions and quality. This is particularly useful for Android where WEBP encoding is efficient.

```dart
void _compressAndroidWebpExample() async {
    // Android compress very nice, but the iOS encode UIImage to webp is slow.
    final logger = TimeLogger();
    logger.startRecoder();
    print("start compress webp");
    final quality = 90;
    final tmpDir = (await getTemporaryDirectory()).path;
    final target = 
        "$tmpDir/${DateTime.now().millisecondsSinceEpoch}-$quality.webp";
    final srcPath = await getExampleFilePath();
    final result = await FlutterImageCompress.compressAndGetFile(
      srcPath,
      target,
      format: CompressFormat.webp,
      minHeight: 800,
      minWidth: 800,
      quality: quality,
    );
    print("Compress webp success.");
    logger.logTime();
    print("src, path = $srcPath length = ${File(srcPath).lengthSync()}");
    print(
        "Compress webp result path: ${result.absolute.path}, size: ${result.lengthSync()}");

    provider = FileImage(result);
    setState(() {});
  }
```

--------------------------------

### Compress Byte List Example

Source: https://pub.dev/packages/flutter_image_compress/versions/0.1.4/example

Compresses a list of bytes representing an image. Useful for in-memory image data.

```dart
Future<void> compress() async {
    var img = AssetImage("img/img.jpg");
    print("pre compress");
    var config = new ImageConfiguration();

    AssetBundleImageKey key = await img.obtainKey(config);
    final ByteData data = await key.bundle.load(key.name);

    var beforeCompress = data.lengthInBytes;
    print("beforeCompress = $beforeCompress");

    var result = await FlutterImageCompress.compressWithList(data.buffer.asUint8List());

    print("after = ${result?.length ?? 0}");
  }
```

--------------------------------

### Get Asset Image as Uint8List

Source: https://pub.dev/packages/flutter_image_compress/versions/1.1.2/example

Utility function to load an image asset from the Flutter bundle and return it as a Uint8List.

```dart
Future<typed_data.Uint8List> getAssetImageUint8List(String key) async {
  final byteData = await rootBundle.load(key);
  return byteData.buffer.asUint8List();
}
```

--------------------------------

### Compress Image from Asset

Source: https://pub.dev/packages/flutter_image_compress/versions/0.1.0/example

This snippet shows how to load an image from assets, compress it using `compressWithList`, and print the byte lengths before and after compression. Ensure you have an image file named 'img/img.jpg' in your assets folder.

```dart
import 'package:flutter/material.dart';
import 'dart:async';
import 'dart:io';

import 'package:flutter/services.dart';
import 'package:flutter_image_compress/flutter_image_compress.dart';
// import 'package:image_picker/image_picker.dart';

void main() => runApp(new MyApp());

class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => new _MyAppState();
}

class _MyAppState extends State<MyApp> {
  @override
  void initState() {
    super.initState();
  }

  // Platform messages are asynchronous, so we initialize in an async method.
  Future<void> compress() async {
    var img = AssetImage("img/img.jpg");
    print("pre compress");
    var config = new ImageConfiguration();

    AssetBundleImageKey key = await img.obtainKey(config);
    final ByteData data = await key.bundle.load(key.name);

    var beforeCompress = data.lengthInBytes;
    print("beforeCompress = $beforeCompress");

    var result = 
        await FlutterImageCompress.compressWithList(data.buffer.asUint8List());

    print("after = ${result?.length ?? 0}");
  }

  @override
  Widget build(BuildContext context) {
    return new MaterialApp(
      home: new Scaffold(
        appBar: new AppBar(
          title: const Text('Plugin example app'),
        ),
        body: new Center(
          child: Column(
            children: <Widget>[
              Image.asset("img/img.jpg"),
              FlatButton(
                child: Text('capture'),
                onPressed: _capture,
              ),
            ],
          ),
        ),
        floatingActionButton: FloatingActionButton(
          child: Icon(Icons.computer),
          onPressed: compress,
        ),
      ),
    );
  }

  void _capture() async {
    var img = AssetImage("img/img.jpg");
    print("pre compress");
    var config = new ImageConfiguration();

    AssetBundleImageKey key = await img.obtainKey(config);
    final ByteData data = await key.bundle.load(key.name);
    File file = File("test.png");
    file.writeAsBytesSync(data.buffer.asUint8List());
    
    var result = await FlutterImageCompress.compressWithFile(
      file.absolute.path,
      minWidth: 2300,
      minHeight: 1500,
      quality: 94,
    );
    print(file.lengthSync());
    print(result.length);
  }
}
```
Tokens:
Raw