MpegAudioUtil.Header | API reference

Artifact: androidx.media3:media3-extractor

Kotlin |Java

class MpegAudioUtil.Header

Stores the metadata for an MPEG audio frame.

Summary

Public constructors
`Header()` Constructs an empty instance.
`Header(header: MpegAudioUtil.Header!)` Constructs an instance with values from `header`.

Public functions
`Boolean`	`setForHeaderData(headerData: Int)` Populates the fields in this instance to reflect the MPEG audio header in `headerData`, returning whether the header was valid.

Public properties
`Int`	`bitrate` Bitrate of the frame in bit/s.
`Int`	`channels` Number of audio channels in the frame.
`Int`	`frameSize` Size of the frame associated with this header, in bytes.
`String?`	`mimeType` The MIME type.
`Int`	`sampleRate` Sample rate in samples per second.
`Int`	`samplesPerFrame` Number of samples stored in the frame.
`Int`	`version` MPEG audio header version.

Public constructors

Header()

Constructs an empty instance.

Header(header: MpegAudioUtil.Header!)

Constructs an instance with values from header.

Public functions

setForHeaderData

fun setForHeaderData(headerData: Int): Boolean

Populates the fields in this instance to reflect the MPEG audio header in headerData, returning whether the header was valid. If false, the values of the fields in this instance will not be updated.

Parameters
`headerData: Int`	Header data to parse.

Returns
`Boolean`	True if the fields were populated. False otherwise, indicating that `headerData` is not a valid MPEG audio header.

Public properties

bitrate

val bitrate: Int

Bitrate of the frame in bit/s.

channels

val channels: Int

Number of audio channels in the frame.

frameSize

val frameSize: Int

Size of the frame associated with this header, in bytes.

mimeType

val mimeType: String?

The MIME type.

sampleRate

val sampleRate: Int

Sample rate in samples per second.

samplesPerFrame

val samplesPerFrame: Int

Number of samples stored in the frame.

version

val version: Int

MPEG audio header version.