MdtaMetadataEntry


@UnstableApi
class MdtaMetadataEntry : Metadata.Entry


Stores extensible metadata with handler type 'mdta'. See also the QuickTime File Format Specification.

Summary

Constants

const Byte

The auxiliary tracks samples are interleaved in the primary video track’s mdat box.

const Byte

The auxiliary tracks samples are not interleaved and are in the axte.mdat box.

const Int

The default locale indicator which implies all speakers in all countries.

const String!
KEY_ANDROID_CAPTURE_FPS = "com.android.capture.fps"

Key for the capture frame rate (in frames per second).

const String!
KEY_AUXILIARY_TRACKS_INTERLEAVED = "auxiliary.tracks.interleaved"

Key for whether auxiliary tracks samples are interleaved.

const String!
KEY_AUXILIARY_TRACKS_LENGTH = "auxiliary.tracks.length"

Key for auxiliary tracks extension box (axte) length.

const String!
KEY_AUXILIARY_TRACKS_MAP = "auxiliary.tracks.map"

Key for auxiliary tracks map.

const String!
KEY_AUXILIARY_TRACKS_OFFSET = "auxiliary.tracks.offset"

Key for auxiliary tracks extension box (axte) offset.

const Int

The type indicator for an 8-bit unsigned integer.

const Int

The type indicator for Float32.

const Int

The type indicator for 32-bit signed integer.

const Int

The type indicator to use when no type needs to be indicated.

const Int

The type indicator for UTF-8 string.

const Int

The type indicator for 64-bit unsigned integer.

Public constructors

MdtaMetadataEntry(key: String!, value: ByteArray!, typeIndicator: Int)

Creates a new metadata entry for the specified metadata key/value with default locale indicator.

MdtaMetadataEntry(
    key: String!,
    value: ByteArray!,
    localeIndicator: Int,
    typeIndicator: Int
)

Creates a new metadata entry for the specified metadata key/value.

Public functions

Boolean
equals(obj: Any?)
(Mutable)List<Int!>!

Returns the auxiliary track types from the auxiliary tracks map metadata.

Int
String!

Public properties

String!

The metadata key name.

Int

The four byte locale indicator.

Int

The four byte type indicator.

ByteArray<Byte>!

The payload.

Inherited functions

From androidx.media3.common.Metadata.Entry
ByteArray<Byte>?

Returns the bytes of the wrapped metadata in this Entry, or null if it doesn't contain wrapped metadata.

Format?

Returns the Format that can be used to decode the wrapped metadata in getWrappedMetadataBytes, or null if this Entry doesn't contain wrapped metadata.

Unit

Updates the MediaMetadata.Builder with the type-specific values stored in this Entry.

Constants

AUXILIARY_TRACKS_SAMPLES_INTERLEAVED

const val AUXILIARY_TRACKS_SAMPLES_INTERLEAVED = 1: Byte

The auxiliary tracks samples are interleaved in the primary video track’s mdat box.

AUXILIARY_TRACKS_SAMPLES_NOT_INTERLEAVED

const val AUXILIARY_TRACKS_SAMPLES_NOT_INTERLEAVED = 0: Byte

The auxiliary tracks samples are not interleaved and are in the axte.mdat box.

DEFAULT_LOCALE_INDICATOR

const val DEFAULT_LOCALE_INDICATOR = 0: Int

The default locale indicator which implies all speakers in all countries.

KEY_ANDROID_CAPTURE_FPS

const val KEY_ANDROID_CAPTURE_FPS = "com.android.capture.fps": String!

Key for the capture frame rate (in frames per second).

KEY_AUXILIARY_TRACKS_INTERLEAVED

const val KEY_AUXILIARY_TRACKS_INTERLEAVED = "auxiliary.tracks.interleaved": String!

Key for whether auxiliary tracks samples are interleaved.

KEY_AUXILIARY_TRACKS_LENGTH

const val KEY_AUXILIARY_TRACKS_LENGTH = "auxiliary.tracks.length": String!

Key for auxiliary tracks extension box (axte) length.

KEY_AUXILIARY_TRACKS_MAP

const val KEY_AUXILIARY_TRACKS_MAP = "auxiliary.tracks.map": String!

Key for auxiliary tracks map.

KEY_AUXILIARY_TRACKS_OFFSET

const val KEY_AUXILIARY_TRACKS_OFFSET = "auxiliary.tracks.offset": String!

Key for auxiliary tracks extension box (axte) offset.

TYPE_INDICATOR_8_BIT_UNSIGNED_INT

const val TYPE_INDICATOR_8_BIT_UNSIGNED_INT = 75: Int

The type indicator for an 8-bit unsigned integer.

TYPE_INDICATOR_FLOAT32

const val TYPE_INDICATOR_FLOAT32 = 23: Int

The type indicator for Float32.

TYPE_INDICATOR_INT32

const val TYPE_INDICATOR_INT32 = 67: Int

The type indicator for 32-bit signed integer.

TYPE_INDICATOR_RESERVED

const val TYPE_INDICATOR_RESERVED = 0: Int

The type indicator to use when no type needs to be indicated.

TYPE_INDICATOR_STRING

const val TYPE_INDICATOR_STRING = 1: Int

The type indicator for UTF-8 string.

TYPE_INDICATOR_UNSIGNED_INT64

const val TYPE_INDICATOR_UNSIGNED_INT64 = 78: Int

The type indicator for 64-bit unsigned integer.

Public constructors

MdtaMetadataEntry

MdtaMetadataEntry(key: String!, value: ByteArray!, typeIndicator: Int)

Creates a new metadata entry for the specified metadata key/value with default locale indicator.

MdtaMetadataEntry

MdtaMetadataEntry(
    key: String!,
    value: ByteArray!,
    localeIndicator: Int,
    typeIndicator: Int
)

Creates a new metadata entry for the specified metadata key/value.

Public functions

equals

fun equals(obj: Any?): Boolean

getAuxiliaryTrackTypesFromMap

fun getAuxiliaryTrackTypesFromMap(): (Mutable)List<Int!>!

Returns the auxiliary track types from the auxiliary tracks map metadata.

hashCode

fun hashCode(): Int

toString

fun toString(): String!

Public properties

key

val keyString!

The metadata key name.

localeIndicator

val localeIndicatorInt

The four byte locale indicator.

typeIndicator

val typeIndicatorInt

The four byte type indicator.

value

val valueByteArray<Byte>!

The payload. The interpretation of the value depends on typeIndicator.