summaryrefslogtreecommitdiff
path: root/SmartDeviceLink/SDLRadioControlCapabilities.h
blob: 0c35df16fce23d64baa615f9e32329673f803d09 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
//
//  SDLRadioControlCapabilities.h
//

#import "SDLRPCMessage.h"
#import "SDLModuleInfo.h"

NS_ASSUME_NONNULL_BEGIN

/**
 * Contains information about a radio control module's capabilities.
 */
@interface SDLRadioControlCapabilities : SDLRPCStruct

/**
 Constructs a newly allocated SDLRadioControlCapabilities object with given parameters.

 @param moduleName The short friendly name of the radio control module.
 @param radioEnableAvailable Availability of the control of enable/disable radio.
 @param radioBandAvailable Availability of the control of radio band.
 @param radioFrequencyAvailable Availability of the control of radio frequency.
 @param hdChannelAvailable Availability of the control of HD radio channel.
 @param rdsDataAvailable Availability of the getting Radio Data System (RDS) data.
 @param availableHDsAvailable Availability of the getting the number of available HD channels.
 @param stateAvailable Availability of the getting the Radio state.
 @param signalStrengthAvailable Availability of the getting the signal strength.
 @param signalChangeThresholdAvailable Availability of the getting the signal Change Threshold.
 @return An instance of the SDLRadioControlCapabilities class.
 */
