# 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
public class CompositionFrameMetadata
```

<br />

*** ** * ** ***

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

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

Applications can extend this class to add custom metadata.

## Summary

| ### Constants |
|---|---|
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/media3/transformer/CompositionFrameMetadata#KEY_COMPOSITION_FRAME_METADATA() = "KEY_COMPOSITION_FRAME_METADATA"` **This field is deprecated.** Use `https://developer.android.com/reference/androidx/media3/transformer/Composition#KEY_COMPOSITION()`, `https://developer.android.com/reference/androidx/media3/effect/DefaultGlFrameProcessor#KEY_COMPOSITION_SEQUENCE_INDEX()` and `https://developer.android.com/reference/androidx/media3/transformer/Composition#KEY_COMPOSITION_ITEM_INDEX()` instead. <br /> |

| ### Public fields |
|---|---|
| `final https://developer.android.com/reference/androidx/media3/transformer/Composition` | `https://developer.android.com/reference/androidx/media3/transformer/CompositionFrameMetadata#composition()` **This field is deprecated.** Deprecated in Java |
| `final int` | `https://developer.android.com/reference/androidx/media3/transformer/CompositionFrameMetadata#itemIndex()` **This field is deprecated.** Deprecated in Java |
| `final int` | `https://developer.android.com/reference/androidx/media3/transformer/CompositionFrameMetadata#sequenceIndex()` **This field is deprecated.** Deprecated in Java |

| ### Public constructors |
|---|
| `[CompositionFrameMetadata](https://developer.android.com/reference/androidx/media3/transformer/CompositionFrameMetadata#CompositionFrameMetadata(androidx.media3.transformer.Composition,int,int))( https://developer.android.com/reference/androidx/media3/transformer/Composition composition, int sequenceIndex, int itemIndex )` **This method is deprecated.** Deprecated in Java |

| ### Public methods |
|---|---|
| `static https://guava.dev/releases/snapshot-android/api/docs/com/google/common/collect/ImmutableMap.html<https://developer.android.com/reference/java/lang/String.html, https://developer.android.com/reference/java/lang/Object.html>` | `@https://developer.android.com/reference/androidx/annotation/RequiresApi(value = 26) [asFrameMetadata](https://developer.android.com/reference/androidx/media3/transformer/CompositionFrameMetadata#asFrameMetadata(androidx.media3.transformer.CompositionFrameMetadata))(https://developer.android.com/reference/androidx/media3/transformer/CompositionFrameMetadata compositionFrameMetadata)` **This method is deprecated.** Deprecated in Java |

## Constants

### KEY_COMPOSITION_FRAME_METADATA

```
public static final String KEY_COMPOSITION_FRAME_METADATA = "KEY_COMPOSITION_FRAME_METADATA"
```

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

Metadata key for storing the composition frame metadata.

## Public fields

### composition

```
public final Composition composition
```

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

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

### itemIndex

```
public final int itemIndex
```

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

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

### sequenceIndex

```
public final int sequenceIndex
```

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

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

## Public constructors

### CompositionFrameMetadata

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

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

Creates a new instance.

## Public methods

### asFrameMetadata

```
@RequiresApi(value = 26)
public static ImmutableMap<String, Object> [asFrameMetadata](https://developer.android.com/reference/androidx/media3/transformer/CompositionFrameMetadata#asFrameMetadata(androidx.media3.transformer.CompositionFrameMetadata))(CompositionFrameMetadata compositionFrameMetadata)
```

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

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