# StaticOverlaySettings

# StaticOverlaySettings

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

*** ** * ** ***

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

<br />

```
@UnstableApi
class StaticOverlaySettings : OverlaySettings
```

<br />

*** ** * ** ***

A statically valued[OverlaySettings](https://developer.android.com/reference/kotlin/androidx/media3/common/OverlaySettings).

## Summary

|                                                                                                                                     ### Nested types                                                                                                                                     |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `class `[StaticOverlaySettings.Builder](https://developer.android.com/reference/kotlin/androidx/media3/effect/StaticOverlaySettings.Builder) A builder for[StaticOverlaySettings](https://developer.android.com/reference/kotlin/androidx/media3/effect/StaticOverlaySettings)instances. |

|                                                                                                               ### Public properties                                                                                                               |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|
| [Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)                                                                                                                                                                   | [alphaScale](https://developer.android.com/reference/kotlin/androidx/media3/effect/StaticOverlaySettings#alphaScale())                         |
| [Pair](https://developer.android.com/reference/android/util/Pair.html)`<`[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`!, `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`!>!` | [backgroundFrameAnchor](https://developer.android.com/reference/kotlin/androidx/media3/effect/StaticOverlaySettings#backgroundFrameAnchor())   |
| [Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)                                                                                                                                                                   | [hdrLuminanceMultiplier](https://developer.android.com/reference/kotlin/androidx/media3/effect/StaticOverlaySettings#hdrLuminanceMultiplier()) |
| [Pair](https://developer.android.com/reference/android/util/Pair.html)`<`[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`!, `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`!>!` | [overlayFrameAnchor](https://developer.android.com/reference/kotlin/androidx/media3/effect/StaticOverlaySettings#overlayFrameAnchor())         |
| [Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)                                                                                                                                                                   | [rotationDegrees](https://developer.android.com/reference/kotlin/androidx/media3/effect/StaticOverlaySettings#rotationDegrees())               |
| [Pair](https://developer.android.com/reference/android/util/Pair.html)`<`[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`!, `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`!>!` | [scale](https://developer.android.com/reference/kotlin/androidx/media3/effect/StaticOverlaySettings#scale())                                   |

|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       ### Inherited Constants                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| From[androidx.media3.common.OverlaySettings](https://developer.android.com/reference/kotlin/androidx/media3/common/OverlaySettings) |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `const `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)                                                                                                                                                                   | [DEFAULT_ALPHA_SCALE](https://developer.android.com/reference/kotlin/androidx/media3/common/OverlaySettings#DEFAULT_ALPHA_SCALE())` = 1.0f` The default alpha scale value of the overlay.                                                              | | `const `[Pair](https://developer.android.com/reference/android/util/Pair.html)`<`[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`!, `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`!>!` | [DEFAULT_BACKGROUND_FRAME_ANCHOR](https://developer.android.com/reference/kotlin/androidx/media3/common/OverlaySettings#DEFAULT_BACKGROUND_FRAME_ANCHOR()) The default coordinates for the anchor point of the overlay within the background frame.    | | `const `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)                                                                                                                                                                   | [DEFAULT_HDR_LUMINANCE_MULTIPLIER](https://developer.android.com/reference/kotlin/androidx/media3/common/OverlaySettings#DEFAULT_HDR_LUMINANCE_MULTIPLIER())` = 1.0f` The default luminance multiplier of an SDR overlay when overlaid on a HDR frame. | | `const `[Pair](https://developer.android.com/reference/android/util/Pair.html)`<`[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`!, `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`!>!` | [DEFAULT_OVERLAY_FRAME_ANCHOR](https://developer.android.com/reference/kotlin/androidx/media3/common/OverlaySettings#DEFAULT_OVERLAY_FRAME_ANCHOR()) The default coordinates for the anchor point of the overlay frame.                                | | `const `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)                                                                                                                                                                   | [DEFAULT_ROTATION_DEGREES](https://developer.android.com/reference/kotlin/androidx/media3/common/OverlaySettings#DEFAULT_ROTATION_DEGREES())` = 0.0f` The default rotation of the overlay, counter-clockwise.                                          | | `const `[Pair](https://developer.android.com/reference/android/util/Pair.html)`<`[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`!, `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`!>!` | [DEFAULT_SCALE](https://developer.android.com/reference/kotlin/androidx/media3/common/OverlaySettings#DEFAULT_SCALE()) The default scaling of the overlay.                                                                                             | |

## Public properties

### alphaScale

```
val alphaScale: Float
```  

### backgroundFrameAnchor

```
val backgroundFrameAnchor: Pair<Float!, Float!>!
```  

### hdrLuminanceMultiplier

```
val hdrLuminanceMultiplier: Float
```  

### overlayFrameAnchor

```
val overlayFrameAnchor: Pair<Float!, Float!>!
```  

### rotationDegrees

```
val rotationDegrees: Float
```  

### scale

```
val scale: Pair<Float!, Float!>!
```