Merge "[TIAF] Unhide TimelineRequest and TableResponse"

This commit is contained in:
Shubang Lu
2023-02-09 19:59:57 +00:00
committed by Android (Google) Code Review
3 changed files with 53 additions and 6 deletions

View File

@@ -26559,7 +26559,11 @@ package android.media.tv {
public final class TableResponse extends android.media.tv.BroadcastInfoResponse implements android.os.Parcelable {
ctor public TableResponse(int, int, int, @Nullable android.net.Uri, int, int);
ctor public TableResponse(int, int, int, @NonNull byte[], int, int);
ctor public TableResponse(int, int, int, @NonNull android.os.SharedMemory, int, int);
method public int getSize();
method @Nullable public byte[] getTableByteArray();
method @Nullable public android.os.SharedMemory getTableSharedMemory();
method @Nullable public android.net.Uri getTableUri();
method public int getVersion();
field @NonNull public static final android.os.Parcelable.Creator<android.media.tv.TableResponse> CREATOR;
@@ -26567,7 +26571,9 @@ package android.media.tv {
public final class TimelineRequest extends android.media.tv.BroadcastInfoRequest implements android.os.Parcelable {
ctor public TimelineRequest(int, int, int);
ctor public TimelineRequest(int, int, int, @NonNull String);
method public int getIntervalMillis();
method @Nullable public String getSelector();
field @NonNull public static final android.os.Parcelable.Creator<android.media.tv.TimelineRequest> CREATOR;
}

View File

@@ -54,6 +54,17 @@ public final class TableResponse extends BroadcastInfoResponse implements Parcel
return new TableResponse(in);
}
/**
* Constructs a TableResponse with a table URI.
*
* @param requestId The ID is used to associate the response with the request.
* @param sequence The sequence number which indicates the order of related responses.
* @param responseResult The result for the response. It's one of {@link #RESPONSE_RESULT_OK},
* {@link #RESPONSE_RESULT_CANCEL}, {@link #RESPONSE_RESULT_ERROR}.
* @param tableUri The URI of the table in the database.
* @param version The version number of requested table.
* @param size The Size number of table in bytes.
*/
public TableResponse(int requestId, int sequence, @ResponseResult int responseResult,
@Nullable Uri tableUri, int version, int size) {
super(RESPONSE_TYPE, requestId, sequence, responseResult);
@@ -64,7 +75,19 @@ public final class TableResponse extends BroadcastInfoResponse implements Parcel
mTableSharedMemory = null;
}
/** @hide */
/**
* Constructs a TableResponse with a table URI.
*
* @param requestId The ID is used to associate the response with the request.
* @param sequence The sequence number which indicates the order of related responses.
* @param responseResult The result for the response. It's one of {@link #RESPONSE_RESULT_OK},
* {@link #RESPONSE_RESULT_CANCEL}, {@link #RESPONSE_RESULT_ERROR}.
* @param tableByteArray The byte array which stores the table in bytes. The structure and
* syntax of the table depends on the table name in
* {@link TableRequest#getTableName()} and the corresponding standard.
* @param version The version number of requested table.
* @param size The Size number of table in bytes.
*/
public TableResponse(int requestId, int sequence, @ResponseResult int responseResult,
@NonNull byte[] tableByteArray, int version, int size) {
super(RESPONSE_TYPE, requestId, sequence, responseResult);
@@ -75,7 +98,21 @@ public final class TableResponse extends BroadcastInfoResponse implements Parcel
mTableSharedMemory = null;
}
/** @hide */
/**
* Constructs a TableResponse with a table URI.
*
* @param requestId The ID is used to associate the response with the request.
* @param sequence The sequence number which indicates the order of related responses.
* @param responseResult The result for the response. It's one of {@link #RESPONSE_RESULT_OK},
* {@link #RESPONSE_RESULT_CANCEL}, {@link #RESPONSE_RESULT_ERROR}.
* @param tableSharedMemory The shared memory which stores the table. The table size can be
* large so using a shared memory optimizes the data
* communication between the table data source and the receiver. The
* structure syntax of the table depends on the table name in
* {@link TableRequest#getTableName()} and the corresponding standard.
* @param version The version number of requested table.
* @param size The Size number of table in bytes.
*/
public TableResponse(int requestId, int sequence, @ResponseResult int responseResult,
@NonNull SharedMemory tableSharedMemory, int version, int size) {
super(RESPONSE_TYPE, requestId, sequence, responseResult);
@@ -115,7 +152,6 @@ public final class TableResponse extends BroadcastInfoResponse implements Parcel
*
* @return the table data as a byte array, or {@code null} if the data is not stored as a byte
* array.
* @hide
*/
@Nullable
public byte[] getTableByteArray() {
@@ -125,9 +161,14 @@ public final class TableResponse extends BroadcastInfoResponse implements Parcel
/**
* Gets the data of the table as a {@link SharedMemory} object.
*
* <p> This data lives in a {@link SharedMemory} instance because of the potentially large
* amount of data needed to store the table. This optimizes the data communication between the
* table data source and the receiver.
*
* @return the table data as a {@link SharedMemory} object, or {@code null} if the data is not
* stored in shared memory.
* @hide
*
* @see SharedMemory#map(int, int, int)
*/
@Nullable
public SharedMemory getTableSharedMemory() {

View File

@@ -17,6 +17,7 @@
package android.media.tv;
import android.annotation.NonNull;
import android.annotation.Nullable;
import android.os.Parcel;
import android.os.Parcelable;
@@ -54,7 +55,6 @@ public final class TimelineRequest extends BroadcastInfoRequest implements Parce
mSelector = null;
}
/** @hide */
public TimelineRequest(int requestId, @RequestOption int option, int intervalMillis,
@NonNull String selector) {
super(REQUEST_TYPE, requestId, option);
@@ -81,8 +81,8 @@ public final class TimelineRequest extends BroadcastInfoRequest implements Parce
* {@code urn:dvb:css:timeline:pts} is a selector in DVB standard.
*
* @return the selector if it's set; {@code null} otherwise.
* @hide
*/
@Nullable
public String getSelector() {
return mSelector;
}