TableResponse

public final class TableResponse
extends BroadcastInfoResponse implements Parcelable

java.lang.Object
   ↳ android.media.tv.BroadcastInfoResponse
     ↳ android.media.tv.TableResponse


A response for Table from broadcast signal.

Summary

Nested classes

class TableResponse.Builder

Builder for TableResponse

Inherited constants

Fields

public static final Creator<TableResponse> CREATOR

Inherited fields

Public constructors

TableResponse(int requestId, int sequence, int responseResult, Uri tableUri, int version, int size)

This constructor is deprecated. use Builder instead.

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

int getSize()

Gets the Size number of table.

byte[] getTableByteArray()

Gets the data of the table as a byte array.

SharedMemory getTableSharedMemory()

Gets the data of the table as a SharedMemory object.

Uri getTableUri()

Gets the URI in TvProvider database.

int getVersion()

Gets the version number of requested table.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

Added in API level 33
public static final Creator<TableResponse> CREATOR

Public constructors

TableResponse

Added in API level 33
public TableResponse (int requestId, 
                int sequence, 
                int responseResult, 
                Uri tableUri, 
                int version, 
                int size)

This constructor is deprecated.
use Builder instead.

Constructs a TableResponse with a table URI.

Parameters
requestId int: The ID is used to associate the response with the request.

sequence int: The sequence number which indicates the order of related responses.

responseResult int: The result for the response. It's one of BroadcastInfoResponse.RESPONSE_RESULT_OK, BroadcastInfoResponse.RESPONSE_RESULT_CANCEL, BroadcastInfoResponse.RESPONSE_RESULT_ERROR. Value is BroadcastInfoResponse.RESPONSE_RESULT_ERROR, BroadcastInfoResponse.RESPONSE_RESULT_OK, or BroadcastInfoResponse.RESPONSE_RESULT_CANCEL

tableUri Uri: The URI of the table in the database. This value may be null.

version int: The version number of requested table.

size int: The Size number of table in bytes.

Public methods

describeContents

Added in API level 33
public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

getSize

Added in API level 33
public int getSize ()

Gets the Size number of table.

Returns
int

getTableByteArray

Added in API level 34
public byte[] getTableByteArray ()

Gets the data of the table as a byte array.

Returns
byte[] the table data as a byte array, or null if the data is not stored as a byte array.

getTableSharedMemory

Added in API level 34
public SharedMemory getTableSharedMemory ()

Gets the data of the table as a SharedMemory object.

This data lives in a 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.

Returns
SharedMemory the table data as a SharedMemory object, or null if the data is not stored in shared memory.

getTableUri

Added in API level 33
public Uri getTableUri ()

Gets the URI in TvProvider database.

Returns
Uri This value may be null.

getVersion

Added in API level 33
public int getVersion ()

Gets the version number of requested table. If it is null, value will be -1.

The consistency of version numbers between request and response depends on BroadcastInfoRequest#getOption(). If the request has RequestOption value REQUEST_OPTION_AUTO_UPDATE, then the response may be set to the latest version which may be different from the version of the request. Otherwise, response with a different version from its request will be considered invalid.

Returns
int

writeToParcel

Added in API level 33
public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: This value cannot be null.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES