diff options
author | Nick Chalko <nchalko@google.com> | 2015-06-11 11:31:42 -0700 |
---|---|---|
committer | Nick Chalko <nchalko@google.com> | 2015-06-12 10:52:38 -0700 |
commit | 1bccd280f59b86d00c04dcc9d827d76b373c600a (patch) | |
tree | 6959fe2119ad9aa6af9ea626d38574b1dd0f17c3 /media | |
parent | 08f247fe2e073a5ec62dc0469d83f514aab31c42 (diff) | |
download | frameworks_base-1bccd280f59b86d00c04dcc9d827d76b373c600a.zip frameworks_base-1bccd280f59b86d00c04dcc9d827d76b373c600a.tar.gz frameworks_base-1bccd280f59b86d00c04dcc9d827d76b373c600a.tar.bz2 |
Improve javadoc for onTune and notifyVideoAvailable.
Bug: 21276782
Change-Id: If445379e83dbde8daaa4be7819b9399bfe1d96a0
Diffstat (limited to 'media')
-rw-r--r-- | media/java/android/media/tv/TvInputService.java | 17 |
1 files changed, 11 insertions, 6 deletions
diff --git a/media/java/android/media/tv/TvInputService.java b/media/java/android/media/tv/TvInputService.java index 50a215c..f52ccc9 100644 --- a/media/java/android/media/tv/TvInputService.java +++ b/media/java/android/media/tv/TvInputService.java @@ -434,9 +434,12 @@ public abstract class TvInputService extends Service { } /** - * Informs the application that the video is now available for watching. This is primarily - * used to signal the application to unblock the screen. The TV input service must call this - * method as soon as the content rendered onto its surface gets ready for viewing. + * Informs the application that the video is now available for watching. Video is blocked + * until this method is called. + * + * <p>The TV input service must call this method as soon as the content rendered onto its + * surface is ready for viewing. This method must be called each time {@link #onTune(Uri)} + * is called. * * @see #notifyVideoUnavailable */ @@ -761,9 +764,11 @@ public abstract class TvInputService extends Service { public abstract void onSetStreamVolume(float volume); /** - * Tunes to a given channel. When the video is available, {@link #notifyVideoAvailable()} - * should be called. Also, {@link #notifyVideoUnavailable(int)} should be called when the TV - * input cannot continue playing the given channel. + * Tunes to a given channel. + * + * <p>No video will be displayed until {@link #notifyVideoAvailable()} is called. + * Also, {@link #notifyVideoUnavailable(int)} should be called when the TV input cannot + * continue playing the given channel. * * @param channelUri The URI of the channel. * @return {@code true} if the tuning was successful, {@code false} otherwise. |