Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dimonovdd/Xamarin.MediaGallery
This plugin is designed to picking and save images and video files from native gallery of Android and iOS devices and capture photos
https://github.com/dimonovdd/Xamarin.MediaGallery
android capture-photo essentials hacktoberfest image media mediagallery mediapicker saving-photos video xamarin xamarin-android xamarin-forms xamarin-ios
Last synced: 30 days ago
JSON representation
This plugin is designed to picking and save images and video files from native gallery of Android and iOS devices and capture photos
- Host: GitHub
- URL: https://github.com/dimonovdd/Xamarin.MediaGallery
- Owner: dimonovdd
- License: mit
- Created: 2021-04-11T16:15:15.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T10:37:44.000Z (about 1 month ago)
- Last Synced: 2024-10-29T12:34:20.132Z (about 1 month ago)
- Topics: android, capture-photo, essentials, hacktoberfest, image, media, mediagallery, mediapicker, saving-photos, video, xamarin, xamarin-android, xamarin-forms, xamarin-ios
- Language: C#
- Homepage:
- Size: 10.6 MB
- Stars: 149
- Watchers: 6
- Forks: 18
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-xamarin-forms - MediaGallery ★101
README
# MediaGallery for .NET Android and iOS
[](https://www.nuget.org/packages/Xamarin.MediaGallery/) [](https://www.nuget.org/packages/Xamarin.MediaGallery/) [](./LICENSE) [](https://www.fuget.org/packages/Xamarin.MediaGallery) [](https://youtu.be/8JvgnlHVyrI)
This plugin is designed for picking and saving photos and video files from the native gallery of Android and iOS devices and capture photo.
[](https://www.buymeacoffee.com/dimonovdd)
## FAQ
Please read this file and see samples before creating an issue.
### Q: Why does the plugin not support Xamarin?
**A:** Yes, it's funny. Initially, I made this plugin as a temporary solution to expand the functionality of Xamarin.Essentials. Xamarin is no longer supported by Microsoft and MAUI still has scant functionality for working with media files. For these reasons, this plugin will continue to exist and support .NET for iOS and Android.
### Q: [Why does a image have wrong orientation?](https://github.com/dimonovdd/Xamarin.MediaGallery/issues/105)
**A:** This is correct behavior. The plugin returns images without any changes, See [metadata](https://www.nuget.org/packages/MetadataExtractor/)
### Q: [How do I get `FilePath`?](https://github.com/dimonovdd/Xamarin.MediaGallery/issues/104)
**A:** It is not possible. [But you can copy a file to a cache directory](./Sample/Common/src/Helpers/FilesHelper.cs#L8)
### Q: [How does Xamarin.MediaGallery work on a PopupPage?](https://stackoverflow.com/questions/70233374/how-does-xamarin-mediagallery-work-in-popuppage-in-xamarin)
**A:** Fine! But you need to [initialize the plugin](#ios-optional) on iOS. [See taht sample code](https://github.com/xamarin/Essentials/pull/1846#issuecomment-975207765)
### Q: [Why an error thrown when picking a image on a iOS simulator?](https://github.com/dimonovdd/Xamarin.MediaGallery/issues/92)
**A:** This issue is on Apple side
## Available Platforms
| Platform | Minimum OS Version |
| --- | --- |
| Android | 5.0 |
| iOS | 13.6 |
### TargetFrameworks
- `net8.0-ios`
- `net8.0-android`
## Getting started
You can just watch the [Video](https://youtu.be/8JvgnlHVyrI) that [@jfversluis](https://github.com/jfversluis) published
[**Migration to 3.X.X version**](./docs/migration3.x.x.md)
~~[**Migration to 2.X.X version**](./docs/migration2.x.x.md)~~
### Android
In the Android project's MainLauncher or any Activity that is launched, this plugin must be initialized in the OnCreate method:
```csharp
protected override void OnCreate(Bundle savedInstanceState)
{
//...
base.OnCreate(savedInstanceState);
NativeMedia.Platform.Init(this, savedInstanceState);
//...
}
```
### iOS (Optional)
In the iOS project's AppDelegate that is launched, this plugin can be initialized in the FinishedLaunching method:
```csharp
public override bool FinishedLaunching(UIApplication app, NSDictionary options)
{
NativeMedia.Platform.Init(GetTopViewController);
global::Xamarin.Forms.Forms.Init();
LoadApplication(new App());
return base.FinishedLaunching(app, options);
}
public UIViewController GetTopViewController()
{
var vc = UIApplication.SharedApplication.KeyWindow.RootViewController;
if (vc is UINavigationController navController)
vc = navController.ViewControllers.Last();
return vc;
}
```
## PickAsync
This method does not require requesting permissions from users
```csharp
var cts = new CancellationTokenSource();
IMediaFile[] files = null;
try
{
var request = new MediaPickRequest(1, MediaFileType.Image, MediaFileType.Video)
{
PresentationSourceBounds = System.Drawing.Rectangle.Empty,
Title = "Select"
};
cts.CancelAfter(TimeSpan.FromMinutes(5));
var results = await MediaGallery.PickAsync(request, cts.Token);
files = results?.Files?.ToArray();
}
catch (OperationCanceledException)
{
// handling a cancellation request
}
catch (Exception)
{
// handling other exceptions
}
finally
{
cts.Dispose();
}
if (files == null)
return;
foreach (var file in files)
{
var fileName = file.NameWithoutExtension; //Can return an null or empty value
var extension = file.Extension;
var contentType = file.ContentType;
using var stream = await file.OpenReadAsync();
//...
file.Dispose();
}
```
This method has two overloads:
- `Task PickAsync(int selectionLimit = 1, params MediaFileType[] types)`
- `Task PickAsync(MediaPickRequest request, CancellationToken token = default)`
### Android
To handle runtime results on Android, this plugin must receive any `OnActivityResult`.
```csharp
protected override void OnActivityResult(int requestCode, Result resultCode, Intent intent)
{
if (NativeMedia.Platform.CheckCanProcessResult(requestCode, resultCode, intent))
NativeMedia.Platform.OnActivityResult(requestCode, resultCode, intent);
base.OnActivityResult(requestCode, resultCode, intent);
}
```
If an app has `android:targetSdkVersion="33"` or greater [new Photo picker](https://developer.android.com/training/data-storage/shared/photopicker) will be used if possible.
#### Default behavior
- When using `PickAsync` method `selectionLimit` parameter just sets multiple pick allowed
- A request to cancel `PickAsync` method will cancel a task, but the picker UI can remain open until it is closed by the user
- The use of `Title` property depends on each device
#### Photo Picker behavior
- `selectionLimit` parameter limits the number of selected media files
- `Title` property not used
### iOS
- Multi picking is supported since iOS version 14.0+ On older versions, the plugin will prompt the user to select a single file
- The `NameWithoutExtension` property on iOS versions before 14 returns a null value if the permission to access photos was not granted
- `Title` property not used
#### Presentation Location
When picking files on iPadOS you have the ability to present in a pop over control. This specifies where the pop over will appear and point an arrow directly to. You can specify the location using the `PresentationSourceBounds` property. Setting this property has the same behavior as [Launcher or Share in Xamarin.Essentials](https://docs.microsoft.com/en-us/xamarin/essentials/share?tabs=android#presentation-location).
`PresentationSourceBounds` property takes `System.Drawing.Rectangle` for `Xamarin` or `Microsoft.Maui.Graphics.Rect` for `.net6(MAUI)`
**Screenshots:**
- [Popover](./Screenshots/iPadPopover.png)
- [PageSheet](./Screenshots/iPadPageSheet.png)
## Сapture Photo with Metadata
```csharp
//...
if (!MediaGallery.CheckCapturePhotoSupport())
return;
var status = await Permissions.RequestAsync();
if (status != PermissionStatus.Granted)
return;
using var file = await MediaGallery.CapturePhotoAsync()
```
`NameWithoutExtension` will always return `$"IMG_{DateTime.Now:yyyyMMdd_HHmmss}"` value.
### Android
Open the AndroidManifest.xml file under the Properties folder and add the following inside of the manifest node.
```xml
```
```xml
```
If Camera is not required in your application, you can specify `false`.
```xml
```
### iOS
In your `Info.plist` add the following keys:
```xml
NSCameraUsageDescription
This app needs access to the camera to take photos.
```
## SaveAsync
```csharp
//...
var status = await Permissions.RequestAsync();
if (status != PermissionStatus.Granted)
return;
await MediaGallery.SaveAsync(MediaFileType.Video, filePath);
//OR Using a byte array or a stream
await MediaGallery.SaveAsync(MediaFileType.Image, stream, fileName);
//The name or the path to the saved file must contain the extension.
//...
```
### Permission
Add [`Xamarin.MediaGallery.Permision`](https://www.nuget.org/packages/Xamarin.MediaGallery.Permision) or [`Xamarin.MediaGallery.Permision.Maui`](https://www.nuget.org/packages/Xamarin.MediaGallery.Permision.Maui) nuget package to use the `SaveMediaPermission`
### Android
Open the AndroidManifest.xml file under the Properties folder and add the following inside of the manifest node.
```xml
```
- When saving media files, the date and time are appended to the file name
### iOS
In your `Info.plist` add the following keys:
```xml
NSPhotoLibraryAddUsageDescription
This app needs access to the photo gallery for saving photos and videos
NSPhotoLibraryUsageDescription
This app needs access to the photo gallery for saving photos and videos
```
## Screenshots
| iOS | Android - Defult | Android - Photo Picker |
|:-------:|:-------:|:-------:|
||||