# IcyHeaders

Artifact: [androidx.media3:media3-extractor](https://developer.android.com/jetpack/androidx/releases/media3) [View Source](https://cs.android.com/search?q=file:androidx/media3/extractor/metadata/icy/IcyHeaders.java+class:androidx.media3.extractor.metadata.icy.IcyHeaders)

*** ** * ** ***


```
@UnstableApi
public final class IcyHeaders implements Metadata.Entry
```

<br />

*** ** * ** ***

ICY headers.

## Summary

| ### Constants |
|---|---|
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/media3/extractor/metadata/icy/IcyHeaders#REQUEST_HEADER_ENABLE_METADATA_NAME() = "Icy-MetaData"` |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/media3/extractor/metadata/icy/IcyHeaders#REQUEST_HEADER_ENABLE_METADATA_VALUE() = "1"` |

| ### Public fields |
|---|---|
| `final int` | `https://developer.android.com/reference/androidx/media3/extractor/metadata/icy/IcyHeaders#bitrate()` Bitrate in bits per second (`(icy-br * 1000)`), or `https://developer.android.com/reference/androidx/media3/common/Format#NO_VALUE()` if the header was not present. |
| `final @https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/media3/extractor/metadata/icy/IcyHeaders#genre()` The genre (`icy-genre`). |
| `final boolean` | `https://developer.android.com/reference/androidx/media3/extractor/metadata/icy/IcyHeaders#isPublic()` Whether the radio station is listed (`icy-pub`), or `false` if the header was not present. |
| `final int` | `https://developer.android.com/reference/androidx/media3/extractor/metadata/icy/IcyHeaders#metadataInterval()` The interval in bytes between metadata chunks (`icy-metaint`), or `https://developer.android.com/reference/androidx/media3/common/C#LENGTH_UNSET()` if the header was not present. |
| `final @https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/media3/extractor/metadata/icy/IcyHeaders#name()` The stream name (`icy-name`). |
| `final @https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/media3/extractor/metadata/icy/IcyHeaders#url()` The URL of the radio station (`icy-url`). |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/media3/extractor/metadata/icy/IcyHeaders#IcyHeaders(int,java.lang.String,java.lang.String,java.lang.String,boolean,int)( int bitrate, @https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/java/lang/String.html genre, @https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/java/lang/String.html name, @https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/java/lang/String.html url, boolean isPublic, int metadataInterval )` |

| ### Public methods |
|---|---|
| `boolean` | `https://developer.android.com/reference/androidx/media3/extractor/metadata/icy/IcyHeaders#equals(java.lang.Object)(@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/java/lang/Object.html obj)` |
| `int` | `https://developer.android.com/reference/androidx/media3/extractor/metadata/icy/IcyHeaders#hashCode()()` |
| `static @https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/androidx/media3/extractor/metadata/icy/IcyHeaders` | `https://developer.android.com/reference/androidx/media3/extractor/metadata/icy/IcyHeaders#parse(java.util.Map<java.lang.String,java.util.List<java.lang.String>>)(https://developer.android.com/reference/java/util/Map.html<https://developer.android.com/reference/java/lang/String.html, https://developer.android.com/reference/java/util/List.html<https://developer.android.com/reference/java/lang/String.html>> responseHeaders)` Parses `https://developer.android.com/reference/androidx/media3/extractor/metadata/icy/IcyHeaders` from response headers. |
| `void` | `https://developer.android.com/reference/androidx/media3/extractor/metadata/icy/IcyHeaders#populateMediaMetadata(androidx.media3.common.MediaMetadata.Builder)(https://developer.android.com/reference/androidx/media3/common/MediaMetadata.Builder builder)` Updates the `https://developer.android.com/reference/androidx/media3/common/MediaMetadata.Builder` with the type-specific values stored in this ` Entry`. |
| `https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/media3/extractor/metadata/icy/IcyHeaders#toString()()` |

| ### Inherited methods |
|---|
| From [androidx.media3.common.Metadata.Entry](https://developer.android.com/reference/androidx/media3/common/Metadata.Entry) |---|---| | `@https://developer.android.com/reference/androidx/annotation/Nullable byte[]` | `https://developer.android.com/reference/androidx/media3/common/Metadata.Entry#getWrappedMetadataBytes()()` Returns the bytes of the wrapped metadata in this Entry, or null if it doesn't contain wrapped metadata. | | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/androidx/media3/common/Format` | `https://developer.android.com/reference/androidx/media3/common/Metadata.Entry#getWrappedMetadataFormat()()` Returns the `https://developer.android.com/reference/androidx/media3/common/Format` that can be used to decode the wrapped metadata in `https://developer.android.com/reference/androidx/media3/common/Metadata.Entry#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 `https://developer.android.com/reference/androidx/media3/common/Format#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 `https://developer.android.com/reference/androidx/media3/common/C#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 `https://developer.android.com/reference/androidx/media3/extractor/metadata/icy/IcyHeaders#bitrate()`. |
| `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/java/lang/String.html genre` | See `https://developer.android.com/reference/androidx/media3/extractor/metadata/icy/IcyHeaders#genre()`. |
| `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/java/lang/String.html name` | See `https://developer.android.com/reference/androidx/media3/extractor/metadata/icy/IcyHeaders#name()`. |
| `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/java/lang/String.html url` | See `https://developer.android.com/reference/androidx/media3/extractor/metadata/icy/IcyHeaders#url()`. |
| `boolean isPublic` | See `https://developer.android.com/reference/androidx/media3/extractor/metadata/icy/IcyHeaders#isPublic()`. |
| `int metadataInterval` | See `https://developer.android.com/reference/androidx/media3/extractor/metadata/icy/IcyHeaders#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 `https://developer.android.com/reference/androidx/media3/extractor/metadata/icy/IcyHeaders` from response headers.

| Parameters |
|---|---|
| `https://developer.android.com/reference/java/util/Map.html<https://developer.android.com/reference/java/lang/String.html, https://developer.android.com/reference/java/util/List.html<https://developer.android.com/reference/java/lang/String.html>> responseHeaders` | The response headers. |

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/androidx/media3/extractor/metadata/icy/IcyHeaders` | The parsed `https://developer.android.com/reference/androidx/media3/extractor/metadata/icy/IcyHeaders`, or `null` if no ICY headers were present. |

### populateMediaMetadata

```
public void populateMediaMetadata(MediaMetadata.Builder builder)
```

Updates the `https://developer.android.com/reference/androidx/media3/common/MediaMetadata.Builder` with the type-specific values stored in this `
Entry`.

| Parameters |
|---|---|
| `https://developer.android.com/reference/androidx/media3/common/MediaMetadata.Builder builder` | The builder to be updated. |

### toString

```
public String toString()
```