# MediaMetadataRetriever.BitmapParams

Added in[API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Summary:[Ctors](https://developer.android.com/reference/android/media/MediaMetadataRetriever.BitmapParams#pubctors)\|[Methods](https://developer.android.com/reference/android/media/MediaMetadataRetriever.BitmapParams#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/media/MediaMetadataRetriever.BitmapParams#inhmethods)  

# MediaMetadataRetriever.BitmapParams

*** ** * ** ***

[Kotlin](https://developer.android.com/reference/kotlin/android/media/MediaMetadataRetriever.BitmapParams "View this page in Kotlin")\|Java

`
public
static
final

class
MediaMetadataRetriever.BitmapParams
`  
`

extends `[Object](https://developer.android.com/reference/java/lang/Object)`


``


`

|---|---------------------------------------------------|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.media.MediaMetadataRetriever.BitmapParams |

<br />

*** ** * ** ***

## Summary

|                                                                          ### Public constructors                                                                          ||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| ` `[BitmapParams](https://developer.android.com/reference/android/media/MediaMetadataRetriever.BitmapParams#BitmapParams())`() ` Create a default BitmapParams object. |

|                                                                                                                                                                                                           ### Public methods                                                                                                                                                                                                           ||
|--------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` `[Bitmap.Config](https://developer.android.com/reference/android/graphics/Bitmap.Config) | ` `[getActualConfig](https://developer.android.com/reference/android/media/MediaMetadataRetriever.BitmapParams#getActualConfig())`() ` Get the actual bitmap config used to decode the bitmap after the decoding.                                                                                                                          |
| ` `[Bitmap.Config](https://developer.android.com/reference/android/graphics/Bitmap.Config) | ` `[getPreferredConfig](https://developer.android.com/reference/android/media/MediaMetadataRetriever.BitmapParams#getPreferredConfig())`() ` Retrieve the preferred bitmap config in the params.                                                                                                                                           |
| ` void`                                                                                    | ` `[setPreferredConfig](https://developer.android.com/reference/android/media/MediaMetadataRetriever.BitmapParams#setPreferredConfig(android.graphics.Bitmap.Config))`(`[Bitmap.Config](https://developer.android.com/reference/android/graphics/Bitmap.Config)` config) ` Set the preferred bitmap config for the decoder to decode into. |

| ### Inherited methods |
|-----------------------|---|
| From class` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object)          | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object.                                                                                                                                                      | | ` boolean`                                                                     | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one.                                           | | ` void`                                                                        | ` `[finalize](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 `[Class](https://developer.android.com/reference/java/lang/Class)`<?>` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this`Object`.                                                                                                                                                | | ` int`                                                                         | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object.                                                                                                                                                 | | ` final void`                                                                  | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor.                                                                                                                            | | ` final void`                                                                  | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor.                                                                                                                         | | ` `[String](https://developer.android.com/reference/java/lang/String)          | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object.                                                                                                                                            | | ` final void`                                                                  | ` `[wait](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`                                                                  | ` `[wait](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`                                                                  | ` `[wait](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*.                                                                                             | ||

## Public constructors

### BitmapParams

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

```
public BitmapParams ()
```

Create a default BitmapParams object. By default, it uses[Bitmap.Config.ARGB_8888](https://developer.android.com/reference/android/graphics/Bitmap.Config#ARGB_8888)as the preferred bitmap config.

<br />

## Public methods

### getActualConfig

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

```
public Bitmap.Config getActualConfig ()
```

Get the actual bitmap config used to decode the bitmap after the decoding.

<br />

|                                                                          Returns                                                                           ||
|-----------------------------------------------------------------------------------------|-------------------------------------------------------------------|
| [Bitmap.Config](https://developer.android.com/reference/android/graphics/Bitmap.Config) | the actual bitmap config used. This value cannot be`null`. <br /> |

### getPreferredConfig

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

```
public Bitmap.Config getPreferredConfig ()
```

Retrieve the preferred bitmap config in the params.

<br />

|                                                                         Returns                                                                          ||
|-----------------------------------------------------------------------------------------|-----------------------------------------------------------------|
| [Bitmap.Config](https://developer.android.com/reference/android/graphics/Bitmap.Config) | the preferred bitmap config. This value cannot be`null`. <br /> |

### setPreferredConfig

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

```
public void setPreferredConfig (Bitmap.Config config)
```

Set the preferred bitmap config for the decoder to decode into. If not set, or the request cannot be met, the decoder will output in[Bitmap.Config.ARGB_8888](https://developer.android.com/reference/android/graphics/Bitmap.Config#ARGB_8888)config by default. After decode, the actual config used can be retrieved by[getActualConfig()](https://developer.android.com/reference/android/media/MediaMetadataRetriever.BitmapParams#getActualConfig()).

<br />

|                                            Parameters                                             ||
|----------|-----------------------------------------------------------------------------------------|
| `config` | `Bitmap.Config`: the preferred bitmap config to use. This value cannot be`null`. <br /> |