Photo Gallery
A Flutter plugin that retrieves images and videos from mobile native gallery.
Installation
First, add photo_gallery as a dependency in your pubspec.yaml file.
iOS
Add the following keys to your Info.plist file, located in
:
NSPhotoLibraryUsageDescription - describe why your app needs permission for the photo library. This is called Privacy - Photo Library Usage Description in the visual editor.
<key>NSPhotoLibraryUsageDescriptionkey>
<string>Example usage descriptionstring>
Android
Add the following permissions to your AndroidManifest.xml, located in
:
<manifest ...> <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" /> <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" /> ... <manifest/>
API 29+
Add the following property to your AndroidManifest.xml, located in
to opt-out of scoped storage:
<manifest ...>
...
<application
android:requestLegacyExternalStorage="true"
...>
<application/>
<manifest/>
Usage
- Listing albums in the gallery
final List<Album> imageAlbums = await PhotoGallery.listAlbums(
mediumType: mediumType.image,
);
final List<Album> videoAlbums = await PhotoGallery.listAlbums(
mediumType: mediumType.video,
hideIfEmpty: false
);
- Listing media in an album
final MediaPage imagePage = await imageAlbum.listMedia(
skip: 5,
take: 10,
);
final MediaPage videoPage = await videoAlbum.listMedia(
newest: false,
skip: 5,
take: 10,
);
final List<Medium> allMedia = [
...imagePage.items,
...videoPage.items,
];
- Loading more media in a album
if (!imagePage.isLast) {
final nextImagePage = await imagePage.nextPage();
// ...
}
- Getting a Medium
final Medium medium = await PhotoGallery.getMedium(
mediumId: "10",
MediumType: MediumType.image
);
- Getting a file
final File file = await medium.getFile();
final File file = await PhotoGallery.getFile(mediumId: mediumId);
- Getting thumbnail data
final List<int> data = await medium.getThumbnail();
final List<int> data = await PhotoGallery.getThumbnail(mediumId: mediumId);
You can also specify thumbnail width and height on Android API 29 or higher; You can also specify thumbnail width, height and whether provider high quality or not on iOS:
final List<int> data = await medium.getThumbnail(
width: 128,
height: 128,
highQuality: true,
);
final List<int> data = await PhotoGallery.getThumbnail(
mediumId: mediumId,
mediumType: MediumType.image,
width: 128,
height: 128,
highQuality: true,
);
- Getting album thumbnail data
final List<int> data = await album.getThumbnail();
final List<int> data = await PhotoGallery.getAlbumThumbnail(albumId: albumId);
You can also specify thumbnail width and height on Android API 29 or higher; You can also specify thumbnail width, height and whether provider high quality or not on iOS:
final List<int> data = await album.getThumbnail(
width: 128,
height: 128,
highQuality: true,
);
final List<int> data = await PhotoGallery.getAlbumThumbnail(
albumId: albumId,
width: 128,
height: 128,
highQuality: true,
);
- Displaying medium thumbnail
ThumbnailProvider are available to display thumbnail images (here with the help of dependency transparent_image):
FadeInImage(
fit: BoxFit.cover,
placeholder: MemoryImage(kTransparentImage),
image: ThumbnailProvider(
mediumId: mediumId,
mediumType: MediumType.image,
width: 128,
height: 128,
hightQuality: true,
),
)
Width and height is only available on Android API 29+ or iOS platform
- Displaying album thumbnail
AlbumThumbnailProvider are available to display album thumbnail images (here with the help of dependency transparent_image):
FadeInImage(
fit: BoxFit.cover,
placeholder: MemoryImage(kTransparentImage),
image: AlbumThumbnailProvider(
albumId: albumId,
width: 128,
height: 128,
hightQuality: true,
),
)
Width and height is only available on Android API 29+ or iOS platform. High quality is only available on iOS platform.
- Displaying a full size image
You can use PhotoProvider to display the full size image (here with the help of dependency transparent_image):
FadeInImage(
fit: BoxFit.cover,
placeholder: MemoryImage(kTransparentImage),
image: PhotoProvider(
mediumId: mediumId,
),
)
0 Dec 25, 2021
40 Oct 5, 2022
32 Oct 8, 2022
677 Dec 28, 2022
227 Jan 6, 2023
0 Feb 7, 2022
112 Dec 26, 2022
309 Aug 21, 2022
3 Aug 15, 2022
1 Mar 14, 2022
10 Jan 5, 2023
2 Aug 24, 2022
3 Apr 15, 2022
4 Oct 12, 2022
1 May 31, 2022
121 Dec 26, 2022
11 Nov 26, 2022
57 Nov 20, 2022
0 Mar 9, 2022