Programs

Kotlin |Java

class Programs : TvContract.BaseTvColumns

kotlin.Any
↳	android.media.tv.TvContract.Programs

Column definitions for the TV programs table.

By default, the query results will be sorted by Programs.COLUMN_START_TIME_UTC_MILLIS in ascending order.

Summary

Nested classes
	`Genres` Canonical genres for TV programs.

Constants
static String	`COLUMN_AUDIO_LANGUAGE` The comma-separated audio languages of this TV program.
static String	`COLUMN_BROADCAST_GENRE` The comma-separated genre string of this TV program.
static String	`COLUMN_CANONICAL_GENRE` The comma-separated canonical genre string of this TV program.
static String	`COLUMN_CHANNEL_ID` The ID of the TV channel that provides this TV program.
static String	`COLUMN_CONTENT_RATING` The comma-separated content ratings of this TV program.
static String	`COLUMN_END_TIME_UTC_MILLIS` The end time of this TV program, in milliseconds since the epoch.
static String	`COLUMN_EPISODE_DISPLAY_NUMBER` The episode display number of this TV program for episodic TV shows.
static String	`COLUMN_EPISODE_NUMBER` The episode number of this TV program for episodic TV shows.
static String	`COLUMN_EPISODE_TITLE` The episode title of this TV program for episodic TV shows.
static String	`COLUMN_EVENT_ID` The event ID of this TV program.
static String	`COLUMN_GLOBAL_CONTENT_ID` The global content ID of this TV program, as a URI.
static String	`COLUMN_INTERNAL_PROVIDER_DATA` Internal data used by individual TV input services.
static String	`COLUMN_INTERNAL_PROVIDER_FLAG1` Internal integer flag used by individual TV input services.
static String	`COLUMN_INTERNAL_PROVIDER_FLAG2` Internal integer flag used by individual TV input services.
static String	`COLUMN_INTERNAL_PROVIDER_FLAG3` Internal integer flag used by individual TV input services.
static String	`COLUMN_INTERNAL_PROVIDER_FLAG4` Internal integer flag used by individual TV input services.
static String	`COLUMN_INTERNAL_PROVIDER_ID` The internal ID used by individual TV input services.
static String	`COLUMN_LONG_DESCRIPTION` The detailed, lengthy description of this TV program that is displayed only when the user wants to see more information.
static String	`COLUMN_MULTI_SERIES_ID` The comma-separated series IDs of this TV program for episodic TV shows.
static String	`COLUMN_POSTER_ART_URI` The URI for the poster art of this TV program.
static String	`COLUMN_RECORDING_PROHIBITED` The flag indicating whether recording of this program is prohibited.
static String	`COLUMN_REVIEW_RATING` The review rating score for this program.
static String	`COLUMN_REVIEW_RATING_STYLE` The review rating score style used for `COLUMN_REVIEW_RATING`.
static String	`COLUMN_SCRAMBLED` The flag indicating whether this TV program is scrambled or not.
static String	`COLUMN_SEARCHABLE` The flag indicating whether this TV program is searchable or not.
static String	`COLUMN_SEASON_DISPLAY_NUMBER` The season display number of this TV program for episodic TV shows.
static String	`COLUMN_SEASON_NUMBER` The season number of this TV program for episodic TV shows.
static String	`COLUMN_SEASON_TITLE` The title of the season for this TV program for episodic TV shows.
static String	`COLUMN_SERIES_ID` The series ID of this TV program for episodic TV shows.
static String	`COLUMN_SHORT_DESCRIPTION` The short description of this TV program that is displayed to the user by default.
static String	`COLUMN_SPLIT_ID` The split ID of this TV program for multi-part content, as a URI.
static String	`COLUMN_START_TIME_UTC_MILLIS` The start time of this TV program, in milliseconds since the epoch.
static String	`COLUMN_THUMBNAIL_URI` The URI for the thumbnail of this TV program.
static String	`COLUMN_TITLE` The title of this TV program.
static String	`COLUMN_VERSION_NUMBER` The version number of this row entry used by TV input services.
static String	`COLUMN_VIDEO_HEIGHT` The height of the video for this TV program, in the unit of pixels.
static String	`COLUMN_VIDEO_WIDTH` The width of the video for this TV program, in the unit of pixels.
static String	`CONTENT_ITEM_TYPE` The MIME type of a single TV program.
static String	`CONTENT_TYPE` The MIME type of a directory of TV programs.
static Int	`REVIEW_RATING_STYLE_PERCENTAGE` The review rating style for 0 to 100 point system.
static Int	`REVIEW_RATING_STYLE_STARS` The review rating style for five star rating.
static Int	`REVIEW_RATING_STYLE_THUMBS_UP_DOWN` The review rating style for thumbs-up and thumbs-down rating.

