Most visited

Recently visited

Added in API level 24

TvContract.RecordedPrograms

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

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


Column definitions for the recorded TV programs table.

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

Summary

Constants

String COLUMN_AUDIO_LANGUAGE

The comma-separated audio languages of this recorded TV program.

String COLUMN_BROADCAST_GENRE

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

String COLUMN_CANONICAL_GENRE

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

String COLUMN_CHANNEL_ID

The ID of the TV channel that provided this recorded TV program.

String COLUMN_CONTENT_RATING

The comma-separated content ratings of this recorded TV program.

String COLUMN_END_TIME_UTC_MILLIS

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

String COLUMN_EPISODE_DISPLAY_NUMBER

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

String COLUMN_EPISODE_TITLE

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

String COLUMN_INPUT_ID

The ID of the TV input service that is associated with this recorded program.

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 recorded 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 recorded TV program.

String COLUMN_RECORDING_DATA_BYTES

The data size (in bytes) for this recorded program.

String COLUMN_RECORDING_DATA_URI

The URI of the recording data for this recorded program.

String COLUMN_RECORDING_DURATION_MILLIS

The duration (in milliseconds) of this recorded program.

String COLUMN_RECORDING_EXPIRE_TIME_UTC_MILLIS

The expiration time for this recorded program, in milliseconds since the epoch.

String COLUMN_SEARCHABLE

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

String COLUMN_SEASON_DISPLAY_NUMBER

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

String COLUMN_SEASON_TITLE

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

String COLUMN_SHORT_DESCRIPTION

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

String COLUMN_START_TIME_UTC_MILLIS

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

String COLUMN_THUMBNAIL_URI

The URI for the thumbnail of this recorded TV program.

String COLUMN_TITLE

The title of this recorded 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 recorded TV program, in the unit of pixels.

String COLUMN_VIDEO_WIDTH

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

String CONTENT_ITEM_TYPE

The MIME type of a single recorded TV program.

String CONTENT_TYPE

The MIME type of a directory of recorded TV programs.

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 24
String COLUMN_AUDIO_LANGUAGE

The comma-separated audio languages of this recorded TV program.

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

Type: TEXT

See also:

Constant Value: "audio_language"

COLUMN_BROADCAST_GENRE

Added in API level 24
String COLUMN_BROADCAST_GENRE

The comma-separated genre string of this recorded 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

See also:

Constant Value: "broadcast_genre"

COLUMN_CANONICAL_GENRE

Added in API level 24
String COLUMN_CANONICAL_GENRE

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

Canonical genres are defined in TvContract.Programs.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

See also:

Constant Value: "canonical_genre"

COLUMN_CHANNEL_ID

Added in API level 24
String COLUMN_CHANNEL_ID

The ID of the TV channel that provided this recorded TV program.

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

This is a required field.

Type: INTEGER (long)

See also:

Constant Value: "channel_id"

COLUMN_CONTENT_RATING

Added in API level 24
String COLUMN_CONTENT_RATING

The comma-separated content ratings of this recorded TV program.

This is used to describe the content rating(s) of this recorded program. Each comma-separated content rating sub-string should be generated by calling flattenToString(). Note that in most cases the recorded 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 recorded 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

See also:

Constant Value: "content_rating"

COLUMN_END_TIME_UTC_MILLIS

Added in API level 24
String COLUMN_END_TIME_UTC_MILLIS

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

Type: INTEGER (long)

See also:

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

Added in API level 24
String COLUMN_EPISODE_TITLE

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

Can be empty.

Type: TEXT

See also:

Constant Value: "episode_title"

COLUMN_INPUT_ID

Added in API level 24
String COLUMN_INPUT_ID

The ID of the TV input service that is associated with this recorded program.

Use buildInputId(ComponentName) to build the ID.

This is a required field.

Type: TEXT

Constant Value: "input_id"

COLUMN_INTERNAL_PROVIDER_DATA

Added in API level 24
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

See also:

Constant Value: "internal_provider_data"

COLUMN_INTERNAL_PROVIDER_FLAG1

Added in API level 24
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

See also:

Constant Value: "internal_provider_flag1"

COLUMN_INTERNAL_PROVIDER_FLAG2

Added in API level 24
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

See also:

Constant Value: "internal_provider_flag2"

COLUMN_INTERNAL_PROVIDER_FLAG3

Added in API level 24
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

See also:

Constant Value: "internal_provider_flag3"

COLUMN_INTERNAL_PROVIDER_FLAG4

Added in API level 24
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

See also:

Constant Value: "internal_provider_flag4"

COLUMN_LONG_DESCRIPTION

Added in API level 24
String COLUMN_LONG_DESCRIPTION

