Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
US
JP
US
JP
To Top Created with Sketch. To Top
To Bottom Created with Sketch. To Bottom
JavaEE Documentation
RadioControlCapabilities

Class RadioControlCapabilities

Hierarchy

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

Package
com.smartdevicelink.proxy.rpc

Overview

Contains information about a radio control module's capabilities.

Quick Jump

Fields
Constructors
Methods

Fields

KEY_MODULE_NAME

public static final java.lang.String KEY_MODULE_NAME
Constant Value
"moduleName"

KEY_RADIO_ENABLE_AVAILABLE

public static final java.lang.String KEY_RADIO_ENABLE_AVAILABLE
Constant Value
"radioEnableAvailable"

KEY_RADIO_BAND_AVAILABLE

public static final java.lang.String KEY_RADIO_BAND_AVAILABLE
Constant Value
"radioBandAvailable"

KEY_RADIO_FREQUENCY_AVAILABLE

public static final java.lang.String KEY_RADIO_FREQUENCY_AVAILABLE
Constant Value
"radioFrequencyAvailable"

KEY_HD_CHANNEL_AVAILABLE

public static final java.lang.String KEY_HD_CHANNEL_AVAILABLE
Constant Value
"hdChannelAvailable"

KEY_RDS_DATA_AVAILABLE

public static final java.lang.String KEY_RDS_DATA_AVAILABLE
Constant Value
"rdsDataAvailable"

KEY_AVAILABLE_HDS_AVAILABLE

public static final java.lang.String KEY_AVAILABLE_HDS_AVAILABLE
Constant Value
"availableHDsAvailable"

KEY_STATE_AVAILABLE

public static final java.lang.String KEY_STATE_AVAILABLE
Constant Value
"stateAvailable"

KEY_SIGNAL_STRENGTH_AVAILABLE

public static final java.lang.String KEY_SIGNAL_STRENGTH_AVAILABLE
Constant Value
"signalStrengthAvailable"

KEY_SIGNAL_CHANGE_THRESHOLD_AVAILABLE

public static final java.lang.String KEY_SIGNAL_CHANGE_THRESHOLD_AVAILABLE
Constant Value
"signalChangeThresholdAvailable"

KEY_HD_RADIO_ENABLE_AVAILABLE

public static final java.lang.String KEY_HD_RADIO_ENABLE_AVAILABLE
Constant Value
"hdRadioEnableAvailable"

KEY_SIRIUS_XM_RADIO_AVAILABLE

public static final java.lang.String KEY_SIRIUS_XM_RADIO_AVAILABLE
Constant Value
"siriusxmRadioAvailable"

KEY_SIS_DATA_AVAILABLE

public static final java.lang.String KEY_SIS_DATA_AVAILABLE
Constant Value
"sisDataAvailable"

KEY_MODULE_INFO

public static final java.lang.String KEY_MODULE_INFO
Constant Value
"moduleInfo"

KEY_AVAILABLE_HD_CHANNELS_AVAILABLE

public static final java.lang.String KEY_AVAILABLE_HD_CHANNELS_AVAILABLE
Constant Value
"availableHdChannelsAvailable"

Inherited Fields

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

Constructors

RadioControlCapabilities()

public RadioControlCapabilities()

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

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

Constructor Parameters

hash

RadioControlCapabilities( String moduleName )

Constructs a new RadioControlCapabilities object 

public RadioControlCapabilities(String moduleName)

Constructor Parameters

moduleName
The short friendly name of the radio control module. It should not be used to identify a module by mobile application.

Methods

setModuleName( String moduleName )

Sets the moduleName portion of the RadioControlCapabilities class 

public com.smartdevicelink.proxy.rpc.RadioControlCapabilities setModuleName(String moduleName)

Method Parameters

moduleName
The short friendly name of the radio control module. It should not be used to identify a module by mobile application.

getModuleName()

Gets the moduleName portion of the RadioControlCapabilities class 

public java.lang.String getModuleName()

setRadioEnableAvailable( Boolean radioEnableAvailable )

Sets the radioEnableAvailable portion of the RadioControlCapabilities class 

