diff options
author | Jae Seo <jaeseo@google.com> | 2015-03-17 17:18:07 -0700 |
---|---|---|
committer | Jae Seo <jaeseo@google.com> | 2015-03-17 18:02:51 -0700 |
commit | c6a1e5d16c9e1fab5e597f308c3886e512791289 (patch) | |
tree | 0ba25877131e3ca33841380e22bc18bccdb4aa5e | |
parent | 27eac1d58fe0b7ca3a2e27f5ed64eff232745f45 (diff) | |
download | frameworks_base-c6a1e5d16c9e1fab5e597f308c3886e512791289.zip frameworks_base-c6a1e5d16c9e1fab5e597f308c3886e512791289.tar.gz frameworks_base-c6a1e5d16c9e1fab5e597f308c3886e512791289.tar.bz2 |
TIF: Add a missing comment for the return value of onSelectTrack()
Bug: 19630395
Change-Id: I2caa9ace23ee003e9662e363538a363ae9a0ced7
-rw-r--r-- | media/java/android/media/tv/TvInputService.java | 40 |
1 files changed, 21 insertions, 19 deletions
diff --git a/media/java/android/media/tv/TvInputService.java b/media/java/android/media/tv/TvInputService.java index 6607765..cf1b441 100644 --- a/media/java/android/media/tv/TvInputService.java +++ b/media/java/android/media/tv/TvInputService.java @@ -241,7 +241,7 @@ public abstract class TvInputService extends Service { final Handler mHandler; private WindowManager.LayoutParams mWindowParams; private Surface mSurface; - private Context mContext; + private final Context mContext; private FrameLayout mOverlayViewContainer; private View mOverlayView; private OverlayViewCleanUpTask mOverlayViewCleanUpTask; @@ -249,11 +249,11 @@ public abstract class TvInputService extends Service { private IBinder mWindowToken; private Rect mOverlayFrame; - private Object mLock = new Object(); + private final Object mLock = new Object(); // @GuardedBy("mLock") private ITvInputSessionCallback mSessionCallback; // @GuardedBy("mLock") - private List<Runnable> mPendingActions = new ArrayList<>(); + private final List<Runnable> mPendingActions = new ArrayList<>(); /** * Creates a new Session. @@ -614,16 +614,17 @@ public abstract class TvInputService extends Service { public void onSetMain(boolean isMain) { } - /** - * Sets the {@link Surface} for the current input session on which the TV input renders video. - * <p> - * When {@code setSurface(null)} is called, the implementation should stop using the Surface - * object previously given and release any references to it. - * - * @param surface possibly {@code null} {@link Surface} an application passes to this TV input - * session. - * @return {@code true} if the surface was set, {@code false} otherwise. - */ + /** + * Sets the {@link Surface} for the current input session on which the TV input renders + * video. + * <p> + * When {@code setSurface(null)} is called, the implementation should stop using the Surface + * object previously given and release any references to it. + * + * @param surface possibly {@code null} {@link Surface} an application passes to this TV + * input session. + * @return {@code true} if the surface was set, {@code false} otherwise. + */ public abstract boolean onSetSurface(Surface surface); /** @@ -662,11 +663,11 @@ public abstract class TvInputService extends Service { /** * 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. + * should be 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} the tuning was successful, {@code false} otherwise. + * @return {@code true} if the tuning was successful, {@code false} otherwise. */ public abstract boolean onTune(Uri channelUri); @@ -675,7 +676,7 @@ public abstract class TvInputService extends Service { * * @param channelUri The URI of the channel. * @param params The extra parameters from other applications. - * @return {@code true} the tuning was successful, {@code false} otherwise. + * @return {@code true} if the tuning was successful, {@code false} otherwise. * @hide */ @SystemApi @@ -711,10 +712,10 @@ public abstract class TvInputService extends Service { } /** - * Select a given track. + * Selects a given track. * <p> * If this is done successfully, the implementation should call {@link #notifyTrackSelected} - * to help applications maintain the selcted track lists. + * to help applications maintain the up-to-date list of the selected tracks. * </p> * * @param trackId The ID of the track to select. {@code null} means to unselect the current @@ -722,6 +723,7 @@ public abstract class TvInputService extends Service { * @param type The type of the track to select. The type can be * {@link TvTrackInfo#TYPE_AUDIO}, {@link TvTrackInfo#TYPE_VIDEO} or * {@link TvTrackInfo#TYPE_SUBTITLE}. + * @return {@code true} if the track selection was successful, {@code false} otherwise. * @see #notifyTrackSelected */ public boolean onSelectTrack(int type, String trackId) { |