TvContractCompat.Channels

public static final class TvContractCompat.Channels
extends Object implements TvContractCompat.BaseTvColumns

java.lang.Object
   ↳ androidx.tvprovider.media.tv.TvContractCompat.Channels


Column definitions for the TV channels table.

Summary

Nested classes

class TvContractCompat.Channels.Logo

A sub-directory of a single TV channel that represents its primary logo. 

Constants

String COLUMN_APP_LINK_COLOR

The accent color of the app link template for this channel.

String COLUMN_APP_LINK_ICON_URI

The URI for the app badge icon of the app link template for this channel.

String COLUMN_APP_LINK_INTENT_URI

The intent URI of the app link for this channel.

String COLUMN_APP_LINK_POSTER_ART_URI

The URI for the poster art used as the background of the app link template for this channel.

String COLUMN_APP_LINK_TEXT

The link text of the app link template for this channel.

String COLUMN_BROWSABLE

The flag indicating whether this TV channel is browsable or not.

String COLUMN_CONFIGURATION_DISPLAY_ORDER

A value that can be used to define the order an app's channels should be displayed in the configure channels menu.

String COLUMN_DESCRIPTION

The description of this TV channel.

String COLUMN_DISPLAY_NAME

The channel name that is displayed to the user.

String COLUMN_DISPLAY_NUMBER

The channel number that is displayed to the user.

String COLUMN_GLOBAL_CONTENT_ID

The global content ID of this TV channel, as a URI.

String COLUMN_INPUT_ID

The ID of the TV input service that provides this TV channel.

String COLUMN_INTERNAL_PROVIDER_DATA

Internal data used by individual TV input services.

String COLUMN_INTERNAL_PROVIDER_FLAG1

Internal integer flag used by individual TV input services.

String COLUMN_INTERNAL_PROVIDER_FLAG2

Internal integer flag used by individual TV input services.

String COLUMN_INTERNAL_PROVIDER_FLAG3

Internal integer flag used by individual TV input services.

String COLUMN_INTERNAL_PROVIDER_FLAG4

Internal integer flag used by individual TV input services.

String COLUMN_INTERNAL_PROVIDER_ID

The internal ID used by individual TV input services.

String COLUMN_LOCKED

The flag indicating whether this TV channel is locked or not.

String COLUMN_NETWORK_AFFILIATION

The network affiliation for this TV channel.

String COLUMN_ORIGINAL_NETWORK_ID

The original network ID of this TV channel.

String COLUMN_SEARCHABLE

The flag indicating whether this TV channel is searchable or not.

String COLUMN_SERVICE_ID

The service ID of this channel.

String COLUMN_SERVICE_TYPE

The predefined service type of this TV channel.

String COLUMN_SYSTEM_CHANNEL_KEY

A channel identifier set in the TvProvider by the app to help OEM differentiate among the app's channels.

String COLUMN_TRANSIENT

The flag indicating whether this TV channel is transient or not.

String COLUMN_TRANSPORT_STREAM_ID

The transport stream ID of this channel.

String COLUMN_TYPE

The broadcast system type of this TV channel.

String COLUMN_VERSION_NUMBER

The version number of this row entry used by TV input services.

String COLUMN_VIDEO_FORMAT

The typical video format for programs from this TV channel.

String CONTENT_ITEM_TYPE

The MIME type of a single TV channel.

String CONTENT_TYPE

The MIME type of a directory of TV channels.

String SERVICE_TYPE_AUDIO

The service type for radio channels that have audio only.

String SERVICE_TYPE_AUDIO_VIDEO

The service type for regular TV channels that have both audio and video.

String SERVICE_TYPE_OTHER

A generic service type.

String TYPE_1SEG

The channel type for 1seg (handheld).

String TYPE_ATSC_C

The channel type for ATSC (cable).

String TYPE_ATSC_M_H

The channel type for ATSC-M/H (mobile/handheld).

String TYPE_ATSC_T

The channel type for ATSC (terrestrial).

String TYPE_CMMB

The channel type for CMMB (handheld).

String TYPE_DTMB

The channel type for DTMB (terrestrial).

String TYPE_DVB_C

The channel type for DVB-C (cable).

String TYPE_DVB_C2

The channel type for DVB-C2 (cable).

