TvContractCompat.Programs

public final class TvContractCompat.Programs implements TvContractCompat.BaseTvColumns


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 types

Canonical genres for TV programs.

Constants

static final String
COLUMN_AUDIO_LANGUAGE = "audio_language"

The comma-separated audio languages of this TV program.

static final String
COLUMN_BROADCAST_GENRE = "broadcast_genre"

The comma-separated genre string of this TV program.

static final String
COLUMN_CANONICAL_GENRE = "canonical_genre"

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

static final String
COLUMN_CHANNEL_ID = "channel_id"

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

static final String
COLUMN_CONTENT_RATING = "content_rating"

The comma-separated content ratings of this TV program.

static final String
COLUMN_END_TIME_UTC_MILLIS = "end_time_utc_millis"

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

static final String
COLUMN_EPISODE_DISPLAY_NUMBER = "episode_display_number"

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

static final String
COLUMN_EPISODE_NUMBER = "episode_number"

This field is deprecated.

Use COLUMN_EPISODE_DISPLAY_NUMBER instead.

static final String
COLUMN_EPISODE_TITLE = "episode_title"

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

static final String
COLUMN_EVENT_ID = "event_id"

The event ID of this TV program.

static final String
COLUMN_GLOBAL_CONTENT_ID = "global_content_id"

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

static final String
COLUMN_INTERNAL_PROVIDER_DATA = "internal_provider_data"

Internal data used by individual TV input services.

static final String
COLUMN_INTERNAL_PROVIDER_FLAG1 = "internal_provider_flag1"

Internal integer flag used by individual TV input services.

static final String
COLUMN_INTERNAL_PROVIDER_FLAG2 = "internal_provider_flag2"

Internal integer flag used by individual TV input services.

static final String
COLUMN_INTERNAL_PROVIDER_FLAG3 = "internal_provider_flag3"

Internal integer flag used by individual TV input services.

static final String
COLUMN_INTERNAL_PROVIDER_FLAG4 = "internal_provider_flag4"

Internal integer flag used by individual TV input services.

static final String
COLUMN_LONG_DESCRIPTION = "long_description"

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

static final String
COLUMN_POSTER_ART_URI = "poster_art_uri"

The URI for the poster art of this TV program.

static final String
COLUMN_RECORDING_PROHIBITED = "recording_prohibited"

The flag indicating whether recording of this program is prohibited.

static final String
COLUMN_REVIEW_RATING = "review_rating"

The review rating score for this program.

static final String
COLUMN_REVIEW_RATING_STYLE = "review_rating_style"

The review rating score style used for COLUMN_REVIEW_RATING.

static final String
COLUMN_SEARCHABLE = "searchable"

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

static final String
COLUMN_SEASON_DISPLAY_NUMBER = "season_display_number"

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

static final String
COLUMN_SEASON_NUMBER = "season_number"

This field is deprecated.

Use COLUMN_SEASON_DISPLAY_NUMBER instead.

static final String
COLUMN_SEASON_TITLE = "season_title"

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

static final String
COLUMN_SERIES_ID = "series_id"

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

static final String
COLUMN_SHORT_DESCRIPTION = "short_description"

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

static final String
COLUMN_START_TIME_UTC_MILLIS = "start_time_utc_millis"

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

static final String
COLUMN_THUMBNAIL_URI = "thumbnail_uri"

The URI for the thumbnail of this TV program.

static final String
COLUMN_TITLE = "title"

The title of this TV program.

static final String
COLUMN_VERSION_NUMBER = "version_number"

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

static final String
COLUMN_VIDEO_HEIGHT = "video_height"

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

static final String
COLUMN_VIDEO_WIDTH = "video_width"

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

static final String
CONTENT_ITEM_TYPE = "vnd.android.cursor.item/program"

The MIME type of a single TV program.

static final String
CONTENT_TYPE = "vnd.android.cursor.dir/program"

The MIME type of a directory of TV programs.

static final Uri

The content:// style URI for this table.

static final int

The review rating style for 0 to 100 point system.

static final int

The review rating style for five star rating.

static final int

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

Inherited Constants

From android.provider.BaseColumns
static final String
_COUNT = "_count"
static final String
_ID = "_id"
From androidx.tvprovider.media.tv.TvContractCompat.BaseTvColumns
static final String
COLUMN_PACKAGE_NAME = "package_name"

The name of the package that owns the current row.

Constants

COLUMN_AUDIO_LANGUAGE

Added in 1.1.0-alpha02
public static final String COLUMN_AUDIO_LANGUAGE = "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

COLUMN_BROADCAST_GENRE

Added in 1.1.0-alpha02
public static final String COLUMN_BROADCAST_GENRE = "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 to create a text that can be stored in this column. Use decode to get the broadcast genre strings from the text stored in the column.

Type: TEXT

See also
encode
decode

COLUMN_CANONICAL_GENRE

Added in 1.1.0-alpha02
public static final String COLUMN_CANONICAL_GENRE = "canonical_genre"

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

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

Type: TEXT

COLUMN_CHANNEL_ID

Added in 1.1.0-alpha02
public static final String COLUMN_CHANNEL_ID = "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)

COLUMN_CONTENT_RATING

Added in 1.1.0-alpha02
public static final String COLUMN_CONTENT_RATING = "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

COLUMN_END_TIME_UTC_MILLIS

Added in 1.1.0-alpha02
public static final String COLUMN_END_TIME_UTC_MILLIS = "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)

