com.smartdevicelink.proxy.rpc

Class RadioControlData

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.rpc.RadioControlData

All Implemented Interfaces:

Cloneable

public class RadioControlData
extends RPCStruct

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_AVAILABLE_HD_CHANNELS
static String	KEY_AVAILABLE_HDS Deprecated.
static String	KEY_BAND
static String	KEY_FREQUENCY_FRACTION
static String	KEY_FREQUENCY_INTEGER
static String	KEY_HD_CHANNEL
static String	KEY_HD_RADIO_ENABLE
static String	KEY_RADIO_ENABLE
static String	KEY_RDS_DATA
static String	KEY_SIGNAL_CHANGE_THRESHOLD
static String	KEY_SIGNAL_STRENGTH
static String	KEY_SIS_DATA
static String	KEY_STATE

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
RadioControlData()
RadioControlData(Hashtable<String,Object> hash)

Method Summary

Modifier and Type	Method and Description
List<Integer>	getAvailableHdChannels() Gets the availableHdChannels portion of the RadioControlData class
Integer	getAvailableHDs() Deprecated.
RadioBand	getBand() Gets the band portion of the RadioControlData class
Integer	getFrequencyFraction() Gets the frequencyFraction portion of the RadioControlData class
Integer	getFrequencyInteger() Gets the frequencyInteger portion of the RadioControlData class
Integer	getHdChannel() Gets the hdChannel portion of the RadioControlData class
Boolean	getHdRadioEnable() Gets the hdRadioEnable portion of the RadioControlData class
Boolean	getRadioEnable() Gets the radioEnable portion of the RadioControlData class Note: If this is set to false, no other data will be included.
RdsData	getRdsData() Gets the rdsData portion of the RadioControlData class
Integer	getSignalChangeThreshold() Gets the signalChangeThreshold portion of the RadioControlData class
Integer	getSignalStrength() Gets the signalStrength portion of the RadioControlData class
SisData	getSisData() Gets the sisData portion of the RadioControlData class
RadioState	getState() Gets the state portion of the RadioControlData class
RadioControlData	setAvailableHdChannels(List<Integer> availableHdChannels) Sets the availableHdChannels portion of the RadioControlData class
RadioControlData	setAvailableHDs(Integer availableHDs) Deprecated.
RadioControlData	setBand(RadioBand band) Sets the band portion of the RadioControlData class
RadioControlData	setFrequencyFraction(Integer frequencyFraction) Sets the frequencyFraction portion of the RadioControlData class
RadioControlData	setFrequencyInteger(Integer frequencyInteger) Sets the frequencyInteger portion of the RadioControlData class
RadioControlData	setHdChannel(Integer hdChannel) Sets the hdChannel portion of the RadioControlData class
RadioControlData	setHdRadioEnable(Boolean hdRadioEnable) Sets the hdRadioEnable portion of the RadioControlData class
RadioControlData	setRadioEnable(Boolean radioEnable) Sets the radioEnable portion of the RadioControlData class Note: If this is set to false, no other data will be included.
RadioControlData	setRdsData(RdsData rdsData) Sets the rdsData portion of the RadioControlData class
RadioControlData	setSignalChangeThreshold(Integer signalChangeThreshold) Sets the signalChangeThreshold portion of the RadioControlData class
RadioControlData	setSignalStrength(Integer signalStrength) Sets the signalStrength portion of the RadioControlData class
RadioControlData	setSisData(SisData sisData) Sets the sisData portion of the RadioControlData class
RadioControlData	setState(RadioState state) Sets the state portion of the RadioControlData class

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, format, formatObject, getBoolean, getBulkData, getDouble, getFloat, getInteger, getLong, getMessageTypeName, getObject, getStore, getStoreValue, getString, getValue, getValueForString, hashCode, hasKey, isPayloadProtected, serializeJSON, serializeJSON, setBulkData, setPayloadProtected, setValue

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY_FREQUENCY_INTEGER

public static final String KEY_FREQUENCY_INTEGER

See Also:

Constant Field Values

KEY_FREQUENCY_FRACTION

public static final String KEY_FREQUENCY_FRACTION

See Also:

Constant Field Values

KEY_BAND

public static final String KEY_BAND

See Also:

Constant Field Values

KEY_RDS_DATA

public static final String KEY_RDS_DATA

See Also:

Constant Field Values

KEY_AVAILABLE_HDS

@Deprecated
public static final String KEY_AVAILABLE_HDS

Deprecated.

See Also:

Constant Field Values

KEY_HD_CHANNEL

public static final String KEY_HD_CHANNEL

See Also:

Constant Field Values

KEY_SIGNAL_STRENGTH

public static final String KEY_SIGNAL_STRENGTH

See Also:

Constant Field Values

