Merge "Update documentation for TV messages" into udc-dev

This commit is contained in:
Shubang Lu
2023-05-20 05:47:07 +00:00
committed by Android (Google) Code Review
2 changed files with 10 additions and 0 deletions

View File

@@ -98,6 +98,11 @@ interface ITvInput {
* detected from the stream based on whether or not they are enabled by
* {@link #setTvMessageEnabled(int, int, TvMessageEventType, boolean)}.
*
* This queue is expected to already contain the message data before calling
* {@link android.hardware.tv.input.ITvInputCallback#notifyTvMessageEvent}.
* The HAL implementation is expected to have already created the queue
* before the notification callback is called for the first time.
*
* @param deviceId The ID of the device that contains the stream to get the queue for.
* @param streamId THe ID of the stream to get the queue for.
* @return The descriptor of the TV message queue.

View File

@@ -39,6 +39,11 @@ interface ITvInputCallback {
* the device that sent the message should be contained in
* {@link android.hardware.tv.input.TvMessage#groupId}
*
* 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);