String TYPE_DVB_H

The channel type for DVB-H (handheld).

String TYPE_DVB_S

The channel type for DVB-S (satellite).

String TYPE_DVB_S2

The channel type for DVB-S2 (satellite).

String TYPE_DVB_SH

The channel type for DVB-SH (satellite).

String TYPE_DVB_T

The channel type for DVB-T (terrestrial).

String TYPE_DVB_T2

The channel type for DVB-T2 (terrestrial).

String TYPE_ISDB_C

The channel type for ISDB-C (cable).

String TYPE_ISDB_S

The channel type for ISDB-S (satellite).

String TYPE_ISDB_T

The channel type for ISDB-T (terrestrial).

String TYPE_ISDB_TB

The channel type for ISDB-Tb (Brazil).

String TYPE_NTSC

The channel type for NTSC.

String TYPE_OTHER

A generic channel type.

String TYPE_PAL

The channel type for PAL.

String TYPE_PREVIEW

The channel type for preview videos.

String TYPE_SECAM

The channel type for SECAM.

String TYPE_S_DMB

The channel type for S-DMB (satellite).

String TYPE_T_DMB

The channel type for T-DMB (terrestrial).

String VIDEO_FORMAT_1080I

The video format for 1080i.

String VIDEO_FORMAT_1080P

The video format for 1080p.

String VIDEO_FORMAT_2160P

The video format for 2160p.

String VIDEO_FORMAT_240P

The video format for 240p.

String VIDEO_FORMAT_360P

The video format for 360p.

String VIDEO_FORMAT_4320P

The video format for 4320p.

String VIDEO_FORMAT_480I

The video format for 480i.

String VIDEO_FORMAT_480P

The video format for 480p.

String VIDEO_FORMAT_576I

The video format for 576i.

String VIDEO_FORMAT_576P

The video format for 576p.

String VIDEO_FORMAT_720P

The video format for 720p.

String VIDEO_RESOLUTION_ED

The video resolution for enhanced-definition.

String VIDEO_RESOLUTION_FHD

The video resolution for full high-definition.

String VIDEO_RESOLUTION_HD

The video resolution for high-definition.

String VIDEO_RESOLUTION_SD

The video resolution for standard-definition.

String VIDEO_RESOLUTION_UHD

The video resolution for ultra high-definition.

Inherited constants

Fields

public static final Uri CONTENT_URI

The content:// style URI for this table.

Public methods

static String getVideoResolution(String videoFormat)

Returns the video resolution (definition) for a given video format.

Inherited methods

Constants

public static final String COLUMN_APP_LINK_COLOR

The accent color of the app link template for this channel. This is primarily used for the background color of the text box in the template.

The app-linking allows channel input sources to provide activity links from their live channel programming to another activity. This enables content providers to increase user engagement by offering the viewer other content or actions.

Type: INTEGER (color value)

Constant Value: "app_link_color"

public static final String COLUMN_APP_LINK_ICON_URI

The URI for the app badge icon of the app link template for this channel.

This small icon is overlaid at the bottom of the poster art specified by COLUMN_APP_LINK_POSTER_ART_URI. The data in the column must be a URI in one of the following formats:

The app-linking allows channel input sources to provide activity links from their live channel programming to another activity. This enables content providers to increase user engagement by offering the viewer other content or actions.

Type: TEXT

Constant Value: "app_link_icon_uri"

public static final String COLUMN_APP_LINK_INTENT_URI

The intent URI of the app link for this channel.

The URI is created using Intent.toUri(int) with Intent.URI_INTENT_SCHEME and converted back to the original intent with Intent.parseUri(String, int). The intent is launched when the user clicks the corresponding app link for the current channel.

The app-linking allows channel input sources to provide activity links from their live channel programming to another activity. This enables content providers to increase user engagement by offering the viewer other content or actions.

Type: TEXT

Constant Value: "app_link_intent_uri"

public static final String COLUMN_APP_LINK_POSTER_ART_URI

The URI for the poster art used as the background of the app link template for this channel.

The data in the column must be a URL, or a URI in one of the following formats:

The app-linking allows channel input sources to provide activity links from their live channel programming to another activity. This enables content providers to increase user engagement by offering the viewer other content or actions.

