public interface

TvContractCompat.PreviewProgramColumns

 androidx.tvprovider.media.tv.TvContractCompat.PreviewProgramColumns

Subclasses:

TvContractCompat.PreviewPrograms, TvContractCompat.WatchNextPrograms

Overview

Common columns for the tables of preview programs.

Summary

Fields
public static final intASPECT_RATIO_1_1

The aspect ratio for 1:1.

public static final intASPECT_RATIO_16_9

The aspect ratio for 16:9.

public static final intASPECT_RATIO_2_3

The aspect ratio for 2:3.

public static final intASPECT_RATIO_3_2

The aspect ratio for 3:2.

public static final intASPECT_RATIO_4_3

The aspect ratio for 4:3.

public static final intASPECT_RATIO_MOVIE_POSTER

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

public static final intAVAILABILITY_AVAILABLE

The availability for "available to this user".

public static final intAVAILABILITY_FREE

The availability for free content.

public static final intAVAILABILITY_FREE_WITH_SUBSCRIPTION

The availability for "free with subscription".

public static final intAVAILABILITY_PAID_CONTENT

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

public static final intAVAILABILITY_PURCHASED

The availability for content already purchased by the user.

public static final java.lang.StringCOLUMN_AUTHOR

The author or artist of this content.

public static final java.lang.StringCOLUMN_AVAILABILITY

The availability of this TV program.

public static final java.lang.StringCOLUMN_BROWSABLE

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

public static final java.lang.StringCOLUMN_CONTENT_ID

The content ID of this TV program.

public static final java.lang.StringCOLUMN_DURATION_MILLIS

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

public static final java.lang.StringCOLUMN_END_TIME_UTC_MILLIS

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

public static final java.lang.StringCOLUMN_GENRE

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

public static final java.lang.StringCOLUMN_INTENT_URI

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

public static final java.lang.StringCOLUMN_INTERACTION_COUNT

The interaction count for this program.

public static final java.lang.StringCOLUMN_INTERACTION_TYPE

The type of interaction for this TV program.

public static final java.lang.StringCOLUMN_INTERNAL_PROVIDER_ID

The internal ID used by individual TV input services.

public static final java.lang.StringCOLUMN_ITEM_COUNT

The count of the items included in this TV program.

public static final java.lang.StringCOLUMN_LAST_PLAYBACK_POSITION_MILLIS

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

public static final java.lang.StringCOLUMN_LIVE

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

public static final java.lang.StringCOLUMN_LOGO_CONTENT_DESCRIPTION

The content description of the logo of this TV program.

public static final java.lang.StringCOLUMN_LOGO_URI

The URI for the logo of this TV program.

public static final java.lang.StringCOLUMN_OFFER_PRICE

The offer price of this TV program.

public static final java.lang.StringCOLUMN_POSTER_ART_ASPECT_RATIO

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

public static final java.lang.StringCOLUMN_PREVIEW_AUDIO_URI

The URI for the preview audio.

public static final java.lang.StringCOLUMN_PREVIEW_VIDEO_URI

The URI for the preview video.

public static final java.lang.StringCOLUMN_RELEASE_DATE

The release date of this TV program.

public static final java.lang.StringCOLUMN_START_TIME_UTC_MILLIS

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

public static final java.lang.StringCOLUMN_STARTING_PRICE

The starting price of this TV program.

public static final java.lang.StringCOLUMN_THUMBNAIL_ASPECT_RATIO

The aspect ratio of the thumbnail for this TV program.

public static final java.lang.StringCOLUMN_TRANSIENT

The flag indicating whether this program is transient or not.

public static final java.lang.StringCOLUMN_TV_SERIES_ITEM_TYPE

The TV series item type.

public static final java.lang.StringCOLUMN_TYPE

The type of this program content.

public static final intINTERACTION_TYPE_FANS

The interaction type for "fans".

public static final intINTERACTION_TYPE_FOLLOWERS

The interaction type for "followers".

