Class RadioControlData

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"

KEY_AVAILABLE_HD_CHANNELS

public static final java.lang.String KEY_AVAILABLE_HD_CHANNELS

Constant Value

"availableHdChannels"

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)

Constructor Parameters

hash

setFrequencyInteger( Integer frequencyInteger )

Sets the frequencyInteger portion of the RadioControlData class

public com.smartdevicelink.proxy.rpc.RadioControlData setFrequencyInteger(Integer frequencyInteger)

Method 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 com.smartdevicelink.proxy.rpc.RadioControlData setFrequencyFraction(Integer frequencyFraction)

Method 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 com.smartdevicelink.proxy.rpc.RadioControlData setBand(RadioBand band)

Method 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 com.smartdevicelink.proxy.rpc.RadioControlData setRdsData(RdsData rdsData)

Method 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 )

Deprecated
Sets the availableHDs portion of the RadioControlData class

public com.smartdevicelink.proxy.rpc.RadioControlData setAvailableHDs(Integer availableHDs)

Method Parameters

availableHDs

Number of HD sub-channels if available.

getAvailableHDs()

Deprecated
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 com.smartdevicelink.proxy.rpc.RadioControlData setHdChannel(Integer hdChannel)

Method 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 com.smartdevicelink.proxy.rpc.RadioControlData setSignalStrength(Integer signalStrength)

Method 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 com.smartdevicelink.proxy.rpc.RadioControlData setSignalChangeThreshold(Integer signalChangeThreshold)

Method 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 com.smartdevicelink.proxy.rpc.RadioControlData setRadioEnable(Boolean radioEnable)

Method 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 com.smartdevicelink.proxy.rpc.RadioControlData setState(RadioState state)

Method 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 com.smartdevicelink.proxy.rpc.RadioControlData setHdRadioEnable(Boolean hdRadioEnable)

Method 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 com.smartdevicelink.proxy.rpc.RadioControlData setSisData(SisData sisData)

Method 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()

setAvailableHdChannels( java.util.List<java.lang.Integer> availableHdChannels )

Sets the availableHdChannels portion of the RadioControlData class

public com.smartdevicelink.proxy.rpc.RadioControlData setAvailableHdChannels(java.util.List<java.lang.Integer> availableHdChannels)

Method Parameters

availableHdChannels

List of available hd sub-channel indexes, empty list means no Hd channel is available, read-only.

getAvailableHdChannels()

Gets the availableHdChannels portion of the RadioControlData class

public java.util.List getAvailableHdChannels()