SignalingDataResponse


class SignalingDataResponse : BroadcastInfoResponse, Parcelable

A response for the signaling data from the broadcast signal.

Summary

Inherited constants
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.

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
SignalingDataResponse(requestId: Int, sequence: Int, responseResult: Int, signalingDataTypes: MutableList<String!>, signalingDataInfoList: MutableList<SignalingDataInfo!>)

Public methods
Int

MutableList<SignalingDataInfo!>

Gets a list of SignalingDataInfo contained in this response.

MutableList<String!>

Gets a list of types of metadata that are contained in this response.

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.

Inherited functions
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.

Public constructors

SignalingDataResponse

SignalingDataResponse(
    requestId: Int,
    sequence: Int,
    responseResult: Int,
    signalingDataTypes: MutableList<String!>,
    signalingDataInfoList: MutableList<SignalingDataInfo!>)
Parameters
responseResult Int: Value is android.media.tv.BroadcastInfoResponse#RESPONSE_RESULT_ERROR, android.media.tv.BroadcastInfoResponse#RESPONSE_RESULT_OK, or android.media.tv.BroadcastInfoResponse#RESPONSE_RESULT_CANCEL
signalingDataTypes MutableList<String!>: This value cannot be null.
signalingDataInfoList MutableList<SignalingDataInfo!>: This value cannot be null.

Public methods

describeContents

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

getSignalingDataInfoList

fun getSignalingDataInfoList(): MutableList<SignalingDataInfo!>

Gets a list of SignalingDataInfo contained in this response.

Return
MutableList<SignalingDataInfo!> A list of SignalingDataInfo contained in this response. This value cannot be null.

getSignalingDataTypes

fun getSignalingDataTypes(): MutableList<String!>

Gets a list of types of metadata that are contained in this response.

This list correlates to all the available types that can be found within getSignalingDataInfoList(). This list is determined by the types specified in SignalingDataRequest.getSignalingDataTypes().

A list of types available are defined in SignalingDataRequest. For more information about these types, see A/344:2023-5 9.2.10 - Query Signaling Data API.

Return
MutableList<String!> A list of types of metadata that are contained in this response. This value cannot be null.

writeToParcel

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

static val CREATOR: Parcelable.Creator<SignalingDataResponse!>