TvContractCompat.PreviewProgramColumns


interface TvContractCompat.PreviewProgramColumns

Known direct subclasses
TvContractCompat.PreviewPrograms

Column definitions for the preview TV programs table.

TvContractCompat.WatchNextPrograms

Column definitions for the "watch next" TV programs table.


Common columns for the tables of preview programs.

Summary

Constants

const Int

The aspect ratio for 16:9.

const Int

The aspect ratio for 1:1.

const Int

The aspect ratio for 2:3.

const Int

The aspect ratio for 3:2.

const Int

The aspect ratio for 3:4.

const Int

The aspect ratio for 4:3.

const Int

The aspect ratio for movie poster which is 1:1.441.

const Int

The availability for "available to this user".

const Int

The availability for free content.

const Int

The availability for free with ads content.

const Int

The availability for "free with subscription".

const Int

The availability for "paid content", either to-own or rental (user has not purchased/rented).

const Int

The availability for content already purchased by the user.

const String!
COLUMN_AUTHOR = "author"

The author or artist of this content.

const String!
COLUMN_AVAILABILITY = "availability"

The availability of this TV program.

const String!
COLUMN_BROWSABLE = "browsable"

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

const String!
COLUMN_CONTENT_ID = "content_id"

The content ID of this TV program.

const String!
COLUMN_DURATION_MILLIS = "duration_millis"

The duration (in milliseconds) of the original content of this preview program.

const String!
COLUMN_END_TIME_UTC_MILLIS = "end_time_utc_millis"

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

const String!
COLUMN_GENRE = "genre"

A genre(s) that are related to this TV program.

const String!
COLUMN_INTENT_URI = "intent_uri"

The intent URI which is launched when the preview program is selected.

const String!
COLUMN_INTERACTION_COUNT = "interaction_count"

The interaction count for this program.

const String!
COLUMN_INTERACTION_TYPE = "interaction_type"

The type of interaction for this TV program.

const String!
COLUMN_INTERNAL_PROVIDER_ID = "internal_provider_id"

The internal ID used by individual TV input services.

const String!
COLUMN_ITEM_COUNT = "item_count"

The count of the items included in this TV program.

const String!
COLUMN_LAST_PLAYBACK_POSITION_MILLIS = "last_playback_position_millis"

The last playback position (in milliseconds) of the original content of this preview program.

const String!
COLUMN_LIVE = "live"

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

const String!
COLUMN_LOGO_CONTENT_DESCRIPTION = "logo_content_description"

The content description of the logo of this TV program.

const String!
COLUMN_LOGO_URI = "logo_uri"

The URI for the logo of this TV program.

const String!
COLUMN_OFFER_PRICE = "offer_price"

The offer price of this TV program.

const String!
COLUMN_POSTER_ART_ASPECT_RATIO = "poster_art_aspect_ratio"

The aspect ratio of the poster art for this TV program.

const String!
COLUMN_PREVIEW_AUDIO_URI = "preview_audio_uri"

The URI for the preview audio.

const String!
COLUMN_PREVIEW_VIDEO_URI = "preview_video_uri"

The URI for the preview video.

const String!
COLUMN_RELEASE_DATE = "release_date"

The release date of this TV program.

const String!
COLUMN_STARTING_PRICE = "starting_price"

The starting price of this TV program.

const String!
COLUMN_START_TIME_UTC_MILLIS = "start_time_utc_millis"

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

const String!
COLUMN_THUMBNAIL_ASPECT_RATIO = "poster_thumbnail_aspect_ratio"

The aspect ratio of the thumbnail for this TV program.

const String!
COLUMN_TRANSIENT = "transient"

The flag indicating whether this program is transient or not.

const String!
COLUMN_TV_SERIES_ITEM_TYPE = "tv_series_item_type"

The TV series item type.

const String!
COLUMN_TYPE = "type"

The type of this program content.

const Int

The interaction type for "fans".

const Int

The interaction type for "followers".

const Int

The interaction type for "likes".

const Int

The interaction type for "listens".

const Int

The interaction type for "thumbs".

const Int

