Search categories, packages and repositories

Package detailsv3.1.4

video_compress

Light library of video manipulation of Flutter. Compress video, remove audio, get video thumbnail from dart code.

AndroidiOSmacOS
30-day downloads
224K
Likes
748
Pub points
140

Install package

flutter pub add video_compress

Package Overview

Package selection guidance compiled from public package information, community data, and project usage.

A lightweight Flutter package for video manipulation, enabling developers to compress videos, remove audio tracks, and generate thumbnails directly from Dart code. Designed for efficient multimedia handling on Android, iOS, and macOS, it simplifies common video processing tasks without requiring native platform code. Ideal for apps needing on-device video optimization and preview generation.

Use cases

  • Compress large video files for storage
  • Remove audio from videos
  • Generate thumbnails from video files
  • Optimize video for upload
  • Process videos in real-time
  • Reduce app size with compressed media

Key features

  • Video compression support
  • Audio removal functionality
  • Thumbnail extraction
  • Cross-platform compatibility
  • Simple Dart API
  • Lightweight and fast

Suitable for

  • Media-heavy apps
  • Video sharing platforms
  • Content creation tools
  • Mobile apps with video uploads
  • Apps requiring offline video processing
  • Developers seeking minimal native code

Considerations

  • Requires native platform permissions
  • May impact performance on low-end devices
  • Limited to basic video operations
  • Depends on underlying native libraries
  • Not suitable for complex video editing
  • File size reduction depends on source quality

Original README

Original README snapshot from the linked source repository. Visit the repository for the latest content.

video_compress

Compress videos, remove audio, manipulate thumbnails, and make your video compatible with all platforms through this lightweight and efficient library. 100% native code was used, we do not use FFMPEG as it is very slow, bloated and the GNU license is an obstacle for commercial applications. In addition, google chrome uses VP8/VP9, safari uses h264, and most of the time, it is necessary to encode the video in two formats, but not with this library. All video files are encoded in an MP4 container with AAC audio that allows 100% compatibility with safari, mozila, chrome, android and iOS.

Works on ANDROID, IOS and desktop (just MacOS for now).

Table of Contents

Lets Get Started

1. Depend on it

Add this to your package's pubspec.yaml file:

dependencies:
  video_compress: ^3.1.0
2. Install it

You can install packages from the command line:

with pub:

$  pub get
3. Import it

Now in your Dart code, you can use:

import 'package:video_compress/video_compress.dart';

How to use

Imports
import 'package:video_compress/video_compress.dart';
    

Video compression

MediaInfo mediaInfo = await VideoCompress.compressVideo(
  path,
  quality: VideoQuality.DefaultQuality, 
  deleteOrigin: false, // It's false by default
);

Check compress state

VideoCompress.isCompressing

Get memory thumbnail from VideoPath

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

Get File thumbnail from VideoPath

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

Get media information

final info = await VideoCompress.getMediaInfo(videopath);

delete all cache files

  • Delete all files generated by this will delete all files located at 'video_compress', you shoule ought to know what are you doing.
await VideoCompress.deleteAllCache()

Listen the compression progress

class _Compress extends State<Compress> {

  Subscription _subscription;

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

  @override
  void dispose() {
    super.dispose();
    _subscription.unsubscribe();
  }
}
TODO
  • Add the trim video function
  • Add cancel function to Android

Methods

Functions Parameters Description Returns
getByteThumbnail String path[video path], int quality(1-100)[thumbnail quality], int position[Get a thumbnail from video position] get thumbnail from video path Future<Uint8List>
getFileThumbnail String path[video path], int quality(1-100)[thumbnail quality], int position[Get a thumbnail from video position] get thumbnail file from video path Future<File>
getMediaInfo String path[video path] get media information from video path Future<MediaInfo>
compressVideo String path[video path], VideoQuality quality[compressed video quality], bool deleteOrigin[delete the origin video], int startTime[compression video start time], int duration[compression video duration from start time], bool includeAudio[is include audio in compressed video], int frameRate[compressed video frame rate] compression video at origin video path Future<MediaInfo>
cancelCompression none cancel compressing Future<void>
deleteAllCache none Delete all files generated by 'video_compress' will delete all files located at 'video_compress' Future<bool>

Subscriptions

Subscriptions Description Stream
compressProgress$ Subscribe the compression progress steam double progress

Contribute

Contributions are always welcome!

acknowledgment

Inspired by the flutter_ffmpeg library. https://github.com/rurico/flutter_video_compress

Categories

Source repository

Projects using this package