Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
RadioControlData

RadioControlData Class Reference

Constructors

Instance Methods

Constructors

new RadioControlData(parameters)

Initalizes an instance of RadioControlData.

Instance Methods

radioControlData.getAvailableHDs() ⇒ Number

Get the AvailableHDs

Kind: Instance method of RadioControlData
Returns: Number - the KEY_AVAILABLE_HDS value

radioControlData.getAvailableHdChannels() ⇒ Array.<Number>

Get the AvailableHdChannels

Kind: Instance method of RadioControlData
Returns: Array.<Number> - the KEY_AVAILABLE_HD_CHANNELS value

radioControlData.getBand() ⇒ RadioBand

Get the Band

Kind: Instance method of RadioControlData
Returns: RadioBand - the KEY_BAND value

radioControlData.getFrequencyFraction() ⇒ Number

Get the FrequencyFraction

Kind: Instance method of RadioControlData
Returns: Number - the KEY_FREQUENCY_FRACTION value

radioControlData.getFrequencyInteger() ⇒ Number

Get the FrequencyInteger

Kind: Instance method of RadioControlData
Returns: Number - the KEY_FREQUENCY_INTEGER value

radioControlData.getHdChannel() ⇒ Number

Get the HdChannel

Kind: Instance method of RadioControlData
Returns: Number - the KEY_HD_CHANNEL value

radioControlData.getHdRadioEnable() ⇒ Boolean

Get the HdRadioEnable

Kind: Instance method of RadioControlData
Returns: Boolean - the KEY_HD_RADIO_ENABLE value

radioControlData.getRadioEnable() ⇒ Boolean

Get the RadioEnable

Kind: Instance method of RadioControlData
Returns: Boolean - the KEY_RADIO_ENABLE value

radioControlData.getRdsData() ⇒ RdsData

Get the RdsData

Kind: Instance method of RadioControlData
Returns: RdsData - the KEY_RDS_DATA value

radioControlData.getSignalChangeThreshold() ⇒ Number

Get the SignalChangeThreshold

Kind: Instance method of RadioControlData
Returns: Number - the KEY_SIGNAL_CHANGE_THRESHOLD value

radioControlData.getSignalStrength() ⇒ Number

Get the SignalStrength

Kind: Instance method of RadioControlData
Returns: Number - the KEY_SIGNAL_STRENGTH value

radioControlData.getSisData() ⇒ SisData

Get the SisData

Kind: Instance method of RadioControlData
Returns: SisData - the KEY_SIS_DATA value

radioControlData.getState() ⇒ RadioState

Get the State

Kind: Instance method of RadioControlData
Returns: RadioState - the KEY_STATE value

radioControlData.setAvailableHDs(ds) ⇒ RadioControlData

Set the AvailableHDs

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

ParamTypeDescription
ds Number Number of HD sub-channels if available - The desired AvailableHDs.

radioControlData.setAvailableHdChannels(channels) ⇒ RadioControlData

Set the AvailableHdChannels

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

ParamTypeDescription
channels Array.<Number> The list of available HD sub-channel indexes. Empty list means no Hd channel is - The desired AvailableHdChannels. available. Read-only.

radioControlData.setBand(band) ⇒ RadioControlData

Set the Band

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

ParamTypeDescription
band RadioBand The desired Band.

radioControlData.setFrequencyFraction(fraction) ⇒ RadioControlData

Set the FrequencyFraction

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

ParamTypeDescription
fraction Number The fractional part of the frequency for 101.7 is 7 - The desired FrequencyFraction.

radioControlData.setFrequencyInteger(integer) ⇒ RadioControlData

Set the FrequencyInteger

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

ParamTypeDescription
integer Number The integer part of the frequency ie for 101.7 this value should be 101 - The desired FrequencyInteger.

radioControlData.setHdChannel(channel) ⇒ RadioControlData

Set the HdChannel

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

ParamTypeDescription
channel Number Current HD sub-channel if available - The desired HdChannel.

radioControlData.setHdRadioEnable(enable) ⇒ RadioControlData

Set the HdRadioEnable

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

ParamTypeDescription
enable Boolean True if the hd radio is on, false if the radio is off - The desired HdRadioEnable.

radioControlData.setRadioEnable(enable) ⇒ RadioControlData

Set the RadioEnable

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

ParamTypeDescription
enable Boolean True if the radio is on, false if the radio is off. If set to false, no other data will - The desired RadioEnable. be included.

radioControlData.setRdsData(data) ⇒ RadioControlData

Set the RdsData

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

ParamTypeDescription
data RdsData The desired RdsData.

radioControlData.setSignalChangeThreshold(threshold) ⇒ RadioControlData

Set the SignalChangeThreshold

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

ParamTypeDescription
threshold Number If the signal strength falls below the set value for this parameter, the radio will - The desired SignalChangeThreshold. tune to an alternative frequency

radioControlData.setSignalStrength(strength) ⇒ RadioControlData

Set the SignalStrength

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

ParamTypeDescription
strength Number The desired SignalStrength.

radioControlData.setSisData(data) ⇒ RadioControlData

Set the SisData

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

ParamTypeDescription
data SisData Read-only Station Information Service (SIS) data provides basic information about the - The desired SisData. station such as call sign, as well as information not displayable to the consumer such as the station identification number

radioControlData.setState(state) ⇒ RadioControlData

Set the State

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

ParamTypeDescription
state RadioState The desired State.
View on GitHub.com
Previous Section Next Section