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

SDLRadioControlCapabilities Class Reference

Section Contents

Overview

Contains information about a radio control module’s capabilities.

-initWithModuleName:radioEnableAvailable:radioBandAvailable:radioFrequencyAvailable:hdChannelAvailable:rdsDataAvailable:availableHDsAvailable:stateAvailable:signalStrengthAvailable:signalChangeThresholdAvailable:

Constructs a newly allocated SDLRadioControlCapabilities object with given parameters.

Objective-C

- (nonnull instancetype)initWithModuleName:(nonnull NSString *)moduleName
                      radioEnableAvailable:(BOOL)radioEnableAvailable
                        radioBandAvailable:(BOOL)radioBandAvailable
                   radioFrequencyAvailable:(BOOL)radioFrequencyAvailable
                        hdChannelAvailable:(BOOL)hdChannelAvailable
                          rdsDataAvailable:(BOOL)rdsDataAvailable
                     availableHDsAvailable:(BOOL)availableHDsAvailable
                            stateAvailable:(BOOL)stateAvailable
                   signalStrengthAvailable:(BOOL)signalStrengthAvailable
            signalChangeThresholdAvailable:(BOOL)signalChangeThresholdAvailable;

Swift

init(moduleName: String, radioEnableAvailable: Bool, radioBandAvailable: Bool, radioFrequencyAvailable: Bool, hdChannelAvailable: Bool, rdsDataAvailable: Bool, availableHDsAvailable: Bool, stateAvailable: Bool, signalStrengthAvailable: Bool, signalChangeThresholdAvailable: Bool)

Parameters

moduleName

The short friendly name of the radio control module.

radioEnableAvailable

Availability of the control of enable/disable radio.

radioBandAvailable

Availability of the control of radio band.

radioFrequencyAvailable

Availability of the control of radio frequency.

hdChannelAvailable

Availability of the control of HD radio channel.

rdsDataAvailable

Availability of the getting Radio Data System (RDS) data.

availableHDsAvailable

Availability of the getting the number of available HD channels.

stateAvailable

Availability of the getting the Radio state.

signalStrengthAvailable

Availability of the getting the signal strength.

signalChangeThresholdAvailable

Availability of the getting the signal Change Threshold.

Return Value

An instance of the SDLRadioControlCapabilities class.

-initWithModuleName:radioEnableAvailable:radioBandAvailable:radioFrequencyAvailable:hdChannelAvailable:rdsDataAvailable:availableHDsAvailable:stateAvailable:signalStrengthAvailable:signalChangeThresholdAvailable:hdRadioEnableAvailable:siriusXMRadioAvailable:sisDataAvailable:

Constructs a newly allocated SDLRadioControlCapabilities object with given parameters.

Objective-C

- (nonnull instancetype)initWithModuleName:(nonnull NSString *)moduleName
                      radioEnableAvailable:(BOOL)radioEnableAvailable
                        radioBandAvailable:(BOOL)radioBandAvailable
                   radioFrequencyAvailable:(BOOL)radioFrequencyAvailable
                        hdChannelAvailable:(BOOL)hdChannelAvailable
                          rdsDataAvailable:(BOOL)rdsDataAvailable
                     availableHDsAvailable:(BOOL)availableHDsAvailable
                            stateAvailable:(BOOL)stateAvailable
                   signalStrengthAvailable:(BOOL)signalStrengthAvailable
            signalChangeThresholdAvailable:(BOOL)signalChangeThresholdAvailable
                    hdRadioEnableAvailable:(BOOL)hdRadioEnableAvailable
                    siriusXMRadioAvailable:(BOOL)siriusXMRadioAvailable
                          sisDataAvailable:(BOOL)sisDataAvailable;

Swift

init(moduleName: String, radioEnableAvailable: Bool, radioBandAvailable: Bool, radioFrequencyAvailable: Bool, hdChannelAvailable: Bool, rdsDataAvailable: Bool, availableHDsAvailable: Bool, stateAvailable: Bool, signalStrengthAvailable: Bool, signalChangeThresholdAvailable: Bool, hdRadioEnableAvailable: Bool, siriusXMRadioAvailable: Bool, sisDataAvailable: Bool)

Parameters

moduleName

The short friendly name of the radio control module.

radioEnableAvailable

Availability of the control of enable/disable radio.

radioBandAvailable

Availability of the control of radio band.

