Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [U Extensions 22](https://developer.android.com/sdkExtensions) Summary: [Nested Classes](https://developer.android.com/reference/android/widget/photopicker/PhotoPickerUiCustomizationParams#nestedclasses) \| [Constants](https://developer.android.com/reference/android/widget/photopicker/PhotoPickerUiCustomizationParams#constants) \| [Inherited Constants](https://developer.android.com/reference/android/widget/photopicker/PhotoPickerUiCustomizationParams#inhconstants) \| [Fields](https://developer.android.com/reference/android/widget/photopicker/PhotoPickerUiCustomizationParams#lfields) \| [Methods](https://developer.android.com/reference/android/widget/photopicker/PhotoPickerUiCustomizationParams#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/widget/photopicker/PhotoPickerUiCustomizationParams#inhmethods)

# PhotoPickerUiCustomizationParams

*** ** * ** ***

` public final class PhotoPickerUiCustomizationParams `   
` extends https://developer.android.com/reference/java/lang/Object ` ` implements https://developer.android.com/reference/android/os/Parcelable `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.widget.photopicker.PhotoPickerUiCustomizationParams |

<br />

*** ** * ** ***

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` | `https://developer.android.com/reference/android/widget/photopicker/PhotoPickerUiCustomizationParams.Builder` A builder class used to construct and validate an immutable `https://developer.android.com/reference/android/widget/photopicker/PhotoPickerUiCustomizationParams` object. |

| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/android/widget/photopicker/PhotoPickerUiCustomizationParams#ASPECT_RATIO_PORTRAIT_9_16` Aspect ratio option requesting portrait 9:16 sizing for the thumbnails within the media grid. |
| `int` | `https://developer.android.com/reference/android/widget/photopicker/PhotoPickerUiCustomizationParams#ASPECT_RATIO_SQUARE_1_1` Aspect ratio option requesting square 1:1 thumbnail sizing within the media grid. |
| `int` | `https://developer.android.com/reference/android/widget/photopicker/PhotoPickerUiCustomizationParams#ASPECT_RATIO_UNDEFINED` Aspect ratio option sent to photo picker when no aspect ratio is set by the calling app. |

### Inherited constants

From interface `https://developer.android.com/reference/android/os/Parcelable` `int` `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR`

Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int` `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`

Flag for use with `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`: 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 https://developer.android.com/reference/android/os/Parcelable.Creator<https://developer.android.com/reference/android/widget/photopicker/PhotoPickerUiCustomizationParams>` | `https://developer.android.com/reference/android/widget/photopicker/PhotoPickerUiCustomizationParams#CREATOR` <br /> |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/widget/photopicker/PhotoPickerUiCustomizationParams#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` int` | ` https://developer.android.com/reference/android/widget/photopicker/PhotoPickerUiCustomizationParams#getAspectRatio()() ` Returns the constant representing the aspect ratio currently configured for thumbnail sizing within the Photo Picker's media grid. |
| ` void` | ` https://developer.android.com/reference/android/widget/photopicker/PhotoPickerUiCustomizationParams#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. |

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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` ` https://developer.android.com/reference/java/lang/Object#wait(long)(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` ` https://developer.android.com/reference/java/lang/Object#wait()() `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.
From interface ` https://developer.android.com/reference/android/os/Parcelable ` ` abstract int` ` https://developer.android.com/reference/android/os/Parcelable#describeContents()() `

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
` abstract void` ` https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) `

Flatten this object in to a Parcel.

## Constants

### ASPECT_RATIO_PORTRAIT_9_16

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [U Extensions 22](https://developer.android.com/sdkExtensions)

```
public static final int ASPECT_RATIO_PORTRAIT_9_16
```

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

<br />

Constant Value: 1 (0x00000001)

### ASPECT_RATIO_SQUARE_1_1

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [U Extensions 22](https://developer.android.com/sdkExtensions)

```
public static final int ASPECT_RATIO_SQUARE_1_1
```

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

<br />

Constant Value: 0 (0x00000000)

### ASPECT_RATIO_UNDEFINED

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [U Extensions 22](https://developer.android.com/sdkExtensions)

```
public static final int ASPECT_RATIO_UNDEFINED
```

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

<br />

Constant Value: -1 (0xffffffff)

## Fields

### CREATOR

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [U Extensions 22](https://developer.android.com/sdkExtensions)

```
public static final Creator<PhotoPickerUiCustomizationParams> CREATOR
```

<br />

<br />

## Public methods

### describeContents

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`, the return value of this method must include the `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` bit.

<br />

| Returns ||
|---|---|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |

### getAspectRatio

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [U Extensions 22](https://developer.android.com/sdkExtensions)

```
public int getAspectRatio ()
```

Returns the constant representing the aspect ratio currently configured for thumbnail sizing within the Photo Picker's media grid. (e.g., `https://developer.android.com/reference/android/widget/photopicker/PhotoPickerUiCustomizationParams#ASPECT_RATIO_SQUARE_1_1`).

If the aspect ratio is not set by the caller app using `https://developer.android.com/reference/android/widget/photopicker/PhotoPickerUiCustomizationParams.Builder#setAspectRatio(int)`, this method returns `https://developer.android.com/reference/android/widget/photopicker/PhotoPickerUiCustomizationParams#ASPECT_RATIO_UNDEFINED`, indicating that the photo picker will use its default 1:1 media grid aspect ratio.

<br />

| Returns ||
|---|---|
| `int` | Value is one of the following: - `https://developer.android.com/reference/android/widget/photopicker/PhotoPickerUiCustomizationParams#ASPECT_RATIO_UNDEFINED` - `https://developer.android.com/reference/android/widget/photopicker/PhotoPickerUiCustomizationParams#ASPECT_RATIO_SQUARE_1_1` - `https://developer.android.com/reference/android/widget/photopicker/PhotoPickerUiCustomizationParams#ASPECT_RATIO_PORTRAIT_9_16` |

### writeToParcel

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void writeToParcel (Parcel dest, 
                int flags)
```

Flatten this object in to a Parcel.

<br />

| Parameters ||
|---|---|
| `dest` | `Parcel`: This value cannot be `null`. <br /> |
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |