gal

Visão geral do pacote

Orientação gerada a partir de informações públicas. Apenas para referência.

O pacote gal é um plugin do Flutter que permite salvar imagens e vídeos na galeria de fotos do dispositivo com gerenciamento integrado de permissões. Ele suporta Android, iOS, macOS e Windows, tornando-o ideal para aplicativos que exigem funcionalidade de exportação de mídia. O plugin simplifica o processo de acesso à galeria ao gerenciar permissões automaticamente, reduzindo o código boilerplate. Ele se integra perfeitamente em fluxos de trabalho multimídia, especialmente em aplicativos que envolvem captura, edição ou compartilhamento de imagens ou vídeos.

Casos de uso

Salvando imagens/vídeos capturados na galeria
Automatizar a exportação de mídia após a edição
Integrando o acesso à galeria em aplicativos multiplataforma
Gerenciando solicitações de permissão para armazenamento de mídia
Habilitar compartilhamento de mídia amigável ao usuário

Principais recursos

Gerenciamento automático de permissões
Suporte multiplataforma (Android, iOS, macOS, Windows)
API simples para salvar mídia
Gerenciamento de erros embutido
Leve e fácil de integrar

Indicado para

Aplicativos Flutter com recursos de captura de mídia
Ferramentas de edição de imagem ou vídeo
Aplicativos que exigem acesso à galeria
Desenvolvedores procurando configuração mínima para salvar mídia
Aplicações multimídia multiplataforma

Considerações

Requer permissões apropriadas nos arquivos de configuração específicos da plataforma
Pode ser necessário tratamento adicional para comportamentos específicos do sistema operacional
Limitado a operações básicas de salvamento sem controle avançado de metadados
Depende de repositório externo para atualizações
Não projetado para seleção ou navegação de mídia

README original

Snapshot do README original do repositório-fonte vinculado. Consulte o repositório para o conteúdo mais recente.

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.',
      };
}