androidx.photopicker.activity

Interfaces

PickVisualMedia.VisualMediaType

Represents filter input type accepted by the photo picker.

Classes

PickMultipleVisualMedia

An ActivityResultContract to use the Photo Picker to select multiple images, videos, or other types of visual media.
PickVisualMedia

An ActivityResultContract to use the Photo Picker to select a single image, video, or other type of visual media.
PickVisualMedia.DefaultTab

Represents filter input type accepted by the photo picker.
PickVisualMedia.MediaCapabilities

Represents the media capabilities of an application.
PickVisualMedia.MediaCapabilities.Builder

A builder for constructing MediaCapabilities instances.
PickVisualMedia.SingleMimeType

VisualMediaType class used to filter a single mime type only when using the photo picker.
PickVisualMediaRequest

A request for a PickMultipleVisualMedia or PickVisualMedia Activity Contract.
PickVisualMediaRequest.Builder

A builder for constructing PickVisualMediaRequest instances.

Objects

PickVisualMedia.DefaultTab.AlbumsTab

DefaultTab object used to open the picker in Albums tab.
PickVisualMedia.DefaultTab.PhotosTab

DefaultTab object used to open the picker in Photos tab (also the default if no value is provided).
PickVisualMedia.ImageAndVideo

VisualMediaType object used to filter images and video when using the photo picker.
PickVisualMedia.ImageOnly

VisualMediaType object used to filter images only when using the photo picker.
PickVisualMedia.VideoOnly

VisualMediaType object used to filter video only when using the photo picker.

Top-level functions summary

PickVisualMediaRequest
PickVisualMediaRequest(
    mediaType: PickVisualMedia.VisualMediaType,
    maxItems: @IntRange(from = 2) Int,
    isOrderedSelection: Boolean,
    defaultTab: PickVisualMedia.DefaultTab
)

Creates a request for a PickMultipleVisualMedia or PickVisualMedia Activity Contract.
PickVisualMediaRequest
PickVisualMediaRequest(
    accentColor: Long,
    mediaType: PickVisualMedia.VisualMediaType,
    maxItems: @IntRange(from = 2) Int,
    isOrderedSelection: Boolean,
    defaultTab: PickVisualMedia.DefaultTab
)

Creates a request for a PickMultipleVisualMedia or PickVisualMedia Activity Contract.
PickVisualMediaRequest
@RequiresApi(value = 33)
PickVisualMediaRequest(
    mediaCapabilitiesForTranscoding: PickVisualMedia.MediaCapabilities?,
    mediaType: PickVisualMedia.VisualMediaType,
    maxItems: @IntRange(from = 2) Int,
    isOrderedSelection: Boolean,
    defaultTab: PickVisualMedia.DefaultTab
)

Creates a request for a PickMultipleVisualMedia or PickVisualMedia Activity Contract.
PickVisualMediaRequest
@RequiresApi(value = 33)
PickVisualMediaRequest(
    mediaCapabilitiesForTranscoding: PickVisualMedia.MediaCapabilities?,
    accentColor: Long,
    mediaType: PickVisualMedia.VisualMediaType,
    maxItems: @IntRange(from = 2) Int,
    isOrderedSelection: Boolean,
    defaultTab: PickVisualMedia.DefaultTab
)

Creates a request for a PickMultipleVisualMedia or PickVisualMedia Activity Contract.

Top-level functions

PickVisualMediaRequest

fun PickVisualMediaRequest(
    mediaType: PickVisualMedia.VisualMediaType = ImageAndVideo,
    maxItems: @IntRange(from = 2) Int = PickMultipleVisualMedia.getMaxItems(),
    isOrderedSelection: Boolean = false,
    defaultTab: PickVisualMedia.DefaultTab = DefaultTab.PhotosTab
): PickVisualMediaRequest

Creates a request for a PickMultipleVisualMedia or PickVisualMedia Activity Contract.

Parameters
mediaType: PickVisualMedia.VisualMediaType = ImageAndVideo

type to go into the PickVisualMediaRequest
maxItems: @IntRange(from = 2) Int = PickMultipleVisualMedia.getMaxItems()

limit the number of selectable items when using PickMultipleVisualMedia
isOrderedSelection: Boolean = false

whether the user can control the order of selected media when using PickMultipleVisualMedia (defaults to false)
defaultTab: PickVisualMedia.DefaultTab = DefaultTab.PhotosTab

the tab to initially open the picker in (defaults to DefaultTab.PhotosTab). Note that the support for this parameter was added in API level 35 / R ext 12 and applies the default behavior for older versions. Also see android.provider.MediaStore.EXTRA_PICK_IMAGES_LAUNCH_TAB
Returns
PickVisualMediaRequest