public static final intINTERACTION_TYPE_LIKES

The interaction type for "likes".

public static final intINTERACTION_TYPE_LISTENS

The interaction type for "listens".

public static final intINTERACTION_TYPE_THUMBS

The interaction type for "thumbs".

public static final intINTERACTION_TYPE_VIEWERS

The interaction type for "viewers".

public static final intINTERACTION_TYPE_VIEWS

The interaction type for "views".

public static final intTV_SERIES_ITEM_TYPE_CHAPTER

The TV series item type for chapter.

public static final intTV_SERIES_ITEM_TYPE_EPISODE

The TV series item type for episode.

public static final intTYPE_ALBUM

The program type for album.

public static final intTYPE_ARTIST

The program type for artist.

public static final intTYPE_CHANNEL

The program type for channel.

public static final intTYPE_CLIP

The program type for clip.

public static final intTYPE_EVENT

The program type for event.

public static final intTYPE_GAME

The program type for game.

public static final intTYPE_MOVIE

The program type for movie.

public static final intTYPE_PLAYLIST

The program type for playlist.

public static final intTYPE_STATION

The program type for station.

public static final intTYPE_TRACK

The program type for track.

public static final intTYPE_TV_EPISODE

The program type for TV episode.

public static final intTYPE_TV_SEASON

The program type for TV season.

public static final intTYPE_TV_SERIES

The program type for TV series.

Fields

public static final int TYPE_MOVIE

The program type for movie.

See also: TvContractCompat.PreviewProgramColumns.COLUMN_TYPE

public static final int TYPE_TV_SERIES

The program type for TV series.

See also: TvContractCompat.PreviewProgramColumns.COLUMN_TYPE

public static final int TYPE_TV_SEASON

The program type for TV season.

See also: TvContractCompat.PreviewProgramColumns.COLUMN_TYPE

public static final int TYPE_TV_EPISODE

The program type for TV episode.

See also: TvContractCompat.PreviewProgramColumns.COLUMN_TYPE

public static final int TYPE_CLIP

The program type for clip.

See also: TvContractCompat.PreviewProgramColumns.COLUMN_TYPE

public static final int TYPE_EVENT

The program type for event.

See also: TvContractCompat.PreviewProgramColumns.COLUMN_TYPE

public static final int TYPE_CHANNEL

The program type for channel.

See also: TvContractCompat.PreviewProgramColumns.COLUMN_TYPE

public static final int TYPE_TRACK

The program type for track.

See also: TvContractCompat.PreviewProgramColumns.COLUMN_TYPE

public static final int TYPE_ALBUM

The program type for album.

See also: TvContractCompat.PreviewProgramColumns.COLUMN_TYPE

public static final int TYPE_ARTIST

The program type for artist.

See also: TvContractCompat.PreviewProgramColumns.COLUMN_TYPE

public static final int TYPE_PLAYLIST

The program type for playlist.

See also: TvContractCompat.PreviewProgramColumns.COLUMN_TYPE

public static final int TYPE_STATION

The program type for station.

See also: TvContractCompat.PreviewProgramColumns.COLUMN_TYPE

public static final int TYPE_GAME

The program type for game.

See also: TvContractCompat.PreviewProgramColumns.COLUMN_TYPE

public static final int TV_SERIES_ITEM_TYPE_EPISODE

The TV series item type for episode.

See also: TvContractCompat.PreviewProgramColumns.COLUMN_TV_SERIES_ITEM_TYPE

public static final int TV_SERIES_ITEM_TYPE_CHAPTER

The TV series item type for chapter.

See also: TvContractCompat.PreviewProgramColumns.COLUMN_TV_SERIES_ITEM_TYPE

public static final int ASPECT_RATIO_16_9

The aspect ratio for 16:9.

See also: TvContractCompat.PreviewProgramColumns.COLUMN_POSTER_ART_ASPECT_RATIO, TvContractCompat.PreviewProgramColumns.COLUMN_THUMBNAIL_ASPECT_RATIO

