Android Dev Summit, October 23-24: two days of technical content, directly from the Android team. Sign-up for livestream updates.

Channels

class Channels : TvContractCompat.BaseTvColumns
kotlin.Any
   ↳ androidx.tvprovider.media.tv.TvContractCompat.Channels

Column definitions for the TV channels table.

Summary

Nested classes

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

Constants

static String

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

static String

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

static String

The intent URI of the app link for this channel.

static String

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

static String

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

static String

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

static String

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

static String

The description of this TV channel.

static String

The channel name that is displayed to the user.

static String

The channel number that is displayed to the user.

static String

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

static String

Internal data used by individual TV input services.

static String

Internal integer flag used by individual TV input services.

static String

Internal integer flag used by individual TV input services.

static String

Internal integer flag used by individual TV input services.

static String

Internal integer flag used by individual TV input services.

static String

The internal ID used by individual TV input services.

static String

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

static String

The network affiliation for this TV channel.

static String

The original network ID of this TV channel.

static String

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

static String

The service ID of this channel.

static String

The predefined service type of this TV channel.

static String

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

static String

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

static String

The transport stream ID of this channel.

static String

The broadcast system type of this TV channel.

static String

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

static String

The typical video format for programs from this TV channel.

static String

The MIME type of a single TV channel.

static String

The MIME type of a directory of TV channels.

static String

The service type for radio channels that have audio only.

static String

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

static String

A generic service type.

static String

The channel type for 1seg (handheld).

static String

The channel type for ATSC (cable).

static String

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

static String

The channel type for ATSC (terrestrial).

static String

The channel type for CMMB (handheld).

static String

The channel type for DTMB (terrestrial).

static String

The channel type for DVB-C (cable).

static String

The channel type for DVB-C2 (cable).

static String

The channel type for DVB-H (handheld).

static String

The channel type for DVB-S (satellite).

static String

The channel type for DVB-S2 (satellite).

static String

The channel type for DVB-SH (satellite).

static String

The channel type for DVB-T (terrestrial).

static String

The channel type for DVB-T2 (terrestrial).

static String

The channel type for ISDB-C (cable).

static String

The channel type for ISDB-S (satellite).

static String

The channel type for ISDB-T (terrestrial).

static String

The channel type for ISDB-Tb (Brazil).

static String

The channel type for NTSC.

static String

A generic channel type.

static String

The channel type for PAL.

static String

The channel type for preview videos.

static String

The channel type for SECAM.

static String

The channel type for S-DMB (satellite).

static String

The channel type for T-DMB (terrestrial).

static String

The video format for 1080i.

static String

The video format for 1080p.

static String

The video format for 2160p.

static String

The video format for 240p.

static String

The video format for 360p.

static String

The video format for 4320p.

static String

The video format for 480i.

static String

The video format for 480p.

static String

The video format for 576i.

static String

The video format for 576p.

static String

The video format for 720p.

static String

The video resolution for enhanced-definition.

static String

The video resolution for full high-definition.

static String

The video resolution for high-definition.

static String

The video resolution for standard-definition.

static String

The video resolution for ultra high-definition.

Inherited constants

Public methods

static String?
getVideoResolution(videoFormat: String!)

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

Properties

static Uri!

The content:// style URI for this table.

Constants

COLUMN_APP_LINK_COLOR

static val COLUMN_APP_LINK_COLOR: String

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)

Value: "app_link_color"

COLUMN_APP_LINK_ICON_URI

static val COLUMN_APP_LINK_ICON_URI: String

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

Value: "app_link_icon_uri"

COLUMN_APP_LINK_INTENT_URI

static val COLUMN_APP_LINK_INTENT_URI: String

The intent URI of the app link for this channel.

The URI is created using Intent#toUri with Intent#URI_INTENT_SCHEME and converted back to the original intent with Intent#parseUri. 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

Value: "app_link_intent_uri"

COLUMN_APP_LINK_POSTER_ART_URI

static val COLUMN_APP_LINK_POSTER_ART_URI: String

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

Value: "app_link_poster_art_uri"

COLUMN_APP_LINK_TEXT

static val COLUMN_APP_LINK_TEXT: String

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

Value: "app_link_text"

COLUMN_BROWSABLE

