# HighlightAlbumParams

Artifact: [androidx.photopicker:photopicker-activity](https://developer.android.com/jetpack/androidx/releases/photopicker) [View Source](https://cs.android.com/search?q=file:androidx/photopicker/activity/params/HighlightAlbumParams.kt+class:androidx.photopicker.activity.params.HighlightAlbumParams) Added in [1.0.0-alpha03](https://developer.android.com/jetpack/androidx/releases/photopicker#1.0.0-alpha03)

*** ** * ** ***


```
class HighlightAlbumParams
```

<br />

*** ** * ** ***

Parameters for launching the photopicker to highlight a specific album's media.

## Summary

| ### Nested types |
|---|
| `class https://developer.android.com/reference/kotlin/androidx/photopicker/activity/params/HighlightAlbumParams.Builder` A builder for constructing `https://developer.android.com/reference/kotlin/androidx/photopicker/activity/params/HighlightAlbumParams` instances. |

| ### Constants |
|---|---|
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/photopicker/activity/params/HighlightAlbumParams#ALBUM_CAMERA()` Highlights media results from the Camera album. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/photopicker/activity/params/HighlightAlbumParams#ALBUM_DOWNLOADS()` Highlights media results from the Downloads album. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/photopicker/activity/params/HighlightAlbumParams#ALBUM_FAVORITES()` Highlights media results from the Favorites album. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/photopicker/activity/params/HighlightAlbumParams#ALBUM_SCREENSHOTS()` Highlights media results from the Screenshots album. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/photopicker/activity/params/HighlightAlbumParams#ALBUM_VIDEOS()` Highlights media results from the Videos album. |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/photopicker/activity/params/HighlightAlbumParams#highlightAlbum()` The requested predefined album to highlight. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/photopicker/activity/params/HighlightAlbumParams#highlightType()` The requested `https://developer.android.com/reference/kotlin/androidx/photopicker/activity/params/HighlightType.Companion.HighlightType` specifying how the highlighted album is displayed. |

## Constants

### ALBUM_CAMERA

```
const val ALBUM_CAMERA: String
```

Highlights media results from the Camera album.

| See also |
|---|---|
| `https://developer.android.com/reference/android/provider/MediaStore.html#PICK_IMAGES_HIGHLIGHT_ALBUM_CAMERA` |   |

### ALBUM_DOWNLOADS

```
const val ALBUM_DOWNLOADS: String
```

Highlights media results from the Downloads album.

| See also |
|---|---|
| `https://developer.android.com/reference/android/provider/MediaStore.html#PICK_IMAGES_HIGHLIGHT_ALBUM_DOWNLOADS` |   |

### ALBUM_FAVORITES

```
const val ALBUM_FAVORITES: String
```

Highlights media results from the Favorites album.

| See also |
|---|---|
| `https://developer.android.com/reference/android/provider/MediaStore.html#PICK_IMAGES_HIGHLIGHT_ALBUM_FAVORITES` |   |

### ALBUM_SCREENSHOTS

```
const val ALBUM_SCREENSHOTS: String
```

Highlights media results from the Screenshots album.

| See also |
|---|---|
| `https://developer.android.com/reference/android/provider/MediaStore.html#PICK_IMAGES_HIGHLIGHT_ALBUM_SCREENSHOTS` |   |

### ALBUM_VIDEOS

```
const val ALBUM_VIDEOS: String
```

Highlights media results from the Videos album.

| See also |
|---|---|
| `https://developer.android.com/reference/android/provider/MediaStore.html#PICK_IMAGES_HIGHLIGHT_ALBUM_VIDEOS` |   |

## Public properties

### highlightAlbum

Added in [1.0.0-alpha03](https://developer.android.com/jetpack/androidx/releases/photopicker#1.0.0-alpha03)

```
val highlightAlbum: String
```

The requested predefined album to highlight.

### highlightType

Added in [1.0.0-alpha03](https://developer.android.com/jetpack/androidx/releases/photopicker#1.0.0-alpha03)

```
val highlightType: Int
```

The requested `https://developer.android.com/reference/kotlin/androidx/photopicker/activity/params/HighlightType.Companion.HighlightType` specifying how the highlighted album is displayed.