public static final int ASPECT_RATIO_3_2

The aspect ratio for 3:2.

See also: TvContractCompat.PreviewProgramColumns.COLUMN_POSTER_ART_ASPECT_RATIO, TvContractCompat.PreviewProgramColumns.COLUMN_THUMBNAIL_ASPECT_RATIO

public static final int ASPECT_RATIO_4_3

The aspect ratio for 4:3.

See also: TvContractCompat.PreviewProgramColumns.COLUMN_POSTER_ART_ASPECT_RATIO, TvContractCompat.PreviewProgramColumns.COLUMN_THUMBNAIL_ASPECT_RATIO

public static final int ASPECT_RATIO_1_1

The aspect ratio for 1:1.

See also: TvContractCompat.PreviewProgramColumns.COLUMN_POSTER_ART_ASPECT_RATIO, TvContractCompat.PreviewProgramColumns.COLUMN_THUMBNAIL_ASPECT_RATIO

public static final int ASPECT_RATIO_2_3

The aspect ratio for 2:3.

See also: TvContractCompat.PreviewProgramColumns.COLUMN_POSTER_ART_ASPECT_RATIO, TvContractCompat.PreviewProgramColumns.COLUMN_THUMBNAIL_ASPECT_RATIO

public static final int ASPECT_RATIO_MOVIE_POSTER

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

See also: TvContractCompat.PreviewProgramColumns.COLUMN_POSTER_ART_ASPECT_RATIO, TvContractCompat.PreviewProgramColumns.COLUMN_THUMBNAIL_ASPECT_RATIO

public static final int AVAILABILITY_AVAILABLE

The availability for "available to this user".

See also: TvContractCompat.PreviewProgramColumns.COLUMN_AVAILABILITY

public static final int AVAILABILITY_FREE_WITH_SUBSCRIPTION

The availability for "free with subscription".

See also: TvContractCompat.PreviewProgramColumns.COLUMN_AVAILABILITY

public static final int AVAILABILITY_PAID_CONTENT

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

See also: TvContractCompat.PreviewProgramColumns.COLUMN_AVAILABILITY

public static final int AVAILABILITY_PURCHASED

The availability for content already purchased by the user.

See also: TvContractCompat.PreviewProgramColumns.COLUMN_AVAILABILITY

public static final int AVAILABILITY_FREE

The availability for free content.

See also: TvContractCompat.PreviewProgramColumns.COLUMN_AVAILABILITY

public static final int INTERACTION_TYPE_VIEWS

The interaction type for "views".

See also: TvContractCompat.PreviewProgramColumns.COLUMN_INTERACTION_TYPE

public static final int INTERACTION_TYPE_LISTENS

The interaction type for "listens".

See also: TvContractCompat.PreviewProgramColumns.COLUMN_INTERACTION_TYPE

public static final int INTERACTION_TYPE_FOLLOWERS

The interaction type for "followers".

See also: TvContractCompat.PreviewProgramColumns.COLUMN_INTERACTION_TYPE

public static final int INTERACTION_TYPE_FANS

The interaction type for "fans".

See also: TvContractCompat.PreviewProgramColumns.COLUMN_INTERACTION_TYPE

public static final int INTERACTION_TYPE_LIKES

The interaction type for "likes".

See also: TvContractCompat.PreviewProgramColumns.COLUMN_INTERACTION_TYPE

public static final int INTERACTION_TYPE_THUMBS

The interaction type for "thumbs".

See also: TvContractCompat.PreviewProgramColumns.COLUMN_INTERACTION_TYPE

public static final int INTERACTION_TYPE_VIEWERS

The interaction type for "viewers".

See also: TvContractCompat.PreviewProgramColumns.COLUMN_INTERACTION_TYPE

public static final java.lang.String COLUMN_TYPE

The type of this program content.

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

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

Type: INTEGER

public static final java.lang.String COLUMN_TV_SERIES_ITEM_TYPE

