belongs to Maven artifact androidx.tvprovider:tvprovider:1.0.0-alpha1

WatchNextProgram

public final class WatchNextProgram
extends Object

java.lang.Object
   ↳ androidx.tvprovider.media.tv.WatchNextProgram


A convenience class to access TvContractCompat.WatchNextPrograms entries in the system content provider.

This class makes it easy to insert or retrieve a program from the system content provider, which is defined in TvContractCompat.

Usage example when inserting a "watch next" program:

 WatchNextProgram watchNextProgram = new WatchNextProgram.Builder()
         .setWatchNextType(WatchNextPrograms.WATCH_NEXT_TYPE_CONTINUE)
         .setType(PreviewPrograms.TYPE_MOVIE)
         .setTitle("Program Title")
         .setDescription("Program Description")
         .setPosterArtUri(Uri.parse("http://example.com/poster_art.png"))
         // Set more attributes...
         .build();
 Uri watchNextProgramUri = getContentResolver().insert(WatchNextPrograms.CONTENT_URI,
         watchNextProgram.toContentValues());
 

Usage example when retrieving a "watch next" program:

 WatchNextProgram watchNextProgram;
 try (Cursor cursor = resolver.query(watchNextProgramUri, null, null, null, null)) {
     if (cursor != null && cursor.getCount() != 0) {
         cursor.moveToNext();
         watchNextProgram = WatchNextProgram.fromCursor(cursor);
     }
 }
 

Usage example when updating an existing "watch next" program:

 WatchNextProgram updatedProgram = new WatchNextProgram.Builder(watchNextProgram)
         .setLastEngagementTimeUtcMillis(System.currentTimeMillis())
         .build();
 getContentResolver().update(TvContractCompat.buildWatchNextProgramUri(updatedProgram.getId()),
         updatedProgram.toContentValues(), null, null);
 

Usage example when deleting a "watch next" program:

 getContentResolver().delete(TvContractCompat.buildWatchNextProgramUri(existingProgram.getId()),
         null, null);
 

Summary

Nested classes

class WatchNextProgram.Builder

This Builder class simplifies the creation of a WatchNextProgram object. 

Constants

int WATCH_NEXT_TYPE_UNKNOWN

The unknown watch next type.

Public methods

boolean equals(Object other)
static WatchNextProgram fromCursor(Cursor cursor)

Creates a WatchNextProgram object from a cursor including the fields defined in TvContractCompat.WatchNextPrograms.

String[] getAudioLanguages()
String getAuthor()
int getAvailability()
String[] getCanonicalGenres()
String getContentId()
TvContentRating[] getContentRatings()
String getDescription()
int getDurationMillis()
long getEndTimeUtcMillis()
String getEpisodeNumber()
String getEpisodeTitle()
String getGenre()
long getId()
Intent getIntent()
Uri getIntentUri()
long getInteractionCount()
int getInteractionType()
byte[] getInternalProviderDataByteArray()
Long getInternalProviderFlag1()
Long getInternalProviderFlag2()
Long getInternalProviderFlag3()
Long getInternalProviderFlag4()
String getInternalProviderId()
int getItemCount()
long getLastEngagementTimeUtcMillis()
int getLastPlaybackPositionMillis()
String getLogoContentDescription()
Uri getLogoUri()
String getLongDescription()
String getOfferPrice()
int getPosterArtAspectRatio()
Uri getPosterArtUri()
Uri getPreviewAudioUri()
Uri getPreviewVideoUri()
String getReleaseDate()
String getReviewRating()
int getReviewRatingStyle()
String getSeasonNumber()
String getSeasonTitle()
long getStartTimeUtcMillis()
String getStartingPrice()
int getThumbnailAspectRatio()
Uri getThumbnailUri()
String getTitle()
int getType()
int getVideoHeight()
int getVideoWidth()
int getWatchNextType()
boolean hasAnyUpdatedValues(WatchNextProgram update)

Indicates whether some other WatchNextProgram has any set attribute that is different from this WatchNextProgram's respective attributes.

int hashCode()
boolean isBrowsable()
boolean isLive()
boolean isSearchable()
boolean isTransient()
ContentValues toContentValues()
String toString()

Inherited methods

Constants

WATCH_NEXT_TYPE_UNKNOWN

int WATCH_NEXT_TYPE_UNKNOWN

The unknown watch next type. Use this type when the actual type is not known.

Constant Value: -1 (0xffffffff)

Public methods

equals

boolean equals (Object other)

Parameters
other Object

Returns
boolean

fromCursor

WatchNextProgram fromCursor (Cursor cursor)

Creates a WatchNextProgram object from a cursor including the fields defined in TvContractCompat.WatchNextPrograms.

Parameters
cursor Cursor: A row from the TV Input Framework database.

Returns
WatchNextProgram A Program with the values taken from the cursor.

getAudioLanguages

String[] getAudioLanguages ()

Returns
String[] The audio languages for the program.

getAuthor

String getAuthor ()

Returns
String The author for the program.

getAvailability

int getAvailability ()

Returns
int The availability of the program.

getCanonicalGenres

String[] getCanonicalGenres ()

Returns
String[] The canonical genre for the program.

getContentId

String getContentId ()

Returns
String The content ID for the program.

getContentRatings

TvContentRating[] getContentRatings ()

