IcyHeaders

Artifact: androidx.media3:media3-extractor

Kotlin |Java

@UnstableApi
public final class IcyHeaders implements Metadata.Entry

ICY headers.

Summary

Constants
`static final String`	`REQUEST_HEADER_ENABLE_METADATA_NAME = "Icy-MetaData"`
`static final String`	`REQUEST_HEADER_ENABLE_METADATA_VALUE = "1"`

Public fields
`final int`	`bitrate` Bitrate in bits per second (`(icy-br * 1000)`), or `NO_VALUE` if the header was not present.
`final @Nullable String`	`genre` The genre (`icy-genre`).
`final boolean`	`isPublic` Whether the radio station is listed (`icy-pub`), or `false` if the header was not present.
`final int`	`metadataInterval` The interval in bytes between metadata chunks (`icy-metaint`), or `LENGTH_UNSET` if the header was not present.
`final @Nullable String`	`name` The stream name (`icy-name`).
`final @Nullable String`	`url` The URL of the radio station (`icy-url`).

Public constructors
`IcyHeaders( int bitrate, @Nullable String genre, @Nullable String name, @Nullable String url, boolean isPublic, int metadataInterval )`

Public methods
`boolean`	`equals(@Nullable Object obj)`
`int`	`hashCode()`
`static @Nullable IcyHeaders`	`parse(Map<String, List<String>> responseHeaders)` Parses `IcyHeaders` from response headers.
`void`	`populateMediaMetadata(MediaMetadata.Builder builder)` Updates the `MediaMetadata.Builder` with the type-specific values stored in this `Entry`.
`String`	`toString()`

Inherited methods

From androidx.media3.common.Metadata.Entry

`@Nullable byte[]`	`getWrappedMetadataBytes()` Returns the bytes of the wrapped metadata in this Entry, or null if it doesn't contain wrapped metadata.
`@Nullable 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

REQUEST_HEADER_ENABLE_METADATA_NAME

public static final String REQUEST_HEADER_ENABLE_METADATA_NAME = "Icy-MetaData"

REQUEST_HEADER_ENABLE_METADATA_VALUE

public static final String REQUEST_HEADER_ENABLE_METADATA_VALUE = "1"

Public fields

bitrate

public final int bitrate

Bitrate in bits per second ((icy-br * 1000)), or NO_VALUE if the header was not present.

genre

public final @Nullable String genre

The genre (icy-genre).

isPublic

public final boolean isPublic

Whether the radio station is listed (icy-pub), or false if the header was not present.

metadataInterval

public final int metadataInterval

The interval in bytes between metadata chunks (icy-metaint), or LENGTH_UNSET if the header was not present.

name

public final @Nullable String name

The stream name (icy-name).

url

public final @Nullable String url

The URL of the radio station (icy-url).

Public constructors

IcyHeaders

public IcyHeaders(
    int bitrate,
    @Nullable String genre,
    @Nullable String name,
    @Nullable String url,
    boolean isPublic,
    int metadataInterval
)

Parameters
`int bitrate`	See `bitrate`.
`@Nullable String genre`	See `genre`.
`@Nullable String name`	See `See`.
`@Nullable String url`	See `url`.
`boolean isPublic`	See `isPublic`.
`int metadataInterval`	See `metadataInterval`.

Public methods

equals

public boolean equals(@Nullable Object obj)

hashCode

public int hashCode()

parse

public static @Nullable IcyHeaders parse(Map<String, List<String>> responseHeaders)

Parses IcyHeaders from response headers.

Parameters
`Map<String, List<String>> responseHeaders`	The response headers.

Returns
`@Nullable IcyHeaders`	The parsed `IcyHeaders`, or `null` if no ICY headers were present.

populateMediaMetadata

public void populateMediaMetadata(MediaMetadata.Builder builder)

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

Parameters
`MediaMetadata.Builder builder`	The builder to be updated.

toString

public String toString()