Metadata.Entry

Artifact: androidx.media3:media3-common

View Source

---

Kotlin |Java

interface Metadata.Entry : Parcelable

Known direct subclasses

AppInfoTable, EventMessage, FakeMetadataEntry, HlsTrackMetadataEntry, IcyHeaders, IcyInfo, Id3Frame, MdtaMetadataEntry, MotionPhotoMetadata, Mp4LocationData, Mp4OrientationData, Mp4TimestampData, PictureFrame, SlowMotionData, SmtaMetadataEntry, SpliceCommand, VorbisComment, XmpData

AppInfoTable	A representation of a DVB Application Information Table (AIT).
EventMessage	An Event Message (emsg) as defined in ISO 23009-1.
FakeMetadataEntry	A fake Metadata.Entry.
HlsTrackMetadataEntry	Holds metadata associated to an HLS media track.
IcyHeaders	ICY headers.
IcyInfo	ICY in-stream information.
Id3Frame	Base class for ID3 frames.
MdtaMetadataEntry	Stores extensible metadata with handler type 'mdta'.
MotionPhotoMetadata	Metadata of a motion photo file.
Mp4LocationData	Stores MP4 location data.
Mp4OrientationData	Stores the orientation hint for the video playback.
Mp4TimestampData	Stores MP4 timestamp data.
PictureFrame	A picture parsed from a Vorbis Comment or a FLAC picture block.
SlowMotionData	Holds information about the segments of slow motion playback within a track.
SmtaMetadataEntry	Stores metadata from the Samsung smta box.
SpliceCommand	Superclass for SCTE35 splice commands.
VorbisComment	This class is deprecated. Use androidx.media3.extractor.metadata.vorbis.VorbisComment instead.
XmpData	Stores XMP data.

Known indirect subclasses

ApicFrame, BinaryFrame, ChapterFrame, ChapterTocFrame, CommentFrame, GeobFrame, InternalFrame, MlltFrame, PrivFrame, PrivateCommand, SpliceInsertCommand, SpliceNullCommand, SpliceScheduleCommand, TextInformationFrame, TimeSignalCommand, UrlLinkFrame, VorbisComment

ApicFrame	APIC (Attached Picture) ID3 frame.
BinaryFrame	Binary ID3 frame.
ChapterFrame	Chapter information ID3 frame.
ChapterTocFrame	Chapter table of contents ID3 frame.
CommentFrame	Comment ID3 frame.
GeobFrame	GEOB (General Encapsulated Object) ID3 frame.
InternalFrame	Internal ID3 frame that is intended for use by the player.
MlltFrame	MPEG location lookup table frame.
PrivFrame	PRIV (Private) ID3 frame.
PrivateCommand	Represents a private command as defined in SCTE35, Section 9.3.6.
SpliceInsertCommand	Represents a splice insert command defined in SCTE35, Section 9.3.3.
SpliceNullCommand	Represents a splice null command as defined in SCTE35, Section 9.3.1.
SpliceScheduleCommand	Represents a splice schedule command as defined in SCTE35, Section 9.3.2.
TextInformationFrame	Text information ID3 frame.
TimeSignalCommand	Represents a time signal command as defined in SCTE35, Section 9.3.4.
UrlLinkFrame	Url link ID3 frame.
VorbisComment	A vorbis comment, extracted from a FLAC or Ogg file.

---

A metadata entry.

Summary

Public functions
ByteArray<Byte>?	getWrappedMetadataBytes() Returns the bytes of the wrapped metadata in this Entry, or null if it doesn't contain wrapped metadata.
Format?	getWrappedMetadataFormat() 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	populateMediaMetadata(builder: MediaMetadata.Builder!) Updates the MediaMetadata.Builder with the type-specific values stored in this Entry.

Inherited Constants
From android.os.Parcelable const Int CONTENTS_FILE_DESCRIPTOR = 1 const Int PARCELABLE_WRITE_RETURN_VALUE = 1

Inherited functions
From android.os.Parcelable Int describeContents() Unit writeToParcel(p: Parcel!, p1: Int)

Public functions

getWrappedMetadataBytes

fun getWrappedMetadataBytes(): ByteArray<Byte>?

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

getWrappedMetadataFormat

fun getWrappedMetadataFormat(): 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.

populateMediaMetadata

fun populateMediaMetadata(builder: MediaMetadata.Builder!): Unit

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

Parameters
builder: MediaMetadata.Builder!	The builder to be updated.