CompositionFrameMetadata

Kotlin |Java

@ExperimentalApi
class CompositionFrameMetadata : HardwareBufferFrame.Metadata

Applications can extend this class to add custom metadata.

Summary

Constants
`const String!`	`KEY_COMPOSITION_FRAME_METADATA = "KEY_COMPOSITION_FRAME_METADATA"` This property is deprecated. Use `KEY_COMPOSITION`, `KEY_COMPOSITION_SEQUENCE_INDEX` and `KEY_COMPOSITION_ITEM_INDEX` instead.

const String!

KEY_COMPOSITION_FRAME_METADATA = "KEY_COMPOSITION_FRAME_METADATA"

This property is deprecated.

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

Public functions
`java-static ImmutableMap<String!, Any!>!`	`@RequiresApi(value = 26) asFrameMetadata(compositionFrameMetadata: CompositionFrameMetadata!)` Converts the `CompositionFrameMetadata` to a map for `getMetadata`.

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.

const val KEY_COMPOSITION_FRAME_METADATA = "KEY_COMPOSITION_FRAME_METADATA": String!

Metadata key for storing the composition frame metadata.

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

Creates a new instance.

@RequiresApi(value = 26)
java-static fun asFrameMetadata(compositionFrameMetadata: CompositionFrameMetadata!): ImmutableMap<String!, Any!>!

val composition: Composition!

The Composition that this frame belongs to.

val itemIndex: Int

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

val sequenceIndex: Int

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