DsmccResponse
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 directory message |
| static String |
BIOP file message |
| static String |
BIOP service gateway message |
| static String |
BIOP stream message |
| Inherited constants | |
|---|---|
| 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 | |
| String |
Returns the BIOP message type. |
| MutableList<String!> |
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 |
Returns all event IDs carried in a given stream message response. |
| Array<String!> |
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 | |
|---|---|
| Properties | |
|---|---|
| static Parcelable.Creator<DsmccResponse!> | |
Constants
BIOP_MESSAGE_TYPE_DIRECTORY
static val BIOP_MESSAGE_TYPE_DIRECTORY: String
BIOP directory message
Value: "directory"BIOP_MESSAGE_TYPE_FILE
static val BIOP_MESSAGE_TYPE_FILE: String
BIOP file message
Value: "file"BIOP_MESSAGE_TYPE_SERVICE_GATEWAY
static val BIOP_MESSAGE_TYPE_SERVICE_GATEWAY: String
BIOP service gateway message
Value: "service_gateway"BIOP_MESSAGE_TYPE_STREAM
static val BIOP_MESSAGE_TYPE_STREAM: String
BIOP stream message
Value: "stream"Public constructors
DsmccResponse
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
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
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
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
fun getBiopMessageType(): String
Returns the BIOP message type.
getChildList
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
fun getFile(): ParcelFileDescriptor
Returns the file descriptor for a given file message response.
| Return | |
|---|---|
ParcelFileDescriptor |
This value cannot be null. |
getStreamEventIds
fun getStreamEventIds(): IntArray
Returns all event IDs carried in a given stream message response.
| Return | |
|---|---|
IntArray |
This value cannot be null. |
getStreamEventNames
fun getStreamEventNames(): Array<String!>
Returns all event names carried in a given stream message response.
| Return | |
|---|---|
Array<String!> |
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 |