Channel

Artifact: androidx.tvprovider:tvprovider

Kotlin |Java

public final class Channel

A convenience class to access 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 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 Channel.Builder` The builder class that makes it easy to chain setters to create a `Channel` object.

Public methods
`boolean`	`equals(Object other)`
`static Channel`	`fromCursor(Cursor cursor)` Creates a Channel object from a cursor including the fields defined in `Channels`.
`int`	`getAppLinkColor()`
`Uri`	`getAppLinkIconUri()`
`Intent`	`getAppLinkIntent()`
`Uri`	`getAppLinkIntentUri()`
`Uri`	`getAppLinkPosterArtUri()`
`String`	`getAppLinkText()`
`int`	`getConfigurationDisplayOrder()`
`String`	`getDescription()`
`String`	`getDisplayName()`
`String`	`getDisplayNumber()`
`@Nullable String`	`getGlobalContentId()`
`long`	`getId()`
`String`	`getInputId()`
`byte[]`	`getInternalProviderDataByteArray()`
`Long`	`getInternalProviderFlag1()`
`Long`	`getInternalProviderFlag2()`
`Long`	`getInternalProviderFlag3()`
`Long`	`getInternalProviderFlag4()`
`String`	`getInternalProviderId()`
`String`	`getNetworkAffiliation()`
`int`	`getOriginalNetworkId()`
`String`	`getPackageName()`
`int`	`getServiceId()`
`String`	`getServiceType()`
`String`	`getSystemChannelKey()`
`int`	`getTransportStreamId()`
`String`	`getType()`
`String`	`getVideoFormat()`
`int`	`hashCode()`
`boolean`	`isBrowsable()`
`boolean`	`isLocked()`
`boolean`	`isSearchable()`
`boolean`	`isTransient()`
`ContentValues`	`toContentValues()`
`String`	`toString()`

Public methods

equals

public boolean equals(Object other)

fromCursor

Added in 1.1.0-alpha02

public static Channel fromCursor(Cursor cursor)

Creates a Channel object from a cursor including the fields defined in Channels.

Parameters
`Cursor cursor`	A row from the TV Input Framework database.

Returns
`Channel`	A channel with the values taken from the cursor.

getAppLinkColor

Added in 1.1.0-alpha02

public int getAppLinkColor()

Returns
`int`	The value of `COLUMN_APP_LINK_COLOR` for the channel.

getAppLinkIconUri

Added in 1.1.0-alpha02

public Uri getAppLinkIconUri()

Returns
`Uri`	The value of `COLUMN_APP_LINK_ICON_URI` for the channel.

getAppLinkIntent

Added in 1.1.0-alpha02

public Intent getAppLinkIntent()

Returns
`Intent`	The value of `COLUMN_APP_LINK_INTENT_URI` for the program.

Throws
`java.net.URISyntaxException`

getAppLinkIntentUri

Added in 1.1.0-alpha02

public Uri getAppLinkIntentUri()

Returns
`Uri`	The value of `COLUMN_APP_LINK_INTENT_URI` for the channel.

getAppLinkPosterArtUri

Added in 1.1.0-alpha02

public Uri getAppLinkPosterArtUri()

Returns
`Uri`	The value of `COLUMN_APP_LINK_POSTER_ART_URI` for the channel.

getAppLinkText

Added in 1.1.0-alpha02

public String getAppLinkText()

Returns
`String`	The value of `COLUMN_APP_LINK_TEXT` for the channel.

getConfigurationDisplayOrder

Added in 1.1.0-alpha02

public int getConfigurationDisplayOrder()

Returns
`int`	The value of `COLUMN_CONFIGURATION_DISPLAY_ORDER` for the channel.

getDescription

Added in 1.1.0-alpha02

public String getDescription()

Returns
`String`	The value of `COLUMN_DESCRIPTION` for the channel.

getDisplayName

Added in 1.1.0-alpha02

public String getDisplayName()

Returns
`String`	The value of `COLUMN_DISPLAY_NAME` for the channel.

getDisplayNumber

Added in 1.1.0-alpha02

public String getDisplayNumber()

Returns
`String`	The value of `COLUMN_DISPLAY_NUMBER` for the channel.

getGlobalContentId

Added in 1.1.0-alpha02

public @Nullable String getGlobalContentId()

Returns
`@Nullable String`	The value of `COLUMN_GLOBAL_CONTENT_ID` for the channel.

getId

Added in 1.1.0-alpha02

public long getId()

Returns
`long`	The value of `_ID` for the channel.

getInputId

Added in 1.1.0-alpha02

public String getInputId()

Returns
`String`	The value of `COLUMN_INPUT_ID` for the channel.

getInternalProviderDataByteArray

Added in 1.1.0-alpha02

public byte[] getInternalProviderDataByteArray()

Returns
`byte[]`	The value of `COLUMN_INTERNAL_PROVIDER_DATA` for the channel.

getInternalProviderFlag1

Added in 1.1.0-alpha02

public Long getInternalProviderFlag1()

Returns
`Long`	The value of `COLUMN_INTERNAL_PROVIDER_FLAG1` for the channel.

getInternalProviderFlag2

Added in 1.1.0-alpha02

public Long getInternalProviderFlag2()

Returns
`Long`	The value of `COLUMN_INTERNAL_PROVIDER_FLAG2` for the channel.

getInternalProviderFlag3

Added in 1.1.0-alpha02

public Long getInternalProviderFlag3()

Returns
`Long`	The value of `COLUMN_INTERNAL_PROVIDER_FLAG3` for the channel.

getInternalProviderFlag4

Added in 1.1.0-alpha02

public Long getInternalProviderFlag4()

Returns
`Long`	The value of `COLUMN_INTERNAL_PROVIDER_FLAG4` for the channel.

getInternalProviderId

Added in 1.1.0-alpha02

public String getInternalProviderId()

Returns
`String`	The value of `COLUMN_INTERNAL_PROVIDER_ID` for the channel.

getNetworkAffiliation

Added in 1.1.0-alpha02

public String getNetworkAffiliation()

Returns
`String`	The value of `COLUMN_NETWORK_AFFILIATION` for the channel.

getOriginalNetworkId

Added in 1.1.0-alpha02

public int getOriginalNetworkId()

Returns
`int`	The value of `COLUMN_ORIGINAL_NETWORK_ID` for the channel.

getPackageName

Added in 1.1.0-alpha02

public String getPackageName()

Returns
`String`	The value of `COLUMN_PACKAGE_NAME` for the channel.

getServiceId

Added in 1.1.0-alpha02

public int getServiceId()

Returns
`int`	The value of `COLUMN_SERVICE_ID` for the channel.

getServiceType

Added in 1.1.0-alpha02

public String getServiceType()

Returns

Returns
`String`	The value of `COLUMN_SERVICE_TYPE` for the channel. Returns `SERVICE_TYPE_AUDIO`, `SERVICE_TYPE_AUDIO_VIDEO`, or `SERVICE_TYPE_OTHER`.

String

The value of COLUMN_SERVICE_TYPE for the channel.

Returns SERVICE_TYPE_AUDIO, SERVICE_TYPE_AUDIO_VIDEO, or SERVICE_TYPE_OTHER.

getSystemChannelKey

Added in 1.1.0-alpha02

public String getSystemChannelKey()

Returns
`String`	The value of `COLUMN_SYSTEM_CHANNEL_KEY` for the channel.

getTransportStreamId

Added in 1.1.0-alpha02

public int getTransportStreamId()

Returns
`int`	The value of `COLUMN_TRANSPORT_STREAM_ID` for the channel.

getType

Added in 1.1.0-alpha02

public String getType()

Returns
`String`	The value of `COLUMN_TYPE` for the channel.

getVideoFormat

Added in 1.1.0-alpha02

public String getVideoFormat()

Returns
`String`	The value of `COLUMN_VIDEO_FORMAT` for the channel.

hashCode

public int hashCode()

isBrowsable

Added in 1.1.0-alpha02

public boolean isBrowsable()

Returns
`boolean`	The value of `COLUMN_BROWSABLE` for the channel.

isLocked

Added in 1.1.0-alpha02

public boolean isLocked()

Returns
`boolean`	The value of `COLUMN_LOCKED` for the channel.

isSearchable

Added in 1.1.0-alpha02

public boolean isSearchable()

Returns
`boolean`	The value of `COLUMN_SEARCHABLE` for the channel.

isTransient

Added in 1.1.0-alpha02

public boolean isTransient()

Returns
`boolean`	The value of `COLUMN_TRANSIENT` for the channel.

toContentValues

Added in 1.1.0-alpha02

public ContentValues toContentValues()

Returns
`ContentValues`	The fields of the Channel in the ContentValues format to be easily inserted into the TV Input Framework database.

toString

public String toString()

Channel

Summary

Nested types

Public methods

Public methods

equals

fromCursor

getAppLinkColor

getAppLinkIconUri

getAppLinkIntent

getAppLinkIntentUri

getAppLinkPosterArtUri

getAppLinkText

getConfigurationDisplayOrder

getDescription

getDisplayName

getDisplayNumber

getGlobalContentId

getId

getInputId

getInternalProviderDataByteArray

getInternalProviderFlag1

getInternalProviderFlag2

getInternalProviderFlag3

getInternalProviderFlag4

getInternalProviderId

getNetworkAffiliation

getOriginalNetworkId

getPackageName

getServiceId

getServiceType

getSystemChannelKey

getTransportStreamId

getType

getVideoFormat

hashCode

isBrowsable

isLocked

isSearchable

isTransient

toContentValues

toString