Id3Peeker

Artifact: androidx.media3:media3-extractor

Kotlin |Java

@UnstableApi
class Id3Peeker

Peeks data from the beginning of an ExtractorInput to determine if there is any ID3 tag.

Summary

Public constructors
`Id3Peeker()`

Public functions
`Metadata?`	`@InlineMe(replacement = "this.peekId3Data(input, id3FramePredicate, /* maxTagPeekBytes= / 0)") peekId3Data( input: ExtractorInput!, id3FramePredicate: Id3Decoder.FramePredicate? )` This function is deprecated.* Use `peekId3Data` instead.
`Metadata?`	`peekId3Data( input: ExtractorInput!, id3FramePredicate: Id3Decoder.FramePredicate?, maxTagPeekBytes: Int )` Peeks ID3 data from the input and parses the first ID3 tag.

Public functions

Metadata?

@InlineMe(replacement = "this.peekId3Data(input, id3FramePredicate, /* maxTagPeekBytes= */ 0)")
peekId3Data(
    input: ExtractorInput!,
    id3FramePredicate: Id3Decoder.FramePredicate?
)

This function is deprecated.

Use peekId3Data instead.

Metadata?

peekId3Data(
    input: ExtractorInput!,
    id3FramePredicate: Id3Decoder.FramePredicate?,
    maxTagPeekBytes: Int
)

Peeks ID3 data from the input and parses the first ID3 tag.

Public constructors

Id3Peeker

Id3Peeker()

Public functions

peekId3Data

@InlineMe(replacement = "this.peekId3Data(input, id3FramePredicate, /* maxTagPeekBytes= */ 0)")
fun peekId3Data(
    input: ExtractorInput!,
    id3FramePredicate: Id3Decoder.FramePredicate?
): Metadata?

Throws
`java.io.IOException`

peekId3Data

fun peekId3Data(
    input: ExtractorInput!,
    id3FramePredicate: Id3Decoder.FramePredicate?,
    maxTagPeekBytes: Int
): Metadata?

Peeks ID3 data from the input and parses the first ID3 tag.

Parameters
`input: ExtractorInput!`	The `ExtractorInput` from which data should be peeked.
`id3FramePredicate: Id3Decoder.FramePredicate?`	Determines which ID3 frames are decoded. May be null to decode all frames.
`maxTagPeekBytes: Int`	The maximum number of bytes to peek when searching for each ID3 tag before giving up.

Returns
`Metadata?`	The first ID3 tag decoded into a `Metadata` object. May be null if ID3 tag is not present in the input.

Throws
`java.io.IOException`	If an error occurred peeking from the input.