DsmccResponse

public final class DsmccResponse
extends BroadcastInfoResponse implements Parcelable

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


A response for DSM-CC from broadcast signal.

Summary

Constants

String BIOP_MESSAGE_TYPE_DIRECTORY

BIOP directory message

String BIOP_MESSAGE_TYPE_FILE

BIOP file message

String BIOP_MESSAGE_TYPE_SERVICE_GATEWAY

BIOP service gateway message

String BIOP_MESSAGE_TYPE_STREAM

BIOP stream message

Inherited constants

Fields

public static final Creator<DsmccResponse> CREATOR

Inherited fields

Public constructors

DsmccResponse(int requestId, int sequence, int responseResult, ParcelFileDescriptor file)

Constructs a BIOP file message response.

DsmccResponse(int requestId, int sequence, int responseResult, boolean isServiceGateway, List<String> childList)

Constructs a BIOP service gateway or directory message response.

DsmccResponse(int requestId, int sequence, int responseResult, int[] eventIds, String[] eventNames)

Constructs a BIOP stream message response.

Public methods

int describeContents()

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

String getBiopMessageType()

Returns the BIOP message type.

List<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.

int[] getStreamEventIds()

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

String[] getStreamEventNames()

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

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Constants

BIOP_MESSAGE_TYPE_DIRECTORY

Added in API level 33
public static final String BIOP_MESSAGE_TYPE_DIRECTORY

BIOP directory message

Constant Value: "directory"

BIOP_MESSAGE_TYPE_FILE

Added in API level 33
public static final String BIOP_MESSAGE_TYPE_FILE

BIOP file message

Constant Value: "file"

BIOP_MESSAGE_TYPE_SERVICE_GATEWAY

Added in API level 33
public static final String BIOP_MESSAGE_TYPE_SERVICE_GATEWAY

BIOP service gateway message

Constant Value: "service_gateway"

BIOP_MESSAGE_TYPE_STREAM

Added in API level 33
public static final String BIOP_MESSAGE_TYPE_STREAM

BIOP stream message

Constant Value: "stream"

Fields

CREATOR

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

Public constructors

DsmccResponse

Added in API level 33
public DsmccResponse (int requestId, 
                int sequence, 
                int responseResult, 
                ParcelFileDescriptor file)

Constructs a BIOP file message response.

Parameters
requestId int

sequence int

responseResult int: Value is BroadcastInfoResponse.RESPONSE_RESULT_ERROR, BroadcastInfoResponse.RESPONSE_RESULT_OK, or BroadcastInfoResponse.RESPONSE_RESULT_CANCEL

file ParcelFileDescriptor: This value may be null.

DsmccResponse

Added in API level 33
public DsmccResponse (int requestId, 
                int sequence, 
                int responseResult, 
                boolean isServiceGateway, 
                List<String> childList)

Constructs a BIOP service gateway or directory message response.

Parameters
requestId int

sequence int

responseResult int: Value is BroadcastInfoResponse.RESPONSE_RESULT_ERROR, BroadcastInfoResponse.RESPONSE_RESULT_OK, or BroadcastInfoResponse.RESPONSE_RESULT_CANCEL

isServiceGateway boolean

childList List: This value may be null.

DsmccResponse

Added in API level 33
public DsmccResponse (int requestId, 
                int sequence, 
                int responseResult, 
                int[] eventIds, 
                String[] eventNames)

Constructs a BIOP stream message response.

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

Parameters
requestId int

sequence int

responseResult int: Value is BroadcastInfoResponse.RESPONSE_RESULT_ERROR, BroadcastInfoResponse.RESPONSE_RESULT_OK, or BroadcastInfoResponse.RESPONSE_RESULT_CANCEL

eventIds int: This value may be null.

eventNames String: This value may be null.

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

getBiopMessageType

Added in API level 33
public String getBiopMessageType ()

Returns the BIOP message type.

Returns
String This value cannot be null. Value is BIOP_MESSAGE_TYPE_DIRECTORY, BIOP_MESSAGE_TYPE_FILE, BIOP_MESSAGE_TYPE_STREAM, or BIOP_MESSAGE_TYPE_SERVICE_GATEWAY

getChildList

Added in API level 33
public List<String> getChildList ()

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

Returns
List<String> This value cannot be null.

getFile

Added in API level 33
public ParcelFileDescriptor getFile ()

Returns the file descriptor for a given file message response.

Returns
ParcelFileDescriptor This value cannot be null.

getStreamEventIds

Added in API level 33
public int[] getStreamEventIds ()

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

Returns
int[] This value cannot be null.

getStreamEventNames

Added in API level 33
public String[] getStreamEventNames ()

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

Returns
String[] This value cannot be null.

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