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
Documentation
RadioControlCapabilities

RadioControlCapabilities Class Reference

Constructors

Instance Methods

Constructors

new RadioControlCapabilities(parameters)

Initalizes an instance of RadioControlCapabilities.

Instance Methods

radioControlCapabilities.getAvailableHDsAvailable() ⇒ Boolean

Get the AvailableHDsAvailable

Kind: Instance method of RadioControlCapabilities
Returns: Boolean - the KEY_AVAILABLE_HDS_AVAILABLE value

radioControlCapabilities.getAvailableHdChannelsAvailable() ⇒ Boolean

Get the AvailableHdChannelsAvailable

Kind: Instance method of RadioControlCapabilities
Returns: Boolean - the KEY_AVAILABLE_HD_CHANNELS_AVAILABLE value

radioControlCapabilities.getHdChannelAvailable() ⇒ Boolean

Get the HdChannelAvailable

Kind: Instance method of RadioControlCapabilities
Returns: Boolean - the KEY_HD_CHANNEL_AVAILABLE value

radioControlCapabilities.getHdRadioEnableAvailable() ⇒ Boolean

Get the HdRadioEnableAvailable

Kind: Instance method of RadioControlCapabilities
Returns: Boolean - the KEY_HD_RADIO_ENABLE_AVAILABLE value

radioControlCapabilities.getModuleInfo() ⇒ ModuleInfo

Get the ModuleInfo

Kind: Instance method of RadioControlCapabilities
Returns: ModuleInfo - the KEY_MODULE_INFO value

radioControlCapabilities.getModuleName() ⇒ String

Get the ModuleName

Kind: Instance method of RadioControlCapabilities
Returns: String - the KEY_MODULE_NAME value

radioControlCapabilities.getRadioBandAvailable() ⇒ Boolean

Get the RadioBandAvailable

Kind: Instance method of RadioControlCapabilities
Returns: Boolean - the KEY_RADIO_BAND_AVAILABLE value

radioControlCapabilities.getRadioEnableAvailable() ⇒ Boolean

Get the RadioEnableAvailable

Kind: Instance method of RadioControlCapabilities
Returns: Boolean - the KEY_RADIO_ENABLE_AVAILABLE value

radioControlCapabilities.getRadioFrequencyAvailable() ⇒ Boolean

Get the RadioFrequencyAvailable

Kind: Instance method of RadioControlCapabilities
Returns: Boolean - the KEY_RADIO_FREQUENCY_AVAILABLE value

radioControlCapabilities.getRdsDataAvailable() ⇒ Boolean

Get the RdsDataAvailable

Kind: Instance method of RadioControlCapabilities
Returns: Boolean - the KEY_RDS_DATA_AVAILABLE value

radioControlCapabilities.getSignalChangeThresholdAvailable() ⇒ Boolean

Get the SignalChangeThresholdAvailable

Kind: Instance method of RadioControlCapabilities
Returns: Boolean - the KEY_SIGNAL_CHANGE_THRESHOLD_AVAILABLE value

radioControlCapabilities.getSignalStrengthAvailable() ⇒ Boolean

Get the SignalStrengthAvailable

Kind: Instance method of RadioControlCapabilities
Returns: Boolean - the KEY_SIGNAL_STRENGTH_AVAILABLE value

radioControlCapabilities.getSiriusxmRadioAvailable() ⇒ Boolean

Get the SiriusxmRadioAvailable

Kind: Instance method of RadioControlCapabilities
Returns: Boolean - the KEY_SIRIUSXM_RADIO_AVAILABLE value

radioControlCapabilities.getSisDataAvailable() ⇒ Boolean

Get the SisDataAvailable

Kind: Instance method of RadioControlCapabilities
Returns: Boolean - the KEY_SIS_DATA_AVAILABLE value

radioControlCapabilities.getStateAvailable() ⇒ Boolean

Get the StateAvailable

Kind: Instance method of RadioControlCapabilities
Returns: Boolean - the KEY_STATE_AVAILABLE value

radioControlCapabilities.setAvailableHDsAvailable(available) ⇒ RadioControlCapabilities

Set the AvailableHDsAvailable

Kind: Instance method of RadioControlCapabilities
Returns: RadioControlCapabilities - The class instance for method chaining.

ParamTypeDescription
available Boolean Availability of the getting the number of available HD channels. True: Available, False: Not Available, Not present: Not Available. - The desired AvailableHDsAvailable.

radioControlCapabilities.setAvailableHdChannelsAvailable(available) ⇒ RadioControlCapabilities

Set the AvailableHdChannelsAvailable

Kind: Instance method of RadioControlCapabilities
Returns: RadioControlCapabilities - The class instance for method chaining.

ParamTypeDescription
available Boolean Availability of the list of available HD sub-channel indexes. True: Available, False: Not Available, Not present: Not Available. - The desired AvailableHdChannelsAvailable.

radioControlCapabilities.setHdChannelAvailable(available) ⇒ RadioControlCapabilities

Set the HdChannelAvailable

Kind: Instance method of RadioControlCapabilities
Returns: RadioControlCapabilities - The class instance for method chaining.