a PickVisualMediaRequest that contains the given input

PickVisualMediaRequest

fun PickVisualMediaRequest(
    accentColor: Long,
    mediaType: PickVisualMedia.VisualMediaType = ImageAndVideo,
    maxItems: @IntRange(from = 2) Int = PickMultipleVisualMedia.getMaxItems(),
    isOrderedSelection: Boolean = false,
    defaultTab: PickVisualMedia.DefaultTab = DefaultTab.PhotosTab
): PickVisualMediaRequest

Creates a request for a PickMultipleVisualMedia or PickVisualMedia Activity Contract.

Parameters
accentColor: Long

color long to customize picker accent color. Note that the support for this parameter was added in API level 35 / R ext 12 and applies the default behavior for older versions. Also see android.provider.MediaStore.EXTRA_PICK_IMAGES_ACCENT_COLOR
mediaType: PickVisualMedia.VisualMediaType = ImageAndVideo

type to go into the PickVisualMediaRequest
maxItems: @IntRange(from = 2) Int = PickMultipleVisualMedia.getMaxItems()

limit the number of selectable items when using PickMultipleVisualMedia
isOrderedSelection: Boolean = false

whether the user can control the order of selected media when using PickMultipleVisualMedia (defaults to false)
defaultTab: PickVisualMedia.DefaultTab = DefaultTab.PhotosTab

the tab to initially open the picker in (defaults to DefaultTab.PhotosTab). Note that the support for this parameter was added in API level 35 / R ext 12 and applies the default behavior for older versions. Also see android.provider.MediaStore.EXTRA_PICK_IMAGES_LAUNCH_TAB
Returns
PickVisualMediaRequest

a PickVisualMediaRequest that contains the given input

PickVisualMediaRequest

@RequiresApi(value = 33)
fun PickVisualMediaRequest(
    mediaCapabilitiesForTranscoding: PickVisualMedia.MediaCapabilities?,
    mediaType: PickVisualMedia.VisualMediaType = ImageAndVideo,
    maxItems: @IntRange(from = 2) Int = PickMultipleVisualMedia.getMaxItems(),
    isOrderedSelection: Boolean = false,
    defaultTab: PickVisualMedia.DefaultTab = DefaultTab.PhotosTab
): PickVisualMediaRequest

Creates a request for a PickMultipleVisualMedia or PickVisualMedia Activity Contract.

Parameters
mediaCapabilitiesForTranscoding: PickVisualMedia.MediaCapabilities?

the MediaCapabilities that the application can handle.
mediaType: PickVisualMedia.VisualMediaType = ImageAndVideo

type to go into the PickVisualMediaRequest
maxItems: @IntRange(from = 2) Int = PickMultipleVisualMedia.getMaxItems()

limit the number of selectable items when using PickMultipleVisualMedia
isOrderedSelection: Boolean = false

whether the user can control the order of selected media when using PickMultipleVisualMedia (defaults to false)
defaultTab: PickVisualMedia.DefaultTab = DefaultTab.PhotosTab

the tab to initially open the picker in (defaults to DefaultTab.PhotosTab)
Returns
PickVisualMediaRequest

a PickVisualMediaRequest that contains the given input

PickVisualMediaRequest

@RequiresApi(value = 33)
fun PickVisualMediaRequest(
    mediaCapabilitiesForTranscoding: PickVisualMedia.MediaCapabilities?,
    accentColor: Long,
    mediaType: PickVisualMedia.VisualMediaType = ImageAndVideo,
    maxItems: @IntRange(from = 2) Int = PickMultipleVisualMedia.getMaxItems(),
    isOrderedSelection: Boolean = false,
    defaultTab: PickVisualMedia.DefaultTab = DefaultTab.PhotosTab
): PickVisualMediaRequest

Creates a request for a PickMultipleVisualMedia or PickVisualMedia Activity Contract.

Parameters
mediaCapabilitiesForTranscoding: PickVisualMedia.MediaCapabilities?

the MediaCapabilities that the application can handle.
accentColor: Long

color long to customize picker accent color
mediaType: PickVisualMedia.VisualMediaType = ImageAndVideo

type to go into the PickVisualMediaRequest
maxItems: @IntRange(from = 2) Int = PickMultipleVisualMedia.getMaxItems()

limit the number of selectable items when using PickMultipleVisualMedia
isOrderedSelection: Boolean = false

whether the user can control the order of selected media when using PickMultipleVisualMedia (defaults to false)
defaultTab: PickVisualMedia.DefaultTab = DefaultTab.PhotosTab

the tab to initially open the picker in (defaults to DefaultTab.PhotosTab)
Returns
PickVisualMediaRequest

a PickVisualMediaRequest that contains the given input