Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
Sidebar

Class RadioControlData

Hierarchy

java.lang.Object
     com.smartdevicelink.proxy.RPCStruct

Package
com.smartdevicelink.proxy.rpc

Overview

Include information (both read-only and changeable data) about a remote control radio module.

Fields

KEY_FREQUENCY_INTEGER

public static final java.lang.String KEY_FREQUENCY_INTEGER
Constant Value
"frequencyInteger"

KEY_FREQUENCY_FRACTION

public static final java.lang.String KEY_FREQUENCY_FRACTION
Constant Value
"frequencyFraction"

KEY_BAND

public static final java.lang.String KEY_BAND
Constant Value
"band"

KEY_RDS_DATA

public static final java.lang.String KEY_RDS_DATA
Constant Value
"rdsData"

KEY_AVAILABLE_HDS

public static final java.lang.String KEY_AVAILABLE_HDS
Constant Value
"availableHDs"

KEY_HD_CHANNEL

public static final java.lang.String KEY_HD_CHANNEL
Constant Value
"hdChannel"

KEY_SIGNAL_STRENGTH

public static final java.lang.String KEY_SIGNAL_STRENGTH
Constant Value
"signalStrength"

KEY_SIGNAL_CHANGE_THRESHOLD

public static final java.lang.String KEY_SIGNAL_CHANGE_THRESHOLD
Constant Value
"signalChangeThreshold"

KEY_RADIO_ENABLE

public static final java.lang.String KEY_RADIO_ENABLE
Constant Value
"radioEnable"

KEY_STATE

public static final java.lang.String KEY_STATE
Constant Value
"state"

KEY_HD_RADIO_ENABLE

public static final java.lang.String KEY_HD_RADIO_ENABLE
Constant Value
"hdRadioEnable"

KEY_SIS_DATA

public static final java.lang.String KEY_SIS_DATA
Constant Value
"sisData"

Inherited Fields

From Class Fields
com.smartdevicelink.proxy.RPCStruct KEY_BULK_DATA, KEY_PROTECTED, store

Constructors

RadioControlData()

public RadioControlData()

RadioControlData( java.util.Hashtable<java.lang.String, java.lang.Object> hash )

public RadioControlData(java.util.Hashtable<java.lang.String, java.lang.Object> hash)

Parameters

hash

Methods

setFrequencyInteger( Integer frequencyInteger )

Sets the frequencyInteger portion of the RadioControlData class

public void setFrequencyInteger(Integer frequencyInteger)

Parameters

frequencyInteger
The integer part of the frequency i.e. for 101.7 this value should be 101

getFrequencyInteger()

Gets the frequencyInteger portion of the RadioControlData class

public java.lang.Integer getFrequencyInteger()

setFrequencyFraction( Integer frequencyFraction )

Sets the frequencyFraction portion of the RadioControlData class

public void setFrequencyFraction(Integer frequencyFraction)

Parameters

frequencyFraction
The fractional part of the frequency i.e. for 101.7 is 7.

getFrequencyFraction()

Gets the frequencyFraction portion of the RadioControlData class

public java.lang.Integer getFrequencyFraction()

setBand( RadioBand band )

Sets the band portion of the RadioControlData class

public void setBand(RadioBand band)

Parameters

band
The radio band (AM|FM|XM) of the radio tuner.

getBand()

Gets the band portion of the RadioControlData class

public com.smartdevicelink.proxy.rpc.enums.RadioBand getBand()

setRdsData( RdsData rdsData )

Sets the rdsData portion of the RadioControlData class

public void setRdsData(RdsData rdsData)

Parameters

rdsData
Read only parameter. See RdsData data type for details.

getRdsData()

Gets the rdsData portion of the RadioControlData class

public com.smartdevicelink.proxy.rpc.RdsData getRdsData()

setAvailableHDs( Integer availableHDs )

Sets the availableHDs portion of the RadioControlData class

public void setAvailableHDs(Integer availableHDs)

Parameters

availableHDs
Number of HD sub-channels if available.

getAvailableHDs()

Gets the availableHDs portion of the RadioControlData class

public java.lang.Integer getAvailableHDs()

setHdChannel( Integer hdChannel )

Sets the hdChannel portion of the RadioControlData class

public void setHdChannel(Integer hdChannel)

Parameters

hdChannel
Current HD sub-channel if available.

getHdChannel()

Gets the hdChannel portion of the RadioControlData class

public java.lang.Integer getHdChannel()

setSignalStrength( Integer signalStrength )

Sets the signalStrength portion of the RadioControlData class

public void setSignalStrength(Integer signalStrength)

Parameters

signalStrength
Read only parameter. Indicates the strength of receiving radio signal in current frequency.

getSignalStrength()

Gets the signalStrength portion of the RadioControlData class

public java.lang.Integer getSignalStrength()

setSignalChangeThreshold( Integer signalChangeThreshold )

Sets the signalChangeThreshold portion of the RadioControlData class

public void setSignalChangeThreshold(Integer signalChangeThreshold)

Parameters

signalChangeThreshold
If the signal strength falls below the set value for this parameter, the radio will tune to an alternative frequency.

getSignalChangeThreshold()

Gets the signalChangeThreshold portion of the RadioControlData class

public java.lang.Integer getSignalChangeThreshold()

setRadioEnable( Boolean radioEnable )

Sets the radioEnable portion of the RadioControlData class
Note: If this is set to false, no other data will be included.
Note: This setting is normally a READ-ONLY setting.

public void setRadioEnable(Boolean radioEnable)

Parameters

radioEnable
True if the radio is on, false is the radio is off.

getRadioEnable()

Gets the radioEnable portion of the RadioControlData class
Note: If this is set to false, no other data will be included.

public java.lang.Boolean getRadioEnable()

setState( RadioState state )

Sets the state portion of the RadioControlData class

public void setState(RadioState state)

Parameters

state
Read only parameter. See RadioState data type for details.

getState()

Gets the state portion of the RadioControlData class

public com.smartdevicelink.proxy.rpc.enums.RadioState getState()

setHdRadioEnable( Boolean hdRadioEnable )

Sets the hdRadioEnable portion of the RadioControlData class

public void setHdRadioEnable(Boolean hdRadioEnable)

Parameters

hdRadioEnable
True if the hd radio is on, false if the radio is off.

getHdRadioEnable()

Gets the hdRadioEnable portion of the RadioControlData class

public java.lang.Boolean getHdRadioEnable()

setSisData( SisData sisData )

Sets the sisData portion of the RadioControlData class

public void setSisData(SisData sisData)

Parameters

sisData
Read-only Station Information Service (SIS) data provides basic information about the station such as call sign, as well as information not displayable to the consumer such as the station identification number.

getSisData()

Gets the sisData portion of the RadioControlData class

public com.smartdevicelink.proxy.rpc.SisData getSisData()

Inherited Methods

From Class Methods
com.smartdevicelink.proxy.RPCStruct getStoreValue, getStore, deserializeJSON, deserializeJSONObject, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong
java.lang.Object getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize
View on GitHub.com
Previous Section Next Section