public com.smartdevicelink.proxy.rpc.RadioControlCapabilities setRadioEnableAvailable(Boolean radioEnableAvailable)

Method Parameters

radioEnableAvailable
Availability of the control of enable/disable radio. True: Available, False: Not Available, Not present: Not Available.

getRadioEnableAvailable()

Gets the radioEnableAvailable portion of the RadioControlCapabilities class 

public java.lang.Boolean getRadioEnableAvailable()

setRadioBandAvailable( Boolean radioBandAvailable )

Sets the radioBandAvailable portion of the RadioControlCapabilities class 

public com.smartdevicelink.proxy.rpc.RadioControlCapabilities setRadioBandAvailable(Boolean radioBandAvailable)

Method Parameters

radioBandAvailable
Availability of the control of radio band. True: Available, False: Not Available, Not present: Not Available.

getRadioBandAvailable()

Gets the radioBandAvailable portion of the RadioControlCapabilities class 

public java.lang.Boolean getRadioBandAvailable()

setRadioFrequencyAvailable( Boolean radioFrequencyAvailable )

Sets the radioFrequencyAvailable portion of the RadioControlCapabilities class 

public com.smartdevicelink.proxy.rpc.RadioControlCapabilities setRadioFrequencyAvailable(Boolean radioFrequencyAvailable)

Method Parameters

radioFrequencyAvailable
Availability of the control of radio frequency. True: Available, False: Not Available, Not present: Not Available.

getRadioFrequencyAvailable()

Gets the radioFrequencyAvailable portion of the RadioControlCapabilities class 

public java.lang.Boolean getRadioFrequencyAvailable()

setHdChannelAvailable( Boolean hdChannelAvailable )

Sets the hdChannelAvailable portion of the RadioControlCapabilities class 

public com.smartdevicelink.proxy.rpc.RadioControlCapabilities setHdChannelAvailable(Boolean hdChannelAvailable)

Method Parameters

hdChannelAvailable
Availability of the control of HD radio channel. True: Available, False: Not Available, Not present: Not Available.

getHdChannelAvailable()

Gets the hdChannelAvailable portion of the RadioControlCapabilities class 

public java.lang.Boolean getHdChannelAvailable()

setRdsDataAvailable( Boolean rdsDataAvailable )

Sets the rdsDataAvailable portion of the RadioControlCapabilities class 

public com.smartdevicelink.proxy.rpc.RadioControlCapabilities setRdsDataAvailable(Boolean rdsDataAvailable)

Method Parameters

rdsDataAvailable
Availability of the getting Radio Data System (RDS) data. True: Available, False: Not Available, Not present: Not Available.

getRdsDataAvailable()

Gets the rdsDataAvailable portion of the RadioControlCapabilities class 

public java.lang.Boolean getRdsDataAvailable()

setAvailableHDsAvailable( Boolean availableHDsAvailable )

Deprecated
Sets the availableHDsAvailable portion of the RadioControlCapabilities class 

public com.smartdevicelink.proxy.rpc.RadioControlCapabilities setAvailableHDsAvailable(Boolean availableHDsAvailable)

Method Parameters

availableHDsAvailable
Availability of the getting the number of available HD channels. True: Available, False: Not Available, Not present: Not Available.

getAvailableHDsAvailable()

Deprecated
Gets the availableHDsAvailable portion of the RadioControlCapabilities class 

public java.lang.Boolean getAvailableHDsAvailable()

setAvailableHdChannelsAvailable( Boolean availableHdChannelsAvailable )

Sets the availableHdChannelsAvailable portion of the RadioControlCapabilities class 

public com.smartdevicelink.proxy.rpc.RadioControlCapabilities setAvailableHdChannelsAvailable(Boolean availableHdChannelsAvailable)

Method Parameters

availableHdChannelsAvailable
Availability of the list of available HD sub-channel indexes. True: Available, False: Not Available, Not present: Not Available.

getAvailableHdChannelsAvailable()

Gets the availableHdChannelsAvailable portion of the RadioControlCapabilities class 

public java.lang.Boolean getAvailableHdChannelsAvailable()