Type: TEXT

Constant Value: "app_link_poster_art_uri"

public static final String COLUMN_APP_LINK_TEXT

The link text of the app link template for this channel.

This provides a short description of the action that happens when the corresponding app link is clicked.

The app-linking allows channel input sources to provide activity links from their live channel programming to another activity. This enables content providers to increase user engagement by offering the viewer other content or actions.

Type: TEXT

Constant Value: "app_link_text"

COLUMN_BROWSABLE

public static final String COLUMN_BROWSABLE

The flag indicating whether this TV channel is browsable or not.

This column can only be set by applications having proper system permission. For other applications, this is a read-only column.

A value of 1 indicates the channel is included in the channel list that applications use to browse channels, a value of 0 indicates the channel is not included in the list. If not specified, this value is set to 0 (not browsable) by default.

Type: INTEGER (boolean)

Constant Value: "browsable"

COLUMN_CONFIGURATION_DISPLAY_ORDER

public static final String COLUMN_CONFIGURATION_DISPLAY_ORDER

A value that can be used to define the order an app's channels should be displayed in the configure channels menu.

If not specified, this value is set to 0 (unordered) by default. A value of 0 indicates that there is no defined order for this TV channel and it will default to alphabetical ordering after any channels ordered by this value. For example, given channels A, B, and C, with orders 0, 1, and 2 respectively, the final order will be B, C, A.

Type: INTEGER

Constant Value: "configuration_display_order"

COLUMN_DESCRIPTION

public static final String COLUMN_DESCRIPTION

The description of this TV channel.

Can be empty initially.

Type: TEXT

Constant Value: "description"

COLUMN_DISPLAY_NAME

public static final String COLUMN_DISPLAY_NAME

The channel name that is displayed to the user.

A call sign is a good candidate to use for this purpose but any name that helps the user recognize the current channel will be enough. Can also be empty depending on broadcast standard.

Type: TEXT

Constant Value: "display_name"

COLUMN_DISPLAY_NUMBER

public static final String COLUMN_DISPLAY_NUMBER

The channel number that is displayed to the user.

The format can vary depending on broadcast standard and product specification.

Type: TEXT

Constant Value: "display_number"

COLUMN_GLOBAL_CONTENT_ID

public static final String COLUMN_GLOBAL_CONTENT_ID

The global content ID of this TV channel, as a URI.

A globally unique URI that identifies this TV channel, if applicable. Suitable URIs include

  • globalServiceId from ATSC A/331. ex https://doi.org/10.5239/7E4E-B472
  • Other broadcast ID provider. ex http://example.com/tv_channel/1234

Can be empty.

Type: TEXT

Constant Value: "global_content_id"

COLUMN_INPUT_ID

public static final String COLUMN_INPUT_ID

The ID of the TV input service that provides this TV channel.

Use TvContractCompat.buildInputId(ComponentName) to build the ID.

This is a required field.

Type: TEXT

Constant Value: "input_id"

COLUMN_INTERNAL_PROVIDER_DATA

public static final String COLUMN_INTERNAL_PROVIDER_DATA

Internal data used by individual TV input services.

This is internal to the provider that inserted it, and should not be decoded by other apps.

Type: BLOB

Constant Value: "internal_provider_data"

COLUMN_INTERNAL_PROVIDER_FLAG1

public static final String COLUMN_INTERNAL_PROVIDER_FLAG1

Internal integer flag used by individual TV input services.

This is internal to the provider that inserted it, and should not be decoded by other apps.

Type: INTEGER

Constant Value: "internal_provider_flag1"

COLUMN_INTERNAL_PROVIDER_FLAG2

public static final String COLUMN_INTERNAL_PROVIDER_FLAG2

Internal integer flag used by individual TV input services.

This is internal to the provider that inserted it, and should not be decoded by other apps.

Type: INTEGER

Constant Value: "internal_provider_flag2"

COLUMN_INTERNAL_PROVIDER_FLAG3

public static final String COLUMN_INTERNAL_PROVIDER_FLAG3

Internal integer flag used by individual TV input services.

This is internal to the provider that inserted it, and should not be decoded by other apps.

Type: INTEGER

Constant Value: "internal_provider_flag3"

COLUMN_INTER