video_compress Flutter Library

To use video_compress in your Flutter project, follow these steps:

1. Add the dependency to your pubspec.yaml file:

2. Run the install command in your terminal:

3. Import the package in your Dart code.

dependencies:
  video_compress: ^3.1.0

$ pub get

import 'package:video_compress/video_compress.dart';

To customize the launch screen for the iOS version of your Flutter project, you can use one of two methods:

1. Direct File Replacement: Replace the existing image files directly within the example/ios/Runner/Assets.xcassets/LaunchImage.imageset/ directory with your own assets.
2. Xcode Interface:
   • Open the iOS workspace using open ios/Runner.xcworkspace.
   • In the Xcode Project Navigator, navigate to Runner/Assets.xcassets.
   • Drag and drop your desired images into the asset catalog to replace the launch images.

To track the progress of a compression task, subscribe to the compressProgress$ stream. Ensure you unsubscribe from the subscription when the widget is disposed to prevent memory leaks.

class _Compress extends State<Compress> {

  Subscription _subscription;

  @override
  void initState() {
    super.initState();
    _subscription = 
        VideoCompress.compressProgress$.subscribe((progress) {
      debugPrint('progress: $progress');
    });
  }

  @override
  void dispose() {
    _subscription.unsubscribe();
    super.dispose();
  }
}

Use VideoCompress.deleteAllCache() to clear all files generated by the library. Warning: This will delete all files located in the video_compress cache directory. Use with caution.

await VideoCompress.deleteAllCache()

To compress a video, use the VideoCompress.compressVideo method. You must provide the file path of the source video. You can optionally specify the compression quality using the VideoQuality enum and decide whether to delete the original file using the deleteOrigin flag.

Returns a MediaInfo object containing the path to the compressed video.

File file = await ImagePicker.pickVideo(source: ImageSource.gallery);
final info = await VideoCompress.compressVideo(
  file.path,
  quality: VideoQuality.MediumQuality,
  deleteOrigin: false,
);

// info.path contains the path to the compressed video
String compressedPath = info.path;

The library provides two ways to extract thumbnails from a video:

Get thumbnail as bytes (getByteThumbnail)

Returns a Future<Uint8List> containing the thumbnail data.

• path: Video path.
• quality: Integer (1-100). Defaults to 100.
• position: The video position to capture the frame from. Defaults to -1.

Get thumbnail as a file (getFileThumbnail)

Returns a Future<File> pointing to the saved thumbnail file.

• path: Video path.
• quality: Integer (1-100). Defaults to 100.
• position: The video position to capture the frame from. Defaults to -1.

// Get bytes
final uint8list = await VideoCompress.getByteThumbnail(
  videopath,
  quality: 50, // default(100)
  position: -1 // default(-1)
);

// Get file
final thumbnailFile = await VideoCompress.getFileThumbnail(
  videopath,
  quality: 50, // default(100)
  position: -1 // default(-1)
);

Use VideoCompress.getMediaInfo(path) to retrieve metadata and information about a video file. Returns a Future<MediaInfo>.

final info = await VideoCompress.getMediaInfo(videopath);

When calling VideoCompress.compressVideo, you can control the output quality using the quality parameter. This parameter accepts values from the VideoQuality enum.

quality: VideoQuality.MediumQuality

You can convert a MediaInfo instance into a Map<String, dynamic> using the toJson() method. This is useful for persisting video metadata. Note that the file field in the resulting JSON map is stored as a string representation of the file path.

final info = MediaInfo(path: '/path/to/video.mp4', title: 'My Video');
Map<String, dynamic> json = info.toJson();
print(json['path']); // Outputs: /path/to/video.mp4