# Channel

Artifact: [androidx.tvprovider:tvprovider](https://developer.android.com/jetpack/androidx/releases/tvprovider) [View Source](https://cs.android.com/search?q=file:androidx/tvprovider/media/tv/Channel.java+class:androidx.tvprovider.media.tv.Channel) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/tvprovider#1.1.0)

*** ** * ** ***


```
public final class Channel
```

<br />

*** ** * ** ***

A convenience class to access `https://developer.android.com/reference/androidx/tvprovider/media/tv/TvContractCompat.Channels` entries in the system content provider.

This class makes it easy to insert or retrieve a channel from the system content provider, which is defined in `https://developer.android.com/reference/androidx/tvprovider/media/tv/TvContractCompat`.

Usage example when inserting a channel:

```
Channel channel = new Channel.Builder()
        .setDisplayName("Channel Name")
        .setDescription("Channel description")
        .setType(Channels.TYPE_PREVIEW)
        // Set more attributes...
        .build();
Uri channelUri = getContentResolver().insert(Channels.CONTENT_URI, channel.toContentValues());
```

Usage example when retrieving a channel:

```
Channel channel;
try (Cursor cursor = resolver.query(channelUri, null, null, null, null)) {
    if (cursor != null && cursor.getCount() != 0) {
        cursor.moveToNext();
        channel = Channel.fromCursor(cursor);
    }
}
```

Usage example when updating an existing channel:

```
Channel updatedChannel = new Channel.Builder(channel)
        .setDescription("New channel description")
        .build();
getContentResolver().update(TvContractCompat.buildChannelUri(updatedChannel.getId()),
        updatedChannel.toContentValues(), null, null);
```

Usage example when deleting a channel:

```
getContentResolver().delete(
        TvContractCompat.buildChannelUri(existingChannel.getId()), null, null);
```

## Summary

| ### Nested types |
|---|
| `public final class https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel.Builder` The builder class that makes it easy to chain setters to create a `https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel` object. |

| ### Public methods |
|---|---|
| `boolean` | `https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object.html other)` |
| `static https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel` | `https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel#fromCursor(android.database.Cursor)(https://developer.android.com/reference/android/database/Cursor.html cursor)` Creates a Channel object from a cursor including the fields defined in `https://developer.android.com/reference/androidx/tvprovider/media/tv/TvContractCompat.Channels`. |
| `int` | `https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel#getAppLinkColor()()` |
| `https://developer.android.com/reference/android/net/Uri.html` | `https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel#getAppLinkIconUri()()` |
| `https://developer.android.com/reference/android/content/Intent.html` | `https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel#getAppLinkIntent()()` |
| `https://developer.android.com/reference/android/net/Uri.html` | `https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel#getAppLinkIntentUri()()` |
| `https://developer.android.com/reference/android/net/Uri.html` | `https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel#getAppLinkPosterArtUri()()` |
| `https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel#getAppLinkText()()` |
| `int` | `https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel#getConfigurationDisplayOrder()()` |
| `https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel#getDescription()()` |
| `https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel#getDisplayName()()` |
| `https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel#getDisplayNumber()()` |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel#getGlobalContentId()()` |
| `long` | `https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel#getId()()` |
| `https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel#getInputId()()` |
| `byte[]` | `https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel#getInternalProviderDataByteArray()()` |
| `https://developer.android.com/reference/java/lang/Long.html` | `https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel#getInternalProviderFlag1()()` |
| `https://developer.android.com/reference/java/lang/Long.html` | `https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel#getInternalProviderFlag2()()` |
| `https://developer.android.com/reference/java/lang/Long.html` | `https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel#getInternalProviderFlag3()()` |
| `https://developer.android.com/reference/java/lang/Long.html` | `https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel#getInternalProviderFlag4()()` |
| `https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel#getInternalProviderId()()` |
| `https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel#getNetworkAffiliation()()` |
| `int` | `https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel#getOriginalNetworkId()()` |
| `https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel#getPackageName()()` |
| `int` | `https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel#getServiceId()()` |
| `https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel#getServiceType()()` |
| `https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel#getSystemChannelKey()()` |
| `int` | `https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel#getTransportStreamId()()` |
| `https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel#getType()()` |
| `https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel#getVideoFormat()()` |
| `int` | `https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel#hashCode()()` |
| `boolean` | `https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel#isBrowsable()()` |
| `boolean` | `https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel#isLocked()()` |
| `boolean` | `https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel#isSearchable()()` |
| `boolean` | `https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel#isTransient()()` |
| `https://developer.android.com/reference/android/content/ContentValues.html` | `https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel#toContentValues()()` |
| `https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel#toString()()` |

## Public methods

### equals

```
public boolean equals(Object other)
```

### fromCursor

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/tvprovider#1.1.0)

```
public static Channel fromCursor(Cursor cursor)
```

Creates a Channel object from a cursor including the fields defined in `https://developer.android.com/reference/androidx/tvprovider/media/tv/TvContractCompat.Channels`.

| Parameters |
|---|---|
| `https://developer.android.com/reference/android/database/Cursor.html cursor` | A row from the TV Input Framework database. |

| Returns |
|---|---|
| `https://developer.android.com/reference/androidx/tvprovider/media/tv/Channel` | A channel with the values taken from the cursor. |

### getAppLinkColor

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/tvprovider#1.1.0)

```
public int getAppLinkColor()
```

| Returns |
|---|---|
| `int` | The value of `https://developer.android.com/reference/androidx/tvprovider/media/tv/TvContractCompat.Channels#COLUMN_APP_LINK_COLOR()` for the channel. |

### getAppLinkIconUri

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/tvprovider#1.1.0)

```
public Uri getAppLinkIconUri()
```

| Returns |
|---|---|
| `https://developer.android.com/reference/android/net/Uri.html` | The value of `https://developer.android.com/reference/androidx/tvprovider/media/tv/TvContractCompat.Channels#COLUMN_APP_LINK_ICON_URI()` for the channel. |

### getAppLinkIntent

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/tvprovider#1.1.0)

```
public Intent getAppLinkIntent()
```

| Returns |
|---|---|
| `https://developer.android.com/reference/android/content/Intent.html` | The value of `https://developer.android.com/reference/androidx/tvprovider/media/tv/TvContractCompat.Channels#COLUMN_APP_LINK_INTENT_URI()` for the program. |

| Throws |
|---|---|
| `https://developer.android.com/reference/java/net/URISyntaxException.html` |   |

### getAppLinkIntentUri

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/tvprovider#1.1.0)

```
public Uri getAppLinkIntentUri()
```

| Returns |
|---|---|
| `https://developer.android.com/reference/android/net/Uri.html` | The value of `https://developer.android.com/reference/androidx/tvprovider/media/tv/TvContractCompat.Channels#COLUMN_APP_LINK_INTENT_URI()` for the channel. |

### getAppLinkPosterArtUri

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/tvprovider#1.1.0)

```
public Uri getAppLinkPosterArtUri()
```

| Returns |
|---|---|
| `https://developer.android.com/reference/android/net/Uri.html` | The value of `https://developer.android.com/reference/androidx/tvprovider/media/tv/TvContractCompat.Channels#COLUMN_APP_LINK_POSTER_ART_URI()` for the channel. |

### getAppLinkText

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/tvprovider#1.1.0)

```
public String getAppLinkText()
```

| Returns |
|---|---|
| `https://developer.android.com/reference/java/lang/String.html` | The value of `https://developer.android.com/reference/androidx/tvprovider/media/tv/TvContractCompat.Channels#COLUMN_APP_LINK_TEXT()` for the channel. |

### getConfigurationDisplayOrder

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/tvprovider#1.1.0)

```
public int getConfigurationDisplayOrder()
```

| Returns |
|---|---|
| `int` | The value of `https://developer.android.com/reference/androidx/tvprovider/media/tv/TvContractCompat.Channels#COLUMN_CONFIGURATION_DISPLAY_ORDER()` for the channel. |

### getDescription

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/tvprovider#1.1.0)

```
public String getDescription()
```

| Returns |
|---|---|
| `https://developer.android.com/reference/java/lang/String.html` | The value of `https://developer.android.com/reference/androidx/tvprovider/media/tv/TvContractCompat.Channels#COLUMN_DESCRIPTION()` for the channel. |

### getDisplayName

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/tvprovider#1.1.0)

```
public String getDisplayName()
```

| Returns |
|---|---|
| `https://developer.android.com/reference/java/lang/String.html` | The value of `https://developer.android.com/reference/androidx/tvprovider/media/tv/TvContractCompat.Channels#COLUMN_DISPLAY_NAME()` for the channel. |

### getDisplayNumber

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/tvprovider#1.1.0)

```
public String getDisplayNumber()
```

| Returns |
|---|---|
| `https://developer.android.com/reference/java/lang/String.html` | The value of `https://developer.android.com/reference/androidx/tvprovider/media/tv/TvContractCompat.Channels#COLUMN_DISPLAY_NUMBER()` for the channel. |

### getGlobalContentId

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/tvprovider#1.1.0)

```
public @Nullable String getGlobalContentId()
```

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/java/lang/String.html` | The value of `https://developer.android.com/reference/androidx/tvprovider/media/tv/TvContractCompat.Channels#COLUMN_GLOBAL_CONTENT_ID()` for the channel. |

### getId

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/tvprovider#1.1.0)

```
public long getId()
```

| Returns |
|---|---|
| `long` | The value of `https://developer.android.com/reference/android/provider/BaseColumns.html#_ID` for the channel. |

### getInputId

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/tvprovider#1.1.0)

```
public String getInputId()
```

| Returns |
|---|---|
| `https://developer.android.com/reference/java/lang/String.html` | The value of `https://developer.android.com/reference/androidx/tvprovider/media/tv/TvContractCompat.Channels#COLUMN_INPUT_ID()` for the channel. |

### getInternalProviderDataByteArray

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/tvprovider#1.1.0)

```
public byte[] getInternalProviderDataByteArray()
```

| Returns |
|---|---|
| `byte[]` | The value of `https://developer.android.com/reference/androidx/tvprovider/media/tv/TvContractCompat.Channels#COLUMN_INTERNAL_PROVIDER_DATA()` for the channel. |

### getInternalProviderFlag1

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/tvprovider#1.1.0)

```
public Long getInternalProviderFlag1()
```

| Returns |
|---|---|
| `https://developer.android.com/reference/java/lang/Long.html` | The value of `https://developer.android.com/reference/androidx/tvprovider/media/tv/TvContractCompat.Channels#COLUMN_INTERNAL_PROVIDER_FLAG1()` for the channel. |

### getInternalProviderFlag2

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/tvprovider#1.1.0)

```
public Long getInternalProviderFlag2()
```

| Returns |
|---|---|
| `https://developer.android.com/reference/java/lang/Long.html` | The value of `https://developer.android.com/reference/androidx/tvprovider/media/tv/TvContractCompat.Channels#COLUMN_INTERNAL_PROVIDER_FLAG2()` for the channel. |

### getInternalProviderFlag3

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/tvprovider#1.1.0)

```
public Long getInternalProviderFlag3()
```

| Returns |
|---|---|
| `https://developer.android.com/reference/java/lang/Long.html` | The value of `https://developer.android.com/reference/androidx/tvprovider/media/tv/TvContractCompat.Channels#COLUMN_INTERNAL_PROVIDER_FLAG3()` for the channel. |

### getInternalProviderFlag4

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/tvprovider#1.1.0)

```
public Long getInternalProviderFlag4()
```

| Returns |
|---|---|
| `https://developer.android.com/reference/java/lang/Long.html` | The value of `https://developer.android.com/reference/androidx/tvprovider/media/tv/TvContractCompat.Channels#COLUMN_INTERNAL_PROVIDER_FLAG4()` for the channel. |

### getInternalProviderId

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/tvprovider#1.1.0)

```
public String getInternalProviderId()
```

| Returns |
|---|---|
| `https://developer.android.com/reference/java/lang/String.html` | The value of `https://developer.android.com/reference/androidx/tvprovider/media/tv/TvContractCompat.Channels#COLUMN_INTERNAL_PROVIDER_ID()` for the channel. |

### getNetworkAffiliation

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/tvprovider#1.1.0)

```
public String getNetworkAffiliation()
```

| Returns |
|---|---|
| `https://developer.android.com/reference/java/lang/String.html` | The value of `https://developer.android.com/reference/androidx/tvprovider/media/tv/TvContractCompat.Channels#COLUMN_NETWORK_AFFILIATION()` for the channel. |

### getOriginalNetworkId

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/tvprovider#1.1.0)

```
public int getOriginalNetworkId()
```

| Returns |
|---|---|
| `int` | The value of `https://developer.android.com/reference/androidx/tvprovider/media/tv/TvContractCompat.Channels#COLUMN_ORIGINAL_NETWORK_ID()` for the channel. |

### getPackageName

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/tvprovider#1.1.0)

```
public String getPackageName()
```

| Returns |
|---|---|
| `https://developer.android.com/reference/java/lang/String.html` | The value of `https://developer.android.com/reference/androidx/tvprovider/media/tv/TvContractCompat.BaseTvColumns#COLUMN_PACKAGE_NAME()` for the channel. |

### getServiceId

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/tvprovider#1.1.0)

```
public int getServiceId()
```

| Returns |
|---|---|
| `int` | The value of `https://developer.android.com/reference/androidx/tvprovider/media/tv/TvContractCompat.Channels#COLUMN_SERVICE_ID()` for the channel. |

### getServiceType

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/tvprovider#1.1.0)

```
public String getServiceType()
```

| Returns |
|---|---|
| `https://developer.android.com/reference/java/lang/String.html` | The value of `https://developer.android.com/reference/androidx/tvprovider/media/tv/TvContractCompat.Channels#COLUMN_SERVICE_TYPE()` for the channel. Returns `https://developer.android.com/reference/androidx/tvprovider/media/tv/TvContractCompat.Channels#SERVICE_TYPE_AUDIO()`, `https://developer.android.com/reference/androidx/tvprovider/media/tv/TvContractCompat.Channels#SERVICE_TYPE_AUDIO_VIDEO()`, or `https://developer.android.com/reference/androidx/tvprovider/media/tv/TvContractCompat.Channels#SERVICE_TYPE_OTHER()`. |

### getSystemChannelKey

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/tvprovider#1.1.0)

```
public String getSystemChannelKey()
```

| Returns |
|---|---|
| `https://developer.android.com/reference/java/lang/String.html` | The value of `https://developer.android.com/reference/androidx/tvprovider/media/tv/TvContractCompat.Channels#COLUMN_SYSTEM_CHANNEL_KEY()` for the channel. |

### getTransportStreamId

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/tvprovider#1.1.0)

```
public int getTransportStreamId()
```

| Returns |
|---|---|
| `int` | The value of `https://developer.android.com/reference/androidx/tvprovider/media/tv/TvContractCompat.Channels#COLUMN_TRANSPORT_STREAM_ID()` for the channel. |

### getType

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/tvprovider#1.1.0)

```
public String getType()
```

| Returns |
|---|---|
| `https://developer.android.com/reference/java/lang/String.html` | The value of `https://developer.android.com/reference/androidx/tvprovider/media/tv/TvContractCompat.Channels#COLUMN_TYPE()` for the channel. |

### getVideoFormat

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/tvprovider#1.1.0)

```
public String getVideoFormat()
```

| Returns |
|---|---|
| `https://developer.android.com/reference/java/lang/String.html` | The value of `https://developer.android.com/reference/androidx/tvprovider/media/tv/TvContractCompat.Channels#COLUMN_VIDEO_FORMAT()` for the channel. |

### hashCode

```
public int hashCode()
```

### isBrowsable

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/tvprovider#1.1.0)

```
public boolean isBrowsable()
```

| Returns |
|---|---|
| `boolean` | The value of `https://developer.android.com/reference/androidx/tvprovider/media/tv/TvContractCompat.Channels#COLUMN_BROWSABLE()` for the channel. |

### isLocked

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/tvprovider#1.1.0)

```
public boolean isLocked()
```

| Returns |
|---|---|
| `boolean` | The value of `https://developer.android.com/reference/androidx/tvprovider/media/tv/TvContractCompat.Channels#COLUMN_LOCKED()` for the channel. |

### isSearchable

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/tvprovider#1.1.0)

```
public boolean isSearchable()
```

| Returns |
|---|---|
| `boolean` | The value of `https://developer.android.com/reference/androidx/tvprovider/media/tv/TvContractCompat.Channels#COLUMN_SEARCHABLE()` for the channel. |

### isTransient

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/tvprovider#1.1.0)

```
public boolean isTransient()
```

| Returns |
|---|---|
| `boolean` | The value of `https://developer.android.com/reference/androidx/tvprovider/media/tv/TvContractCompat.Channels#COLUMN_TRANSIENT()` for the channel. |

### toContentValues

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/tvprovider#1.1.0)

```
public ContentValues toContentValues()
```

| Returns |
|---|---|
| `https://developer.android.com/reference/android/content/ContentValues.html` | The fields of the Channel in the ContentValues format to be easily inserted into the TV Input Framework database. |

### toString

```
public String toString()
```