The interaction type for "viewers".

const Int

The interaction type for "views".

const Int

The TV series item type for chapter.

const Int

The TV series item type for episode.

const Int

The program type for album.

const Int

The program type for artist.

const Int

The program type for channel.

const Int

The program type for clip.

const Int

The program type for event.

const Int

The program type for game.

const Int

The program type for movie.

const Int

The program type for playlist.

const Int

The program type for station.

const Int

The program type for track.

const Int

The program type for TV episode.

const Int

The program type for TV season.

const Int

The program type for TV series.

Constants

ASPECT_RATIO_16_9

Added in 1.1.0-beta01
const val ASPECT_RATIO_16_9 = 0: Int

The aspect ratio for 16:9.

ASPECT_RATIO_1_1

Added in 1.1.0-beta01
const val ASPECT_RATIO_1_1 = 3: Int

The aspect ratio for 1:1.

ASPECT_RATIO_2_3

Added in 1.1.0-beta01
const val ASPECT_RATIO_2_3 = 4: Int

The aspect ratio for 2:3.

ASPECT_RATIO_3_2

Added in 1.1.0-beta01
const val ASPECT_RATIO_3_2 = 1: Int

The aspect ratio for 3:2.

ASPECT_RATIO_3_4

Added in 1.1.0-beta01
const val ASPECT_RATIO_3_4 = 6: Int

The aspect ratio for 3:4.

ASPECT_RATIO_4_3

Added in 1.1.0-beta01
const val ASPECT_RATIO_4_3 = 2: Int

The aspect ratio for 4:3.

ASPECT_RATIO_MOVIE_POSTER

Added in 1.1.0-beta01
const val ASPECT_RATIO_MOVIE_POSTER = 5: Int

The aspect ratio for movie poster which is 1:1.441.

AVAILABILITY_AVAILABLE

Added in 1.1.0-beta01
const val AVAILABILITY_AVAILABLE = 0: Int

The availability for "available to this user".

AVAILABILITY_FREE

Added in 1.1.0-beta01
const val AVAILABILITY_FREE = 4: Int

The availability for free content.

AVAILABILITY_FREE_WITH_ADS

Added in 1.1.0-beta01
const val AVAILABILITY_FREE_WITH_ADS = 5: Int

The availability for free with ads content.

AVAILABILITY_FREE_WITH_SUBSCRIPTION

Added in 1.1.0-beta01
const val AVAILABILITY_FREE_WITH_SUBSCRIPTION = 1: Int

The availability for "free with subscription".

AVAILABILITY_PAID_CONTENT

Added in 1.1.0-beta01
const val AVAILABILITY_PAID_CONTENT = 2: Int

The availability for "paid content", either to-own or rental (user has not purchased/rented).

AVAILABILITY_PURCHASED

Added in 1.1.0-beta01
const val AVAILABILITY_PURCHASED = 3: Int

The availability for content already purchased by the user.

COLUMN_AUTHOR

Added in 1.1.0-beta01
const val COLUMN_AUTHOR = "author": String!

The author or artist of this content.

Type: TEXT

COLUMN_AVAILABILITY

Added in 1.1.0-beta01
const val COLUMN_AVAILABILITY = "availability": String!

The availability of this TV program.

The value should match one of the followings: AVAILABILITY_AVAILABLE, AVAILABILITY_FREE_WITH_SUBSCRIPTION, AVAILABILITY_PAID_CONTENT, AVAILABILITY_PURCHASED and AVAILABILITY_FREE.

Type: INTEGER

COLUMN_BROWSABLE

Added in 1.1.0-beta01
const val COLUMN_BROWSABLE = "browsable": String!

The flag indicating whether this TV program 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 that the program is browsable and can be shown to users in the UI. A value of 0 indicates that the program should be hidden from users and the application who changes this value to 0 should send ACTION_WATCH_NEXT_PROGRAM_BROWSABLE_DISABLED to the owner of the program to notify this change.

This value is set to 1 (browsable) by default.

Type: INTEGER (boolean)

COLUMN_CONTENT_ID