static val COLUMN_BROWSABLE: String

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)

Value: "browsable"

COLUMN_CONFIGURATION_DISPLAY_ORDER

static val COLUMN_CONFIGURATION_DISPLAY_ORDER: String

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

Value: "configuration_display_order"

COLUMN_DESCRIPTION

static val COLUMN_DESCRIPTION: String

The description of this TV channel.

Can be empty initially.

Type: TEXT

Value: "description"

COLUMN_DISPLAY_NAME

static val COLUMN_DISPLAY_NAME: String

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

Value: "display_name"

COLUMN_DISPLAY_NUMBER

static val COLUMN_DISPLAY_NUMBER: String

The channel number that is displayed to the user.

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

Type: TEXT

Value: "display_number"

COLUMN_INPUT_ID

static val COLUMN_INPUT_ID: String

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

Use buildInputId to build the ID.

This is a required field.

Type: TEXT

Value: "input_id"

COLUMN_INTERNAL_PROVIDER_DATA

static val COLUMN_INTERNAL_PROVIDER_DATA: String

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

Value: "internal_provider_data"

COLUMN_INTERNAL_PROVIDER_FLAG1

static val COLUMN_INTERNAL_PROVIDER_FLAG1: String

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

Value: "internal_provider_flag1"

COLUMN_INTERNAL_PROVIDER_FLAG2

static val COLUMN_INTERNAL_PROVIDER_FLAG2: String

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

Value: "internal_provider_flag2"

COLUMN_INTERNAL_PROVIDER_FLAG3

static val COLUMN_INTERNAL_PROVIDER_FLAG3: String

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

Value: "internal_provider_flag3"

COLUMN_INTERNAL_PROVIDER_FLAG4

static val COLUMN_INTERNAL_PROVIDER_FLAG4: String

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

Value: "internal_provider_flag4"

COLUMN_INTERNAL_PROVIDER_ID

static val COLUMN_INTERNAL_PROVIDER_ID: String

The internal ID used by individual TV input services.

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

Can be empty.

Type: TEXT

Value: "internal_provider_id"

COLUMN_LOCKED

static val COLUMN_LOCKED: String

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

This is primarily used for alternative parental control to prevent unauthorized users from watching the current channel regardless of the content rating. A value of 1 indicates the channel is locked and the user is required to enter passcode to unlock it in order to watch the current program from the channel, a value of 0 indicates the channel is not locked thus the user is not prompted to enter passcode If not specified, this value is set to 0 (not locked) by default.

This column can only be set by applications having proper system permission to modify parental control settings.

Type: INTEGER (boolean)

Value: "locked"

COLUMN_NETWORK_AFFILIATION

static val COLUMN_NETWORK_AFFILIATION: String

The network affiliation for this TV channel.

This is used to identify a channel that is commonly called by its network affiliation instead of the display name. Examples include ABC for the channel KGO-HD, FOX for the channel KTVU-HD and NBC for the channel KNTV-HD. Can be empty if not applicable.

Type: TEXT

Value: "network_affiliation"

COLUMN_ORIGINAL_NETWORK_ID

static val COLUMN_ORIGINAL_NETWORK_ID: String

The original network ID of this TV channel.

It is used to identify the originating delivery system, if applicable. Use the same coding for original_network_id for ETSI EN 300 468/TR 101 211 and ARIB STD-B10.

This is a required field only if the underlying broadcast standard defines the same name field. Otherwise, leave empty.

Type: INTEGER

Value: "original_network_id"

COLUMN_SEARCHABLE

static val COLUMN_SEARCHABLE: String

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

The columns of searchable channels can be read by other applications that have proper permission. Care must be taken not to open sensitive data.

A value of 1 indicates that the channel is searchable and its columns can be read by other applications, a value of 0 indicates that the channel is hidden and its columns can be read only by the package that owns the channel and the system. If not specified, this value is set to 1 (searchable) by default.

Type: INTEGER (boolean)

Value: "searchable"

COLUMN_SERVICE_ID

static val COLUMN_SERVICE_ID: String

The service ID of this channel.

It is used to identify the current service, or channel from any other services within a given Transport Stream, if applicable. Use the same coding for service_id in ETSI EN 300 468 and ARIB STD-B10 or program_number in ISO/IEC 13818-1.

