fl_assets_picker library

Classes

AdvancedCustomFilter
The advanced custom filter.
AlbumType
The extra information of the album type.
AndroidMediaColumns
A class that contains the names of the columns used in the custom filter.
AndroidPermission
The permission for android.
ArabicAssetPickerTextDelegate
AssetPickerTextDelegate implements with Arabic. الترجمة العربية
AssetEntity
The abstraction of assets (images/videos/audios). It represents a series of fields MediaStore on Android and the PHAsset object on iOS/macOS.
AssetEntityGridItemBuilder
AssetEntityGridItemWidgetState
AssetEntityImage
A widget that displays an AssetEntity image.
AssetEntityImageProvider
The ImageProvider that handles AssetEntity.
AssetPathEntity
The abstraction of albums and folders. It represent a bucket in the MediaStore on Android, and the PHAssetCollection object on iOS/macOS.
AssetPicker<Asset, Path>
AssetPickerAppBar
A custom app bar. 自定义的顶栏
AssetPickerAppBarWrapper
Wrapper for AssetPickerAppBar. Avoid elevation covered by body. 顶栏封装。防止内容块层级高于顶栏导致遮挡阴影。
AssetPickerBuilderDelegate<Asset, Path>
The delegate to build the whole picker's components.
AssetPickerConfig
AssetPickerDelegate
AssetPickerPageRoute<T>
Built a slide page transition for the picker. 为选择器构造一个上下进出的页面过渡动画
AssetPickerProvider<Asset, Path>
Helps the assets picker to manage Paths and Assets.
AssetPickerState<Asset, Path>
AssetPickerTextDelegate
Text delegate that controls text in widgets. 控制部件中的文字实现
AssetPickerViewer<Asset, Path>
AssetPickerViewerBuilderDelegate<Asset, Path>
AssetPickerViewerProvider<A>
ChangeNotifier for assets picker viewer. 资源选择查看器的 provider model.
AssetPickerViewerState<Asset, Path>
AssetsPickerController
AssetsPickerItemConfig
CameraController
Controls a device camera.
CameraDescription
Properties of a camera device.
CameraFocusPoint
CameraFocusPointPainter
A CustomPaint that draws the exposure point with four arcs and one circle. 包含了四条弧及一个圆的曝光点绘制。
CameraImage
A single complete image buffer from the platform camera.
CameraPicker
The camera picker widget. 拍照选择器。
CameraPickerConfig
Configurations for the CameraPicker. CameraPicker 的配置项
CameraPickerPageRoute<T>
Built a slide page transition for the picker. 为选择器构造一个上下进出的页面过渡动画
CameraPickerState
CameraPickerTextDelegate
Text delegate implemented with Chinese. 中文文字实现
CameraPickerViewer
CameraPickerViewerState
CameraPreview
A widget showing a live camera preview.
CameraValue
The state of a CameraController.
ColumnUtils
Utility functions for working with the CustomColumns class.
ColumnWhereCondition
The where condition item for custom filter.
CommonSortPathDelegate
Common sort path delegate. 常用的路径排序实现
CustomColumns
A class that contains the names of the columns used in the custom filter.
CustomFilter
Full custom filter.
DarwinAlbumType
The extra information of the album type on macOS and iOS.
DarwinColumns
A class that contains the names of the columns of the iOS/macOS platform.
DateColumnWhereCondition
The where condition item for date type.
DateTimeCond
A class that specifies the date and time constraints for queried assets.
DefaultAssetPickerBuilderDelegate
DefaultAssetPickerProvider
The default implementation of the AssetPickerProvider for the picker. The Asset is AssetEntity, and the Path is AssetPathEntity.
DefaultAssetPickerViewerBuilderDelegate
DefaultDeleteIcon
DefaultPickIcon
DurationConstraint
A class that specifies the duration constraints for queried assets.
EnglishAssetPickerTextDelegate
AssetPickerTextDelegate implements with English. English Localization
EnglishCameraPickerTextDelegate
Text delegate implements with English.
ExtendedAssetEntity
FilterOption
A series of filter options for AssetType when querying assets.
FilterOptionGroup
A collection of filtering and sorting options for querying assets.
FlAssetsPicker
FlPickFromTypeBuilder
FlPreviewGesturePageView
FrenchAssetPickerTextDelegate
AssetPickerTextDelegate implements with French. Délégué texte français
GermanAssetPickerTextDelegate
AssetPickerTextDelegate implementiert mit der deutschen Übersetzung. Deutsche Textimplementierung.
HebrewAssetPickerTextDelegate
AssetPickerTextDelegate implements with Hebrew. תרגום בשפה העברית
ImageFormat
Describes how pixels are represented in an image.
JapaneseAssetPickerTextDelegate
AssetPickerTextDelegate implements with Japanese. 日本語の TextDelegate
KoreanAssetPickerTextDelegate
AssetPickerTextDelegate implements with Korean. 한국어 현지화
LatLng
Represents a geographical location as a latitude-longitude pair.
MultipleAssetPicker
NotifyManager
The manager for receiving notifications when assets change.
OhosAlbumType
The extra information of the album type on OpenHarmony.
OhosColumns
A class that contains the names of the columns used in the custom filter.
Optional<T>
A value that might be absent.
OrderByItem
The order by item.
OrderOption
A class that specifies the ordering criteria for queried assets.
PathWrapper<Path>
A wrapper that holds Path with it's nullable (late initialize) fields.
PermissionRequestOption
See PermissionState.
PhotoCachingManager
The cache manager that helps to create/remove caches with specified assets.
PhotoManager
The core manager of this package, providing methods for accessing and managing assets.
PhotoManagerPlugin
The plugin class is the core class that call channel's methods.
PickerFromTypeItem
PickerWrapBuilderConfig
Plane
A single color plane of image data.
PMDarwinPathFilter
The filter of AssetPathEntity on iOS and macOS.
PMFilter
The base class of all the filters.
PMOhosPathFilter
The filter of AssetPathEntity on OpenHarmony.
PMPathFilter
For filter the AssetPathEntity.
PMProgressHandler
Manages the progress of asset downloads from cloud storage services, such as iCloud.
PMProgressState
A state class that contains progress of the current downloading and state to indicate the request state of the asset.
RequestType
The request type when requesting paths.
RussianAssetPickerTextDelegate
AssetPickerTextDelegate implements with Russian. Локализация на русский язык.
SingleAssetPicker
SizeConstraint
A class that specifies the size constraints for queried images.
SortPathDelegate<Path>
@{template wechat_assets_picker.delegates.SortPathDelegate} Delegate to sort asset path entities. 用于资源路径排序的实现 @{endtemplate}
SqlCustomFilter
The sql custom filter.
TextWhereCondition
The where condition item for text.
ThumbnailOption
The options used when requesting thumbnails.
ThumbnailSize
The dimensions of the thumbnail data for an AssetEntity.
TurkishAssetPickerTextDelegate
AssetPickerTextDelegate implements with Turkish Türkçe Yerelleştirme
VietnameseAssetPickerTextDelegate
AssetPickerTextDelegate implements with Vietnamese. Dịch tiếng Việt
VietnameseCameraPickerTextDelegate
Text delegate implemented with Vietnamese. Dịch tiếng Việt
WhereConditionGroup
The group of WhereConditionItem and WhereConditionGroup.
WhereConditionItem
The where condition item for custom filter.
WhereItem
Where item class
XFile
A CrossFile is a cross-platform, simplified File abstraction.

