RadioControlCapabilities (sdl

java.lang.Object
- com.smartdevicelink.proxy.RPCStruct
- - com.smartdevicelink.proxy.rpc.RadioControlCapabilities

All Implemented Interfaces:

Cloneable
```
public class RadioControlCapabilities
extends RPCStruct
```
Contains information about a radio control module's capabilities.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`KEY_AVAILABLE_HD_CHANNELS_AVAILABLE`
`static String`	`KEY_AVAILABLE_HDS_AVAILABLE` Deprecated.
`static String`	`KEY_HD_CHANNEL_AVAILABLE`
`static String`	`KEY_HD_RADIO_ENABLE_AVAILABLE`
`static String`	`KEY_MODULE_INFO`
`static String`	`KEY_MODULE_NAME`
`static String`	`KEY_RADIO_BAND_AVAILABLE`
`static String`	`KEY_RADIO_ENABLE_AVAILABLE`
`static String`	`KEY_RADIO_FREQUENCY_AVAILABLE`
`static String`	`KEY_RDS_DATA_AVAILABLE`
`static String`	`KEY_SIGNAL_CHANGE_THRESHOLD_AVAILABLE`
`static String`	`KEY_SIGNAL_STRENGTH_AVAILABLE`
`static String`	`KEY_SIRIUS_XM_RADIO_AVAILABLE`
`static String`	`KEY_SIS_DATA_AVAILABLE`
`static String`	`KEY_STATE_AVAILABLE`

Fields inherited from class com.smartdevicelink.proxy.RPCStruct
KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors
Constructor and Description
`RadioControlCapabilities()`
`RadioControlCapabilities(Hashtable<String,Object> hash)`
`RadioControlCapabilities(String moduleName)` Constructs a new RadioControlCapabilities object

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Boolean`	`getAvailableHdChannelsAvailable()` Gets the availableHdChannelsAvailable portion of the RadioControlCapabilities class
`Boolean`	`getAvailableHDsAvailable()` Deprecated.
`Boolean`	`getHdChannelAvailable()` Gets the hdChannelAvailable portion of the RadioControlCapabilities class
`Boolean`	`getHdRadioEnableAvailable()` Gets the hdRadioEnableAvailable portion of the RadioControlCapabilities class
`ModuleInfo`	`getModuleInfo()` Gets a ModuleInfo of this capability
`String`	`getModuleName()` Gets the moduleName portion of the RadioControlCapabilities class
`Boolean`	`getRadioBandAvailable()` Gets the radioBandAvailable portion of the RadioControlCapabilities class
`Boolean`	`getRadioEnableAvailable()` Gets the radioEnableAvailable portion of the RadioControlCapabilities class
`Boolean`	`getRadioFrequencyAvailable()` Gets the radioFrequencyAvailable portion of the RadioControlCapabilities class
`Boolean`	`getRdsDataAvailable()` Gets the rdsDataAvailable portion of the RadioControlCapabilities class
`Boolean`	`getSignalChangeThresholdAvailable()` Gets the signalChangeThresholdAvailable portion of the RadioControlCapabilities class
`Boolean`	`getSignalStrengthAvailable()` Gets the signalStrengthAvailable portion of the RadioControlCapabilities class
`Boolean`	`getSiriusXMRadioAvailable()` Gets the siriusxmRadioAvailable portion of the RadioControlCapabilities class
`Boolean`	`getSisDataAvailable()` Gets the sisDataAvailable portion of the RadioControlCapabilities class
`Boolean`	`getStateAvailable()` Gets the stateAvailable portion of the RadioControlCapabilities class
`RadioControlCapabilities`	`setAvailableHdChannelsAvailable(Boolean availableHdChannelsAvailable)` Sets the availableHdChannelsAvailable portion of the RadioControlCapabilities class
`RadioControlCapabilities`	`setAvailableHDsAvailable(Boolean availableHDsAvailable)` Deprecated.
`RadioControlCapabilities`	`setHdChannelAvailable(Boolean hdChannelAvailable)` Sets the hdChannelAvailable portion of the RadioControlCapabilities class
`RadioControlCapabilities`	`setHdRadioEnableAvailable(Boolean hdRadioEnableAvailable)` Sets the hdRadioEnableAvailable portion of the RadioControlCapabilities class
`RadioControlCapabilities`	`setModuleInfo(ModuleInfo info)` Sets ModuleInfo for this capability
`RadioControlCapabilities`	`setModuleName(String moduleName)` Sets the moduleName portion of the RadioControlCapabilities class
`RadioControlCapabilities`	`setRadioBandAvailable(Boolean radioBandAvailable)` Sets the radioBandAvailable portion of the RadioControlCapabilities class
`RadioControlCapabilities`	`setRadioEnableAvailable(Boolean radioEnableAvailable)` Sets the radioEnableAvailable portion of the RadioControlCapabilities class
`RadioControlCapabilities`	`setRadioFrequencyAvailable(Boolean radioFrequencyAvailable)` Sets the radioFrequencyAvailable portion of the RadioControlCapabilities class
`RadioControlCapabilities`	`setRdsDataAvailable(Boolean rdsDataAvailable)` Sets the rdsDataAvailable portion of the RadioControlCapabilities class
`RadioControlCapabilities`	`setSignalChangeThresholdAvailable(Boolean signalChangeThresholdAvailable)` Sets the signalChangeThresholdAvailable portion of the RadioControlCapabilities class
`RadioControlCapabilities`	`setSignalStrengthAvailable(Boolean signalStrengthAvailable)` Sets the signalStrengthAvailable portion of the RadioControlCapabilities class
`RadioControlCapabilities`	`setSiriusXMRadioAvailable(Boolean siriusxmRadioAvailable)` Sets the siriusxmRadioAvailable portion of the RadioControlCapabilities class
`RadioControlCapabilities`	`setSisDataAvailable(Boolean sisDataAvailable)` Sets the sisDataAvailable portion of the RadioControlCapabilities class
`RadioControlCapabilities`	`setStateAvailable(Boolean stateAvailable)` Sets the stateAvailable portion of the RadioControlCapabilities 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_MODULE_NAME
```
public static final String KEY_MODULE_NAME
```
    See Also:
    
    Constant Field Values
  - KEY_RADIO_ENABLE_AVAILABLE
```
public static final String KEY_RADIO_ENABLE_AVAILABLE
```
    See Also:
    
    Constant Field Values
  - KEY_RADIO_BAND_AVAILABLE
```
public static final String KEY_RADIO_BAND_AVAILABLE
```
    See Also:
    
    Constant Field Values
  - KEY_RADIO_FREQUENCY_AVAILABLE
```
public static final String KEY_RADIO_FREQUENCY_AVAILABLE
```
    See Also:
    
    Constant Field Values
  - KEY_HD_CHANNEL_AVAILABLE
```
public static final String KEY_HD_CHANNEL_AVAILABLE
```
    See Also:
    
    Constant Field Values
  - KEY_RDS_DATA_AVAILABLE
```
public static final String KEY_RDS_DATA_AVAILABLE
```
    See Also:
    
    Constant Field Values
  - KEY_AVAILABLE_HDS_AVAILABLE
```
@Deprecated
public static final String KEY_AVAILABLE_HDS_AVAILABLE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - KEY_STATE_AVAILABLE
```
public static final String KEY_STATE_AVAILABLE
```
    See Also:
    
    Constant Field Values
  - KEY_SIGNAL_STRENGTH_AVAILABLE
```
public static final String KEY_SIGNAL_STRENGTH_AVAILABLE
```
    See Also:
    
    Constant Field Values
  - KEY_SIGNAL_CHANGE_THRESHOLD_AVAILABLE
```
public static final String KEY_SIGNAL_CHANGE_THRESHOLD_AVAILABLE
```
    See Also:
    
    Constant Field Values
  - KEY_HD_RADIO_ENABLE_AVAILABLE
```
public static final String KEY_HD_RADIO_ENABLE_AVAILABLE
```
    See Also:
    
    Constant Field Values
  - KEY_SIRIUS_XM_RADIO_AVAILABLE
```
public static final String KEY_SIRIUS_XM_RADIO_AVAILABLE
```
    See Also:
    
    Constant Field Values
  - KEY_SIS_DATA_AVAILABLE
```
public static final String KEY_SIS_DATA_AVAILABLE
```
    See Also:
    
    Constant Field Values
  - KEY_MODULE_INFO
```
public static final String KEY_MODULE_INFO
```
    See Also:
    
    Constant Field Values
  - KEY_AVAILABLE_HD_CHANNELS_AVAILABLE
```
public static final String KEY_AVAILABLE_HD_CHANNELS_AVAILABLE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - RadioControlCapabilities
```
public RadioControlCapabilities()
```
  - RadioControlCapabilities
```
public RadioControlCapabilities(Hashtable<String,Object> hash)
```
  - RadioControlCapabilities
```
public RadioControlCapabilities(@NonNull
                                String moduleName)
```
    Constructs a new RadioControlCapabilities object
    
    Parameters:
    
    moduleName - The short friendly name of the radio control module. It should not be used to identify a module by mobile application.
- Method Detail
  - setModuleName
```
public RadioControlCapabilities setModuleName(@NonNull
                                              String moduleName)
```
    Sets the moduleName portion of the RadioControlCapabilities class
    
    Parameters:
    
    moduleName - The short friendly name of the radio control module. It should not be used to identify a module by mobile application.
  - getModuleName
```
public String getModuleName()
```
    Gets the moduleName portion of the RadioControlCapabilities class
    
    Returns:
    
    String - Short friendly name of the radio control module.
  - setRadioEnableAvailable
```
public RadioControlCapabilities setRadioEnableAvailable(Boolean radioEnableAvailable)
```
    Sets the radioEnableAvailable portion of the RadioControlCapabilities class
    
    Parameters:
    
    radioEnableAvailable - Availability of the control of enable/disable radio. True: Available, False: Not Available, Not present: Not Available.
  - getRadioEnableAvailable
```
public Boolean getRadioEnableAvailable()
```
    Gets the radioEnableAvailable portion of the RadioControlCapabilities class
    
    Returns:
    
    Boolean - Availability of the control of enable/disable radio. True: Available, False: Not Available, Not present: Not Available.
  - setRadioBandAvailable
```
public RadioControlCapabilities setRadioBandAvailable(Boolean radioBandAvailable)
```
    Sets the radioBandAvailable portion of the RadioControlCapabilities class
    
    Parameters:
    
    radioBandAvailable - Availability of the control of radio band. True: Available, False: Not Available, Not present: Not Available.
  - getRadioBandAvailable
```
public Boolean getRadioBandAvailable()
```
    Gets the radioBandAvailable portion of the RadioControlCapabilities class
    
    Returns:
    
    Boolean - Availability of the control of radio band. True: Available, False: Not Available, Not present: Not Available.
  - setRadioFrequencyAvailable
```
public RadioControlCapabilities setRadioFrequencyAvailable(Boolean radioFrequencyAvailable)
```
    Sets the radioFrequencyAvailable portion of the RadioControlCapabilities class
    
    Parameters:
    
    radioFrequencyAvailable - Availability of the control of radio frequency. True: Available, False: Not Available, Not present: Not Available.
  - getRadioFrequencyAvailable
```
public Boolean getRadioFrequencyAvailable()
```
    Gets the radioFrequencyAvailable portion of the RadioControlCapabilities class
    
    Returns:
    
    Boolean - Availability of the control of radio frequency. True: Available, False: Not Available, Not present: Not Available.
  - setHdChannelAvailable
```
public RadioControlCapabilities setHdChannelAvailable(Boolean hdChannelAvailable)
```
    Sets the hdChannelAvailable portion of the RadioControlCapabilities class
    
    Parameters:
    
    hdChannelAvailable - Availability of the control of HD radio channel. True: Available, False: Not Available, Not present: Not Available.
  - getHdChannelAvailable
```
public Boolean getHdChannelAvailable()
```
    Gets the hdChannelAvailable portion of the RadioControlCapabilities class
    
    Returns:
    
    Boolean - Availability of the control of HD radio channel. True: Available, False: Not Available, Not present: Not Available.
  - setRdsDataAvailable
```
public RadioControlCapabilities setRdsDataAvailable(Boolean rdsDataAvailable)
```
    Sets the rdsDataAvailable portion of the RadioControlCapabilities class
    
    Parameters:
    
    rdsDataAvailable - Availability of the getting Radio Data System (RDS) data. True: Available, False: Not Available, Not present: Not Available.
  - getRdsDataAvailable
```
public Boolean getRdsDataAvailable()
```
    Gets the rdsDataAvailable portion of the RadioControlCapabilities class
    
    Returns:
    
    Boolean - Availability of the getting Radio Data System (RDS) data. True: Available, False: Not Available, Not present: Not Available.
  - setAvailableHDsAvailable
```
@Deprecated
public RadioControlCapabilities setAvailableHDsAvailable(Boolean availableHDsAvailable)
```
    Deprecated.
    
    Sets the availableHDsAvailable portion of the RadioControlCapabilities class
    
    Parameters:
    
    availableHDsAvailable - Availability of the getting the number of available HD channels. True: Available, False: Not Available, Not present: Not Available.
  - getAvailableHDsAvailable
```
@Deprecated
public Boolean getAvailableHDsAvailable()
```
    Deprecated.
    
    Gets the availableHDsAvailable portion of the RadioControlCapabilities class
    
    Returns:
    
    Boolean - Availability of the getting the number of available HD channels. True: Available, False: Not Available, Not present: Not Available.
  - setAvailableHdChannelsAvailable
```
public RadioControlCapabilities setAvailableHdChannelsAvailable(Boolean availableHdChannelsAvailable)
```
    Sets the availableHdChannelsAvailable portion of the RadioControlCapabilities class
    
    Parameters:
    
    availableHdChannelsAvailable - Availability of the list of available HD sub-channel indexes. True: Available, False: Not Available, Not present: Not Available.
  - getAvailableHdChannelsAvailable
```
public Boolean getAvailableHdChannelsAvailable()
```
    Gets the availableHdChannelsAvailable portion of the RadioControlCapabilities class
    
    Returns:
    
    Boolean - Availability of the list of available HD sub-channel indexes. True: Available, False: Not Available, Not present: Not Available.
  - setStateAvailable
```
public RadioControlCapabilities setStateAvailable(Boolean stateAvailable)
```
    Sets the stateAvailable portion of the RadioControlCapabilities class
    
    Parameters:
    
    stateAvailable - Availability of the getting the Radio state. True: Available, False: Not Available, Not present: Not Available.
  - getStateAvailable
```
public Boolean getStateAvailable()
```
    Gets the stateAvailable portion of the RadioControlCapabilities class
    
    Returns:
    
    Boolean - Availability of the getting the Radio state. True: Available, False: Not Available, Not present: Not Available.
  - setSignalStrengthAvailable
```
public RadioControlCapabilities setSignalStrengthAvailable(Boolean signalStrengthAvailable)
```
    Sets the signalStrengthAvailable portion of the RadioControlCapabilities class
    
    Parameters:
    
    signalStrengthAvailable - Availability of the getting the signal strength. True: Available, False: Not Available, Not present: Not Available.
  - getSignalStrengthAvailable
```
public Boolean getSignalStrengthAvailable()
```
    Gets the signalStrengthAvailable portion of the RadioControlCapabilities class
    
    Returns:
    
    Boolean - Availability of the getting the signal strength. True: Available, False: Not Available, Not present: Not Available.
  - setSignalChangeThresholdAvailable
```
public RadioControlCapabilities setSignalChangeThresholdAvailable(Boolean signalChangeThresholdAvailable)
```
    Sets the signalChangeThresholdAvailable portion of the RadioControlCapabilities class
    
    Parameters:
    
    signalChangeThresholdAvailable - Availability of the getting the signal Change Threshold. True: Available, False: Not Available, Not present: Not Available.
  - getSignalChangeThresholdAvailable
```
public Boolean getSignalChangeThresholdAvailable()
```
    Gets the signalChangeThresholdAvailable portion of the RadioControlCapabilities class
    
    Returns:
    
    Boolean - Availability of the getting the signal Change Threshold. True: Available, False: Not Available, Not present: Not Available.
  - setHdRadioEnableAvailable
```
public RadioControlCapabilities setHdRadioEnableAvailable(Boolean hdRadioEnableAvailable)
```
    Sets the hdRadioEnableAvailable portion of the RadioControlCapabilities class
    
    Parameters:
    
    hdRadioEnableAvailable - Availability of the control of enable/disable HD radio. True: Available, False: Not Available, Not present: Not Available.
  - getHdRadioEnableAvailable
```
public Boolean getHdRadioEnableAvailable()
```
    Gets the hdRadioEnableAvailable portion of the RadioControlCapabilities class
    
    Returns:
    
    Boolean - Availability of the control of enable/disable HD radio. True: Available, False: Not Available, Not present: Not Available.
  - setSiriusXMRadioAvailable
```
public RadioControlCapabilities setSiriusXMRadioAvailable(Boolean siriusxmRadioAvailable)
```
    Sets the siriusxmRadioAvailable portion of the RadioControlCapabilities class
    
    Parameters:
    
    siriusxmRadioAvailable - Availability of sirius XM radio. True: Available, False: Not Available, Not present: Not Available.
  - getSiriusXMRadioAvailable
```
public Boolean getSiriusXMRadioAvailable()
```
    Gets the siriusxmRadioAvailable portion of the RadioControlCapabilities class
    
    Returns:
    
    Boolean - Availability of sirius XM radio. True: Available, False: Not Available, Not present: Not Available.
  - setSisDataAvailable
```
public RadioControlCapabilities setSisDataAvailable(Boolean sisDataAvailable)
```
    Sets the sisDataAvailable portion of the RadioControlCapabilities class
    
    Parameters:
    
    sisDataAvailable - Availability of the getting HD radio Station Information Service (SIS) data. True: Available, False: Not Available, Not present: Not Available.
  - getSisDataAvailable
```
public Boolean getSisDataAvailable()
```
    Gets the sisDataAvailable portion of the RadioControlCapabilities class
    
    Returns:
    
    Boolean - Availability of the getting HD radio Station Information Service (SIS) data. True: Available, False: Not Available, Not present: Not Available.
  - setModuleInfo
```
public RadioControlCapabilities setModuleInfo(ModuleInfo info)
```
    Sets ModuleInfo for this capability
    
    Parameters:
    
    info - the ModuleInfo to be set
  - getModuleInfo
```
public ModuleInfo getModuleInfo()
```
    Gets a ModuleInfo of this capability
    
    Returns:
    
    module info of this capability

Class RadioControlCapabilities

Field Summary

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

Constructor Summary

Method Summary

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

Methods inherited from class java.lang.Object

Field Detail

KEY_MODULE_NAME

KEY_RADIO_ENABLE_AVAILABLE

KEY_RADIO_BAND_AVAILABLE

KEY_RADIO_FREQUENCY_AVAILABLE

KEY_HD_CHANNEL_AVAILABLE

KEY_RDS_DATA_AVAILABLE

KEY_AVAILABLE_HDS_AVAILABLE

KEY_STATE_AVAILABLE

KEY_SIGNAL_STRENGTH_AVAILABLE

KEY_SIGNAL_CHANGE_THRESHOLD_AVAILABLE

KEY_HD_RADIO_ENABLE_AVAILABLE

KEY_SIRIUS_XM_RADIO_AVAILABLE

KEY_SIS_DATA_AVAILABLE

KEY_MODULE_INFO

KEY_AVAILABLE_HD_CHANNELS_AVAILABLE

Constructor Detail

RadioControlCapabilities

RadioControlCapabilities

RadioControlCapabilities

Method Detail

setModuleName

getModuleName

setRadioEnableAvailable

getRadioEnableAvailable

setRadioBandAvailable

getRadioBandAvailable

setRadioFrequencyAvailable

getRadioFrequencyAvailable

setHdChannelAvailable

getHdChannelAvailable

setRdsDataAvailable

getRdsDataAvailable

setAvailableHDsAvailable

getAvailableHDsAvailable

setAvailableHdChannelsAvailable

getAvailableHdChannelsAvailable

setStateAvailable

getStateAvailable

setSignalStrengthAvailable

getSignalStrengthAvailable

setSignalChangeThresholdAvailable

getSignalChangeThresholdAvailable

setHdRadioEnableAvailable

getHdRadioEnableAvailable

setSiriusXMRadioAvailable

getSiriusXMRadioAvailable

setSisDataAvailable

getSisDataAvailable

setModuleInfo

getModuleInfo