Added in API level 33

DsmccResponse

---

Kotlin |Java

class DsmccResponse : BroadcastInfoResponse, Parcelable

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

A response for DSM-CC from broadcast signal.

Summary

Constants
static String	BIOP_MESSAGE_TYPE_DIRECTORY BIOP directory message
static String	BIOP_MESSAGE_TYPE_FILE BIOP file message
static String	BIOP_MESSAGE_TYPE_SERVICE_GATEWAY BIOP service gateway message
static String	BIOP_MESSAGE_TYPE_STREAM BIOP stream message

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
DsmccResponse(requestId: Int, sequence: Int, responseResult: Int, file: ParcelFileDescriptor?) Constructs a BIOP file message response.
DsmccResponse(requestId: Int, sequence: Int, responseResult: Int, isServiceGateway: Boolean, childList: MutableList<String!>?) Constructs a BIOP service gateway or directory message response.
DsmccResponse(requestId: Int, sequence: Int, responseResult: Int, eventIds: IntArray?, eventNames: Array<String!>?) Constructs a BIOP stream message response.

Public methods
Int	describeContents()
String	getBiopMessageType() Returns the BIOP message type.
MutableList<String!>	getChildList() Returns a list of subobject names for the given service gateway or directory message response.
ParcelFileDescriptor	getFile() Returns the file descriptor for a given file message response.
IntArray	getStreamEventIds() Returns all event IDs carried in a given stream message response.
Array<String!>	getStreamEventNames() Returns all event names carried in a given stream message response.
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<DsmccResponse!>	CREATOR

Constants

BIOP_MESSAGE_TYPE_DIRECTORY

Added in API level 33

static val BIOP_MESSAGE_TYPE_DIRECTORY: String

BIOP directory message

Value: "directory"

BIOP_MESSAGE_TYPE_FILE

Added in API level 33

static val BIOP_MESSAGE_TYPE_FILE: String

BIOP file message

Value: "file"

BIOP_MESSAGE_TYPE_SERVICE_GATEWAY

Added in API level 33

static val BIOP_MESSAGE_TYPE_SERVICE_GATEWAY: String

BIOP service gateway message

Value: "service_gateway"

BIOP_MESSAGE_TYPE_STREAM

Added in API level 33

static val BIOP_MESSAGE_TYPE_STREAM: String

BIOP stream message

Value: "stream"

Public constructors

DsmccResponse

Added in API level 33

DsmccResponse(
    requestId: Int, 
    sequence: Int, 
    responseResult: Int, 
    file: ParcelFileDescriptor?)

Constructs a BIOP file message response.

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
file	ParcelFileDescriptor?: This value may be null.

DsmccResponse

Added in API level 33

DsmccResponse(
    requestId: Int, 
    sequence: Int, 
    responseResult: Int, 
    isServiceGateway: Boolean, 
    childList: MutableList<String!>?)

Constructs a BIOP service gateway or directory message response.

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
childList	MutableList<String!>?: This value may be null.

DsmccResponse

Added in API level 33

DsmccResponse(
    requestId: Int, 
    sequence: Int, 
    responseResult: Int, 
    eventIds: IntArray?, 
    eventNames: Array<String!>?)

Constructs a BIOP stream message response.

The current stream message response does not support other stream messages types than stream event message type.

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
eventIds	IntArray?: This value may be null.
eventNames	Array<String!>?: This value may be null.

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

getBiopMessageType

Added in API level 33

fun getBiopMessageType(): String

Returns the BIOP message type.

Return
String	This value cannot be null. Value is android.media.tv.DsmccResponse#BIOP_MESSAGE_TYPE_DIRECTORY, android.media.tv.DsmccResponse#BIOP_MESSAGE_TYPE_FILE, android.media.tv.DsmccResponse#BIOP_MESSAGE_TYPE_STREAM, or android.media.tv.DsmccResponse#BIOP_MESSAGE_TYPE_SERVICE_GATEWAY

getChildList

Added in API level 33

fun getChildList(): MutableList<String!>

Returns a list of subobject names for the given service gateway or directory message response.

Return
MutableList<String!>	This value cannot be null.

getFile

Added in API level 33

fun getFile(): ParcelFileDescriptor

Returns the file descriptor for a given file message response.

Return
ParcelFileDescriptor	This value cannot be null.

getStreamEventIds

Added in API level 33

fun getStreamEventIds(): IntArray

Returns all event IDs carried in a given stream message response.

Return
IntArray	This value cannot be null.

getStreamEventNames

Added in API level 33

fun getStreamEventNames(): Array<String!>

Returns all event names carried in a given stream message response.

Return
Array<String!>	This value cannot be null.

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<DsmccResponse!>