The detailed, lengthy description of this recorded 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

See also:

Constant Value: "long_description"

COLUMN_POSTER_ART_URI

Added in API level 24
String COLUMN_POSTER_ART_URI

The URI for the poster art of this recorded 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

See also:

Constant Value: "poster_art_uri"

COLUMN_RECORDING_DATA_BYTES

Added in API level 24
String COLUMN_RECORDING_DATA_BYTES

The data size (in bytes) for this recorded program.

Together with COLUMN_RECORDING_DATA_URI, applications can use this information to manage recording storage.

Type: INTEGER (long)

See also:

Constant Value: "recording_data_bytes"

COLUMN_RECORDING_DATA_URI

Added in API level 24
String COLUMN_RECORDING_DATA_URI

The URI of the recording data for this recorded program.

Together with COLUMN_RECORDING_DATA_BYTES, applications can use this information to manage recording storage. The URI should indicate a file or directory with the scheme SCHEME_FILE.

Type: TEXT

See also:

Constant Value: "recording_data_uri"

COLUMN_RECORDING_DURATION_MILLIS

Added in API level 24
String COLUMN_RECORDING_DURATION_MILLIS

The duration (in milliseconds) of this recorded program.

The actual duration of the recorded program can differ from the one calculated by COLUMN_END_TIME_UTC_MILLIS - COLUMN_START_TIME_UTC_MILLIS as program recording can be interrupted in the middle for some reason, resulting in a partially recorded program, which is still playable.

Type: INTEGER

Constant Value: "recording_duration_millis"

COLUMN_RECORDING_EXPIRE_TIME_UTC_MILLIS

Added in API level 24
String COLUMN_RECORDING_EXPIRE_TIME_UTC_MILLIS

The expiration time for this recorded program, in milliseconds since the epoch.

Recorded TV programs do not expire by default unless explicitly requested by the user or the user allows applications to delete them in order to free up disk space for future recording. However, some TV content can have expiration date set by the content provider when recorded. This field is used to indicate such a restriction.

Can be empty.

Type: INTEGER (long)

Constant Value: "recording_expire_time_utc_millis"

COLUMN_SEARCHABLE

Added in API level 24
String COLUMN_SEARCHABLE

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

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

Type: INTEGER (boolean)

See also:

Constant Value: "searchable"

COLUMN_SEASON_DISPLAY_NUMBER

Added in API level 24
String COLUMN_SEASON_DISPLAY_NUMBER

The season display number of this recorded 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_TITLE

Added in API level 24
String COLUMN_SEASON_TITLE

The title of the season for this recorded 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 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 24
String COLUMN_SHORT_DESCRIPTION

The short description of this recorded 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

See also:

Constant Value: "short_description"

COLUMN_START_TIME_UTC_MILLIS

Added in API level 24
String COLUMN_START_TIME_UTC_MILLIS

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

Type: INTEGER (long)

See also:

Constant Value: "start_time_utc_millis"

COLUMN_THUMBNAIL_URI

Added in API level 24
String COLUMN_THUMBNAIL_URI

The URI for the thumbnail of this recorded 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

See also:

Constant Value: "thumbnail_uri"

COLUMN_TITLE

Added in API level 24
String COLUMN_TITLE

The title of this recorded TV program.

If this recorded 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_EPISODE_DISPLAY_NUMBER, and COLUMN_EPISODE_TITLE) are filled in.

Type: TEXT

See also:

Constant Value: "title"

COLUMN_VERSION_NUMBER

Added in API level 24
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

See also:

Constant Value: "version_number"

COLUMN_VIDEO_HEIGHT

Added in API level 24
String COLUMN_VIDEO_HEIGHT

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

Together with COLUMN_VIDEO_WIDTH this is used to determine the video resolution of the current recorded TV program. Can be empty if it is not known or the recorded program does not convey any video.

Type: INTEGER

See also:

Constant Value: "video_height"

COLUMN_VIDEO_WIDTH

Added in API level 24
String COLUMN_VIDEO_WIDTH

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

Together with COLUMN_VIDEO_HEIGHT this is used to determine the video resolution of the current recorded TV program. Can be empty if it is not known or the recorded program does not convey any video.

Type: INTEGER

See also:

Constant Value: "video_width"

CONTENT_ITEM_TYPE

Added in API level 24
String CONTENT_ITEM_TYPE

The MIME type of a single recorded TV program.

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

CONTENT_TYPE

Added in API level 24
String CONTENT_TYPE

The MIME type of a directory of recorded TV programs.

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

Fields

CONTENT_URI

Added in API level 24
Uri CONTENT_URI

The content:// style URI for this table.