- (instancetype)initWithModuleName:(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 __deprecated_msg(("Use initWithModuleName:moduleName:radioEnableAvailable radioFrequencyAvailable:hdChannelAvailable:rdsDataAvailable:availableHDChannelsAvailable:stateAvailable:signalStrengthAvailable:signalChangeThresholdAvailable:hdRadioEnableAvailable:siriusXMRadioAvailable:sisDataAvailable: instead"));

/**
 Constructs a newly allocated SDLRadioControlCapabilities object with given parameters.

 @param moduleName The short friendly name of the radio control module.
 @param radioEnableAvailable Availability of the control of enable/disable radio.
 @param radioBandAvailable Availability of the control of radio band.
 @param radioFrequencyAvailable Availability of the control of radio frequency.
 @param hdChannelAvailable Availability of the control of HD radio channel.
 @param rdsDataAvailable Availability of the getting Radio Data System (RDS) data.
 @param availableHDsAvailable Availability of the getting the number of available HD channels.
 @param stateAvailable Availability of the getting the Radio state.
 @param signalStrengthAvailable Availability of the getting the signal strength.
 @param signalChangeThresholdAvailable Availability of the getting the signal Change Threshold.
 @param hdRadioEnableAvailable Availability of the control of enable/disable HD radio.
 @param siriusXMRadioAvailable Availability of sirius XM radio.
 @param sisDataAvailable Availability of sis data.
 @return An instance of the SDLRadioControlCapabilities class
 */
- (instancetype)initWithModuleName:(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 __deprecated_msg(("Use initWithModuleName:moduleName:radioEnableAvailable radioFrequencyAvailable:hdChannelAvailable:rdsDataAvailable:availableHDChannelsAvailable:stateAvailable:signalStrengthAvailable:signalChangeThresholdAvailable:hdRadioEnableAvailable:siriusXMRadioAvailable:sisDataAvailable: instead"));

/**
 Constructs a newly allocated SDLRadioControlCapabilities object with given parameters.
 
 @param moduleName The short friendly name of the radio control module.
 @param radioEnableAvailable Availability of the control of enable/disable radio.
 @param radioBandAvailable Availability of the control of radio band.
 @param radioFrequencyAvailable Availability of the control of radio frequency.
 @param hdChannelAvailable Availability of the control of HD radio channel.
 @param rdsDataAvailable Availability of the getting Radio Data System (RDS) data.
 @param availableHDChannelsAvailable Availability of the list of available HD sub-channel indexes.
 @param stateAvailable Availability of the getting the Radio state.
 @param signalStrengthAvailable Availability of the getting the signal strength.
 @param signalChangeThresholdAvailable Availability of the getting the signal Change Threshold.
 @param hdRadioEnableAvailable Availability of the control of enable/disable HD radio.
 @param siriusXMRadioAvailable Availability of sirius XM radio.
 @param sisDataAvailable Availability of sis data.
 @return An instance of the SDLRadioControlCapabilities class
 */
- (instancetype)initWithModuleName:(NSString *)moduleName radioEnableAvailable:(BOOL)radioEnableAvailable radioBandAvailable:(BOOL)radioBandAvailable radioFrequencyAvailable:(BOOL)radioFrequencyAvailable hdChannelAvailable:(BOOL)hdChannelAvailable rdsDataAvailable:(BOOL)rdsDataAvailable availableHDChannelsAvailable:(BOOL)availableHDChannelsAvailable stateAvailable:(BOOL)stateAvailable signalStrengthAvailable:(BOOL)signalStrengthAvailable signalChangeThresholdAvailable:(BOOL)signalChangeThresholdAvailable hdRadioEnableAvailable:(BOOL)hdRadioEnableAvailable siriusXMRadioAvailable:(BOOL)siriusXMRadioAvailable sisDataAvailable:(BOOL)sisDataAvailable __deprecated_msg(("Use initWithModuleName:moduleName:moduleInfo:radioEnableAvailable radioFrequencyAvailable:hdChannelAvailable:rdsDataAvailable:availableHDChannelsAvailable:stateAvailable:signalStrengthAvailable:signalChangeThresholdAvailable:hdRadioEnableAvailable:siriusXMRadioAvailable:sisDataAvailable: instead"));

/**
 Constructs a newly allocated SDLRadioControlCapabilities object with given parameters.
 
 @param moduleName The short friendly name of the radio control module.
 @param moduleInfo Information about a RC module, including its id.
 @param radioEnableAvailable Availability of the control of enable/disable radio.
 @param radioBandAvailable Availability of the control of radio band.
 @param radioFrequencyAvailable Availability of the control of radio frequency.
 @param hdChannelAvailable Availability of the control of HD radio channel.
 @param rdsDataAvailable Availability of the getting Radio Data System (RDS) data.
 @param availableHDChannelsAvailable Availability of the list of available HD sub-channel indexes.
 @param stateAvailable Availability of the getting the Radio state.
 @param signalStrengthAvailable Availability of the getting the signal strength.
 @param signalChangeThresholdAvailable Availability of the getting the signal Change Threshold.
 @param hdRadioEnableAvailable Availability of the control of enable/disable HD radio.
 @param siriusXMRadioAvailable Availability of sirius XM radio.
 @param sisDataAvailable Availability of sis data.
 @return An instance of the SDLRadioControlCapabilities class
 */
- (instancetype)initWithModuleName:(NSString *)moduleName moduleInfo:(nullable SDLModuleInfo *)moduleInfo radioEnableAvailable:(BOOL)radioEnableAvailable radioBandAvailable:(BOOL)radioBandAvailable radioFrequencyAvailable:(BOOL)radioFrequencyAvailable hdChannelAvailable:(BOOL)hdChannelAvailable rdsDataAvailable:(BOOL)rdsDataAvailable availableHDChannelsAvailable:(BOOL)availableHDChannelsAvailable stateAvailable:(BOOL)stateAvailable signalStrengthAvailable:(BOOL)signalStrengthAvailable signalChangeThresholdAvailable:(BOOL)signalChangeThresholdAvailable hdRadioEnableAvailable:(BOOL)hdRadioEnableAvailable siriusXMRadioAvailable:(BOOL)siriusXMRadioAvailable sisDataAvailable:(BOOL)sisDataAvailable;

/**
 * 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
 */
@property (strong, nonatomic) NSString *moduleName;

/**
 * Availability of the control of enable/disable radio.

 * True: Available, False: Not Available, Not present: Not Available.
 *
 * Optional, Boolean
 */
@property (nullable, strong, nonatomic) NSNumber<SDLBool> *radioEnableAvailable;

/**
 *  Availability of the control of radio band.

 * True: Available, False: Not Available, Not present: Not Available.
 *
 * Optional, Boolean
 */
@property (nullable, strong, nonatomic) NSNumber<SDLBool> *radioBandAvailable;

/**
 * Availability of the control of radio frequency.

 * True: Available, False: Not Available, Not present: Not Available.
 *
 * Optional, Boolean
 */
@property (nullable, strong, nonatomic) NSNumber<SDLBool> *radioFrequencyAvailable;

/**
 * Availability of the control of HD radio channel.

 * True: Available, False: Not Available, Not present: Not Available.
 *
 * Optional, Boolean
 */
@property (nullable, strong, nonatomic) NSNumber<SDLBool> *hdChannelAvailable;

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

 * True: Available, False: Not Available, Not present: Not Available.
 *
 * Optional, Boolean
 */
@property (nullable, strong, nonatomic) NSNumber<SDLBool> *rdsDataAvailable;

/**
 * Availability of the getting the number of available HD channels.

 * True: Available, False: Not Available, Not present: Not Available.
 *
 * Optional, Boolean
 */
@property (nullable, strong, nonatomic) NSNumber<SDLBool> *availableHDsAvailable __deprecated_msg("Use availableHDChannelsAvailable instead.");

/**
 * Availability of the list of available HD sub-channel indexes.
 
 * True: Available, False: Not Available, Not present: Not Available.
 *
 * Optional, Boolean
 */
@property (nullable, strong, nonatomic) NSNumber<SDLBool> *availableHDChannelsAvailable;

/**
 * Availability of the getting the Radio state.

 * True: Available, False: Not Available, Not present: Not Available.
 *
 * Optional, Boolean
 */
@property (nullable, strong, nonatomic) NSNumber<SDLBool> *stateAvailable;

/**
 * Availability of the getting the signal strength.

 * True: Available, False: Not Available, Not present: Not Available.
 *
 * Optional, Boolean
 */
@property (nullable, strong, nonatomic) NSNumber<SDLBool> *signalStrengthAvailable;

/**
 * Availability of the getting the signal Change Threshold

 * True: Available, False: Not Available, Not present: Not Available.
 *
 * Optional, Boolean
 */
@property (nullable, strong, nonatomic) NSNumber<SDLBool> *signalChangeThresholdAvailable;

/**
 * Availability of the control of enable/disable HD radio.
 * True: Available, False: Not Available, Not present: Not Available.
 *
 * Optional, Boolean
 */
@property (nullable, strong, nonatomic) NSNumber<SDLBool> *hdRadioEnableAvailable;

/**
 * Availability of sirius XM radio.
 * True: Available, False: Not Available, Not present: Not Available.
 *
 * Optional, Boolean
 */
@property (nullable, strong, nonatomic) NSNumber<SDLBool> *siriusXMRadioAvailable;

/**
 * Availability of the getting HD radio Station Information Service (SIS) data.
 * True: Available, False: Not Available, Not present: Not Available.
 *
 * Optional, Boolean
 */
@property (nullable, strong, nonatomic) NSNumber<SDLBool> *sisDataAvailable;

/**
 *  Information about a RC module, including its id.
 *
 *  SDLModuleInfo
 */
@property (nullable, strong, nonatomic) SDLModuleInfo *moduleInfo;

@end

NS_ASSUME_NONNULL_END