# CompositionFrameMetadata

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

*** ** * ** ***


```
@ExperimentalApi
class CompositionFrameMetadata
```

<br />

*** ** * ** ***

> [!CAUTION]
> **This class is deprecated.**   
>
> Use similar keys in `https://developer.android.com/reference/kotlin/androidx/media3/effect/DefaultGlFrameProcessor` instead.

Metadata included on frames in `https://developer.android.com/reference/kotlin/androidx/media3/transformer/CompositionPlayer`.

Applications can extend this class to add custom metadata.

## Summary

| ### Constants |
|---|---|
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html!` | `https://developer.android.com/reference/kotlin/androidx/media3/transformer/CompositionFrameMetadata#KEY_COMPOSITION_FRAME_METADATA() = "KEY_COMPOSITION_FRAME_METADATA"` **This property is deprecated.** Use `https://developer.android.com/reference/kotlin/androidx/media3/transformer/Composition#KEY_COMPOSITION()`, `https://developer.android.com/reference/kotlin/androidx/media3/effect/DefaultGlFrameProcessor#KEY_COMPOSITION_SEQUENCE_INDEX()` and `https://developer.android.com/reference/kotlin/androidx/media3/transformer/Composition#KEY_COMPOSITION_ITEM_INDEX()` instead. <br /> |

| ### Public constructors |
|---|
| `[CompositionFrameMetadata](https://developer.android.com/reference/kotlin/androidx/media3/transformer/CompositionFrameMetadata#CompositionFrameMetadata(androidx.media3.transformer.Composition,int,int))( composition: https://developer.android.com/reference/kotlin/androidx/media3/transformer/Composition!, sequenceIndex: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, itemIndex: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html )` **This function is deprecated.** Deprecated in Java |

| ### Public functions |
|---|---|
| `java-static https://guava.dev/releases/snapshot-android/api/docs/com/google/common/collect/ImmutableMap.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html!, https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html!>!` | `@https://developer.android.com/reference/kotlin/androidx/annotation/RequiresApi(value = 26) [asFrameMetadata](https://developer.android.com/reference/kotlin/androidx/media3/transformer/CompositionFrameMetadata#asFrameMetadata(androidx.media3.transformer.CompositionFrameMetadata))(compositionFrameMetadata: https://developer.android.com/reference/kotlin/androidx/media3/transformer/CompositionFrameMetadata!)` **This function is deprecated.** Deprecated in Java |

| ### Public properties |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/media3/transformer/Composition!` | `https://developer.android.com/reference/kotlin/androidx/media3/transformer/CompositionFrameMetadata#composition()` **This property is deprecated.** Deprecated in Java |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/transformer/CompositionFrameMetadata#itemIndex()` **This property is deprecated.** Deprecated in Java |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/transformer/CompositionFrameMetadata#sequenceIndex()` **This property is deprecated.** Deprecated in Java |

## Constants

### KEY_COMPOSITION_FRAME_METADATA

```
const val KEY_COMPOSITION_FRAME_METADATA = "KEY_COMPOSITION_FRAME_METADATA": String!
```

> [!CAUTION]
> **This property is deprecated.**   
>
> Use `https://developer.android.com/reference/kotlin/androidx/media3/transformer/Composition#KEY_COMPOSITION()`, `https://developer.android.com/reference/kotlin/androidx/media3/effect/DefaultGlFrameProcessor#KEY_COMPOSITION_SEQUENCE_INDEX()` and `https://developer.android.com/reference/kotlin/androidx/media3/transformer/Composition#KEY_COMPOSITION_ITEM_INDEX()` instead.

Metadata key for storing the composition frame metadata.

## Public constructors

### CompositionFrameMetadata

```
[CompositionFrameMetadata](https://developer.android.com/reference/kotlin/androidx/media3/transformer/CompositionFrameMetadata#CompositionFrameMetadata(androidx.media3.transformer.Composition,int,int))(
    composition: Composition!,
    sequenceIndex: Int,
    itemIndex: Int
)
```

> [!CAUTION]
> **This function is deprecated.**   
> Deprecated in Java

Creates a new instance.

## Public functions

### asFrameMetadata

```
@RequiresApi(value = 26)
java-static fun [asFrameMetadata](https://developer.android.com/reference/kotlin/androidx/media3/transformer/CompositionFrameMetadata#asFrameMetadata(androidx.media3.transformer.CompositionFrameMetadata))(compositionFrameMetadata: CompositionFrameMetadata!): ImmutableMap<String!, Any!>!
```

> [!CAUTION]
> **This function is deprecated.**   
> Deprecated in Java

Converts the `https://developer.android.com/reference/kotlin/androidx/media3/transformer/CompositionFrameMetadata` to a map for `https://developer.android.com/reference/kotlin/androidx/media3/common/video/Frame#getMetadata()`.

## Public properties

### composition

```
val composition: Composition!
```

> [!CAUTION]
> **This property is deprecated.**   
> Deprecated in Java

The `https://developer.android.com/reference/kotlin/androidx/media3/transformer/Composition` that this frame belongs to.

### itemIndex

```
val itemIndex: Int
```

> [!CAUTION]
> **This property is deprecated.**   
> Deprecated in Java

The media item index in the `https://developer.android.com/reference/kotlin/androidx/media3/transformer/Composition#sequences()` that this frame belongs to.

### sequenceIndex

```
val sequenceIndex: Int
```

> [!CAUTION]
> **This property is deprecated.**   
> Deprecated in Java

The sequence index in the `https://developer.android.com/reference/kotlin/androidx/media3/transformer/CompositionFrameMetadata#composition()` that this frame belongs to.