The TV series item type. Can be one of the followings: TvContractCompat.PreviewProgramColumns.TV_SERIES_ITEM_TYPE_EPISODE, TvContractCompat.PreviewProgramColumns.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 TvContractCompat.PreviewProgramColumns.TV_SERIES_ITEM_TYPE_EPISODE

Type: INTEGER

public static final java.lang.String COLUMN_POSTER_ART_ASPECT_RATIO

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

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

Type: INTEGER

public static final java.lang.String COLUMN_THUMBNAIL_ASPECT_RATIO

The aspect ratio of the thumbnail for this TV program.

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

Type: INTEGER

public static final java.lang.String COLUMN_LOGO_URI

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:

  • content ()
  • android.resource ()
  • file ()

Can be empty.

Type: TEXT

public static final java.lang.String COLUMN_AVAILABILITY

The availability of this TV program.

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

Type: INTEGER

public static final java.lang.String COLUMN_STARTING_PRICE

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 TvContractCompat.PreviewProgramColumns.AVAILABILITY_PAID_CONTENT or TvContractCompat.PreviewProgramColumns.AVAILABILITY_FREE.

Type: TEXT

See also: TvContractCompat.PreviewProgramColumns.COLUMN_OFFER_PRICE

public static final java.lang.String COLUMN_OFFER_PRICE

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 TvContractCompat.PreviewProgramColumns.AVAILABILITY_PAID_CONTENT.

Type: TEXT

See also: TvContractCompat.PreviewProgramColumns.COLUMN_STARTING_PRICE

public static final java.lang.String COLUMN_RELEASE_DATE

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

public static final java.lang.String COLUMN_ITEM_COUNT

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

public static final java.lang.String COLUMN_LIVE

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)

public static final java.lang.String COLUMN_INTERNAL_PROVIDER_ID

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

public static final java.lang.String COLUMN_PREVIEW_VIDEO_URI

The URI for the preview video.

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

  • content ()
  • android.resource ()
  • file ()

Can be empty.

Type: TEXT

public static final java.lang.String COLUMN_LAST_PLAYBACK_POSITION_MILLIS

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

Can be empty.

Type: INTEGER

public static final java.lang.String COLUMN_DURATION_MILLIS

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

Can be empty.

Type: INTEGER

public static final java.lang.String COLUMN_INTENT_URI

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

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

Can be empty.

Type: TEXT

public static final java.lang.String COLUMN_TRANSIENT

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: TvContractCompat.Channels.COLUMN_TRANSIENT

public static final java.lang.String COLUMN_INTERACTION_TYPE

The type of interaction for this TV program.

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

Type: INTEGER

See also: TvContractCompat.PreviewProgramColumns.COLUMN_INTERACTION_COUNT

public static final java.lang.String COLUMN_INTERACTION_COUNT

The interaction count for this program.

This indicates the number of times interaction has happened.

Type: INTEGER (long)

See also: TvContractCompat.PreviewProgramColumns.COLUMN_INTERACTION_TYPE

public static final java.lang.String COLUMN_AUTHOR

The author or artist of this content.

Type: TEXT

public static final java.lang.String COLUMN_BROWSABLE

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 TvContractCompat.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)

public static final java.lang.String COLUMN_CONTENT_ID

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

public static final java.lang.String COLUMN_LOGO_CONTENT_DESCRIPTION

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: TvContractCompat.PreviewProgramColumns.COLUMN_LOGO_URI

public static final java.lang.String COLUMN_GENRE

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

public static final java.lang.String COLUMN_START_TIME_UTC_MILLIS

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: TvContractCompat.PreviewProgramColumns.COLUMN_LIVE

public static final java.lang.String COLUMN_END_TIME_UTC_MILLIS

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: TvContractCompat.PreviewProgramColumns.COLUMN_LIVE

public static final java.lang.String COLUMN_PREVIEW_AUDIO_URI

The URI for the preview audio.

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

  • content ()
  • android.resource ()
  • file ()

Can be empty.

Type: TEXT