# AdOverlayInfo

# AdOverlayInfo

Artifact:[androidx.media3:media3-common](https://developer.android.com/jetpack/androidx/releases/media3)  
[View Source](https://cs.android.com/search?q=file:androidx/media3/common/AdOverlayInfo.java+class:androidx.media3.common.AdOverlayInfo)

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/androidx/media3/common/AdOverlayInfo "View this page in Java")

<br />

```
class AdOverlayInfo
```

<br />

*** ** * ** ***

Provides information about an overlay view shown on top of an ad view group.

## Summary

|                                                                                                                                                                                                                                                                                                                                       ### Nested types                                                                                                                                                                                                                                                                                                                                       |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `class `[AdOverlayInfo.Builder](https://developer.android.com/reference/kotlin/androidx/media3/common/AdOverlayInfo.Builder) A builder for[AdOverlayInfo](https://developer.android.com/reference/kotlin/androidx/media3/common/AdOverlayInfo)instances.                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| `@`[Documented](https://developer.android.com/reference/java/lang/annotation/Documented.html) `@`[Retention](https://developer.android.com/reference/java/lang/annotation/Retention.html)`(value = `[RetentionPolicy.SOURCE](https://developer.android.com/reference/java/lang/annotation/RetentionPolicy.html#SOURCE)`)` `@`[Target](https://developer.android.com/reference/java/lang/annotation/Target.html)`(value = )` `@`[IntDef](https://developer.android.com/reference/kotlin/androidx/annotation/IntDef)`(value = )` `annotation `[AdOverlayInfo.Purpose](https://developer.android.com/reference/kotlin/androidx/media3/common/AdOverlayInfo.Purpose) The purpose of the overlay. |

|                                    ### Constants                                    |
|-------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `const `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) | [PURPOSE_CLOSE_AD](https://developer.android.com/reference/kotlin/androidx/media3/common/AdOverlayInfo#PURPOSE_CLOSE_AD())` = 2` Purpose for ad close buttons overlaying the player.  |
| `const `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) | [PURPOSE_CONTROLS](https://developer.android.com/reference/kotlin/androidx/media3/common/AdOverlayInfo#PURPOSE_CONTROLS())` = 1` Purpose for playback controls overlaying the player. |
| `const `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) | [PURPOSE_NOT_VISIBLE](https://developer.android.com/reference/kotlin/androidx/media3/common/AdOverlayInfo#PURPOSE_NOT_VISIBLE())` = 4` Purpose for overlays that are not visible.     |
| `const `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) | [PURPOSE_OTHER](https://developer.android.com/reference/kotlin/androidx/media3/common/AdOverlayInfo#PURPOSE_OTHER())` = 3` Purpose for other overlays.                                |

|                                                                                                                                                                                                                                                                                                                                                                                                                 ### Public constructors                                                                                                                                                                                                                                                                                                                                                                                                                 |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `@`[UnstableApi](https://developer.android.com/reference/kotlin/androidx/media3/common/util/UnstableApi) ~~[AdOverlayInfo](https://developer.android.com/reference/kotlin/androidx/media3/common/AdOverlayInfo#AdOverlayInfo(android.view.View,int))~~`(view: `[View](https://developer.android.com/reference/android/view/View.html)`!, @`[AdOverlayInfo.Purpose](https://developer.android.com/reference/kotlin/androidx/media3/common/AdOverlayInfo.Purpose)` purpose: `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)`)` **This function is deprecated.** Use[Builder](https://developer.android.com/reference/kotlin/androidx/media3/common/AdOverlayInfo.Builder)instead. <br />                                                                                                                                     |
| `@`[UnstableApi](https://developer.android.com/reference/kotlin/androidx/media3/common/util/UnstableApi) ~~[AdOverlayInfo](https://developer.android.com/reference/kotlin/androidx/media3/common/AdOverlayInfo#AdOverlayInfo(android.view.View,int,java.lang.String))~~`(` ` view: `[View](https://developer.android.com/reference/android/view/View.html)`!,` ` @`[AdOverlayInfo.Purpose](https://developer.android.com/reference/kotlin/androidx/media3/common/AdOverlayInfo.Purpose)` purpose: `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)`,` ` detailedReason: `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)`?` `)` **This function is deprecated.** Use[Builder](https://developer.android.com/reference/kotlin/androidx/media3/common/AdOverlayInfo.Builder)instead. <br /> |

|                                ### Public properties                                 |
|--------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)          | `@`[AdOverlayInfo.Purpose](https://developer.android.com/reference/kotlin/androidx/media3/common/AdOverlayInfo.Purpose) [purpose](https://developer.android.com/reference/kotlin/androidx/media3/common/AdOverlayInfo#purpose()) The purpose of the overlay view. |
| [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)`?` | [reasonDetail](https://developer.android.com/reference/kotlin/androidx/media3/common/AdOverlayInfo#reasonDetail()) An optional, detailed reason that the overlay view is needed.                                                                                  |
| [View](https://developer.android.com/reference/android/view/View.html)`!`            | [view](https://developer.android.com/reference/kotlin/androidx/media3/common/AdOverlayInfo#view()) The overlay view.                                                                                                                                              |

## Constants

### PURPOSE_CLOSE_AD

```
const val PURPOSE_CLOSE_AD = 2: Int
```

Purpose for ad close buttons overlaying the player.  

### PURPOSE_CONTROLS

```
const val PURPOSE_CONTROLS = 1: Int
```

Purpose for playback controls overlaying the player.  

### PURPOSE_NOT_VISIBLE

```
const val PURPOSE_NOT_VISIBLE = 4: Int
```

Purpose for overlays that are not visible.  

### PURPOSE_OTHER

```
const val PURPOSE_OTHER = 3: Int
```

Purpose for other overlays.  

## Public constructors

### AdOverlayInfo

```
@UnstableApi
[AdOverlayInfo](https://developer.android.com/reference/kotlin/androidx/media3/common/AdOverlayInfo#AdOverlayInfo(android.view.View,int))(view: View!, @AdOverlayInfo.Purpose purpose: Int)
```
| **This function is deprecated.**   
|
Use[Builder](https://developer.android.com/reference/kotlin/androidx/media3/common/AdOverlayInfo.Builder)instead.  

### AdOverlayInfo

```
@UnstableApi
[AdOverlayInfo](https://developer.android.com/reference/kotlin/androidx/media3/common/AdOverlayInfo#AdOverlayInfo(android.view.View,int,java.lang.String))(
    view: View!,
    @AdOverlayInfo.Purpose purpose: Int,
    detailedReason: String?
)
```
| **This function is deprecated.**   
|
Use[Builder](https://developer.android.com/reference/kotlin/androidx/media3/common/AdOverlayInfo.Builder)instead.  

## Public properties

### purpose

```
@AdOverlayInfo.Purpose
val purpose: Int
```

The purpose of the overlay view.  

### reasonDetail

```
val reasonDetail: String?
```

An optional, detailed reason that the overlay view is needed.  

### view

```
val view: View!
```

The overlay view.