Inherited constants

From class BaseTvColumns

String

COLUMN_PACKAGE_NAME

The name of the package that owns the current row.

The TV provider fills in this column with the name of the package that provides the initial data of the row. If the package is later uninstalled, the rows it owns are automatically removed from the tables.

Type: TEXT

From class BaseColumns

String

_COUNT

The count of rows in a directory.

Type: INTEGER

String

_ID

The unique ID for a row.

Type: INTEGER (long)

Properties
static Uri!	`CONTENT_URI` The content:// style URI for this table.

Constants

COLUMN_AUDIO_LANGUAGE

static val COLUMN_AUDIO_LANGUAGE: String

The comma-separated audio languages of this TV program.

This is used to describe available audio languages included in the program. Use either ISO 639-1 or 639-2/T codes.

Type: TEXT

Value: "audio_language"

COLUMN_BROADCAST_GENRE

Added in API level 21

static val COLUMN_BROADCAST_GENRE: String

The comma-separated genre string of this TV program.

Use the same language appeared in the underlying broadcast standard, if applicable. (For example, one can refer to the genre strings used in Genre Descriptor of ATSC A/65 or Content Descriptor of ETSI EN 300 468, if appropriate.) Otherwise, leave empty. Use Genres.encode to create a text that can be stored in this column. Use Genres.decode to get the broadcast genre strings from the text stored in the column.

Type: TEXT

Value: "broadcast_genre"

See Also

COLUMN_CANONICAL_GENRE

static val COLUMN_CANONICAL_GENRE: String

The comma-separated canonical genre string of this TV program.

Canonical genres are defined in Genres. Use Genres#encode to create a text that can be stored in this column. Use Genres#decode to get the canonical genre strings from the text stored in the column.

Type: TEXT

Value: "canonical_genre"

See Also

COLUMN_CHANNEL_ID

Added in API level 21

static val COLUMN_CHANNEL_ID: String

The ID of the TV channel that provides this TV program.

This is a part of the channel URI and matches to BaseColumns._ID.

This is a required field.

Type: INTEGER (long)

Value: "channel_id"

COLUMN_CONTENT_RATING

static val COLUMN_CONTENT_RATING: String

The comma-separated content ratings of this TV program.

This is used to describe the content rating(s) of this program. Each comma-separated content rating sub-string should be generated by calling TvContentRating.flattenToString. Note that in most cases the program content is rated by a single rating system, thus resulting in a corresponding single sub-string that does not require comma separation and multiple sub-strings appear only when the program content is rated by two or more content rating systems. If any of those ratings is specified as "blocked rating" in the user's parental control settings, the TV input service should block the current content and wait for the signal that it is okay to unblock.

Type: TEXT

Value: "content_rating"

COLUMN_END_TIME_UTC_MILLIS

Added in API level 21

static val COLUMN_END_TIME_UTC_MILLIS: String

The end time of this TV program, in milliseconds since the epoch.

The value should be equal to or less than COLUMN_START_TIME_UTC_MILLIS of the next program in the same channel. In practice, end time will usually be the start time of the next program.

Can be empty if this program belongs to a Channels.TYPE_PREVIEW channel.

Type: INTEGER (long)

Value: "end_time_utc_millis"

COLUMN_EPISODE_DISPLAY_NUMBER

static val COLUMN_EPISODE_DISPLAY_NUMBER: String

The episode display number of this TV program for episodic TV shows.

This is used to indicate the episode number. (e.g. 1, 2 or 3) Note that the value does not necessarily be numeric. (e.g. 12B)

Can be empty.

Type: TEXT

Value: "episode_display_number"

COLUMN_EPISODE_NUMBER

Added in API level 21
Deprecated in API level 24

static val COLUMN_EPISODE_NUMBER: String

Deprecated: Use COLUMN_EPISODE_DISPLAY_NUMBER instead.

The episode number of this TV program for episodic TV shows.

Can be empty.

Type: INTEGER

Value: "episode_number"

COLUMN_EPISODE_TITLE

static val COLUMN_EPISODE_TITLE: String

The episode title of this TV program for episodic TV shows.

Can be empty.

Type: TEXT

Value: "episode_title"

COLUMN_EVENT_ID

Added in API level 30

static val COLUMN_EVENT_ID: String

The event ID of this TV program.