This is a required field only if the underlying broadcast standard defines the same name field, or the current channel is transmitted via the MPEG Transport Stream. Leave empty otherwise.

Type: INTEGER

Value: "service_id"

COLUMN_SERVICE_TYPE

static val COLUMN_SERVICE_TYPE: String

The predefined service type of this TV channel.

This is primarily used to indicate whether the current channel is a regular TV channel or a radio-like channel. Use the same coding for service_type in the underlying broadcast standard if it is defined there (e.g. ATSC A/53, ETSI EN 300 468 and ARIB STD-B10). Otherwise use one of the followings: SERVICE_TYPE_OTHER, SERVICE_TYPE_AUDIO_VIDEO, SERVICE_TYPE_AUDIO

This is a required field.

Type: TEXT

Value: "service_type"

COLUMN_SYSTEM_CHANNEL_KEY

static val COLUMN_SYSTEM_CHANNEL_KEY: String

A channel identifier set in the TvProvider by the app to help OEM differentiate among the app's channels. This identifier should be unique per channel for each app, and should be agreed between the app and the OEM. It is up to the OEM on how they use this identifier for customization purposes.

Can be empty.

Type: TEXT

Value: "system_channel_key"

COLUMN_TRANSIENT

static val COLUMN_TRANSIENT: String

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

A value of 1 indicates that the channel will be automatically removed by the system on reboot, and a value of 0 indicates that the channel is persistent across reboot. If not specified, this value is set to 0 (not transient) by default.

Type: INTEGER (boolean)

Value: "transient"

COLUMN_TRANSPORT_STREAM_ID

static val COLUMN_TRANSPORT_STREAM_ID: String

The transport stream ID of this channel.

It is used to identify the Transport Stream that contains the current channel from any other multiplex within a network, if applicable. Use the same coding for transport_stream_id defined in ISO/IEC 13818-1 if the channel is transmitted via the MPEG Transport Stream.

This is a required field only if the current channel is transmitted via the MPEG Transport Stream. Leave empty otherwise.

Type: INTEGER

Value: "transport_stream_id"

COLUMN_TYPE

static val COLUMN_TYPE: String

The broadcast system type of this TV channel.

This is used to indicate the broadcast standard (e.g. ATSC, DVB or ISDB) the current channel conforms to. Use TYPE_OTHER for streaming-based channels, which is the default channel type. The value should match one of the followings: TYPE_1SEG, TYPE_ATSC_C, TYPE_ATSC_M_H, TYPE_ATSC_T, TYPE_CMMB, TYPE_DTMB, TYPE_DVB_C, TYPE_DVB_C2, TYPE_DVB_H, TYPE_DVB_S, TYPE_DVB_S2, TYPE_DVB_SH, TYPE_DVB_T, TYPE_DVB_T2, TYPE_ISDB_C, TYPE_ISDB_S, TYPE_ISDB_T, TYPE_ISDB_TB, TYPE_NTSC, TYPE_OTHER, TYPE_PAL, TYPE_SECAM, TYPE_S_DMB, and TYPE_T_DMB.

This is a required field.

Type: TEXT

Value: "type"

COLUMN_VERSION_NUMBER

static val COLUMN_VERSION_NUMBER: String

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

This is best used by sync adapters to identify the rows to update. The number can be defined by individual TV input services. One may assign the same value as version_number that appears in ETSI EN 300 468 or ATSC A/65, if the data are coming from a TV broadcast.

Type: INTEGER

Value: "version_number"

COLUMN_VIDEO_FORMAT

static val COLUMN_VIDEO_FORMAT: String

The typical video format for programs from this TV channel.

This is primarily used to filter out channels based on video format by applications. The value should match one of the followings: VIDEO_FORMAT_240P, VIDEO_FORMAT_360P, VIDEO_FORMAT_480I, VIDEO_FORMAT_480P, VIDEO_FORMAT_576I, VIDEO_FORMAT_576P, VIDEO_FORMAT_720P, VIDEO_FORMAT_1080I, VIDEO_FORMAT_1080P, VIDEO_FORMAT_2160P, VIDEO_FORMAT_4320P. Note that the actual video resolution of each program from a given channel can vary thus one should use Programs#COLUMN_VIDEO_WIDTH and Programs#COLUMN_VIDEO_HEIGHT to get more accurate video resolution.