Added in 1.1.0-beta01
const val COLUMN_CONTENT_ID = "content_id": String!

The content ID of this TV program.

A public ID of the content which allows the application to apply the same operation to all the program copies in different channels.

Can be empty.

Type: TEXT

COLUMN_DURATION_MILLIS

Added in 1.1.0-beta01
const val COLUMN_DURATION_MILLIS = "duration_millis": String!

The duration (in milliseconds) of the original content of this preview program.

Can be empty.

Type: INTEGER

COLUMN_END_TIME_UTC_MILLIS

Added in 1.1.0-beta01
const val COLUMN_END_TIME_UTC_MILLIS = "end_time_utc_millis": String!

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

Should be empty if this program is not live.

Type: INTEGER (long)

See also
COLUMN_LIVE

COLUMN_GENRE

Added in 1.1.0-beta01
const val COLUMN_GENRE = "genre": String!

A genre(s) that are related to this TV program.

A short freeform description of the genre(s) of the program. Usually a comma seperated list of a few genres. For example: Drama, Sci-Fi.

Can be empty.

Type: TEXT

COLUMN_INTENT_URI

Added in 1.1.0-beta01
const val COLUMN_INTENT_URI = "intent_uri": String!

The intent URI which is launched when the preview program is selected.

The URI is created using toUri with URI_INTENT_SCHEME and converted back to the original intent with parseUri. The intent is launched when the user selects the preview program item.

Can be empty.

Type: TEXT

COLUMN_INTERACTION_COUNT

Added in 1.1.0-beta01
const val COLUMN_INTERACTION_COUNT = "interaction_count": String!

The interaction count for this program.

This indicates the number of times interaction has happened.

Type: INTEGER (long)

COLUMN_INTERACTION_TYPE

Added in 1.1.0-beta01
const val COLUMN_INTERACTION_TYPE = "interaction_type": String!

The type of interaction for this TV program.

The value should match one of the followings: INTERACTION_TYPE_LISTENS, INTERACTION_TYPE_FOLLOWERS, INTERACTION_TYPE_FANS, INTERACTION_TYPE_LIKES, INTERACTION_TYPE_THUMBS, INTERACTION_TYPE_VIEWS, and INTERACTION_TYPE_VIEWERS.

Type: INTEGER

COLUMN_INTERNAL_PROVIDER_ID

Added in 1.1.0-beta01
const val COLUMN_INTERNAL_PROVIDER_ID = "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

COLUMN_ITEM_COUNT

Added in 1.1.0-beta01
const val COLUMN_ITEM_COUNT = "item_count": String!

The count of the items included in this TV program.

This is only relevant if the program represents a collection of items such as series, episodes, or music tracks.

Type: INTEGER

COLUMN_LAST_PLAYBACK_POSITION_MILLIS

Added in 1.1.0-beta01
const val COLUMN_LAST_PLAYBACK_POSITION_MILLIS = "last_playback_position_millis": String!

The last playback position (in milliseconds) of the original content of this preview program.

Can be empty.

Type: INTEGER

COLUMN_LIVE

Added in 1.1.0-beta01
const val COLUMN_LIVE = "live": String!

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

A value of 1 indicates that the content is airing and should be consumed now, a value of 0 indicates that the content is off the air and does not need to be consumed at the present time. If not specified, the value is set to 0 (not live) by default.

Type: INTEGER (boolean)

COLUMN_LOGO_CONTENT_DESCRIPTION

Added in 1.1.0-beta01
const val COLUMN_LOGO_CONTENT_DESCRIPTION = "logo_content_description": String!

The content description of the logo of this TV program.

A description of the logo shown on the program used in accessibility mode.

Can be empty.

Type: TEXT

See also
COLUMN_LOGO_URI

COLUMN_LOGO_URI

Added in 1.1.0-beta01
const val COLUMN_LOGO_URI = "logo_uri": String!

The URI for the logo of this TV program.

This is a small badge shown on top of the poster art or thumbnail representing the source of the content.

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

Can be empty.

Type: TEXT

COLUMN_OFFER_PRICE

