gal

パッケージ概要

公開情報に基づく選定ガイドです。参考としてご利用ください。

gal パッケージは、デバイスの写真ギャラリーに画像や動画を保存する機能を提供し、組み込みの権限処理を備えたFlutterプラグインです。Android、iOS、macOS、Windowsをサポートしており、メディアエクスポート機能が必要なアプリに最適です。このプラグインは、権限を自動的に管理することでギャラリーへのアクセスプロセスを簡素化し、ボイラープレートコードを削減します。画像または動画のキャプチャ、編集、共有を含むマルチメディアワークフローにシームレスに統合できます。

用途

ギャラリーにキャプチャした画像/動画を保存する
編集後のメディアエクスポートの自動化
クロスプラットフォームアプリでのギャラリーへのアクセスの統合
メディアストレージの権限要求を処理する
ユーザーにやさしいメディア共有の有効化

主な機能

自動権限処理
クロスプラットフォーム対応（Android、iOS、macOS、Windows）
メディアを保存するためのシンプルな API
組み込みエラーマネジメント
軽量で統合が簡単

適している対象

メディアキャプチャ機能を備えたFlutterアプリ
画像または動画編集ツール
ギャラリーへのアクセスが必要なアプリ
メディア保存の最小構成を求める開発者
クロスプラットフォームマルチメディアアプリケーション

注意事項

プラットフォーム固有の構成ファイルに適切な権限が必要です
特定のOSの動作に対して追加の処理が必要になる場合があります
高度なメタデータ制御なしで基本的な保存操作に限定
更新には外部リポジトリに依存しています
メディア選択またはブラウジング用に設計されていません

元の README

関連するソースリポジトリの README 原文のスナップショットです。最新の内容はリポジトリをご覧ください。

Dart3 plugin for saving image or video to photos gallery

pub.dev »

📢 Support Us

Please support our volunteer efforts by giving us a LIKE👍 and STAR⭐️.

🧠 DeepWiki Documentation

📱 Supported Platforms

	Android	iOS	macOS	Windows	Linux
Support	SDK 21+	11+	11+	10+	See: gal_linux

Support means that all functions have been tested manually or automatically whenever possible.

📸 Demo

	iOS	Android
Example

✨ Features

Open gallery
Save video
Save image
Save to album
Save with metadata
Handle permission
Handle errors
Comprehensive documentation and wiki

🚀 Getting Started

Add Dependency

Add the latest stable version of gal to your dependencies:

flutter pub add gal

iOS Setup

Add the following keys to ios/Runner/Info.plist:

<key>NSPhotoLibraryAddUsageDescription</key> Required
<key>NSPhotoLibraryUsageDescription</key> Required for iOS < 14 or saving to album

You can copy from example's Info.plist.

Android Setup

Add the following keys to android/app/src/main/AndroidManifest.xml:

<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" android:maxSdkVersion="29" /> Required for API <= 29
android:requestLegacyExternalStorage="true" Required for saving to album in API 29

You can copy from example's AndroidManifest.xml.

[!WARNING] Android emulators with API < 29 require SD card setup. Real devices don't.

macOS Setup

Add the following keys to macos/Runner/Info.plist:

<key>NSPhotoLibraryAddUsageDescription</key> Required
<key>NSPhotoLibraryUsageDescription</key> Required for saving to album

You can copy from example's Info.plist.

[!WARNING] Flutter currently has a fatal problem for loading info.plist, which may cause permission denials or app crashes in some code editors.

Windows Setup

Update Visual Studio to the latest version for using C++ 20.

[!TIP] If you can't compile, try downloading the latest Windows SDK:

Open Visual Studio Installer

Select Modify

Select Windows SDK

Linux Setup

Linux is not officially supported, but can be added through a non-endorsed federated plugin. See: gal_linux

💻 Usage

Save from Local

// Save Image (Supports two ways)
await Gal.putImage('$filePath');
await Gal.putImageBytes('$uint8List');

// Save Video
await Gal.putVideo('$filePath');

// Save to Album
await Gal.putImage('$filePath', album: '$album')
...

Download from Internet

flutter pub add dio

// Download Image
final imagePath = '${Directory.systemTemp.path}/image.jpg';
await Dio().download('$url',imagePath);
await Gal.putImage(imagePath);

// Download Video
final videoPath = '${Directory.systemTemp.path}/video.mp4';
await Dio().download('$url',videoPath);
await Gal.putVideo(videoPath);

Save from Camera

flutter pub add image_picker

// Capture and Save
final image = await ImagePicker.pickImage(source: ImageSource.camera);
await Gal.putImage(image.path);

flutter pub add camera

// Record and Save
...
final video = await controller.stopVideoRecording();
await Gal.putVideo(video.path);

Handle Permissions

// Check Access Permission
final hasAccess = await Gal.hasAccess();

// Request Access Permission
await Gal.requestAccess();

// ... for saving to album
final hasAccess = await Gal.hasAccess(toAlbum: true);
await Gal.requestAccess(toAlbum: true);

Handle Errors

// Save Image with try-catch
try {
  await Gal.putImage('$filePath');
} on GalException catch (e) {
  log(e.type.message);
}

// Exception Type
enum GalExceptionType {
  accessDenied,
  notEnoughSpace,
  notSupportedFormat,
  unexpected;

  String get message => switch (this) {
        accessDenied => 'Permission to access the gallery is denied.',
        notEnoughSpace => 'Not enough space for storage.',
        notSupportedFormat => 'Unsupported file format.',
        unexpected => 'An unexpected error has occurred.',
      };
}