COLUMN_EPISODE_DISPLAY_NUMBER

Added in 1.1.0-alpha02
public static final String COLUMN_EPISODE_DISPLAY_NUMBER = "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

COLUMN_EPISODE_NUMBER

Added in 1.1.0-alpha02
Deprecated in 1.1.0-alpha02
public static final String COLUMN_EPISODE_NUMBER = "episode_number"

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

Can be empty.

Type: INTEGER

COLUMN_EPISODE_TITLE

Added in 1.1.0-alpha02
public static final String COLUMN_EPISODE_TITLE = "episode_title"

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

Can be empty.

Type: TEXT

COLUMN_EVENT_ID

Added in 1.1.0-alpha02
public static final String COLUMN_EVENT_ID = "event_id"

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

COLUMN_GLOBAL_CONTENT_ID

Added in 1.1.0-alpha02
public static final String COLUMN_GLOBAL_CONTENT_ID = "global_content_id"

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

COLUMN_INTERNAL_PROVIDER_DATA

Added in 1.1.0-alpha02
public static final String COLUMN_INTERNAL_PROVIDER_DATA = "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

COLUMN_INTERNAL_PROVIDER_FLAG1

Added in 1.1.0-alpha02
public static final String COLUMN_INTERNAL_PROVIDER_FLAG1 = "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

COLUMN_INTERNAL_PROVIDER_FLAG2

Added in 1.1.0-alpha02
public static final String COLUMN_INTERNAL_PROVIDER_FLAG2 = "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

COLUMN_INTERNAL_PROVIDER_FLAG3

Added in 1.1.0-alpha02
public static final String COLUMN_INTERNAL_PROVIDER_FLAG3 = "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

COLUMN_INTERNAL_PROVIDER_FLAG4

Added in 1.1.0-alpha02
public static final String COLUMN_INTERNAL_PROVIDER_FLAG4 = "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

COLUMN_LONG_DESCRIPTION

Added in 1.1.0-alpha02
public static final String COLUMN_LONG_DESCRIPTION = "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

COLUMN_POSTER_ART_URI

Added in 1.1.0-alpha02
public static final String COLUMN_POSTER_ART_URI = "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

COLUMN_RECORDING_PROHIBITED

Added in 1.1.0-alpha02
public static final String COLUMN_RECORDING_PROHIBITED = "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)

COLUMN_REVIEW_RATING

Added in 1.1.0-alpha02
public static final String COLUMN_REVIEW_RATING = "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

COLUMN_REVIEW_RATING_STYLE

Added in 1.1.0-alpha02
public static final String COLUMN_REVIEW_RATING_STYLE = "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

COLUMN_SEARCHABLE

Added in 1.1.0-alpha02
public static final String COLUMN_SEARCHABLE = "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)

COLUMN_SEASON_DISPLAY_NUMBER

Added in 1.1.0-alpha02
public static final String COLUMN_SEASON_DISPLAY_NUMBER = "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

COLUMN_SEASON_NUMBER

Added in 1.1.0-alpha02
Deprecated in 1.1.0-alpha02
public static final String COLUMN_SEASON_NUMBER = "season_number"

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

Can be empty.

Type: INTEGER

COLUMN_SEASON_TITLE

Added in 1.1.0-alpha02
public static final String COLUMN_SEASON_TITLE = "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

COLUMN_SERIES_ID

Added in 1.1.0-alpha02
public static final String COLUMN_SERIES_ID = "series_id"

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

COLUMN_SHORT_DESCRIPTION

Added in 1.1.0-alpha02
public static final String COLUMN_SHORT_DESCRIPTION = "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

COLUMN_START_TIME_UTC_MILLIS

Added in 1.1.0-alpha02
public static final String COLUMN_START_TIME_UTC_MILLIS = "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)

COLUMN_THUMBNAIL_URI

Added in 1.1.0-alpha02
public static final String COLUMN_THUMBNAIL_URI = "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

COLUMN_TITLE

Added in 1.1.0-alpha02
public static final String COLUMN_TITLE = "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

COLUMN_VERSION_NUMBER

Added in 1.1.0-alpha02
public static final String COLUMN_VERSION_NUMBER = "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

COLUMN_VIDEO_HEIGHT

Added in 1.1.0-alpha02
public static final String COLUMN_VIDEO_HEIGHT = "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

COLUMN_VIDEO_WIDTH

Added in 1.1.0-alpha02
public static final String COLUMN_VIDEO_WIDTH = "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

CONTENT_ITEM_TYPE

Added in 1.1.0-alpha02
public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/program"

The MIME type of a single TV program.

CONTENT_TYPE

Added in 1.1.0-alpha02
public static final String CONTENT_TYPE = "vnd.android.cursor.dir/program"

The MIME type of a directory of TV programs.

CONTENT_URI

Added in 1.1.0-alpha02
public static final Uri CONTENT_URI

The content:// style URI for this table.

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

REVIEW_RATING_STYLE_PERCENTAGE

Added in 1.1.0-alpha02
public static final int REVIEW_RATING_STYLE_PERCENTAGE = 2

The review rating style for 0 to 100 point system.

REVIEW_RATING_STYLE_STARS

Added in 1.1.0-alpha02
public static final int REVIEW_RATING_STYLE_STARS = 0

The review rating style for five star rating.

REVIEW_RATING_STYLE_THUMBS_UP_DOWN

Added in 1.1.0-alpha02
public static final int REVIEW_RATING_STYLE_THUMBS_UP_DOWN = 1

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