Enums

AssetType
The type of the asset.
BaseFilterType
The type of the filter.
CameraLensDirection
The direction the camera is facing.
CameraPickerViewType
Two types for the viewer: image and video. 两种预览类型：图片和视频
DeliveryMode
Enumeration for PHImageRequestOptionsDeliveryMode on iOS/macOS.
ErrorDes
ExposureMode
The possible exposure modes that can be set for a camera.
FlashMode
The possible flash modes that can be set for a camera
FocusMode
The possible focus modes that can be set for a camera.
ImageCroppingQuality
ImageFileType
Common file types for images.
ImageFormatGroup
Group of image formats that are comparable across Android and iOS platforms.
IosAccessLevel
The app’s level of access to the user’s photo library.
LogicalType
The logical operator used in the CustomFilter.
OrderOptionType
An enumeration of possible options for sorting asset lists.
PermissionState
Information about app’s authorization to access the user’s photo library.
PickerFromType
PMDarwinAssetCollectionSubtype
See document: https://developer.apple.com/documentation/photokit/phassetcollectionsubtype
PMDarwinAssetCollectionType
The type of PHAssetCollection.
PMOhosAlbumSubtype
The subtype of the album on ohos. See also: https://docs.openharmony.cn/pages/v4.0/zh-cn/application-dev/reference/apis/js-apis-photoAccessHelper.md#albumsubtype
PMOhosAlbumType
The type of the album on ohos. See also: https://docs.openharmony.cn/pages/v4.0/zh-cn/application-dev/reference/apis/js-apis-photoAccessHelper.md#albumtype
PMRequestState
Indicate the current state when an asset is loading with PMProgressHandler.
ResizeContentMode
Fitting an image’s aspect ratio to a requested size on iOS/macOS.
ResizeMode
Specifies how to resize the requested image on iOS/macOS.
ResolutionPreset
Affect the quality of video recording and image capture:
SpecialImageType
An enumeration of special image types.
SpecialItemPosition
Provide an item slot for custom widget insertion. 提供一个自定义位置供特殊item放入资源列表中。
SpecialPickerType
Provide some special picker types to integrate un-common pick pattern. 提供一些特殊的选择器类型以整合非常规的选择行为。
ThumbnailFormat
Which format the thumbnail should be, generally support JPG and PNG.

