RadioControlData Class Reference
Constructors
Instance Methods
- getAvailableHDs() ⇒
Number - getAvailableHdChannels() ⇒
Array.<Number> - getBand() ⇒
RadioBand - getFrequencyFraction() ⇒
Number - getFrequencyInteger() ⇒
Number - getHdChannel() ⇒
Number - getHdRadioEnable() ⇒
Boolean - getRadioEnable() ⇒
Boolean - getRdsData() ⇒
RdsData - getSignalChangeThreshold() ⇒
Number - getSignalStrength() ⇒
Number - getSisData() ⇒
SisData - getState() ⇒
RadioState - setAvailableHDs(ds) ⇒
RadioControlData - setAvailableHdChannels(channels) ⇒
RadioControlData - setBand(band) ⇒
RadioControlData - setFrequencyFraction(fraction) ⇒
RadioControlData - setFrequencyInteger(integer) ⇒
RadioControlData - setHdChannel(channel) ⇒
RadioControlData - setHdRadioEnable(enable) ⇒
RadioControlData - setRadioEnable(enable) ⇒
RadioControlData - setRdsData(data) ⇒
RadioControlData - setSignalChangeThreshold(threshold) ⇒
RadioControlData - setSignalStrength(strength) ⇒
RadioControlData - setSisData(data) ⇒
RadioControlData - setState(state) ⇒
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.
| Param | Type | Description |
|---|---|---|
| ds | Number |
Number of HD sub-channels if available - The desired AvailableHDs. {'num_min_value': 1, 'num_max_value': 7} |
radioControlData.setAvailableHdChannels(channels) ⇒ RadioControlData
Set the AvailableHdChannels
Kind: Instance method of RadioControlData
Returns: RadioControlData - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| channels | Array.<Number> |
The list of available HD sub-channel indexes. Empty list means no Hd channel is available. Read-only. - The desired AvailableHdChannels. {'array_min_size': 0, 'array_max_size': 8, 'num_min_value': 0, 'num_max_value': 7} |
radioControlData.setBand(band) ⇒ RadioControlData
Set the Band
Kind: Instance method of RadioControlData
Returns: RadioControlData - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| 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.
| Param | Type | Description |
|---|---|---|
| fraction | Number |
The fractional part of the frequency for 101.7 is 7 - The desired FrequencyFraction. {'num_min_value': 0, 'num_max_value': 9} |
radioControlData.setFrequencyInteger(integer) ⇒ RadioControlData
Set the FrequencyInteger
Kind: Instance method of RadioControlData
Returns: RadioControlData - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| integer | Number |
The integer part of the frequency ie for 101.7 this value should be 101 - The desired FrequencyInteger. {'num_min_value': 0, 'num_max_value': 1710} |
radioControlData.setHdChannel(channel) ⇒ RadioControlData
Set the HdChannel
Kind: Instance method of RadioControlData
Returns: RadioControlData - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| channel | Number |
Current HD sub-channel if available - The desired HdChannel. {'num_min_value': 0, 'num_max_value': 7} |
radioControlData.setHdRadioEnable(enable) ⇒ RadioControlData
Set the HdRadioEnable
Kind: Instance method of RadioControlData
Returns: RadioControlData - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| 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.
| Param | Type | Description |
|---|---|---|
| enable | Boolean |
True if the radio is on, false if the radio is off. If set to false, no other data will be included. - The desired RadioEnable. |
radioControlData.setRdsData(data) ⇒ RadioControlData
Set the RdsData
Kind: Instance method of RadioControlData
Returns: RadioControlData - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| 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.
| Param | Type | Description |
|---|---|---|
| threshold | Number |
If the signal strength falls below the set value for this parameter, the radio will tune to an alternative frequency - The desired SignalChangeThreshold. {'num_min_value': 0, 'num_max_value': 100} |
radioControlData.setSignalStrength(strength) ⇒ RadioControlData
Set the SignalStrength
Kind: Instance method of RadioControlData
Returns: RadioControlData - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| strength | Number |
The desired SignalStrength. {'num_min_value': 0, 'num_max_value': 100} |
radioControlData.setSisData(data) ⇒ RadioControlData
Set the SisData
Kind: Instance method of RadioControlData
Returns: RadioControlData - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| data | 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 - The desired SisData. |