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


#import "SDLRPCResponse.h"

#import "SDLHMIZoneCapabilities.h"
#import "SDLLanguage.h"
#import "SDLPrerecordedSpeech.h"
#import "SDLSpeechCapabilities.h"
#import "SDLVrCapabilities.h"

@class SDLAudioPassThruCapabilities;
@class SDLButtonCapabilities;
@class SDLDisplayCapabilities;
@class SDLHMICapabilities;
@class SDLPresetBankCapabilities;
@class SDLSoftButtonCapabilities;
@class SDLSyncMsgVersion;
@class SDLVehicleType;


/**
 Response to SDLRegisterAppInterface

 Since SmartDeviceLink 1.0
 */

NS_ASSUME_NONNULL_BEGIN

@interface SDLRegisterAppInterfaceResponse : SDLRPCResponse

/**
 The RPC spec version supported by the connected IVI system.

 Optional
 */
@property (nullable, strong, nonatomic) SDLSyncMsgVersion *syncMsgVersion;

/**
 The currently active VR+TTS language on the module. See "Language" for options.

 Optional
 */
@property (nullable, strong, nonatomic) SDLLanguage language;

/**
 The currently active display language on the module. See "Language" for options.

 Since SmartDeviceLink 2.0

 Optional
 */
@property (nullable, strong, nonatomic) SDLLanguage hmiDisplayLanguage;

/**
 Contains information about the display for the SDL system to which the application is currently connected.

 Optional
 */
@property (nullable, strong, nonatomic) SDLDisplayCapabilities *displayCapabilities;

/**
 Provides information about the capabilities of a SDL HMI button.

 Optional, Array of length 1 - 100, of SDLButtonCapabilities
 */
@property (nullable, strong, nonatomic) NSArray<SDLButtonCapabilities *> *buttonCapabilities;

/**
 Contains information about a SoftButton's capabilities.

 Optional, Array of length 1 - 100, of SDLSoftButtonCapabilities
 */
@property (nullable, strong, nonatomic) NSArray<SDLSoftButtonCapabilities *> *softButtonCapabilities;

/**
 If returned, the platform supports custom on-screen Presets
 
 Optional
 */
@property (nullable, strong, nonatomic) SDLPresetBankCapabilities *presetBankCapabilities;

/**
 Specifies HMI Zones in the vehicle.

 Optional, Array of length 1 - 100, of SDLHMIZoneCapabilities
 */
@property (nullable, strong, nonatomic) NSArray<SDLHMIZoneCapabilities> *hmiZoneCapabilities;

/**
 Contains information about TTS capabilities on the SDL platform.

 Optional, Array of length 1 - 100, of SDLSpeechCapabilities
 */
@property (nullable, strong, nonatomic) NSArray<SDLSpeechCapabilities> *speechCapabilities;

/**
 Contains information about the speech capabilities on the SDL platform
 *
 * Optional, Array of length 1 - 100, of SDLPrerecordedSpeech
 */
@property (nullable, strong, nonatomic) NSArray<SDLPrerecordedSpeech> *prerecordedSpeech;

/**
 The VR capabilities of the connected SDL platform.

 Optional, Array of length 1 - 100, of SDLVRCapabilities
 */
@property (nullable, strong, nonatomic) NSArray<SDLVRCapabilities> *vrCapabilities;

/**
 Describes different audio type configurations for SDLPerformAudioPassThru, e.g. {8kHz,8-bit,PCM}

 Optional, Array of length 1 - 100, of SDLAudioPassThruCapabilities
 */
@property (nullable, strong, nonatomic) NSArray<SDLAudioPassThruCapabilities *> *audioPassThruCapabilities;

/**
 Describes different audio type configurations for the audio PCM stream service, e.g. {8kHz,8-bit,PCM}
 */
@property (nullable, strong, nonatomic) SDLAudioPassThruCapabilities *pcmStreamCapabilities;

/**
 Specifies the connected vehicle's type
 */
@property (nullable, strong, nonatomic) SDLVehicleType *vehicleType;

/**
 Specifies the white-list of supported diagnostic modes (0x00-0xFF) capable for DiagnosticMessage requests. If a mode outside this list is requested, it will be rejected.

 Optional, Array of length 1 - 100, Integer 0 - 255
 */
@property (nullable, strong, nonatomic) NSArray<NSNumber<SDLInt> *> *supportedDiagModes;

/**
 Specifies the availability of various SDL features.

 Optional
 */
@property (nullable, strong, nonatomic) SDLHMICapabilities *hmiCapabilities;

/**
 The SmartDeviceLink Core version

 Optional, String max length 100
 */
@property (nullable, strong, nonatomic) NSString *sdlVersion;

/**
 The software version of the system that implements SmartDeviceLink Core

 Optional, String max length 100
 */
@property (nullable, strong, nonatomic) NSString *systemSoftwareVersion;


@end

NS_ASSUME_NONNULL_END