Returns
TvContentRating[] The content rating for the program.

getDescription

String getDescription ()

Returns
String The short description for the program.

getDurationMillis

int getDurationMillis ()

Returns
int The duration of the program in millis.

getEndTimeUtcMillis

long getEndTimeUtcMillis ()

Returns
long The end time for the program.

getEpisodeNumber

String getEpisodeNumber ()

Returns
String The episode display number for the program.

getEpisodeTitle

String getEpisodeTitle ()

Returns
String The episode title for the program.

getGenre

String getGenre ()

Returns
String The genre for the program.

getId

long getId ()

Returns
long The ID for the program.

See also:

getIntent

Intent getIntent ()

Returns
Intent The intent which is launched when the program is selected.

Throws
URISyntaxException

getIntentUri

Uri getIntentUri ()

Returns
Uri The intent URI which is launched when the program is selected.

getInteractionCount

long getInteractionCount ()

Returns
long The interaction count for the program.

getInteractionType

int getInteractionType ()

Returns
int The interaction type for the program.

getInternalProviderDataByteArray

byte[] getInternalProviderDataByteArray ()

Returns
byte[] The internal provider data for the program.

getInternalProviderFlag1

Long getInternalProviderFlag1 ()

Returns
Long The first internal provider flag for the program.

getInternalProviderFlag2

Long getInternalProviderFlag2 ()

Returns
Long The second internal provider flag for the program.

getInternalProviderFlag3

Long getInternalProviderFlag3 ()

Returns
Long The third internal provider flag for the program.

getInternalProviderFlag4

Long getInternalProviderFlag4 ()

Returns
Long The forth internal provider flag for the program.

getInternalProviderId

String getInternalProviderId ()

Returns
String The internal provider ID for the program.

getItemCount

int getItemCount ()

Returns
int The item count for the program.

getLastEngagementTimeUtcMillis

long getLastEngagementTimeUtcMillis ()

Returns
long The value of TvContractCompat.WatchNextPrograms.COLUMN_LAST_ENGAGEMENT_TIME_UTC_MILLIS for the program.

getLastPlaybackPositionMillis

int getLastPlaybackPositionMillis ()

Returns
int The last playback position of the program in millis.

getLogoContentDescription

String getLogoContentDescription ()

Returns
String The logo content description for the program.

getLogoUri

Uri getLogoUri ()

Returns
Uri The logo URI for the program.

getLongDescription

String getLongDescription ()

Returns
String The long description for the program.

getOfferPrice

String getOfferPrice ()

Returns
String The offer price of the program.

getPosterArtAspectRatio

int getPosterArtAspectRatio ()

Returns
int The poster art aspect ratio for the program.

getPosterArtUri

Uri getPosterArtUri ()

Returns
Uri The poster art URI for the program.

getPreviewAudioUri

Uri getPreviewAudioUri ()

Returns
Uri The preview audio URI for the program.

getPreviewVideoUri

Uri getPreviewVideoUri ()

Returns
Uri The preview video URI for the program.

getReleaseDate

String getReleaseDate ()

Returns
String The release date of the program.

getReviewRating

String getReviewRating ()

Returns
String The review rating for the program.

getReviewRatingStyle

int getReviewRatingStyle ()

Returns
int The review rating style for the program.

getSeasonNumber

String getSeasonNumber ()

Returns
String The season display number for the program.

getSeasonTitle

String getSeasonTitle ()

Returns
String The season title for the program.

getStartTimeUtcMillis

long getStartTimeUtcMillis ()

Returns
long The start time for the program.

getStartingPrice

String getStartingPrice ()

Returns
String The starting price of the program.

getThumbnailAspectRatio

int getThumbnailAspectRatio ()

Returns
int The thumbnail aspect ratio for the program.

getThumbnailUri

Uri getThumbnailUri ()

Returns
Uri The thumbnail URI for the program.

getTitle

String getTitle ()

Returns
String The title for the program.

getType

int getType ()

Returns
int The type of the program.

getVideoHeight

int getVideoHeight ()

Returns
int The video height for the program.

getVideoWidth

int getVideoWidth ()

Returns
int The video width for the program.

getWatchNextType

int getWatchNextType ()

Returns
int The value of TvContractCompat.WatchNextPrograms.COLUMN_WATCH_NEXT_TYPE for the program, or WATCH_NEXT_TYPE_UNKNOWN if it's unknown.

hasAnyUpdatedValues

boolean hasAnyUpdatedValues (WatchNextProgram update)

Indicates whether some other WatchNextProgram has any set attribute that is different from this WatchNextProgram's respective attributes. An attribute is considered "set" if its key is present in the ContentValues vector.

Parameters
update WatchNextProgram

Returns
boolean

hashCode

int hashCode ()

Returns
int

isBrowsable

boolean isBrowsable ()

Returns
boolean Whether the program is browsable or not.

isLive

boolean isLive ()

Returns
boolean Whether the program is live or not.

isSearchable

boolean isSearchable ()

Returns
boolean Whether the program is searchable or not.

isTransient

boolean isTransient ()

Returns
boolean Whether the program is transient or not.

toContentValues

ContentValues toContentValues ()

Returns
ContentValues The fields of the Program in the ContentValues format to be easily inserted into the TV Input Framework database.

toString

String toString ()

Returns
String