Functions

assetPickerTextDelegateFromLocale(Locale? locale) → AssetPickerTextDelegate
Obtain the text delegate from the given locale.
availableCameras() → Future<List<CameraDescription>>
Completes with a list of available cameras.
cameraPickerTextDelegateFromLocale(Locale? locale) → CameraPickerTextDelegate
Obtain the text delegate from the given locale.

Typedefs

AssetPickerPageRouteBuilder<T> = AssetPickerPageRoute<T> Function(Widget picker)
Build AssetPickerPageRoute with the given generic type. 构建匹配泛型的 AssetPickerPageRoute
AssetSelectPredicate<Asset> = FutureOr<bool> Function(BuildContext context, Asset asset, bool isSelected)
Predicate whether an asset can be selected or unselected. 判断资源可否被选择。
CameraErrorHandler = void Function(Object error, StackTrace? stackTrace)
The error handler when any error occurred during the picking process. 拍摄照片过程中的自定义错误处理
CNP<T extends ChangeNotifier?> = ChangeNotifierProvider<T>
Mirroring ChangeNotifierProvider.
DeletionConfirmation = Future<bool> Function(ExtendedAssetEntity entity)
EntitySaveCallback = FutureOr Function(BuildContext context, CameraPickerViewType viewType, File file)
The callback type define for saving entity in the viewer. 在查看器中保存图片时的回调
FlAssetBuilder = Widget Function(ExtendedAssetEntity entity, bool isThumbnail)
FlAssetFileRenovate = Future Function(AssetEntity entity)
FlAssetsPickerCheckPermission = Future<bool> Function(PickerFromType fromType)
FlAssetsPickerErrorCallback = void Function(ErrorDes des)
FlPreviewAssetsBuilder = Widget Function(BuildContext context, ExtendedAssetEntity entity, List<ExtendedAssetEntity> entitys)
FlPreviewAssetsModalPopupBuilder = void Function(BuildContext context, Widget previewAssets)
ForegroundBuilder = Widget Function(BuildContext context, CameraController? controller)
Build the foreground/overlay widget with the given CameraValue. 根据给定的 CameraValue 构建自定义的前景 widget
LimitedPermissionOverlayPredicate = bool Function(PermissionState permissionState)
Predicate whether the limited permission overlay should be displayed. 判断有限的权限情况下是否展示提示页面。
LoadingIndicatorBuilder = Widget Function(BuildContext context, bool isAssetsEmpty)
Build the loading indicator with the given isAssetsEmpty. 根据给定的 isAssetsEmpty 构建加载指示器。
MultiplePickerItemBuilder = Widget Function(ExtendedAssetEntity item, int index)
onLatestImageAvailable = void Function(CameraImage image)
Signature for a callback receiving the a camera image.
PathNameBuilder<Path> = String Function(Path path)
Build customized path name. 构建自定义路径名称。
PickerFromTypeBuilder = Widget Function(BuildContext context, List<PickerFromTypeItem> fromTypes)
PickerIconBuilder = Widget Function()
PickerWrapBuilder = Widget Function(List<Widget>)
PreviewTransformBuilder = Widget? Function(BuildContext context, CameraController controller, Widget child)
Build the transformed widget with the given CameraController. 根据给定的 CameraController 构建自定义的变换 widget
SinglePickerEntryBuilder = Widget Function(ExtendedAssetEntity entry)
SpecialItemBuilder<Path> = Widget? Function(BuildContext context, Path? path, int length)
Build the special item with the given path and assets length. 根据给定的目录和资源数量构建特殊 item。
XFileCapturedCallback = bool Function(XFile, CameraPickerViewType)
The callback type definition when the XFile is captured by the camera. 拍摄文件生成后的回调

Exceptions / Errors

CameraException
This is thrown when the plugin reports an error.