Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 44308a63 authored by David Zhao's avatar David Zhao
Browse files

Update TV Input HAL documentation for device IDs

Test: mmm
Bug: 278628657
Change-Id: I631f1ddf3348c0a570d98db16b0ce711bb7cb53f
parent 73ab3173
Loading
Loading
Loading
Loading
+8 −1
Original line number Diff line number Diff line
@@ -30,7 +30,14 @@ interface ITvInputCallback {
    void notify(in TvInputEvent event);
    /**
     * Notifies the client that an TV message event has occurred. For possible event types,
     * check TvMessageEventType.
     * check {@link android.hardware.tv.input.TvMessageEventType}.
     *
     * The first message in a list of messages contained in a
     * {@link android.hardware.tv.input.TvMessageEvent} should always have a
     * {@link android.hardware.tv.input.TvMessage#subType} of "device_id",
     * otherwise the event is discarded. When the subType of a message is "device_id", the ID of
     * the device that sent the message should be contained in
     * {@link android.hardware.tv.input.TvMessage#groupId}
     *
     * @param event Event passed to the client.
     */
+10 −2
Original line number Diff line number Diff line
@@ -23,8 +23,13 @@ parcelable TvMessage {
     */
    const long NO_GROUP_ID = -1;
    /**
     * Extended data type, like “ATSC A/336 Watermark”, “ATSC_CC”, etc. This is opaque
     * to the framework.
     * Extended data type, like “ATSC A/336 Watermark”, “ATSC_CC”, etc. This type is opaque to the
     * framework except when the subtype is "device_id". If the subtype is "device_id", the ID of
     * device that sent the message should be contained in {@link #groupId}.
     *
     * The first message in a list of messages contained in
     * {@link android.hardware.tv.input.TvMessageEvent} should always have the subtype "device_id",
     * otherwise the event is discarded.
     */
    String subType;
    /**
@@ -32,6 +37,9 @@ parcelable TvMessage {
     * headers and bodies of the same event. For messages that do not have a group, this value
     * should be -1.
     *
     * If {@link #subType} is "device_id", this value should contain the ID of the device that sent
     * this message.
     *
     * As -1 is a reserved value, -1 should not be used as a valid groupId.
     */
    long groupId;