TableResponse

Kotlin |Java

class TableResponse : BroadcastInfoResponse, Parcelable

kotlin.Any
↳	android.media.tv.BroadcastInfoResponse
	↳	android.media.tv.TableResponse

A response for Table from broadcast signal.

Summary

Nested classes
	`Builder` Builder for `TableResponse`.

Inherited constants

From class Parcelable

Int

CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

Int

PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

From class BroadcastInfoResponse

Int

RESPONSE_RESULT_CANCEL

Response result: cancel. This means the request has been cancelled.

Int

RESPONSE_RESULT_ERROR

Response result: error. This means the request can not be set up successfully.

Int

RESPONSE_RESULT_OK

Response result: OK. This means the request is set up successfully and the related responses are normal responses.

Public constructors
`TableResponse(requestId: Int, sequence: Int, responseResult: Int, tableUri: Uri?, version: Int, size: Int)` Constructs a TableResponse with a table URI.

Public methods
Int	`describeContents()`
Int	`getSize()` Gets the Size number of table.
ByteArray?	`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.
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Inherited functions

From class BroadcastInfoResponse

`Int`	`getRequestId()` Gets the ID of the request. The ID is used to associate the response with the request.
`Int`	`getResponseResult()` Gets the result for the response.
`Int`	`getSequence()` Gets the sequence number which indicates the order of related responses.
`Int`	`getType()` Gets the broadcast info type. The type indicates what broadcast information is requested, such as broadcast table, PES (packetized Elementary Stream), TS (transport stream), etc. The type of the request and the related responses should be the same.

Properties
static Parcelable.Creator<TableResponse!>	`CREATOR`

Public constructors

TableResponse

Added in API level 33

TableResponse(
    requestId: Int, 
    sequence: Int, 
    responseResult: Int, 
    tableUri: Uri?, 
    version: Int, 
    size: Int)

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 `RESPONSE_RESULT_OK`, `RESPONSE_RESULT_CANCEL`, `RESPONSE_RESULT_ERROR`. Value is `android.media.tv.BroadcastInfoResponse#RESPONSE_RESULT_ERROR`, `android.media.tv.BroadcastInfoResponse#RESPONSE_RESULT_OK`, or `android.media.tv.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

fun describeContents(): Int

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR`

getSize

Added in API level 33

fun getSize(): Int

Gets the Size number of table.

getTableByteArray

Added in API level 34

fun getTableByteArray(): ByteArray?

Gets the data of the table as a byte array.

Return
`ByteArray?`	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

fun getTableSharedMemory(): SharedMemory?

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.

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

See Also

android.os.SharedMemory#map(int, int, int)

getTableUri

Added in API level 33

fun getTableUri(): Uri?

Gets the URI in TvProvider database.

Return
`Uri?`	This value may be `null`.

getVersion

Added in API level 33

fun getVersion(): Int

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.

writeToParcel

Added in API level 33

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

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_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 33

static val CREATOR: Parcelable.Creator<TableResponse!>