Skip to content

Most visited

Recently visited

navigation

TvContract.Programs

public static final class TvContract.Programs
extends Object implements TvContract.BaseTvColumns

java.lang.Object
   ↳ android.media.tv.TvContract.Programs


Column definitions for the TV programs table.

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

Summary

Nested classes

class TvContract.Programs.Genres

Canonical genres for TV programs. 

Constants

String COLUMN_AUDIO_LANGUAGE

The comma-separated audio languages of this TV program.

String COLUMN_BROADCAST_GENRE

The comma-separated genre string of this TV program.

String COLUMN_CANONICAL_GENRE

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

String COLUMN_CHANNEL_ID

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

String COLUMN_CONTENT_RATING

The comma-separated content ratings of this TV program.

String COLUMN_END_TIME_UTC_MILLIS

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

String COLUMN_EPISODE_DISPLAY_NUMBER

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

String COLUMN_EPISODE_NUMBER

This constant was deprecated in API level 24. Use COLUMN_EPISODE_DISPLAY_NUMBER instead.

String COLUMN_EPISODE_TITLE

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

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_LONG_DESCRIPTION

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

String COLUMN_POSTER_ART_URI

The URI for the poster art of this TV program.

String COLUMN_RECORDING_PROHIBITED

The flag indicating whether recording of this program is prohibited.

String COLUMN_REVIEW_RATING

The review rating score for this program.

String COLUMN_REVIEW_RATING_STYLE

The review rating score style used for COLUMN_REVIEW_RATING.

String COLUMN_SEARCHABLE

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

String COLUMN_SEASON_DISPLAY_NUMBER

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

String COLUMN_SEASON_NUMBER

This constant was deprecated in API level 24. Use COLUMN_SEASON_DISPLAY_NUMBER instead.

String COLUMN_SEASON_TITLE

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

String COLUMN_SHORT_DESCRIPTION

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

String COLUMN_START_TIME_UTC_MILLIS

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

String COLUMN_THUMBNAIL_URI

The URI for the thumbnail of this TV program.

String COLUMN_TITLE

The title of this TV program.

String COLUMN_VERSION_NUMBER

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

String COLUMN_VIDEO_HEIGHT

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

String COLUMN_VIDEO_WIDTH

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

String CONTENT_ITEM_TYPE

The MIME type of a single TV program.

String CONTENT_TYPE

The MIME type of a directory of TV programs.

int REVIEW_RATING_STYLE_PERCENTAGE

The review rating style for 0 to 100 point system.

int REVIEW_RATING_STYLE_STARS

The review rating style for five star rating.

int REVIEW_RATING_STYLE_THUMBS_UP_DOWN

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

Inherited constants

From interface android.media.tv.TvContract.BaseTvColumns
From interface android.provider.BaseColumns

Fields

public static final Uri CONTENT_URI

The content:// style URI for this table.

Inherited methods

From class java.lang.Object

Constants

COLUMN_AUDIO_LANGUAGE

added in API level 21
String COLUMN_AUDIO_LANGUAGE

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

Constant Value: "audio_language"

COLUMN_BROADCAST_GENRE

added in API level 21
String COLUMN_BROADCAST_GENRE

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 encode(String...) to create a text that can be stored in this column. Use decode(String) to get the broadcast genre strings from the text stored in the column.

Type: TEXT

See also:

Constant Value: "broadcast_genre"

COLUMN_CANONICAL_GENRE

added in API level 21
String COLUMN_CANONICAL_GENRE

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

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

Type: TEXT

See also:

Constant Value: "canonical_genre"

COLUMN_CHANNEL_ID

added in API level 21
String COLUMN_CHANNEL_ID

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

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

This is a required field.

Type: INTEGER (long)

Constant Value: "channel_id"

COLUMN_CONTENT_RATING

added in API level 21
String COLUMN_CONTENT_RATING

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

Constant Value: "content_rating"

COLUMN_END_TIME_UTC_MILLIS

added in API level 21
String COLUMN_END_TIME_UTC_MILLIS

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 TYPE_PREVIEW channel.

Type: INTEGER (long)

Constant Value: "end_time_utc_millis"

COLUMN_EPISODE_DISPLAY_NUMBER

added in API level 24
String COLUMN_EPISODE_DISPLAY_NUMBER

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

Constant Value: "episode_display_number"

COLUMN_EPISODE_NUMBER

added in API level 21
String COLUMN_EPISODE_NUMBER

This constant was deprecated in API level 24.
Use COLUMN_EPISODE_DISPLAY_NUMBER instead.

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

Can be empty.

Type: INTEGER

