Photo Gallery Pro

A Flutter plugin for accessing and managing photos and videos from the device gallery. Supports Android, iOS, and Linux platforms.

Features

• 📱 List all media albums (photos and videos)
• 🖼️ Filter albums by media type (images or videos)
• 📂 Get media items from specific albums
• 🎬 Support for both images and videos
• 👍 Permission handling (on Android and iOS)
• 🔍 Generate thumbnails for:
  • Individual media items
  • Album covers
• ⚡ Optimized performance
• 🎨 Material Design 3 example app

Platform Support

Android	iOS	Linux
✅	✅	✅

Installation

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

dependencies:
  photo_gallery_pro: ^0.0.4

Platform Setup

Android

Add the following permissions to your Android Manifest (android/app/src/main/AndroidManifest.xml):

<!-- For Android 12 and below -->
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />

<!-- For Android 13 and above -->
<uses-permission android:name="android.permission.READ_MEDIA_IMAGES" />
<uses-permission android:name="android.permission.READ_MEDIA_VIDEO" />

iOS

Add the following keys to your iOS Info.plist (ios/Runner/Info.plist):

<key>NSPhotoLibraryUsageDescription</key>
<string>This app requires access to the photo library to display your photos and videos.</string>

Linux

Ensure you have the necessary dependencies installed:

sudo apt-get update
sudo apt-get install libgtk-3-dev pkg-config cmake ninja-build libgdk-pixbuf2.0-dev

Usage

Basic Setup

import 'package:photo_gallery_pro/photo_gallery_pro.dart';

// Initialize the plugin
final photoGallery = PhotoGalleryPro();

// Request permissions if needed (not required on Linux)
if (!await photoGallery.hasPermission()) {
  final granted = await photoGallery.requestPermission();
  if (!granted) return;
}

Working with Albums

// Get all albums
final albums = await photoGallery.getAlbums();

// Or get only image albums
final imageAlbums = await photoGallery.getAlbums(type: MediaType.image);

// Or get only video albums
final videoAlbums = await photoGallery.getAlbums(type: MediaType.video);

// Get album thumbnail
final albumThumbnail = await photoGallery.getAlbumThumbnail(
  albums[0].id,
  type: albums[0].type,
);

Working with Media

// Get media in an album
final mediaList = await photoGallery.getMediaInAlbum(
  albums[0].id,
  type: albums[0].type,
);

// Get thumbnail for a specific media item
final thumbnail = await photoGallery.getThumbnail(
  mediaList[0].id,
  type: mediaList[0].type,
);

Understanding the Models

Album Model

The Album model represents a collection of media items on the device:

final Album album = albums[0];

print(album.id);        // Unique identifier for the album
print(album.name);      // Display name (e.g., "Camera", "Screenshots")
print(album.count);     // Number of media items in the album
print(album.type);      // MediaType.image, MediaType.video, or MediaType.mixed

Media Model

The Media model contains information about individual photos or videos:

final Media media = mediaList[0];

print(media.id);        // Unique identifier for the media item
print(media.filename);  // Original file name with extension
print(media.type);      // MediaType.image or MediaType.video
print(media.path);      // Path to the media file on the device
print(media.created);   // DateTime when the media was created
print(media.width);     // Original width in pixels
print(media.height);    // Original height in pixels
print(media.mimeType);  // MIME type (e.g., "image/jpeg", "video/mp4")
print(media.duration);  // Duration for videos (null for images)

Thumbnail Model

The Thumbnail model provides access to the preview image data:

final Thumbnail thumb = await photoGallery.getThumbnail(media.id);

print(thumb.width);     // Width of the thumbnail in pixels
print(thumb.height);    // Height of the thumbnail in pixels
print(thumb.bytes);     // Raw bytes of the thumbnail image (Uint8List)

// Example: Display thumbnail in an Image widget
Image.memory(thumb.bytes)

Platform Specific Notes

Linux

• No explicit permissions are required
• Uses the standard Pictures directory for media access
• Supports common image formats (JPG, PNG) and video formats (MP4, AVI, MKV)
• Thumbnails are generated using GDK-Pixbuf

Example

Check the example directory for a complete sample app demonstrating all features.

Contributing

Feel free to contribute to this project by:

• Opening issues
• Submitting pull requests
• Adding documentation
• Reporting bugs

License

This project is licensed under the MIT License - see the LICENSE file for details.