SignalingDataInfo

Kotlin |Java

public final class SignalingDataInfo
extends Object implements Parcelable

java.lang.Object
↳	android.media.tv.SignalingDataInfo

Describes a metadata object of a SignalingDataResponse.

Summary

Constants
`String`	`CONTENT_ENCODING_BASE64` A/344:2023-5 9.2.10 compliant string for when the encoding of the content is Base64.
`String`	`CONTENT_ENCODING_UTF_8` The encoding of the content is UTF-8.
`int`	`LLS_NO_GROUP_ID` This value for `getGroup()` denotes that there's no group associated with this metadata.

Inherited constants

From interface android.os.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(Parcel, int)`: 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)`".

Fields
`public static final Creator<SignalingDataInfo>`	`CREATOR`

Public constructors
`SignalingDataInfo(String table, String signalingDataType, int version, int group)`
`SignalingDataInfo(String table, String signalingDataType, int version, int group, String encoding)`

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`String`	`getEncoding()` The content encoding of the data.
`int`	`getGroup()` Gets the LLS group ID.
`String`	`getSignalingDataType()` Gets the signaling data type contained in this metadata object.
`String`	`getTable()` The signaling table data, represented as a XML, JSON or BASE64 string.
`int`	`getVersion()` Gets the version of the signalling element.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Constants

CONTENT_ENCODING_BASE64

Added in Android Baklava

public static final String CONTENT_ENCODING_BASE64

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

Constant Value: "Base64"

CONTENT_ENCODING_UTF_8

Added in Android Baklava

public static final String CONTENT_ENCODING_UTF_8

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

Constant Value: "UTF-8"

LLS_NO_GROUP_ID

Added in Android Baklava

public static final int LLS_NO_GROUP_ID

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

Constant Value: -1 (0xffffffff)

Fields

CREATOR

Added in Android Baklava

public static final Creator<SignalingDataInfo> CREATOR

Public constructors

SignalingDataInfo

Added in Android Baklava

public SignalingDataInfo (String table, 
                String signalingDataType, 
                int version, 
                int group)

Parameters
`table`	`String`: This value cannot be `null`.
`signalingDataType`	`String`: This value cannot be `null`.
`version`	`int`
`group`	`int`

SignalingDataInfo

Added in Android Baklava

public SignalingDataInfo (String table, 
                String signalingDataType, 
                int version, 
                int group, 
                String encoding)

Parameters
`table`	`String`: This value cannot be `null`.
`signalingDataType`	`String`: This value cannot be `null`.
`version`	`int`
`group`	`int`
`encoding`	`String`: This value cannot be `null`.

Public methods

describeContents

Added in Android Baklava

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`

getEncoding

Added in Android Baklava

public String getEncoding ()

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.

Returns
`String`	The content encoding of the data. This value cannot be `null`. Value is `CONTENT_ENCODING_UTF_8`, or `CONTENT_ENCODING_BASE64`

getGroup

Added in Android Baklava

public int getGroup ()

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

Returns
`int`	the LLS group ID.

getSignalingDataType

Added in Android Baklava

public String getSignalingDataType ()

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.

Returns

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

String

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

getTable

Added in Android Baklava

public String getTable ()

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.

Returns
`String`	The signaling table data. This value cannot be `null`.

getVersion

Added in Android Baklava

public int getVersion ()

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.

Returns
`int`	The version of the signalling element.

writeToParcel

Added in Android Baklava

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