Added in 1.1.0-beta01
const val COLUMN_OFFER_PRICE = "offer_price": String!

The offer price of this TV program.

This is the promotional cost of the content. It is only used if the availability of the program is AVAILABILITY_PAID_CONTENT.

Type: TEXT

COLUMN_POSTER_ART_ASPECT_RATIO

Added in 1.1.0-beta01
const val COLUMN_POSTER_ART_ASPECT_RATIO = "poster_art_aspect_ratio": String!

The aspect ratio of the poster art for this TV program.

The value should match one of the followings: ASPECT_RATIO_16_9, ASPECT_RATIO_3_2, ASPECT_RATIO_4_3, ASPECT_RATIO_1_1, ASPECT_RATIO_2_3, ASPECT_RATIO_MOVIE_POSTER, and ASPECT_RATIO_3_4.

Type: INTEGER

COLUMN_PREVIEW_AUDIO_URI

Added in 1.1.0-beta01
const val COLUMN_PREVIEW_AUDIO_URI = "preview_audio_uri": String!

The URI for the preview audio.

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

Can be empty.

Type: TEXT

COLUMN_PREVIEW_VIDEO_URI

Added in 1.1.0-beta01
const val COLUMN_PREVIEW_VIDEO_URI = "preview_video_uri": String!

The URI for the preview video.

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

Can be empty.

Type: TEXT

COLUMN_RELEASE_DATE

Added in 1.1.0-beta01
const val COLUMN_RELEASE_DATE = "release_date": String!

The release date of this TV program.

The value should be in one of the following formats: "yyyy", "yyyy-MM-dd", and "yyyy-MM-ddTHH:mm:ssZ" (UTC in ISO 8601).

Type: TEXT

COLUMN_STARTING_PRICE

Added in 1.1.0-beta01
const val COLUMN_STARTING_PRICE = "starting_price": String!

The starting price of this TV program.

This indicates the lowest regular acquisition cost of the content. It is only used if the availability of the program is AVAILABILITY_PAID_CONTENT or AVAILABILITY_FREE.

Type: TEXT

COLUMN_START_TIME_UTC_MILLIS

Added in 1.1.0-beta01
const val COLUMN_START_TIME_UTC_MILLIS = "start_time_utc_millis": String!

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

Should be empty if this program is not live.

Type: INTEGER (long)

See also
COLUMN_LIVE

COLUMN_THUMBNAIL_ASPECT_RATIO

Added in 1.1.0-beta01
const val COLUMN_THUMBNAIL_ASPECT_RATIO = "poster_thumbnail_aspect_ratio": String!

The aspect ratio of the thumbnail for this TV program.

The value should match one of the followings: ASPECT_RATIO_16_9, ASPECT_RATIO_3_2, ASPECT_RATIO_4_3, ASPECT_RATIO_1_1, ASPECT_RATIO_2_3, ASPECT_RATIO_MOVIE_POSTER, and ASPECT_RATIO_3_4.

Type: INTEGER

COLUMN_TRANSIENT

Added in 1.1.0-beta01
const val COLUMN_TRANSIENT = "transient": String!

The flag indicating whether this program 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)

See also
COLUMN_TRANSIENT

COLUMN_TV_SERIES_ITEM_TYPE

Added in 1.1.0-beta01
const val COLUMN_TV_SERIES_ITEM_TYPE = "tv_series_item_type": String!

The TV series item type. Can be one of the followings: TV_SERIES_ITEM_TYPE_EPISODE, TV_SERIES_ITEM_TYPE_CHAPTER

This is used to indicate whether a TV season has the sub-division as episode or chapter. If this is not set, it is default to TV_SERIES_ITEM_TYPE_EPISODE

Type: INTEGER

COLUMN_TYPE

Added in 1.1.0-beta01
const val COLUMN_TYPE = "type": String!

The type of this program content.

The value should match one of the followings: TYPE_MOVIE, TYPE_TV_SERIES, TYPE_TV_SEASON, TYPE_TV_EPISODE, TYPE_CLIP, TYPE_EVENT, TYPE_CHANNEL, TYPE_TRACK, TYPE_ALBUM, TYPE_ARTIST, TYPE_PLAYLIST, TYPE_STATION, and TYPE_GAME.