Type: TEXT

Value: "video_format"

CONTENT_ITEM_TYPE

static val CONTENT_ITEM_TYPE: String

The MIME type of a single TV channel.

Value: "vnd.android.cursor.item/channel"

CONTENT_TYPE

static val CONTENT_TYPE: String

The MIME type of a directory of TV channels.

Value: "vnd.android.cursor.dir/channel"

SERVICE_TYPE_AUDIO

static val SERVICE_TYPE_AUDIO: String

The service type for radio channels that have audio only.

Value: "SERVICE_TYPE_AUDIO"

SERVICE_TYPE_AUDIO_VIDEO

static val SERVICE_TYPE_AUDIO_VIDEO: String

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

Value: "SERVICE_TYPE_AUDIO_VIDEO"

SERVICE_TYPE_OTHER

static val SERVICE_TYPE_OTHER: String

A generic service type.

Value: "SERVICE_TYPE_OTHER"

TYPE_1SEG

static val TYPE_1SEG: String

The channel type for 1seg (handheld).

Value: "TYPE_1SEG"

See Also

TYPE_ATSC_C

static val TYPE_ATSC_C: String

The channel type for ATSC (cable).

Value: "TYPE_ATSC_C"

See Also

TYPE_ATSC_M_H

static val TYPE_ATSC_M_H: String

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

Value: "TYPE_ATSC_M_H"

See Also

TYPE_ATSC_T

static val TYPE_ATSC_T: String

The channel type for ATSC (terrestrial).

Value: "TYPE_ATSC_T"

See Also

TYPE_CMMB

static val TYPE_CMMB: String

The channel type for CMMB (handheld).

Value: "TYPE_CMMB"

See Also

TYPE_DTMB

static val TYPE_DTMB: String

The channel type for DTMB (terrestrial).

Value: "TYPE_DTMB"

See Also

TYPE_DVB_C

static val TYPE_DVB_C: String

The channel type for DVB-C (cable).

Value: "TYPE_DVB_C"

See Also

TYPE_DVB_C2

static val TYPE_DVB_C2: String

The channel type for DVB-C2 (cable).

Value: "TYPE_DVB_C2"

See Also

TYPE_DVB_H

static val TYPE_DVB_H: String

The channel type for DVB-H (handheld).

Value: "TYPE_DVB_H"

See Also

TYPE_DVB_S

static val TYPE_DVB_S: String

The channel type for DVB-S (satellite).

Value: "TYPE_DVB_S"

See Also

TYPE_DVB_S2

static val TYPE_DVB_S2: String

The channel type for DVB-S2 (satellite).

Value: "TYPE_DVB_S2"

See Also

TYPE_DVB_SH

static val TYPE_DVB_SH: String

The channel type for DVB-SH (satellite).

Value: "TYPE_DVB_SH"

See Also

TYPE_DVB_T

static val TYPE_DVB_T: String

The channel type for DVB-T (terrestrial).

Value: "TYPE_DVB_T"

See Also

TYPE_DVB_T2

static val TYPE_DVB_T2: String

The channel type for DVB-T2 (terrestrial).

Value: "TYPE_DVB_T2"

See Also

TYPE_ISDB_C

static val TYPE_ISDB_C: String

The channel type for ISDB-C (cable).

Value: "TYPE_ISDB_C"

See Also

TYPE_ISDB_S

static val TYPE_ISDB_S: String

The channel type for ISDB-S (satellite).

Value: "TYPE_ISDB_S"

See Also

TYPE_ISDB_T

static val TYPE_ISDB_T: String

The channel type for ISDB-T (terrestrial).

Value: "TYPE_ISDB_T"

See Also

TYPE_ISDB_TB

static val TYPE_ISDB_TB: String

The channel type for ISDB-Tb (Brazil).

Value: "TYPE_ISDB_TB"

See Also

TYPE_NTSC

static val TYPE_NTSC: String

The channel type for NTSC.

Value: "TYPE_NTSC"

See Also

TYPE_OTHER

static val TYPE_OTHER: String

