CommandRequest

Kotlin |Java

class CommandRequest : BroadcastInfoRequest, Parcelable

kotlin.Any
↳	android.media.tv.BroadcastInfoRequest
	↳	android.media.tv.CommandRequest

A request for command from broadcast signal.

Summary

Constants
static String	`ARGUMENT_TYPE_JSON`
static String	`ARGUMENT_TYPE_XML`

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 BroadcastInfoRequest

Int

REQUEST_OPTION_AUTO_UPDATE

Request option: auto update.

With this option, a response is sent only when broadcast information is detected for the first time, new values are detected.

Int

REQUEST_OPTION_REPEAT

Request option: repeat.

With this option, a response is sent when related broadcast information is detected, even if the same information has been sent previously.

Public constructors
`CommandRequest(requestId: Int, option: Int, namespace: String, name: String, arguments: String, argumentType: String)`

Public methods
Int	`describeContents()`
String	`getArgumentType()` Gets the argument type of the command.
String	`getArguments()` Gets the arguments of the command.
String	`getName()` Gets the name of the command.
String	`getNamespace()` Gets the namespace of the command.
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Inherited functions

From class BroadcastInfoRequest

Int

getOption()

Gets the request option of the request.

Int

getRequestId()

Gets the ID of the request.

The ID is used to associate the response with the request.

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<CommandRequest!>	`CREATOR`

Constants

ARGUMENT_TYPE_JSON

Added in API level 33

static val ARGUMENT_TYPE_JSON: String

Value: "json"

ARGUMENT_TYPE_XML

Added in API level 33

static val ARGUMENT_TYPE_XML: String

Value: "xml"

Public constructors

CommandRequest

Added in API level 33

CommandRequest(
    requestId: Int, 
    option: Int, 
    namespace: String, 
    name: String, 
    arguments: String, 
    argumentType: String)

Parameters
`option`	Int: Value is `android.media.tv.BroadcastInfoRequest#REQUEST_OPTION_REPEAT`, `android.media.tv.BroadcastInfoRequest#REQUEST_OPTION_AUTO_UPDATE`, android.media.tv.BroadcastInfoRequest.REQUEST_OPTION_ONEWAY, or android.media.tv.BroadcastInfoRequest.REQUEST_OPTION_ONESHOT
`namespace`	String: This value cannot be `null`.
`name`	String: This value cannot be `null`.
`arguments`	String: This value cannot be `null`.
`argumentType`	String: This value cannot 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`

getArgumentType

Added in API level 33

fun getArgumentType(): String

Gets the argument type of the command. It could be either JSON or XML.

Return
`String`	This value cannot be `null`.

getArguments

Added in API level 33

fun getArguments(): String

Gets the arguments of the command. It could be serialized from some formats, such as JSON, XML, etc.

Return
`String`	This value cannot be `null`.

getName

Added in API level 33

fun getName(): String

Gets the name of the command.

Return
`String`	This value cannot be `null`.

getNamespace

Added in API level 33

fun getNamespace(): String

Gets the namespace of the command.

Return
`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<CommandRequest!>