Added in API level 37
Also in U Extensions 22

Summary: Nested Classes | Inherited Constants | Fields | Methods | Inherited Methods

PhotoPickerSelectionParams

Kotlin |Java

public final class PhotoPickerSelectionParams
extends Object implements Parcelable

java.lang.Object
↳	android.widget.photopicker.PhotoPickerSelectionParams

An immutable parcel that carries constraints to be applied to media items displayed in the Photo Picker.

Media items that fail to satisfy these constraints will be disabled for selection.

Callers should use Builder to construct an instance of this class.

Summary

Nested classes
`class`	`PhotoPickerSelectionParams.Builder` A builder class used to construct and validate an immutable `PhotoPickerSelectionParams` object.

Inherited constants

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

Fields
`public static final Creator<PhotoPickerSelectionParams>`	`CREATOR`

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`long`	`getMaxMediaItemResolutionInPixels()` Returns the maximum allowed resolution, in pixels, for a media item to be selectable.
`long`	`getMaxMediaItemSizeInBytes()` Returns the maximum allowed size, in bytes, for a media item to be selectable.
`long`	`getMaxSelectionBatchSizeInBytes()` Returns the maximum allowed cumulative size, in bytes, for the entire batch of selected media items.
`Duration`	`getMaxVideoDuration()` Returns the maximum allowed duration for a video to be selectable.
`List<String>`	`getMimeTypes()` Returns the list of allowed MIME types that media items must match to be selectable.
`long`	`getMinMediaItemResolutionInPixels()` Returns the minimum required resolution, in pixels, for a media item to be selectable.
`Duration`	`getMinVideoDuration()` Returns the minimum required duration for a video to be selectable.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 37
Also in U Extensions 22

public static final Creator<PhotoPickerSelectionParams> CREATOR

Public methods

describeContents

Added in API level 37

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
`int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

getMaxMediaItemResolutionInPixels

Added in API level 37
Also in U Extensions 22

public long getMaxMediaItemResolutionInPixels ()

Returns the maximum allowed resolution, in pixels, for a media item to be selectable.

If the maximum resolution is not set by the caller app using Builder.setMaxMediaItemResolutionInPixels(long), this method returns -1, indicating that the photo picker will not restrict selection based on the maximum media item resolution.

Returns
`long`

getMaxMediaItemSizeInBytes

Added in API level 37
Also in U Extensions 22

public long getMaxMediaItemSizeInBytes ()

Returns the maximum allowed size, in bytes, for a media item to be selectable.

If the maximum media item size is not set by the caller app using Builder.setMaxMediaItemSizeInBytes(long), this method returns -1, indicating that the photo picker will not restrict selection based on the maximum media item size.

Returns
`long`

getMaxSelectionBatchSizeInBytes

Added in API level 37
Also in U Extensions 22

public long getMaxSelectionBatchSizeInBytes ()

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

If the maximum selection batch size is not set by the caller app using Builder.setMaxSelectionBatchSizeInBytes(long), this method returns -1, indicating that the photo picker will not restrict selection based on the total batch size.

Returns
`long`

getMaxVideoDuration

Added in API level 37
Also in U Extensions 22

public Duration getMaxVideoDuration ()

Returns the maximum allowed duration for a video to be selectable.

If the maximum video duration is not set by the caller app using Builder.setMaxVideoDuration(Duration), this method returns null, indicating that the photo picker will not restrict selection based on the maximum video duration.

Returns
`Duration`

getMimeTypes

Added in API level 37
Also in U Extensions 22

public List<String> getMimeTypes ()

Returns the list of allowed MIME types that media items must match to be selectable.

If the allowed MIME types are not set by the caller app using Builder.setMimeTypes(List), this method returns an empty list, indicating that the photo picker will not restrict selection based on the MIME type.

Returns
`List<String>`	This value cannot be `null`.

getMinMediaItemResolutionInPixels

Added in API level 37
Also in U Extensions 22

public long getMinMediaItemResolutionInPixels ()

Returns the minimum required resolution, in pixels, for a media item to be selectable.

If the minimum resolution is not set by the caller app using Builder.setMinMediaItemResolutionInPixels(long), this method returns -1, indicating that the photo picker will not restrict selection based on the minimum media item resolution.

Returns
`long`

getMinVideoDuration

Added in API level 37
Also in U Extensions 22

public Duration getMinVideoDuration ()

Returns the minimum required duration for a video to be selectable.

If the minimum video duration is not set by the caller app using Builder.setMinVideoDuration(Duration), this method returns null, indicating that the photo picker will not restrict selection based on the minimum video duration.

Returns
`Duration`

writeToParcel

Added in API level 37

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
`dest`	`Parcel`: This value cannot be `null`.
`flags`	`int`: Additional flags about how the object should be written. May be 0 or `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`

PhotoPickerSelectionParams

Summary

Nested classes

Inherited constants

Fields

Public methods

Inherited methods

Fields

CREATOR

Public methods

describeContents

getMaxMediaItemResolutionInPixels

getMaxMediaItemSizeInBytes

getMaxSelectionBatchSizeInBytes

getMaxVideoDuration

getMimeTypes

getMinMediaItemResolutionInPixels

getMinVideoDuration

writeToParcel