setStateAvailable( Boolean stateAvailable )

Sets the stateAvailable portion of the RadioControlCapabilities class 

public com.smartdevicelink.proxy.rpc.RadioControlCapabilities setStateAvailable(Boolean stateAvailable)

Method Parameters

stateAvailable
Availability of the getting the Radio state. True: Available, False: Not Available, Not present: Not Available.

getStateAvailable()

Gets the stateAvailable portion of the RadioControlCapabilities class 

public java.lang.Boolean getStateAvailable()

setSignalStrengthAvailable( Boolean signalStrengthAvailable )

Sets the signalStrengthAvailable portion of the RadioControlCapabilities class 

public com.smartdevicelink.proxy.rpc.RadioControlCapabilities setSignalStrengthAvailable(Boolean signalStrengthAvailable)

Method Parameters

signalStrengthAvailable
Availability of the getting the signal strength. True: Available, False: Not Available, Not present: Not Available.

getSignalStrengthAvailable()

Gets the signalStrengthAvailable portion of the RadioControlCapabilities class 

public java.lang.Boolean getSignalStrengthAvailable()

setSignalChangeThresholdAvailable( Boolean signalChangeThresholdAvailable )

Sets the signalChangeThresholdAvailable portion of the RadioControlCapabilities class 

public com.smartdevicelink.proxy.rpc.RadioControlCapabilities setSignalChangeThresholdAvailable(Boolean signalChangeThresholdAvailable)

Method Parameters

signalChangeThresholdAvailable
Availability of the getting the signal Change Threshold. True: Available, False: Not Available, Not present: Not Available.

getSignalChangeThresholdAvailable()

Gets the signalChangeThresholdAvailable portion of the RadioControlCapabilities class 

public java.lang.Boolean getSignalChangeThresholdAvailable()

setHdRadioEnableAvailable( Boolean hdRadioEnableAvailable )

Sets the hdRadioEnableAvailable portion of the RadioControlCapabilities class 

public com.smartdevicelink.proxy.rpc.RadioControlCapabilities setHdRadioEnableAvailable(Boolean hdRadioEnableAvailable)

Method Parameters

hdRadioEnableAvailable
Availability of the control of enable/disable HD radio. True: Available, False: Not Available, Not present: Not Available.

getHdRadioEnableAvailable()

Gets the hdRadioEnableAvailable portion of the RadioControlCapabilities class 

public java.lang.Boolean getHdRadioEnableAvailable()

setSiriusXMRadioAvailable( Boolean siriusxmRadioAvailable )

Sets the siriusxmRadioAvailable portion of the RadioControlCapabilities class 

public com.smartdevicelink.proxy.rpc.RadioControlCapabilities setSiriusXMRadioAvailable(Boolean siriusxmRadioAvailable)

Method Parameters

siriusxmRadioAvailable
Availability of sirius XM radio. True: Available, False: Not Available, Not present: Not Available.

getSiriusXMRadioAvailable()

Gets the siriusxmRadioAvailable portion of the RadioControlCapabilities class 

public java.lang.Boolean getSiriusXMRadioAvailable()

setSisDataAvailable( Boolean sisDataAvailable )

Sets the sisDataAvailable portion of the RadioControlCapabilities class 

public com.smartdevicelink.proxy.rpc.RadioControlCapabilities setSisDataAvailable(Boolean sisDataAvailable)

Method Parameters

sisDataAvailable
Availability of the getting HD radio Station Information Service (SIS) data. True: Available, False: Not Available, Not present: Not Available.

getSisDataAvailable()

Gets the sisDataAvailable portion of the RadioControlCapabilities class 

public java.lang.Boolean getSisDataAvailable()

setModuleInfo( ModuleInfo info )

Sets ModuleInfo for this capability 

public com.smartdevicelink.proxy.rpc.RadioControlCapabilities setModuleInfo(ModuleInfo info)

Method Parameters

info
the ModuleInfo to be set

getModuleInfo()

Gets a ModuleInfo of this capability 

public com.smartdevicelink.proxy.rpc.ModuleInfo getModuleInfo()

Inherited Methods

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