SelectionParams.Builder

fun build(): SelectionParams

Builds a new immutable SelectionParams object.

fun clearMaxMediaItemResolution(): SelectionParams.Builder

Clears the maximum allowed resolution limit for media items.

On calling this, the PhotoPicker will not enforce an upper limit on the resolution of media items.

fun clearMaxMediaItemSize(): SelectionParams.Builder

Clears the maximum allowed size limit for individual media items.

On calling this, the PhotoPicker will not enforce an upper limit on the size of individual media items.

fun clearMaxSelectionBatchSize(): SelectionParams.Builder

Clears the maximum allowed cumulative batch size limit.

On calling this, the PhotoPicker will not enforce an upper limit on the cumulative size of selected media items.

fun clearMaxVideoDuration(): SelectionParams.Builder

Clears the maximum allowed duration limit for video media items.

On calling this, the PhotoPicker will not enforce an upper limit on the duration of video media items.

fun clearMimeTypes(): SelectionParams.Builder

Clears the allowed mime types selection constraint.

On calling this, the PhotoPicker will not enforce allowed mime type constraints for selection.

fun clearMinMediaItemResolution(): SelectionParams.Builder

Clears the minimum allowed resolution limit for media items.

On calling this, the PhotoPicker will not enforce a lower limit on the resolution of media items.

fun clearMinVideoDuration(): SelectionParams.Builder

Clears the minimum allowed duration limit for video media items.

On calling this, the PhotoPicker will not enforce a lower limit on the duration of video media items.

fun setMaxMediaItemResolutionInPixels(maxMediaItemResolutionInPixels: Long): SelectionParams.Builder

Sets the maximum allowed resolution constraint for a media item to be selectable.

Media items with total resolution (width * height) exceeding this limit will be disabled and cannot be selected.

If the maximum resolution is not set by the caller app using setMaxMediaItemResolutionInPixels, there will be no restriction on the maximum resolution.

fun setMaxMediaItemSizeInBytes(maxMediaItemSizeInBytes: Long): SelectionParams.Builder

Sets the maximum allowed size, in bytes, for any individual media item to be selectable.

Media items exceeding this size will be disabled and cannot be selected.

If the maximum media item size is not set by the caller app using setMaxMediaItemSizeInBytes, there will be no restriction on the maximum media item size.

fun setMaxSelectionBatchSizeInBytes(maxSelectionBatchSizeInBytes: Long): SelectionParams.Builder

Sets the maximum allowed cumulative size, in bytes, for the entire batch of selected media items.

This limits the aggregate size of all items selected in a single PhotoPicker session. If selecting an item causes the total cumulative size to exceed this limit, the user will be alerted that the maximum selection size has been reached and cannot add more items until existing selections are removed.

If the maximum selection batch size is not set by the caller app using setMaxSelectionBatchSizeInBytes, there will be no restriction on the cumulative size of selected media items.

fun setMaxVideoDuration(maxVideoDuration: Duration): SelectionParams.Builder

Sets the maximum allowed duration for a video media item to be selectable.

Video items exceeding this duration will be disabled and cannot be selected.

If the maximum video duration is not set by the caller app using setMaxVideoDuration, there will be no restriction on the maximum video duration.

fun setMimeTypes(mimeTypes: List<String>): SelectionParams.Builder

Sets the list of mime types that are allowed for selection.

Media items whose mime type is not in this list will be visible in the picker grid but disabled for selection.

If the allowed mime types are not set by the caller app using setMimeTypes, all items matching the requested media type filter will be selectable.

This constraint is distinct from the media type filter specified via androidx.photopicker.activity.PickVisualMediaRequest.Builder.setMediaType. The media type in the request determines which items are queried and displayed in the PhotoPicker grid in the first place, whereas setMimeTypes controls which displayed items are enabled for selection.

fun setMinMediaItemResolutionInPixels(minMediaItemResolutionInPixels: Long): SelectionParams.Builder

Sets the minimum allowed resolution constraint for a media item to be selectable.

Media items with total resolution (width * height) below this limit will be disabled and cannot be selected.

If the minimum resolution is not set by the caller app using setMinMediaItemResolutionInPixels, there will be no restriction on the minimum resolution.

fun setMinVideoDuration(minVideoDuration: Duration): SelectionParams.Builder

Sets the minimum allowed duration for a video media item to be selectable.

Video items shorter than this duration will be disabled and cannot be selected.

If the minimum video duration is not set by the caller app using setMinVideoDuration, there will be no restriction on the minimum video duration.