summaryrefslogtreecommitdiff
path: root/SmartDeviceLink/SDLDeviceStatus.h
blob: d8442d4387e9d4a7fb96f7707a6a1c4463b78995 (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
//  SDLDeviceStatus.h
//

#import "SDLRPCMessage.h"

@class SDLDeviceLevelStatus;
@class SDLPrimaryAudioSource;


/**
 * Describes the status related to a connected mobile device or SDL and if or how  it is represented in the vehicle.
 *
 * Parameter List
 * <table border="1" rules="all">
 * 		<tr>
 * 			<th>Name</th>
 * 			<th>Type</th>
 * 			<th>Description</th>
 * 			<th>SmartDeviceLink Ver. Available</th>
 * 		</tr>
 * 		<tr>
 * 			<td>voiceRecOn</td>
 * 			<td>NSNumber * </td>
 * 			<td>Voice recognition is on
 * 			</td>
 * 			<td>SmartDeviceLink 2.0</td>
 * 		</tr>
 * 		<tr>
 * 			<td>btIconOn</td>
 * 			<td>NSNumber * </td>
 * 			<td>Bluetooth connection established
 * 			</td>
 * 			<td>SmartDeviceLink 2.0</td>
 * 		</tr>
 * 		<tr>
 * 			<td>callActive</td>
 * 			<td>NSNumber * </td>
 * 			<td>A call is being active
 * 			</td>
 * 			<td>SmartDeviceLink 2.0</td>
 * 		</tr>
 * 		<tr>
 * 			<td>phoneRoaming</td>
 * 			<td>NSNumber * </td>
 * 			<td>The phone is in roaming mode
 * 			</td>
 * 			<td>SmartDeviceLink 2.0</td>
 * 		</tr>
 * 		<tr>
 * 			<td>textMsgAvailable</td>
 * 			<td>NSNumber * </td>
 * 			<td>A textmessage is available
 * 			</td>
 * 			<td>SmartDeviceLink 2.0</td>
 * 		</tr>
 * 		<tr>
 * 			<td>battLevelStatus</td>
 * 			<td>SDLDeviceLevelStatus * </td>
 * 			<td>Battery level status
 * 			</td>
 * 			<td>SmartDeviceLink 2.0</td>
 * 		</tr>
 * 		<tr>
 * 			<td>stereoAudioOutputMuted</td>
 * 			<td>NSNumber * </td>
 * 			<td>Status of the stereo audio output channel
 * 			</td>
 * 			<td>SmartDeviceLink 2.0</td>
 * 		</tr>
 * 		<tr>
 * 			<td>monoAudioOutputMuted</td>
 * 			<td>NSNumber * </td>
 * 			<td>Status of the mono audio output channel
 * 			</td>
 * 			<td>SmartDeviceLink 2.0</td>
 * 		</tr>
 * 		<tr>
 * 			<td>signalLevelStatus</td>
 * 			<td>SDLDeviceLevelStatus * </td>
 * 			<td>Signal level status
 * 			</td>
 * 			<td>SmartDeviceLink 2.0</td>
 * 		</tr>
 * 		<tr>
 * 			<td>primaryAudioSource</td>
 * 			<td>PrimaryAudioSource * </td>
 * 			<td>Reflects the current primary audio source of SDL (if selected).
 * 			</td>
 * 			<td>SmartDeviceLink 2.0</td>
 * 		</tr>
 * 		<tr>
 * 			<td>eCallEventActive</td>
 * 			<td>NSNumber * </td>
 * 			<td>Reflects, if an eCall event is active
 * 			</td>
 * 			<td>SmartDeviceLink 2.0</td>
 * 		</tr>
 *  </table>
 * @since SDL 2.0
 */
@interface SDLDeviceStatus : SDLRPCStruct {
}

/**
 * Constructs a newly allocated SDLDeviceStatus object
 */
- (instancetype)init;

/**
 * Constructs a newly allocated SDLDeviceStatus object indicated by the dictionary parameter
 *
 * @param dict The dictionary to use to construct the object
 */
- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;

/**
 * @abstract Indicates whether the voice recognition is on or off
 *
 * Required, Boolean
 */
@property (strong) NSNumber *voiceRecOn;

/**
 * @abstract Indicates whether the bluetooth connection established
 *
 * Required, Boolean
 */
@property (strong) NSNumber *btIconOn;

/**
 * @abstract Indicates whether a call is being active
 *
 * Required, Boolean
 */
@property (strong) NSNumber *callActive;

/**
 * @abstract Indicates whether the phone is in roaming mode
 *
 * Required, Boolean
 */
@property (strong) NSNumber *phoneRoaming;

/**
 * @abstract Indicates whether a textmessage is available
 *
 * Required, Boolean
 */
@property (strong) NSNumber *textMsgAvailable;

/**
 * @abstract Battery level status
 *
 * @see SDLDeviceLevelStatus
 *
 * Required
 */
@property (strong) SDLDeviceLevelStatus *battLevelStatus;

/**
 * @abstract The status of the stereo audio output channel
 *
 * Required, Boolean
 */
@property (strong) NSNumber *stereoAudioOutputMuted;

/**
 * @abstract The status of the mono audio output channel
 *
 * Required, Boolean
 */
@property (strong) NSNumber *monoAudioOutputMuted;

/**
 * @abstract Signal level status
 *
 * @see SDLDeviceLevelStatus
 *
 * Required
 */
@property (strong) SDLDeviceLevelStatus *signalLevelStatus;

/**
 * @abstract The current primary audio source of SDL (if selected).
 *
 * @see SDLPrimaryAudioSource
 * 
 * Required
 */
@property (strong) SDLPrimaryAudioSource *primaryAudioSource;

/**
 * @abstract Indicates if an emergency call is active
 *
 * Required, Boolean
 */
@property (strong) NSNumber *eCallEventActive;

@end