From 49c1b69a568ce58c940e5a2b0641a2c50798cbe2 Mon Sep 17 00:00:00 2001 From: Dongwon Kang Date: Mon, 20 Oct 2014 14:35:58 +0900 Subject: [PATCH] TIF: add more documentation on Hardware session. Bug: 17909341 Change-Id: Ie537eb77b6ac4b63e4e9306c1781f84dd4be2719 --- media/java/android/media/tv/TvInputService.java | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/media/java/android/media/tv/TvInputService.java b/media/java/android/media/tv/TvInputService.java index 4f8facbbd5028..819affc6ef302 100644 --- a/media/java/android/media/tv/TvInputService.java +++ b/media/java/android/media/tv/TvInputService.java @@ -1067,9 +1067,19 @@ public abstract class TvInputService extends Service { /** * Base class for a TV input session which represents an external device connected to a - * hardware TV input. Once TV input returns an implementation of this class on - * {@link #onCreateSession(String)}, the framework will create a hardware session and forward - * the application's surface to the hardware TV input. + * hardware TV input. + *

+ * This class is for an input which provides channels for the external set-top box to the + * application. Once a TV input returns an implementation of this class on + * {@link #onCreateSession(String)}, the framework will create a separate session for + * a hardware TV Input (e.g. HDMI 1) and forward the application's surface to the session so + * that the user can see the screen of the hardware TV Input when she tunes to a channel from + * this TV input. The implementation of this class is expected to change the channel of the + * external set-top box via a proprietary protocol when {@link HardwareSession#onTune(Uri)} is + * requested by the application. + *

+ * Note that this class is not for inputs for internal hardware like built-in tuner and HDMI 1. + *

* @see #onCreateSession(String) */ public abstract static class HardwareSession extends Session {