Added in API level 37
Also in U Extensions 22

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

PhotoPickerUiCustomizationParams

---

Kotlin |Java

public final class PhotoPickerUiCustomizationParams
extends Object implements Parcelable

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

---

Defines UI customization options for the system's Photo Picker interface.

This immutable class allows an application to specify visual preferences to optimize the user experience within the picker.

Summary

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

Constants
int	ASPECT_RATIO_PORTRAIT_9_16 Aspect ratio option requesting portrait 9:16 sizing for the thumbnails within the media grid.
int	ASPECT_RATIO_SQUARE_1_1 Aspect ratio option requesting square 1:1 thumbnail sizing within the media grid.
int	ASPECT_RATIO_UNDEFINED Aspect ratio option sent to photo picker when no aspect ratio is set by the calling app.

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<PhotoPickerUiCustomizationParams>	CREATOR

Public methods
int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
int	getAspectRatio() Returns the constant representing the aspect ratio currently configured for thumbnail sizing within the Photo Picker's media grid.
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.

Constants

ASPECT_RATIO_PORTRAIT_9_16

Added in API level 37
Also in U Extensions 22

public static final int ASPECT_RATIO_PORTRAIT_9_16

Aspect ratio option requesting portrait 9:16 sizing for the thumbnails within the media grid.

Constant Value: 1 (0x00000001)

ASPECT_RATIO_SQUARE_1_1

Added in API level 37
Also in U Extensions 22

public static final int ASPECT_RATIO_SQUARE_1_1

Aspect ratio option requesting square 1:1 thumbnail sizing within the media grid.

Constant Value: 0 (0x00000000)

ASPECT_RATIO_UNDEFINED

Added in API level 37
Also in U Extensions 22

public static final int ASPECT_RATIO_UNDEFINED

Aspect ratio option sent to photo picker when no aspect ratio is set by the calling app.

Constant Value: -1 (0xffffffff)

Fields

CREATOR

Added in API level 37
Also in U Extensions 22

public static final Creator<PhotoPickerUiCustomizationParams> 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

getAspectRatio

Added in API level 37
Also in U Extensions 22

public int getAspectRatio ()

Returns the constant representing the aspect ratio currently configured for thumbnail sizing within the Photo Picker's media grid. (e.g., ASPECT_RATIO_SQUARE_1_1).

If the aspect ratio is not set by the caller app using Builder.setAspectRatio(int), this method returns ASPECT_RATIO_SQUARE_1_1, indicating that the photo picker will use its default 1:1 media grid aspect ratio.

Returns
int	Value is one of the following: ASPECT_RATIO_UNDEFINED ASPECT_RATIO_SQUARE_1_1 ASPECT_RATIO_PORTRAIT_9_16

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