summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLRemoteControlCapabilities.html
blob: 53345e3411c6aaff41ad19ae8be2c68da8c28854 (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
<h1>SDLRemoteControlCapabilities Class Reference</h1>

<h3>Section Contents</h3>

<ul>
  <li><a href="#section--initWithClimateControlCapabilities:radioControlCapabilities:buttonCapabilities:seatControlCapabilities:audioControlCapabilities:hmiSettingsControlCapabilities:lightControlCapabilities:">-initWithClimateControlCapabilities:radioControlCapabilities:buttonCapabilities:seatControlCapabilities:audioControlCapabilities:hmiSettingsControlCapabilities:lightControlCapabilities:</a></li>
  <li><a href="#section-climateControlCapabilities">climateControlCapabilities</a></li>
  <li><a href="#section-radioControlCapabilities">radioControlCapabilities</a></li>
  <li><a href="#section-buttonCapabilities">buttonCapabilities</a></li>
  <li><a href="#section-seatControlCapabilities">seatControlCapabilities</a></li>
  <li><a href="#section-audioControlCapabilities">audioControlCapabilities</a></li>
  <li><a href="#section-hmiSettingsControlCapabilities">hmiSettingsControlCapabilities</a></li>
  <li><a href="#section-lightControlCapabilities">lightControlCapabilities</a></li>
</ul>

<h3>Overview</h3>

<p>Capabilities of the remote control feature</p>


<section class="section task-group-section">
  <h3 id="section--initWithClimateControlCapabilities:radioControlCapabilities:buttonCapabilities:seatControlCapabilities:audioControlCapabilities:hmiSettingsControlCapabilities:lightControlCapabilities:">
      -initWithClimateControlCapabilities:radioControlCapabilities:buttonCapabilities:seatControlCapabilities:audioControlCapabilities:hmiSettingsControlCapabilities:lightControlCapabilities:
  </h3>
  
  <p>Constructs a newly allocated SDLRemoteControlCapabilities object with given parameters</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span>
    <span class="nf">initWithClimateControlCapabilities</span><span class="p">:</span>
        <span class="p">(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLClimateControlCapabilities.html">SDLClimateControlCapabilities</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="p">)</span>
            <span class="n"><a href="../Classes/SDLRemoteControlCapabilities.html#/c:objc(cs)SDLRemoteControlCapabilities(py)climateControlCapabilities">climateControlCapabilities</a></span>
              <span class="n"><a href="../Classes/SDLRemoteControlCapabilities.html#/c:objc(cs)SDLRemoteControlCapabilities(py)radioControlCapabilities">radioControlCapabilities</a></span><span class="o">:</span>
                  <span class="p">(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLRadioControlCapabilities.html">SDLRadioControlCapabilities</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="p">)</span>
                      <span class="n"><a href="../Classes/SDLRemoteControlCapabilities.html#/c:objc(cs)SDLRemoteControlCapabilities(py)radioControlCapabilities">radioControlCapabilities</a></span>
                    <span class="n"><a href="../Classes/SDLRemoteControlCapabilities.html#/c:objc(cs)SDLRemoteControlCapabilities(py)buttonCapabilities">buttonCapabilities</a></span><span class="o">:</span>
                        <span class="p">(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLButtonCapabilities.html">SDLButtonCapabilities</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="p">)</span>
                            <span class="n"><a href="../Classes/SDLRemoteControlCapabilities.html#/c:objc(cs)SDLRemoteControlCapabilities(py)buttonCapabilities">buttonCapabilities</a></span>
               <span class="n"><a href="../Classes/SDLRemoteControlCapabilities.html#/c:objc(cs)SDLRemoteControlCapabilities(py)seatControlCapabilities">seatControlCapabilities</a></span><span class="o">:</span>
                   <span class="p">(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLSeatControlCapabilities.html">SDLSeatControlCapabilities</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="p">)</span>
                       <span class="n"><a href="../Classes/SDLRemoteControlCapabilities.html#/c:objc(cs)SDLRemoteControlCapabilities(py)seatControlCapabilities">seatControlCapabilities</a></span>
              <span class="n"><a href="../Classes/SDLRemoteControlCapabilities.html#/c:objc(cs)SDLRemoteControlCapabilities(py)audioControlCapabilities">audioControlCapabilities</a></span><span class="o">:</span>
                  <span class="p">(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLAudioControlCapabilities.html">SDLAudioControlCapabilities</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="p">)</span>
                      <span class="n"><a href="../Classes/SDLRemoteControlCapabilities.html#/c:objc(cs)SDLRemoteControlCapabilities(py)audioControlCapabilities">audioControlCapabilities</a></span>
        <span class="n"><a href="../Classes/SDLRemoteControlCapabilities.html#/c:objc(cs)SDLRemoteControlCapabilities(py)hmiSettingsControlCapabilities">hmiSettingsControlCapabilities</a></span><span class="o">:</span>
            <span class="p">(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLHMISettingsControlCapabilities.html">SDLHMISettingsControlCapabilities</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="p">)</span>
                <span class="n"><a href="../Classes/SDLRemoteControlCapabilities.html#/c:objc(cs)SDLRemoteControlCapabilities(py)hmiSettingsControlCapabilities">hmiSettingsControlCapabilities</a></span>
              <span class="n"><a href="../Classes/SDLRemoteControlCapabilities.html#/c:objc(cs)SDLRemoteControlCapabilities(py)lightControlCapabilities">lightControlCapabilities</a></span><span class="o">:</span>
                  <span class="p">(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLLightControlCapabilities.html">SDLLightControlCapabilities</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="p">)</span>
                      <span class="n"><a href="../Classes/SDLRemoteControlCapabilities.html#/c:objc(cs)SDLRemoteControlCapabilities(py)lightControlCapabilities">lightControlCapabilities</a></span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">climateControlCapabilities</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLClimateControlCapabilities.html">SDLClimateControlCapabilities</a></span><span class="p">]?,</span> <span class="nv">radioControlCapabilities</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLRadioControlCapabilities.html">SDLRadioControlCapabilities</a></span><span class="p">]?,</span> <span class="nv">buttonCapabilities</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLButtonCapabilities.html">SDLButtonCapabilities</a></span><span class="p">]?,</span> <span class="nv">seatControlCapabilities</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLSeatControlCapabilities.html">SDLSeatControlCapabilities</a></span><span class="p">]?,</span> <span class="nv">audioControlCapabilities</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLAudioControlCapabilities.html">SDLAudioControlCapabilities</a></span><span class="p">]?,</span> <span class="nv">hmiSettingsControlCapabilities</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLHMISettingsControlCapabilities.html">SDLHMISettingsControlCapabilities</a></span><span class="p">]?,</span> <span class="nv">lightControlCapabilities</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLLightControlCapabilities.html">SDLLightControlCapabilities</a></span><span class="p">]?)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>climateControlCapabilities</dt>
      <dd><p>Array of SDLClimateControlCapabilities</p></dd>
      <dt>radioControlCapabilities</dt>
      <dd><p>Array of SDLRadioControlCapabilities</p></dd>
      <dt>buttonCapabilities</dt>
      <dd><p>Array of SDLButtonCapabilities</p></dd>
      <dt>lightControlCapabilities</dt>
      <dd><p>Array of SDLLightControlCapabilities</p></dd>
      <dt>seatControlCapabilities</dt>
      <dd><p>Array of SDLSeatControlCapabilities</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>An instance of the SDLRemoteControlCapabilities class</p>
  </div>
  
  <h3 id="section-climateControlCapabilities">
      climateControlCapabilities
  </h3>
  
  <p>If included, the platform supports RC climate controls.
 For this baseline version, maxsize=1. i.e. only one climate control module is supported.</p>

<p>Optional, Array of SDLClimateControlCapabilities, Array length 1 - 100</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLClimateControlCapabilities.html">SDLClimateControlCapabilities</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="n">climateControlCapabilities</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">climateControlCapabilities</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLClimateControlCapabilities.html">SDLClimateControlCapabilities</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-radioControlCapabilities">
      radioControlCapabilities
  </h3>
  
  <p>If included, the platform supports RC radio controls.
 For this baseline version, maxsize=1. i.e. only one radio control module is supported.</p>

<p>Optional, Array of SDLRadioControlCapabilities, Array length 1 - 100</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLRadioControlCapabilities.html">SDLRadioControlCapabilities</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="n">radioControlCapabilities</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">radioControlCapabilities</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLRadioControlCapabilities.html">SDLRadioControlCapabilities</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-buttonCapabilities">
      buttonCapabilities
  </h3>
  
  <p>If included, the platform supports RC button controls with the included button names.</p>

<p>Optional, Array of SDLButtonCapabilities, Array length 1 - 100</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLButtonCapabilities.html">SDLButtonCapabilities</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="n">buttonCapabilities</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">buttonCapabilities</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLButtonCapabilities.html">SDLButtonCapabilities</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-seatControlCapabilities">
      seatControlCapabilities
  </h3>
  
  <p>If included, the platform supports seat controls.</p>

<p>Optional, Array of SDLSeatControlCapabilities, Array length 1 - 100</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLSeatControlCapabilities.html">SDLSeatControlCapabilities</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="n">seatControlCapabilities</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">seatControlCapabilities</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLSeatControlCapabilities.html">SDLSeatControlCapabilities</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-audioControlCapabilities">
      audioControlCapabilities
  </h3>
  
  <p>If included, the platform supports audio controls.</p>

<p>Optional, Array of SDLAudioControlCapabilities, Array length 1 - 100</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLAudioControlCapabilities.html">SDLAudioControlCapabilities</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="n">audioControlCapabilities</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">audioControlCapabilities</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLAudioControlCapabilities.html">SDLAudioControlCapabilities</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-hmiSettingsControlCapabilities">
      hmiSettingsControlCapabilities
  </h3>
  
  <p>If included, the platform supports hmi setting controls.</p>

<p>Optional, Array of SDLHMISettingsControlCapabilities, Array length 1 - 100</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLHMISettingsControlCapabilities.html">SDLHMISettingsControlCapabilities</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="n">hmiSettingsControlCapabilities</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">hmiSettingsControlCapabilities</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLHMISettingsControlCapabilities.html">SDLHMISettingsControlCapabilities</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-lightControlCapabilities">
      lightControlCapabilities
  </h3>
  
  <p>If included, the platform supports light controls.</p>

<p>Optional, Array of SDLLightControlCapabilities, Array length 1 - 100</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLLightControlCapabilities.html">SDLLightControlCapabilities</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="n">lightControlCapabilities</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">lightControlCapabilities</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLLightControlCapabilities.html">SDLLightControlCapabilities</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
</section>