SDLRadioControlData Class Reference
Section Contents
- -initWithFrequencyInteger:frequencyFraction:band:hdChannel:radioEnable:hdRadioEnable:
- -initFMWithFrequencyInteger:frequencyFraction:hdChannel:
- -initAMWithFrequencyInteger:hdChannel:
- -initXMWithFrequencyInteger:
- frequencyInteger
- frequencyFraction
- band
- rdsData
- availableHDs
- availableHDChannels
- hdChannel
- signalStrength
- signalChangeThreshold
- radioEnable
- state
- hdRadioEnable
- sisData
Overview
Include information (both read-only and changeable data) about a remote control radio module.
-initWithFrequencyInteger:frequencyFraction:band:hdChannel:radioEnable:hdRadioEnable:
Constructs a newly allocated SDLRadioControlCapabilities object with given parameters.
Objective-C
- (nonnull instancetype)
initWithFrequencyInteger:(nullable NSNumber<SDLInt> *)frequencyInteger
frequencyFraction:(nullable NSNumber<SDLInt> *)frequencyFraction
band:(nullable SDLRadioBand)band
hdChannel:(nullable NSNumber<SDLInt> *)hdChannel
radioEnable:(nullable NSNumber<SDLBool> *)radioEnable
hdRadioEnable:(nullable NSNumber<SDLBool> *)hdRadioEnable;Swift
init(frequencyInteger: (NSNumber & SDLInt)?, frequencyFraction: (NSNumber & SDLInt)?, band: SDLRadioBand?, hdChannel: (NSNumber & SDLInt)?, radioEnable: (NSNumber & SDLBool)?, hdRadioEnable: (NSNumber & SDLBool)?)Parameters
- frequencyInteger
integer part of the frequency
- frequencyFraction
fractional part of the frequency
- band
Radio band value
- hdChannel
Current HD sub-channel
- radioEnable
whether or not radio is enabled
- hdRadioEnable
whether or not hdradio is enabled
Return Value
An instance of the SDLRadioControlData class
-initFMWithFrequencyInteger:frequencyFraction:hdChannel:
Constructs a newly allocated SDLRadioControlCapabilities object with given parameters.
Objective-C
- (nonnull instancetype)
initFMWithFrequencyInteger:(nullable NSNumber<SDLInt> *)frequencyInteger
frequencyFraction:(nullable NSNumber<SDLInt> *)frequencyFraction
hdChannel:(nullable NSNumber<SDLInt> *)hdChannel;Swift
init(fmWithFrequencyInteger frequencyInteger: (NSNumber & SDLInt)?, frequencyFraction: (NSNumber & SDLInt)?, hdChannel: (NSNumber & SDLInt)?)Parameters
- frequencyInteger
Must be between 0 and 1710
- frequencyFraction
Must be between 0 and 9
- hdChannel
Must be between 0 and 7
Return Value
An instance of the SDLRadioControlData class
-initAMWithFrequencyInteger:hdChannel:
Constructs a newly allocated SDLRadioControlCapabilities object with given parameters.
Objective-C
- (nonnull instancetype)
initAMWithFrequencyInteger:(nullable NSNumber<SDLInt> *)frequencyInteger
hdChannel:(nullable NSNumber<SDLInt> *)hdChannel;Swift
init(amWithFrequencyInteger frequencyInteger: (NSNumber & SDLInt)?, hdChannel: (NSNumber & SDLInt)?)Parameters
- frequencyInteger
Must be between 0 and 1710
- hdChannel
Must be between 0 and 7
Return Value
An instance of the SDLRadioControlData class
-initXMWithFrequencyInteger:
Constructs a newly allocated SDLRadioControlCapabilities object with given parameters.
Objective-C
- (nonnull instancetype)initXMWithFrequencyInteger:
(nullable NSNumber<SDLInt> *)frequencyInteger;Swift
init(xmWithFrequencyInteger frequencyInteger: (NSNumber & SDLInt)?)Parameters
- frequencyInteger
Must be between 1 and 1710
Return Value
An instance of the SDLRadioControlData class
frequencyInteger
The integer part of the frequency ie for 101.7 this value should be 101
Integer
Objective-C
@property (nonatomic, strong, nullable) NSNumber<SDLInt> *frequencyInteger;Swift
var frequencyInteger: (NSNumber & SDLInt)? { get set }frequencyFraction
The fractional part of the frequency for 101.7 is 7
Integer
Objective-C
@property (nonatomic, strong, nullable) NSNumber<SDLInt> *frequencyFraction;Swift
var frequencyFraction: (NSNumber & SDLInt)? { get set }band
Radio band value
SDLRadioBand
Objective-C
@property (nonatomic, strong, nullable) SDLRadioBand band;Swift
var band: SDLRadioBand? { get set }rdsData
Read only parameter. See RDSData data type for details.
Warning
This property is readonly and cannot be set on the module.SDLRDSData
Objective-C
@property (nonatomic, strong, nullable) SDLRDSData *rdsData;Swift
var rdsData: SDLRDSData? { get set }availableHDs
number of HD sub-channels if available
Warning
This property is readonly and cannot be set on the module.Integer value Min Value - 1 Max Value -7
Objective-C
@property (nonatomic, strong, nullable) NSNumber<SDLInt> *availableHDs;Swift
var availableHDs: (NSNumber & SDLInt)? { get set }availableHDChannels
the list of available hd sub-channel indexes, empty list means no Hd channel is available, read-only
Warning
This property is readonly and cannot be set on the module.Integer value Min Value - 0 Max Value -7
Objective-C
@property (nonatomic, strong, nullable) NSNumber<SDLInt> *availableHDChannels;Swift
var availableHDChannels: (NSNumber & SDLInt)? { get set }hdChannel
Current HD sub-channel if available
Integer value Min Value - 0 Max Value -7
Objective-C
@property (nonatomic, strong, nullable) NSNumber<SDLInt> *hdChannel;Swift
var hdChannel: (NSNumber & SDLInt)? { get set }signalStrength
Signal Strength Value
Warning
This property is readonly and cannot be set on the module.Integer value Min Value - 0 Max Value - 100
Objective-C
@property (nonatomic, strong, nullable) NSNumber<SDLInt> *signalStrength;Swift
var signalStrength: (NSNumber & SDLInt)? { get set }signalChangeThreshold
If the signal strength falls below the set value for this parameter, the radio will tune to an alternative frequency
Warning
This property is readonly and cannot be set on the module.Integer value Min Value - 0 Max Value - 100
Objective-C
@property (nonatomic, strong, nullable) NSNumber<SDLInt> *signalChangeThreshold;Swift
var signalChangeThreshold: (NSNumber & SDLInt)? { get set }radioEnable
True if the radio is on, false is the radio is off. When the radio is disabled, no data other than radioEnable is included in a GetInteriorVehicleData response
Boolean value
Objective-C
@property (nonatomic, strong, nullable) NSNumber<SDLBool> *radioEnable;Swift
var radioEnable: (NSNumber & SDLBool)? { get set }state
Read only parameter. See RadioState data type for details.
Warning
This property is readonly and cannot be set on the module.SDLRadioState
Objective-C
@property (nonatomic, strong, nullable) SDLRadioState state;Swift
var state: SDLRadioState? { get set }hdRadioEnable
True if the hd radio is on, false is the radio is off
Boolean value
Objective-C
@property (nonatomic, strong, nullable) NSNumber<SDLBool> *hdRadioEnable;Swift
var hdRadioEnable: (NSNumber & SDLBool)? { get set }sisData
Read 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
Optional, SDLSISData
Objective-C
@property (nonatomic, strong, nullable) SDLSISData *sisData;Swift
var sisData: SDLSISData? { get set }