ParamTypeDescription
available Boolean Availability of the control of HD radio channel. True: Available, False: Not Available, Not present: Not Available. - The desired HdChannelAvailable.

radioControlCapabilities.setHdRadioEnableAvailable(available) ⇒ RadioControlCapabilities

Set the HdRadioEnableAvailable

Kind: Instance method of RadioControlCapabilities
Returns: RadioControlCapabilities - The class instance for method chaining.

ParamTypeDescription
available Boolean Availability of the control of enable/disable HD radio. True: Available, False: Not Available, Not present: Not Available. - The desired HdRadioEnableAvailable.

radioControlCapabilities.setModuleInfo(info) ⇒ RadioControlCapabilities

Set the ModuleInfo

Kind: Instance method of RadioControlCapabilities
Returns: RadioControlCapabilities - The class instance for method chaining.

ParamTypeDescription
info ModuleInfo Information about a RC module, including its id. - The desired ModuleInfo.

radioControlCapabilities.setModuleName(name) ⇒ RadioControlCapabilities

Set the ModuleName

Kind: Instance method of RadioControlCapabilities
Returns: RadioControlCapabilities - The class instance for method chaining.

ParamTypeDescription
name String The short friendly name of the climate control module. It should not be used to identify a module by mobile application. - The desired ModuleName. {'string_min_length': 1, 'string_max_length': 100}

radioControlCapabilities.setRadioBandAvailable(available) ⇒ RadioControlCapabilities

Set the RadioBandAvailable

Kind: Instance method of RadioControlCapabilities
Returns: RadioControlCapabilities - The class instance for method chaining.

ParamTypeDescription
available Boolean Availability of the control of radio band. True: Available, False: Not Available, Not present: Not Available. - The desired RadioBandAvailable.

radioControlCapabilities.setRadioEnableAvailable(available) ⇒ RadioControlCapabilities

Set the RadioEnableAvailable

Kind: Instance method of RadioControlCapabilities
Returns: RadioControlCapabilities - The class instance for method chaining.

ParamTypeDescription
available Boolean Availability of the control of enable/disable radio. True: Available, False: Not Available, Not present: Not Available. - The desired RadioEnableAvailable.

radioControlCapabilities.setRadioFrequencyAvailable(available) ⇒ RadioControlCapabilities

Set the RadioFrequencyAvailable

Kind: Instance method of RadioControlCapabilities
Returns: RadioControlCapabilities - The class instance for method chaining.

ParamTypeDescription
available Boolean Availability of the control of radio frequency. True: Available, False: Not Available, Not present: Not Available. - The desired RadioFrequencyAvailable.

radioControlCapabilities.setRdsDataAvailable(available) ⇒ RadioControlCapabilities

Set the RdsDataAvailable

Kind: Instance method of RadioControlCapabilities
Returns: RadioControlCapabilities - The class instance for method chaining.

ParamTypeDescription
available Boolean Availability of the getting Radio Data System (RDS) data. True: Available, False: Not Available, Not present: Not Available. - The desired RdsDataAvailable.

radioControlCapabilities.setSignalChangeThresholdAvailable(available) ⇒ RadioControlCapabilities

Set the SignalChangeThresholdAvailable

Kind: Instance method of RadioControlCapabilities
Returns: RadioControlCapabilities - The class instance for method chaining.

ParamTypeDescription
available Boolean Availability of the getting the signal Change Threshold. True: Available, False: Not Available, Not present: Not Available. - The desired SignalChangeThresholdAvailable.

radioControlCapabilities.setSignalStrengthAvailable(available) ⇒ RadioControlCapabilities

Set the SignalStrengthAvailable

Kind: Instance method of RadioControlCapabilities
Returns: RadioControlCapabilities - The class instance for method chaining.

ParamTypeDescription
available Boolean Availability of the getting the signal strength. True: Available, False: Not Available, Not present: Not Available. - The desired SignalStrengthAvailable.

radioControlCapabilities.setSiriusxmRadioAvailable(available) ⇒ RadioControlCapabilities

Set the SiriusxmRadioAvailable

Kind: Instance method of RadioControlCapabilities
Returns: RadioControlCapabilities - The class instance for method chaining.

ParamTypeDescription
available Boolean Availability of Sirius XM radio. True: Available, False: Not Available, Not present: Not Available. - The desired SiriusxmRadioAvailable.

radioControlCapabilities.setSisDataAvailable(available) ⇒ RadioControlCapabilities

Set the SisDataAvailable

Kind: Instance method of RadioControlCapabilities
Returns: RadioControlCapabilities - The class instance for method chaining.

ParamTypeDescription
available Boolean Availability of the getting HD radio Station Information Service (SIS) data. True: Available, False: Not Available, Not present: Not Available. - The desired SisDataAvailable.

radioControlCapabilities.setStateAvailable(available) ⇒ RadioControlCapabilities

Set the StateAvailable

Kind: Instance method of RadioControlCapabilities
Returns: RadioControlCapabilities - The class instance for method chaining.

ParamTypeDescription
available Boolean Availability of the getting the Radio state. True: Available, False: Not Available, Not present: Not Available. - The desired StateAvailable.
View on GitHub.com
Previous Section Next Section