tv/input/aidl/android/hardware/tv/input/ITvInputCallback.aidl

/*
 * Copyright 2022 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package android.hardware.tv.input;

import android.hardware.tv.input.TvInputEvent;
import android.hardware.tv.input.TvMessageEvent;

@VintfStability
interface ITvInputCallback {
    /**
     * Notifies the client that an event has occurred. For possible event types,
     * check TvInputEventType.
     *
     * @param event Event passed to the client.
     */
    void notify(in TvInputEvent event);
    /**
     * Notifies the client that an TV message event has occurred. For possible event types,
     * check {@link android.hardware.tv.input.TvMessageEventType}.
     *
     * <p> For implementations of version 1, 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}.
     *
     * <p> For version 2 and beyond, the device ID should be contained in
     * {@link android.hardware.tv.input.TvMessageEvent#deviceId}.
     *
     * <p> Invoking this callback for the first time immediately triggers
     * {@link android.hardware.tv.input.ITvInput#getTvMessageQueueDesc}. It is
     * expected for the queue to be ready with the relevant messages for the event before this
     * callback is called.
     *
     * @param event Event passed to the client.
     */
    void notifyTvMessageEvent(in TvMessageEvent event);
}