Constant Value: "episode_number"

COLUMN_EPISODE_TITLE

added in API level 21
String COLUMN_EPISODE_TITLE

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

Can be empty.

Type: TEXT

Constant Value: "episode_title"

COLUMN_INTERNAL_PROVIDER_DATA

added in API level 21
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

added in API level 23
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

added in API level 23
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

added in API level 23
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_INTERNAL_PROVIDER_FLAG4

added in API level 23
String COLUMN_INTERNAL_PROVIDER_FLAG4

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_flag4"

COLUMN_LONG_DESCRIPTION

added in API level 21
String COLUMN_LONG_DESCRIPTION

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

Constant Value: "long_description"

COLUMN_POSTER_ART_URI

added in API level 21
String COLUMN_POSTER_ART_URI

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:

Can be empty.

Type: TEXT

Constant Value: "poster_art_uri"

COLUMN_RECORDING_PROHIBITED

added in API level 24
String COLUMN_RECORDING_PROHIBITED

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)

Constant Value: "recording_prohibited"

COLUMN_REVIEW_RATING

added in API level 26
String COLUMN_REVIEW_RATING

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

See also:

Constant Value: "review_rating"

COLUMN_REVIEW_RATING_STYLE

added in API level 26
String COLUMN_REVIEW_RATING_STYLE

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

See also:

Constant Value: "review_rating_style"

COLUMN_SEARCHABLE

added in API level 23
String COLUMN_SEARCHABLE

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)

Constant Value: "searchable"

COLUMN_SEASON_DISPLAY_NUMBER

added in API level 24
String COLUMN_SEASON_DISPLAY_NUMBER

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

Constant Value: "season_display_number"

COLUMN_SEASON_NUMBER

added in API level 21
String COLUMN_SEASON_NUMBER

This constant was deprecated in API level 24.
Use COLUMN_SEASON_DISPLAY_NUMBER instead.

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

Can be empty.

Type: INTEGER

Constant Value: "season_number"

COLUMN_SEASON_TITLE

added in API level 24
String COLUMN_SEASON_TITLE

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

Constant Value: "season_title"

COLUMN_SHORT_DESCRIPTION

added in API level 21
String COLUMN_SHORT_DESCRIPTION

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

Constant Value: "short_description"

COLUMN_START_TIME_UTC_MILLIS

added in API level 21
String COLUMN_START_TIME_UTC_MILLIS

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 TYPE_PREVIEW channel.

Type: INTEGER (long)

Constant Value: "start_time_utc_millis"

COLUMN_THUMBNAIL_URI

added in API level 21
String COLUMN_THUMBNAIL_URI

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:

Can be empty.

Type: TEXT

Constant Value: "thumbnail_uri"

COLUMN_TITLE

added in API level 21
String COLUMN_TITLE

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

Constant Value: "title"

COLUMN_VERSION_NUMBER

added in API level 21
String COLUMN_VERSION_NUMBER

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

Constant Value: "version_number"

COLUMN_VIDEO_HEIGHT

added in API level 21
String COLUMN_VIDEO_HEIGHT

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 SERVICE_TYPE_AUDIO channels.

Type: INTEGER

Constant Value: "video_height"

COLUMN_VIDEO_WIDTH

added in API level 21
String COLUMN_VIDEO_WIDTH

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 SERVICE_TYPE_AUDIO channels.

Type: INTEGER

Constant Value: "video_width"

CONTENT_ITEM_TYPE

added in API level 21
String CONTENT_ITEM_TYPE

The MIME type of a single TV program.

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

CONTENT_TYPE

added in API level 21
String CONTENT_TYPE

The MIME type of a directory of TV programs.

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

REVIEW_RATING_STYLE_PERCENTAGE

added in API level 26
int REVIEW_RATING_STYLE_PERCENTAGE

The review rating style for 0 to 100 point system.

See also:

Constant Value: 2 (0x00000002)

REVIEW_RATING_STYLE_STARS

added in API level 26
int REVIEW_RATING_STYLE_STARS

The review rating style for five star rating.

See also:

Constant Value: 0 (0x00000000)

REVIEW_RATING_STYLE_THUMBS_UP_DOWN

added in API level 26
int REVIEW_RATING_STYLE_THUMBS_UP_DOWN

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

See also:

Constant Value: 1 (0x00000001)

Fields

CONTENT_URI

added in API level 21
Uri CONTENT_URI

The content:// style URI for this table.

SQL selection is not supported for query(Uri, String[], Bundle, CancellationSignal), update(Uri, ContentValues, String, String[]) and delete(Uri, String, String[]) operations.

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.