CompositionFrameMetadata

Artifact: androidx.media3:media3-transformer

View Source

---

Kotlin |Java

@ExperimentalApi
class CompositionFrameMetadata : HardwareBufferFrame.Metadata

---

Metadata included on HardwareBufferFrames in CompositionPlayer.

Applications can extend this class to add custom metadata.

Summary

Constants
const String!	KEY_COMPOSITION_FRAME_METADATA = "KEY_COMPOSITION_FRAME_METADATA" Metadata key for storing the composition frame metadata.

Public constructors
CompositionFrameMetadata(     composition: Composition!,     sequenceIndex: Int,     itemIndex: Int ) Creates a new instance.

Public properties
Composition!	composition The Composition that this frame belongs to.
Int	itemIndex The media item index in the sequence that this frame belongs to.
Int	sequenceIndex The sequence index in the composition that this frame belongs to.

Constants

KEY_COMPOSITION_FRAME_METADATA

const val KEY_COMPOSITION_FRAME_METADATA = "KEY_COMPOSITION_FRAME_METADATA": String!

Metadata key for storing the composition frame metadata.

Public constructors

CompositionFrameMetadata

CompositionFrameMetadata(
    composition: Composition!,
    sequenceIndex: Int,
    itemIndex: Int
)

Creates a new instance.

Public properties

composition

val composition: Composition!

The Composition that this frame belongs to.

itemIndex

val itemIndex: Int

The media item index in the sequence that this frame belongs to.

sequenceIndex

val sequenceIndex: Int

The sequence index in the composition that this frame belongs to.