Type: String */ public static final String TV_MESSAGE_KEY_STREAM_ID = "android.media.tv.TvInputManager.stream_id"; + /** + * This constant is used as a {@link Bundle} key for TV messages. The value of the key + * identifies the subtype of the data, such as the format of the CC data. The format + * found at this key can then be used to identify how to parse the data at + * {@link #TV_MESSAGE_KEY_RAW_DATA}. + * + * To parse the raw data bsed on the subtype, please refer to the official documentation of the + * concerning subtype. For example, for the subtype "ATSC A/335" for watermarking, the + * document for A/335 from the ATSC standard details how this data is formatted. + * + * Some other examples of common formats include: + *
Type: String + */ + public static final String TV_MESSAGE_KEY_SUBTYPE = + "android.media.tv.TvInputManager.subtype"; + + /** + * This constant is used as a {@link Bundle} key for TV messages. The value of the key + * stores the raw data contained in this TV Message. The format of this data is determined + * by the format defined by the subtype, found using the key at + * {@link #TV_MESSAGE_KEY_SUBTYPE}. See {@link #TV_MESSAGE_KEY_SUBTYPE} for more + * information on how to parse this data. + * + *
Type: byte[] + */ + public static final String TV_MESSAGE_KEY_RAW_DATA = + "android.media.tv.TvInputManager.raw_data"; + static final int VIDEO_UNAVAILABLE_REASON_START = 0; static final int VIDEO_UNAVAILABLE_REASON_END = 18; @@ -802,7 +837,13 @@ public final class TvInputManager { * * @param session A {@link TvInputManager.Session} associated with this callback. * @param type The type of message received, such as {@link #TV_MESSAGE_TYPE_WATERMARK} - * @param data The raw data of the message + * @param data The raw data of the message. The bundle keys are: + * {@link TvInputManager#TV_MESSAGE_KEY_STREAM_ID}, + * {@link TvInputManager#TV_MESSAGE_KEY_SUBTYPE}, + * {@link TvInputManager#TV_MESSAGE_KEY_RAW_DATA}. + * See {@link TvInputManager#TV_MESSAGE_KEY_SUBTYPE} for more information on + * how to parse this data. + * */ public void onTvMessage(Session session, @TvInputManager.TvMessageType int type, Bundle data) { diff --git a/media/java/android/media/tv/TvInputService.java b/media/java/android/media/tv/TvInputService.java index 3c6ed91d21002..4e380c41ccdbd 100644 --- a/media/java/android/media/tv/TvInputService.java +++ b/media/java/android/media/tv/TvInputService.java @@ -1030,7 +1030,12 @@ public abstract class TvInputService extends Service { * * @param type The of message that was sent, such as * {@link TvInputManager#TV_MESSAGE_TYPE_WATERMARK} - * @param data The data sent with the message. + * @param data The raw data of the message. The bundle keys are: + * {@link TvInputManager#TV_MESSAGE_KEY_STREAM_ID}, + * {@link TvInputManager#TV_MESSAGE_KEY_SUBTYPE}, + * {@link TvInputManager#TV_MESSAGE_KEY_RAW_DATA}. + * See {@link TvInputManager#TV_MESSAGE_KEY_SUBTYPE} for more information on + * how to parse this data. */ public void notifyTvMessage(@TvInputManager.TvMessageType int type, @NonNull Bundle data) { @@ -1500,7 +1505,12 @@ public abstract class TvInputService extends Service { * * @param type The type of message received, such as * {@link TvInputManager#TV_MESSAGE_TYPE_WATERMARK} - * @param data The raw data of the message + * @param data The raw data of the message. The bundle keys are: + * {@link TvInputManager#TV_MESSAGE_KEY_STREAM_ID}, + * {@link TvInputManager#TV_MESSAGE_KEY_SUBTYPE}, + * {@link TvInputManager#TV_MESSAGE_KEY_RAW_DATA}. + * See {@link TvInputManager#TV_MESSAGE_KEY_SUBTYPE} for more information on + * how to parse this data. */ public void onTvMessage(@NonNull @TvInputManager.TvMessageType String type, @NonNull Bundle data) { diff --git a/media/java/android/media/tv/TvView.java b/media/java/android/media/tv/TvView.java index 19a2e5d8d1570..8a886832e88e2 100644 --- a/media/java/android/media/tv/TvView.java +++ b/media/java/android/media/tv/TvView.java @@ -1254,7 +1254,12 @@ public class TvView extends ViewGroup { * @param inputId The ID of the TV input bound to this view. * @param type The type of message received, such as * {@link TvInputManager#TV_MESSAGE_TYPE_WATERMARK} - * @param data The raw data of the message + * @param data The raw data of the message. The bundle keys are: + * {@link TvInputManager#TV_MESSAGE_KEY_STREAM_ID}, + * {@link TvInputManager#TV_MESSAGE_KEY_SUBTYPE}, + * {@link TvInputManager#TV_MESSAGE_KEY_RAW_DATA}. + * See {@link TvInputManager#TV_MESSAGE_KEY_SUBTYPE} for more information on + * how to parse this data. */ public void onTvMessage(@NonNull String inputId, @TvInputManager.TvMessageType int type, @NonNull Bundle data) { diff --git a/media/java/android/media/tv/interactive/TvInteractiveAppService.java b/media/java/android/media/tv/interactive/TvInteractiveAppService.java index 7dfe16a3caf99..69ff9c63b32bc 100755 --- a/media/java/android/media/tv/interactive/TvInteractiveAppService.java +++ b/media/java/android/media/tv/interactive/TvInteractiveAppService.java @@ -919,7 +919,12 @@ public abstract class TvInteractiveAppService extends Service { * * @param type The type of message received, such as * {@link TvInputManager#TV_MESSAGE_TYPE_WATERMARK} - * @param data The raw data of the message + * @param data The raw data of the message. The bundle keys are: + * {@link TvInputManager#TV_MESSAGE_KEY_STREAM_ID}, + * {@link TvInputManager#TV_MESSAGE_KEY_SUBTYPE}, + * {@link TvInputManager#TV_MESSAGE_KEY_RAW_DATA}. + * See {@link TvInputManager#TV_MESSAGE_KEY_SUBTYPE} for more information on + * how to parse this data. */ public void onTvMessage(@TvInputManager.TvMessageType int type, @NonNull Bundle data) { diff --git a/media/java/android/media/tv/interactive/TvInteractiveAppView.java b/media/java/android/media/tv/interactive/TvInteractiveAppView.java index 1a0319bddc2d8..80a14354ef7a5 100755 --- a/media/java/android/media/tv/interactive/TvInteractiveAppView.java +++ b/media/java/android/media/tv/interactive/TvInteractiveAppView.java @@ -944,7 +944,12 @@ public class TvInteractiveAppView extends ViewGroup { * * @param type The type of message received, such as * {@link TvInputManager#TV_MESSAGE_TYPE_WATERMARK} - * @param data The raw data of the message + * @param data The raw data of the message. The bundle keys are: + * {@link TvInputManager#TV_MESSAGE_KEY_STREAM_ID}, + * {@link TvInputManager#TV_MESSAGE_KEY_SUBTYPE}, + * {@link TvInputManager#TV_MESSAGE_KEY_RAW_DATA}. + * See {@link TvInputManager#TV_MESSAGE_KEY_SUBTYPE} for more information on + * how to parse this data. */ public void notifyTvMessage(@NonNull @TvInputManager.TvMessageType int type, @NonNull Bundle data) {