radioFrequencyAvailable

Availability of the control of radio frequency.

hdChannelAvailable

Availability of the control of HD radio channel.

rdsDataAvailable

Availability of the getting Radio Data System (RDS) data.

availableHDsAvailable

Availability of the getting the number of available HD channels.

stateAvailable

Availability of the getting the Radio state.

signalStrengthAvailable

Availability of the getting the signal strength.

signalChangeThresholdAvailable

Availability of the getting the signal Change Threshold.

hdRadioEnableAvailable

Availability of the control of enable/disable HD radio.

siriusXMRadioAvailable

Availability of sirius XM radio.

sisDataAvailable

Availability of sis data.

Return Value

An instance of the SDLRadioControlCapabilities class

moduleName

The short friendly name of the radio control module.

It should not be used to identify a module by mobile application.

Max string length 100 chars

Objective-C

@property (readwrite, strong, nonatomic) NSString *_Nonnull moduleName;

Swift

var moduleName: String { get set }

radioEnableAvailable

Availability of the control of enable/disable radio.

True: Available, False: Not Available, Not present: Not Available.

Optional, Boolean

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    NSNumber<SDLBool> *radioEnableAvailable;

Swift

var radioEnableAvailable: (NSNumber & SDLBool)? { get set }

radioBandAvailable

Availability of the control of radio band.

True: Available, False: Not Available, Not present: Not Available.

Optional, Boolean

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    NSNumber<SDLBool> *radioBandAvailable;

Swift

var radioBandAvailable: (NSNumber & SDLBool)? { get set }

radioFrequencyAvailable

Availability of the control of radio frequency.

True: Available, False: Not Available, Not present: Not Available.

Optional, Boolean

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    NSNumber<SDLBool> *radioFrequencyAvailable;

Swift

var radioFrequencyAvailable: (NSNumber & SDLBool)? { get set }

hdChannelAvailable

Availability of the control of HD radio channel.

True: Available, False: Not Available, Not present: Not Available.

Optional, Boolean

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    NSNumber<SDLBool> *hdChannelAvailable;

Swift

var hdChannelAvailable: (NSNumber & SDLBool)? { get set }

rdsDataAvailable

Availability of the getting Radio Data System (RDS) data.

True: Available, False: Not Available, Not present: Not Available.

Optional, Boolean

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    NSNumber<SDLBool> *rdsDataAvailable;

Swift

var rdsDataAvailable: (NSNumber & SDLBool)? { get set }

availableHDsAvailable

Availability of the getting the number of available HD channels.

True: Available, False: Not Available, Not present: Not Available.

Optional, Boolean

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    NSNumber<SDLBool> *availableHDsAvailable;

Swift

var availableHDsAvailable: (NSNumber & SDLBool)? { get set }

stateAvailable

Availability of the getting the Radio state.

True: Available, False: Not Available, Not present: Not Available.

Optional, Boolean

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    NSNumber<SDLBool> *stateAvailable;

Swift

var stateAvailable: (NSNumber & SDLBool)? { get set }

signalStrengthAvailable

Availability of the getting the signal strength.

True: Available, False: Not Available, Not present: Not Available.

Optional, Boolean

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    NSNumber<SDLBool> *signalStrengthAvailable;

Swift

var signalStrengthAvailable: (NSNumber & SDLBool)? { get set }

signalChangeThresholdAvailable

Availability of the getting the signal Change Threshold

True: Available, False: Not Available, Not present: Not Available.

Optional, Boolean

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    NSNumber<SDLBool> *signalChangeThresholdAvailable;

Swift

var signalChangeThresholdAvailable: (NSNumber & SDLBool)? { get set }

hdRadioEnableAvailable

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

Optional, Boolean

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    NSNumber<SDLBool> *hdRadioEnableAvailable;

Swift

var hdRadioEnableAvailable: (NSNumber & SDLBool)? { get set }

siriusXMRadioAvailable

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

Optional, Boolean

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    NSNumber<SDLBool> *siriusXMRadioAvailable;

Swift

var siriusXMRadioAvailable: (NSNumber & SDLBool)? { get set }

sisDataAvailable

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

Optional, Boolean

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    NSNumber<SDLBool> *sisDataAvailable;

Swift

var sisDataAvailable: (NSNumber & SDLBool)? { get set }
View on GitHub.com
Previous Section Next Section