ImagePickerPlatform class abstract

The interface that implementations of image_picker must implement.

Platform implementations should extend this class rather than implement it as image_picker does not consider newly added methods to be breaking changes. Extending this class (using extends) ensures that the subclass will get the default implementation, while platform implementations that implements this interface will be broken by newly added ImagePickerPlatform methods.

Inheritance
  • Object
  • PlatformInterface
  • ImagePickerPlatform
Implementers

Constructors

ImagePickerPlatform()
Constructs a ImagePickerPlatform.

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

getImage({required ImageSource source, double? maxWidth, double? maxHeight, int? imageQuality, CameraDevice preferredCameraDevice = CameraDevice.rear}) → Future<XFile?>
Returns an XFile with the image that was picked.
getImageFromSource({required ImageSource source, ImagePickerOptions options = const ImagePickerOptions()}) → Future<XFile?>
Returns an XFile with the image that was picked.
getLostData() → Future<LostDataResponse>
Retrieves any previously picked files, that were lost due to the MainActivity being destroyed. (Android only)
getMedia({required MediaOptions options}) → Future<List<XFile>>
Returns a List<XFile> with the images and/or videos that were picked. The images and videos come from the gallery.
getMultiImage({double? maxWidth, double? maxHeight, int? imageQuality}) → Future<List<XFile>?>
Returns a List<XFile> with the images that were picked.
getMultiImageWithOptions({MultiImagePickerOptions options = const MultiImagePickerOptions()}) → Future<List<XFile>>
Returns a List<XFile> with the images that were picked.
getVideo({required ImageSource source, CameraDevice preferredCameraDevice = CameraDevice.rear, Duration? maxDuration}) → Future<XFile?>
Returns a XFile containing the video that was picked.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pickImage({required ImageSource source, double? maxWidth, double? maxHeight, int? imageQuality, CameraDevice preferredCameraDevice = CameraDevice.rear}) → Future<PickedFile?>
Returns a PickedFile with the image that was picked.
pickMultiImage({double? maxWidth, double? maxHeight, int? imageQuality}) → Future<List<PickedFile>?>
Returns a List<PickedFile> with the images that were picked.
pickVideo({required ImageSource source, CameraDevice preferredCameraDevice = CameraDevice.rear, Duration? maxDuration}) → Future<PickedFile?>
Returns a PickedFile containing the video that was picked.
retrieveLostData() → Future<LostData>
Retrieves any previously picked file, that was lost due to the MainActivity being destroyed. In case multiple files were lost, only the last file will be recovered. (Android only).
supportsImageSource(ImageSource source) → bool
Returns true if the implementation supports source.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

instance ↔ ImagePickerPlatform
The default instance of ImagePickerPlatform to use.
getter/setter pair