It is used to identify the current TV program in the same channel, if applicable. Use the same coding for event_id in the underlying broadcast standard if it is defined there (e.g. ATSC A/65, ETSI EN 300 468 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: "event_id"

COLUMN_GLOBAL_CONTENT_ID

Added in API level 30

static val COLUMN_GLOBAL_CONTENT_ID: String

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

A globally unique ID that identifies this TV program, if applicable. Suitable URIs include

crid://<CRIDauthority>/<data> from ETSI TS 102 323
globalContentId from ATSC A/332
Other broadcast ID provider. ex http://example.com/tv_program/1234

Can be empty.

Type: TEXT

Value: "global_content_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

Added in API level 33

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_LONG_DESCRIPTION

static val COLUMN_LONG_DESCRIPTION: String

The detailed, lengthy description of this TV program that is displayed only when the user wants to see more information.

TV input services should leave this field empty if they have no additional details beyond COLUMN_SHORT_DESCRIPTION.

Type: TEXT

Value: "long_description"

COLUMN_MULTI_SERIES_ID

Added in API level 33

static val COLUMN_MULTI_SERIES_ID: String

The comma-separated series IDs of this TV program for episodic TV shows.

This is used to indicate the series IDs. Programs in the same series share a series ID. Use this instead of COLUMN_SERIES_ID if more than one series IDs are assigned to the TV program.

Can be empty.

Type: TEXT

Value: "multi_series_id"

COLUMN_POSTER_ART_URI

static val COLUMN_POSTER_ART_URI: String

The URI for the poster art of this TV program.

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

content (android.content.ContentResolver#SCHEME_CONTENT)
android.resource (android.content.ContentResolver#SCHEME_ANDROID_RESOURCE)
file (android.content.ContentResolver#SCHEME_FILE)

Can be empty.

Type: TEXT

Value: "poster_art_uri"

COLUMN_RECORDING_PROHIBITED

Added in API level 24

static val COLUMN_RECORDING_PROHIBITED: String

The flag indicating whether recording of this program is prohibited.

A value of 1 indicates that recording of this program is prohibited and application will not schedule any recording for this program. A value of 0 indicates that the recording is not prohibited. If not specified, this value is set to 0 (not prohibited) by default.

Type: INTEGER (boolean)

Value: "recording_prohibited"

COLUMN_REVIEW_RATING

static val COLUMN_REVIEW_RATING: String

The review rating score for this program.

The format of the value is dependent on COLUMN_REVIEW_RATING_STYLE. If the style is REVIEW_RATING_STYLE_STARS, the value should be a real number between 0.0 and 5.0. (e.g. "4.5") If the style is REVIEW_RATING_STYLE_THUMBS_UP_DOWN, the value should be two integers, one for thumbs-up count and the other for thumbs-down count, with a comma between them. (e.g. "200,40") If the style is REVIEW_RATING_STYLE_PERCENTAGE, the value shoule be a real number between 0 and 100. (e.g. "99.9")

Type: TEXT

Value: "review_rating"

See Also

#COLUMN_REVIEW_RATING_STYLE

COLUMN_REVIEW_RATING_STYLE

static val COLUMN_REVIEW_RATING_STYLE: String

The review rating score style used for COLUMN_REVIEW_RATING.

The value should match one of the followings: REVIEW_RATING_STYLE_STARS, REVIEW_RATING_STYLE_THUMBS_UP_DOWN, and REVIEW_RATING_STYLE_PERCENTAGE.

Type: INTEGER

Value: "review_rating_style"

See Also

#COLUMN_REVIEW_RATING

COLUMN_SCRAMBLED

Added in API level 33

static val COLUMN_SCRAMBLED: String

The flag indicating whether this TV program is scrambled or not.

Use the same coding for scrambled in the underlying broadcast standard if free_ca_mode in EIT is defined there (e.g. ETSI EN 300 468).

Type: INTEGER (boolean)

Value: "scrambled"

COLUMN_SEARCHABLE

static val COLUMN_SEARCHABLE: String

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

The columns of searchable programs 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 program is searchable and its columns can be read by other applications, a value of 0 indicates that the program is hidden and its columns can be read only by the package that owns the program and the system. If not specified, this value is set to 1 (searchable) by default.

Type: INTEGER (boolean)

Value: "searchable"

COLUMN_SEASON_DISPLAY_NUMBER

static val COLUMN_SEASON_DISPLAY_NUMBER: String

The season display number of this TV program for episodic TV shows.

This is used to indicate the season number. (e.g. 1, 2 or 3) Note that the value does not necessarily be numeric. (e.g. 12B)

Can be empty.

Type: TEXT

Value: "season_display_number"

COLUMN_SEASON_NUMBER

Added in API level 21
Deprecated in API level 24

static val COLUMN_SEASON_NUMBER: String

Deprecated: Use COLUMN_SEASON_DISPLAY_NUMBER instead.

The season number of this TV program for episodic TV shows.

Can be empty.

Type: INTEGER

Value: "season_number"

COLUMN_SEASON_TITLE

static val COLUMN_SEASON_TITLE: String

The title of the season for this TV program for episodic TV shows.

This is an optional field supplied only when the season has a special title (e.g. The Final Season). If provided, the applications should display it instead of COLUMN_SEASON_DISPLAY_NUMBER, and should display it without alterations. (e.g. for "The Final Season", displayed string should be "The Final Season", not "Season The Final Season"). When displaying multiple programs, the order should be based on COLUMN_SEASON_DISPLAY_NUMBER, even when COLUMN_SEASON_TITLE exists.

Can be empty.

Type: TEXT

Value: "season_title"

COLUMN_SERIES_ID

static val COLUMN_SERIES_ID: String

The series ID of this TV program for episodic TV shows.

This is used to indicate the series ID. Programs in the same series share a series ID.

Can be empty.

Type: TEXT

Value: "series_id"

COLUMN_SHORT_DESCRIPTION

static val COLUMN_SHORT_DESCRIPTION: String

The short description of this TV program that is displayed to the user by default.

It is recommended to limit the length of the descriptions to 256 characters.

Type: TEXT

Value: "short_description"

COLUMN_SPLIT_ID

static val COLUMN_SPLIT_ID: String

The split ID of this TV program for multi-part content, as a URI.

A content may consist of multiple programs within the same channel or over several channels. For example, a film might be divided into two parts interrupted by a news in the middle or a longer sport event might be split into several parts over several channels. The split ID is used to identify all the programs in the same multi-part content. Suitable URIs include

crid://<CRIDauthority>/<data>#<IMI> from ETSI TS 102 323

Can be empty.

Type: TEXT

Value: "split_id"

COLUMN_START_TIME_UTC_MILLIS

Added in API level 21

static val COLUMN_START_TIME_UTC_MILLIS: String

The start time of this TV program, in milliseconds since the epoch.

The value should be equal to or larger than COLUMN_END_TIME_UTC_MILLIS of the previous program in the same channel. In practice, start time will usually be the end time of the previous program.

Can be empty if this program belongs to a Channels.TYPE_PREVIEW channel.

Type: INTEGER (long)

Value: "start_time_utc_millis"

COLUMN_THUMBNAIL_URI

static val COLUMN_THUMBNAIL_URI: String

The URI for the thumbnail of this TV program.

The system can generate a thumbnail from the poster art if this column is not specified. Thus it is not necessary for TV input services to include a thumbnail if it is just a scaled image of the poster art.

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

content (android.content.ContentResolver#SCHEME_CONTENT)
android.resource (android.content.ContentResolver#SCHEME_ANDROID_RESOURCE)
file (android.content.ContentResolver#SCHEME_FILE)

Can be empty.

Type: TEXT

Value: "thumbnail_uri"

COLUMN_TITLE

static val COLUMN_TITLE: String

The title of this TV program.

If this program is an episodic TV show, it is recommended that the title is the series title and its related fields (COLUMN_SEASON_TITLE and/or COLUMN_SEASON_DISPLAY_NUMBER, COLUMN_SEASON_DISPLAY_NUMBER, COLUMN_EPISODE_DISPLAY_NUMBER, and COLUMN_EPISODE_TITLE) are filled in.

Type: TEXT

Value: "title"

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 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_HEIGHT

static val COLUMN_VIDEO_HEIGHT: String

The height of the video for this TV program, in the unit of pixels.

Together with COLUMN_VIDEO_WIDTH this is used to determine the video resolution of the current TV program. Can be empty if it is not known initially or the program does not convey any video such as the programs from type Channels.SERVICE_TYPE_AUDIO channels.

Type: INTEGER

Value: "video_height"

COLUMN_VIDEO_WIDTH

static val COLUMN_VIDEO_WIDTH: String

The width of the video for this TV program, in the unit of pixels.

Together with COLUMN_VIDEO_HEIGHT this is used to determine the video resolution of the current TV program. Can be empty if it is not known initially or the program does not convey any video such as the programs from type Channels.SERVICE_TYPE_AUDIO channels.

Type: INTEGER

Value: "video_width"

CONTENT_ITEM_TYPE

Added in API level 21

static val CONTENT_ITEM_TYPE: String

The MIME type of a single TV program.

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

CONTENT_TYPE

Added in API level 21

static val CONTENT_TYPE: String

The MIME type of a directory of TV programs.

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

REVIEW_RATING_STYLE_PERCENTAGE

static val REVIEW_RATING_STYLE_PERCENTAGE: Int

The review rating style for 0 to 100 point system.

Value: 2

See Also

#COLUMN_REVIEW_RATING_STYLE

REVIEW_RATING_STYLE_STARS

static val REVIEW_RATING_STYLE_STARS: Int

The review rating style for five star rating.

Value: 0

See Also

#COLUMN_REVIEW_RATING_STYLE

REVIEW_RATING_STYLE_THUMBS_UP_DOWN

static val REVIEW_RATING_STYLE_THUMBS_UP_DOWN: Int

The review rating style for thumbs-up and thumbs-down rating.

Value: 1

See Also

#COLUMN_REVIEW_RATING_STYLE

Properties

CONTENT_URI

Added in API level 21

static val CONTENT_URI: Uri!

The content:// style URI for this table.

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