A generic channel type. Use this if the current channel is streaming-based or its broadcast system type does not fit under any other types. This is the default channel type.

Value: "TYPE_OTHER"

See Also

TYPE_PAL

static val TYPE_PAL: String

The channel type for PAL.

Value: "TYPE_PAL"

See Also

TYPE_PREVIEW

static val TYPE_PREVIEW: String

The channel type for preview videos.

Unlike other broadcast TV channel types, the programs in the preview channel usually are promotional videos. The UI may treat the preview channels differently from the other broadcast channels.

Value: "TYPE_PREVIEW"

See Also

TYPE_SECAM

static val TYPE_SECAM: String

The channel type for SECAM.

Value: "TYPE_SECAM"

See Also

TYPE_S_DMB

static val TYPE_S_DMB: String

The channel type for S-DMB (satellite).

Value: "TYPE_S_DMB"

See Also

TYPE_T_DMB

static val TYPE_T_DMB: String

The channel type for T-DMB (terrestrial).

Value: "TYPE_T_DMB"

See Also

VIDEO_FORMAT_1080I

static val VIDEO_FORMAT_1080I: String

The video format for 1080i.

Value: "VIDEO_FORMAT_1080I"

VIDEO_FORMAT_1080P

static val VIDEO_FORMAT_1080P: String

The video format for 1080p.

Value: "VIDEO_FORMAT_1080P"

VIDEO_FORMAT_2160P

static val VIDEO_FORMAT_2160P: String

The video format for 2160p.

Value: "VIDEO_FORMAT_2160P"

VIDEO_FORMAT_240P

static val VIDEO_FORMAT_240P: String

The video format for 240p.

Value: "VIDEO_FORMAT_240P"

VIDEO_FORMAT_360P

static val VIDEO_FORMAT_360P: String

The video format for 360p.

Value: "VIDEO_FORMAT_360P"

VIDEO_FORMAT_4320P

static val VIDEO_FORMAT_4320P: String

The video format for 4320p.

Value: "VIDEO_FORMAT_4320P"

VIDEO_FORMAT_480I

static val VIDEO_FORMAT_480I: String

The video format for 480i.

Value: "VIDEO_FORMAT_480I"

VIDEO_FORMAT_480P

static val VIDEO_FORMAT_480P: String

The video format for 480p.

Value: "VIDEO_FORMAT_480P"

VIDEO_FORMAT_576I

static val VIDEO_FORMAT_576I: String

The video format for 576i.

Value: "VIDEO_FORMAT_576I"

VIDEO_FORMAT_576P

static val VIDEO_FORMAT_576P: String

The video format for 576p.

Value: "VIDEO_FORMAT_576P"

VIDEO_FORMAT_720P

static val VIDEO_FORMAT_720P: String

The video format for 720p.

Value: "VIDEO_FORMAT_720P"

VIDEO_RESOLUTION_ED

static val VIDEO_RESOLUTION_ED: String

The video resolution for enhanced-definition.

Value: "VIDEO_RESOLUTION_ED"

VIDEO_RESOLUTION_FHD

static val VIDEO_RESOLUTION_FHD: String

The video resolution for full high-definition.

Value: "VIDEO_RESOLUTION_FHD"

VIDEO_RESOLUTION_HD

static val VIDEO_RESOLUTION_HD: String

The video resolution for high-definition.

Value: "VIDEO_RESOLUTION_HD"

VIDEO_RESOLUTION_SD

static val VIDEO_RESOLUTION_SD: String

The video resolution for standard-definition.

Value: "VIDEO_RESOLUTION_SD"

VIDEO_RESOLUTION_UHD

static val VIDEO_RESOLUTION_UHD: String

The video resolution for ultra high-definition.

Value: "VIDEO_RESOLUTION_UHD"

Public methods

getVideoResolution

@Nullable static fun getVideoResolution(videoFormat: String!): String?

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

Parameters
videoFormat String!: The video format defined in Channels.
Return
String?: the corresponding video resolution string. null if the resolution string is not defined for the given video format.

Properties

CONTENT_URI

static val CONTENT_URI: Uri!

The content:// style URI for this table.

SQL selection is not supported for ContentResolver#query, ContentResolver#update and ContentResolver#delete operations.