PictureFrame

Artifact: androidx.media3:media3-extractor

Kotlin |Java

@UnstableApi
class PictureFrame : Metadata.Entry

A picture parsed from a Vorbis Comment or a FLAC picture block.

Summary

Constants
`const Parcelable.Creator<PictureFrame!>!`	`CREATOR`

Public constructors
`PictureFrame( pictureType: Int, mimeType: String!, description: String!, width: Int, height: Int, depth: Int, colors: Int, pictureData: ByteArray! )`

Public functions
`Int`	`describeContents()`
`Boolean`	`equals(obj: Any?)`
`java-static PictureFrame!`	`fromPictureBlock(pictureBlock: ParsableByteArray!)` Parses a `METADATA_BLOCK_PICTURE` into a `PictureFrame` instance.
`Int`	`hashCode()`
`Unit`	`populateMediaMetadata(builder: MediaMetadata.Builder!)` Updates the `MediaMetadata.Builder` with the type-specific values stored in this `Entry`.
`String!`	`toString()`
`Unit`	`writeToParcel(dest: Parcel!, flags: Int)`

Public properties
`Int`	`colors` For indexed-color pictures (e.g. GIF), the number of colors used.
`Int`	`depth` The color depth of the picture in bits-per-pixel.
`String!`	`description` A description of the picture.
`Int`	`height` The height of the picture in pixels.
`String!`	`mimeType` The MIME type of the picture.
`ByteArray<Byte>!`	`pictureData` The encoded picture data.
`Int`	`pictureType` The type of the picture.
`Int`	`width` The width of the picture in pixels.

Inherited Constants

From android.os.Parcelable

`const Int`	`CONTENTS_FILE_DESCRIPTOR = 1`
`const Int`	`PARCELABLE_WRITE_RETURN_VALUE = 1`

Inherited functions

From androidx.media3.common.Metadata.Entry

`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.

Constants

CREATOR

const val CREATOR: Parcelable.Creator<PictureFrame!>!

Public constructors

PictureFrame

PictureFrame(
    pictureType: Int,
    mimeType: String!,
    description: String!,
    width: Int,
    height: Int,
    depth: Int,
    colors: Int,
    pictureData: ByteArray!
)

Public functions

describeContents

fun describeContents(): Int

equals

fun equals(obj: Any?): Boolean

fromPictureBlock

java-static fun fromPictureBlock(pictureBlock: ParsableByteArray!): PictureFrame!

Parses a METADATA_BLOCK_PICTURE into a PictureFrame instance.

pictureBlock may be read directly from a FLAC file, or decoded from the base64 content of a Vorbis Comment.

Parameters
`pictureBlock: ParsableByteArray!`	The data of the `METADATA_BLOCK_PICTURE`, not including any headers.

Returns
`PictureFrame!`	A `PictureFrame` parsed from `pictureBlock`.

hashCode

fun hashCode(): Int

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.

toString

fun toString(): String!

writeToParcel

fun writeToParcel(dest: Parcel!, flags: Int): Unit

Public properties

colors

val colors: Int

For indexed-color pictures (e.g. GIF), the number of colors used. 0 otherwise.

depth

val depth: Int

The color depth of the picture in bits-per-pixel.

description

val description: String!

A description of the picture.

height

val height: Int

The height of the picture in pixels.

mimeType

val mimeType: String!

The MIME type of the picture.

pictureData

val pictureData: ByteArray<Byte>!

The encoded picture data.

pictureType

val pictureType: Int

The type of the picture.

width

val width: Int

The width of the picture in pixels.