KEY_SIGNAL_CHANGE_THRESHOLD

public static final String KEY_SIGNAL_CHANGE_THRESHOLD

See Also:

Constant Field Values

KEY_RADIO_ENABLE

public static final String KEY_RADIO_ENABLE

See Also:

Constant Field Values

KEY_STATE

public static final String KEY_STATE

See Also:

Constant Field Values

KEY_HD_RADIO_ENABLE

public static final String KEY_HD_RADIO_ENABLE

See Also:

Constant Field Values

KEY_SIS_DATA

public static final String KEY_SIS_DATA

See Also:

Constant Field Values

KEY_AVAILABLE_HD_CHANNELS

public static final String KEY_AVAILABLE_HD_CHANNELS

See Also:

Constant Field Values

Constructor Detail

RadioControlData

public RadioControlData()

RadioControlData

public RadioControlData(Hashtable<String,Object> hash)

Method Detail

setFrequencyInteger

public RadioControlData setFrequencyInteger(Integer frequencyInteger)

Sets the frequencyInteger portion of the RadioControlData class

Parameters:

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

getFrequencyInteger

public Integer getFrequencyInteger()

Gets the frequencyInteger portion of the RadioControlData class

Returns:

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

setFrequencyFraction

public RadioControlData setFrequencyFraction(Integer frequencyFraction)

Sets the frequencyFraction portion of the RadioControlData class

Parameters:

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

getFrequencyFraction

public Integer getFrequencyFraction()

Gets the frequencyFraction portion of the RadioControlData class

Returns:

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

setBand

public RadioControlData setBand(RadioBand band)

Sets the band portion of the RadioControlData class

Parameters:

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

getBand

public RadioBand getBand()

Gets the band portion of the RadioControlData class

Returns:

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

setRdsData

public RadioControlData setRdsData(RdsData rdsData)

Sets the rdsData portion of the RadioControlData class

Parameters:

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

getRdsData

public RdsData getRdsData()

Gets the rdsData portion of the RadioControlData class

Returns:

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

setAvailableHDs

@Deprecated
public RadioControlData setAvailableHDs(Integer availableHDs)

Deprecated.

Sets the availableHDs portion of the RadioControlData class

Parameters:

availableHDs - Number of HD sub-channels if available.

getAvailableHDs

@Deprecated
public Integer getAvailableHDs()

Deprecated.

Gets the availableHDs portion of the RadioControlData class

Returns:

Integer - Number of HD sub-channels if available.

setHdChannel

public RadioControlData setHdChannel(Integer hdChannel)

Sets the hdChannel portion of the RadioControlData class

Parameters:

hdChannel - Current HD sub-channel if available.

getHdChannel

public Integer getHdChannel()

Gets the hdChannel portion of the RadioControlData class

Returns:

Integer - Current HD sub-channel if available.

setSignalStrength

public RadioControlData setSignalStrength(Integer signalStrength)

Sets the signalStrength portion of the RadioControlData class

Parameters:

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

getSignalStrength

public Integer getSignalStrength()

Gets the signalStrength portion of the RadioControlData class

Returns:

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

setSignalChangeThreshold

public RadioControlData setSignalChangeThreshold(Integer signalChangeThreshold)

Sets the signalChangeThreshold portion of the RadioControlData class

Parameters:

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

getSignalChangeThreshold

public Integer getSignalChangeThreshold()

Gets the signalChangeThreshold portion of the RadioControlData class

Returns:

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

setRadioEnable

public RadioControlData 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.

Parameters:

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

getRadioEnable

public Boolean getRadioEnable()

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

Returns:

Boolean - True if the radio is on, false is the radio is off.

setState

public RadioControlData setState(RadioState state)

Sets the state portion of the RadioControlData class

Parameters:

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

getState

public RadioState getState()

Gets the state portion of the RadioControlData class

Returns:

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

setHdRadioEnable

public RadioControlData setHdRadioEnable(Boolean hdRadioEnable)

Sets the hdRadioEnable portion of the RadioControlData class

Parameters:

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

getHdRadioEnable

public Boolean getHdRadioEnable()

Gets the hdRadioEnable portion of the RadioControlData class

Returns:

Boolean - True if the hd radio is on, false if the radio is off.

setSisData

public RadioControlData setSisData(SisData sisData)

Sets the sisData portion of the RadioControlData class

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

public SisData getSisData()

Gets the sisData portion of the RadioControlData class

Returns:

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.

setAvailableHdChannels

public RadioControlData setAvailableHdChannels(List<Integer> availableHdChannels)

Sets the availableHdChannels portion of the RadioControlData class

Parameters:

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

getAvailableHdChannels

public List<Integer> getAvailableHdChannels()

Gets the availableHdChannels portion of the RadioControlData class

Returns:

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