SignalingDataInfo


class SignalingDataInfo : Parcelable
kotlin.Any
   ↳ android.media.tv.SignalingDataInfo

Describes a metadata object of a SignalingDataResponse.

Summary

Constants
static String

A/344:2023-5 9.

static String

The encoding of the content is UTF-8.

static Int

This value for getGroup() denotes that there's no group associated with this metadata.

Inherited constants
Public constructors
SignalingDataInfo(table: String, signalingDataType: String, version: Int, group: Int)

SignalingDataInfo(table: String, signalingDataType: String, version: Int, group: Int, encoding: String)

Public methods
Int

String

The content encoding of the data.

Int

Gets the LLS group ID.

String

Gets the signaling data type contained in this metadata object.

String

The signaling table data, represented as a XML, JSON or BASE64 string.

Int

Gets the version of the signalling element.

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<SignalingDataInfo!>

Constants

CONTENT_ENCODING_BASE64

static val CONTENT_ENCODING_BASE64: String

A/344:2023-5 9.2.10 compliant string for when the encoding of the content is Base64.

Value: "Base64"

CONTENT_ENCODING_UTF_8

static val CONTENT_ENCODING_UTF_8: String

The encoding of the content is UTF-8. This is the default value.

Value: "UTF-8"

LLS_NO_GROUP_ID

static val LLS_NO_GROUP_ID: Int

This value for getGroup() denotes that there's no group associated with this metadata.

Value: -1

Public constructors

SignalingDataInfo

SignalingDataInfo(
    table: String,
    signalingDataType: String,
    version: Int,
    group: Int)
Parameters
table String: This value cannot be null.
signalingDataType String: This value cannot be null.

SignalingDataInfo

SignalingDataInfo(
    table: String,
    signalingDataType: String,
    version: Int,
    group: Int,
    encoding: String)
Parameters
table String: This value cannot be null.
signalingDataType String: This value cannot be null.
encoding String: 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

getEncoding

fun getEncoding(): String

The content encoding of the data. This value defaults to CONTENT_ENCODING_UTF_8.

Can be either CONTENT_ENCODING_BASE64 or CONTENT_ENCODING_UTF_8.

Return
String The content encoding of the data. This value cannot be null. Value is android.media.tv.SignalingDataInfo#CONTENT_ENCODING_UTF_8, or android.media.tv.SignalingDataInfo#CONTENT_ENCODING_BASE64

getGroup

fun getGroup(): Int

Gets the LLS group ID. Required for LLS Tables. For SLS Metadata Objects, this should be LLS_NO_GROUP_ID.

Return
Int the LLS group ID.

getSignalingDataType

fun getSignalingDataType(): String

Gets the signaling data type contained in this metadata object. This may be either a LLS Metadata Object or a SLS Metadata Object name.

For more details on each type of metadata that can be requested, refer to the ATSC standard A/344:2023-5 9.2.10 - Query Signaling Data API.

Return
String the type of metadata in this metadata object This value cannot be null. Value is android.media.tv.SignalingDataRequest#SIGNALING_METADATA_APD, android.media.tv.SignalingDataRequest#SIGNALING_METADATA_USBD, android.media.tv.SignalingDataRequest#SIGNALING_METADATA_STSID, android.media.tv.SignalingDataRequest#SIGNALING_METADATA_MPD, android.media.tv.SignalingDataRequest#SIGNALING_METADATA_USD, android.media.tv.SignalingDataRequest#SIGNALING_METADATA_PAT, android.media.tv.SignalingDataRequest#SIGNALING_METADATA_MPT, android.media.tv.SignalingDataRequest#SIGNALING_METADATA_MPIT, android.media.tv.SignalingDataRequest#SIGNALING_METADATA_CRIT, android.media.tv.SignalingDataRequest#SIGNALING_METADATA_DCIT, android.media.tv.SignalingDataRequest#SIGNALING_METADATA_HELD, android.media.tv.SignalingDataRequest#SIGNALING_METADATA_DWD, android.media.tv.SignalingDataRequest#SIGNALING_METADATA_AEI, android.media.tv.SignalingDataRequest#SIGNALING_METADATA_VSPD, android.media.tv.SignalingDataRequest#SIGNALING_METADATA_ASD, android.media.tv.SignalingDataRequest#SIGNALING_METADATA_IED, android.media.tv.SignalingDataRequest#SIGNALING_METADATA_CAD, android.media.tv.SignalingDataRequest#SIGNALING_METADATA_ASPD, android.media.tv.SignalingDataRequest#SIGNALING_METADATA_SSD, android.media.tv.SignalingDataRequest#SIGNALING_METADATA_EMSG, android.media.tv.SignalingDataRequest#SIGNALING_METADATA_EVTI, android.media.tv.SignalingDataRequest#SIGNALING_METADATA_RSAT, android.media.tv.SignalingDataRequest#SIGNALING_METADATA_RDT, android.media.tv.SignalingDataRequest#SIGNALING_METADATA_SLT, android.media.tv.SignalingDataRequest#SIGNALING_METADATA_RRT, android.media.tv.SignalingDataRequest#SIGNALING_METADATA_STT, android.media.tv.SignalingDataRequest#SIGNALING_METADATA_AEAT, android.media.tv.SignalingDataRequest#SIGNALING_METADATA_OSN, android.media.tv.SignalingDataRequest#SIGNALING_METADATA_SMT, or android.media.tv.SignalingDataRequest#SIGNALING_METADATA_CDT

getTable

fun getTable(): String

The signaling table data, represented as a XML, JSON or BASE64 string.

For more details on how this data is formatted refer to the ATSC standard A/344:2023-5 9.2.10 - Query Signaling Data API.

Return
String The signaling table data. This value cannot be null.

getVersion

fun getVersion(): Int

Gets the version of the signalling element. For LLS, this should be the LLS_table_version. For SLS Metadata Objects, this should be metadataEnvelope@version. For more details on where this version comes from, refer to the ATSC 3.0 standard A/344:2023-5 9.2.10 - Query Signaling Data API.

Return
Int The version of the signalling element.

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