This is a required field if the program is from a TYPE_PREVIEW channel.

Type: INTEGER

INTERACTION_TYPE_FANS

Added in 1.1.0-beta01
const val INTERACTION_TYPE_FANS = 3: Int

The interaction type for "fans".

INTERACTION_TYPE_FOLLOWERS

Added in 1.1.0-beta01
const val INTERACTION_TYPE_FOLLOWERS = 2: Int

The interaction type for "followers".

INTERACTION_TYPE_LIKES

Added in 1.1.0-beta01
const val INTERACTION_TYPE_LIKES = 4: Int

The interaction type for "likes".

INTERACTION_TYPE_LISTENS

Added in 1.1.0-beta01
const val INTERACTION_TYPE_LISTENS = 1: Int

The interaction type for "listens".

INTERACTION_TYPE_THUMBS

Added in 1.1.0-beta01
const val INTERACTION_TYPE_THUMBS = 5: Int

The interaction type for "thumbs".

INTERACTION_TYPE_VIEWERS

Added in 1.1.0-beta01
const val INTERACTION_TYPE_VIEWERS = 6: Int

The interaction type for "viewers".

INTERACTION_TYPE_VIEWS

Added in 1.1.0-beta01
const val INTERACTION_TYPE_VIEWS = 0: Int

The interaction type for "views".

TV_SERIES_ITEM_TYPE_CHAPTER

Added in 1.1.0-beta01
const val TV_SERIES_ITEM_TYPE_CHAPTER = 1: Int

The TV series item type for chapter.

TV_SERIES_ITEM_TYPE_EPISODE

Added in 1.1.0-beta01
const val TV_SERIES_ITEM_TYPE_EPISODE = 0: Int

The TV series item type for episode.

TYPE_ALBUM

Added in 1.1.0-beta01
const val TYPE_ALBUM = 8: Int

The program type for album.

See also
COLUMN_TYPE

TYPE_ARTIST

Added in 1.1.0-beta01
const val TYPE_ARTIST = 9: Int

The program type for artist.

See also
COLUMN_TYPE

TYPE_CHANNEL

Added in 1.1.0-beta01
const val TYPE_CHANNEL = 6: Int

The program type for channel.

See also
COLUMN_TYPE

TYPE_CLIP

Added in 1.1.0-beta01
const val TYPE_CLIP = 4: Int

The program type for clip.

See also
COLUMN_TYPE

TYPE_EVENT

Added in 1.1.0-beta01
const val TYPE_EVENT = 5: Int

The program type for event.

See also
COLUMN_TYPE

TYPE_GAME

Added in 1.1.0-beta01
const val TYPE_GAME = 12: Int

The program type for game.

See also
COLUMN_TYPE

TYPE_MOVIE

Added in 1.1.0-beta01
const val TYPE_MOVIE = 0: Int

The program type for movie.

See also
COLUMN_TYPE

TYPE_PLAYLIST

Added in 1.1.0-beta01
const val TYPE_PLAYLIST = 10: Int

The program type for playlist.

See also
COLUMN_TYPE

TYPE_STATION

Added in 1.1.0-beta01
const val TYPE_STATION = 11: Int

The program type for station.

See also
COLUMN_TYPE

TYPE_TRACK

Added in 1.1.0-beta01
const val TYPE_TRACK = 7: Int

The program type for track.

See also
COLUMN_TYPE

TYPE_TV_EPISODE

Added in 1.1.0-beta01
const val TYPE_TV_EPISODE = 3: Int

The program type for TV episode.

See also
COLUMN_TYPE

TYPE_TV_SEASON

Added in 1.1.0-beta01
const val TYPE_TV_SEASON = 2: Int

The program type for TV season.

See also
COLUMN_TYPE

TYPE_TV_SERIES

Added in 1.1.0-beta01
const val TYPE_TV_SERIES = 1: Int

The program type for TV series.

See also
COLUMN_TYPE