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

<h3>Section Contents</h3>

<ul>
  <li><a href="#section--initWithName:">-initWithName:</a></li>
  <li><a href="#section--initWithName:densityAvailable:colorAvailable:statusAvailable:">-initWithName:densityAvailable:colorAvailable:statusAvailable:</a></li>
  <li><a href="#section-name">name</a></li>
  <li><a href="#section-densityAvailable">densityAvailable</a></li>
  <li><a href="#section-colorAvailable">colorAvailable</a></li>
  <li><a href="#section-statusAvailable">statusAvailable</a></li>
</ul>

<h3>Overview</h3>

<p>Undocumented</p>


<section class="section task-group-section">
  <h3 id="section--initWithName:">
      -initWithName:
  </h3>
  
  <p>Constructs a newly allocated SDLLightCapabilities object with the name of the light or group of lights</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">initWithName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type Definitions.html#/c:SDLLightName.h@T@SDLLightName">SDLLightName</a></span><span class="p">)</span><span class="nv">name</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">name</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLLightName.h@T@SDLLightName">SDLLightName</a></span><span class="p">)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>name</dt>
      <dd><p>The name of a light or a group of lights</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>An instance of the SDLLightCapabilities class</p>
  </div>
  
  <h3 id="section--initWithName:densityAvailable:colorAvailable:statusAvailable:">
      -initWithName:densityAvailable:colorAvailable:statusAvailable:
  </h3>
  
  <p>Constructs a newly allocated SDLLightCapabilities 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">initWithName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type Definitions.html#/c:SDLLightName.h@T@SDLLightName">SDLLightName</a></span><span class="p">)</span><span class="nv">name</span>
                    <span class="nf">densityAvailable</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">densityAvailable</span>
                      <span class="nf">colorAvailable</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">colorAvailable</span>
                     <span class="nf">statusAvailable</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">statusAvailable</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">name</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLLightName.h@T@SDLLightName">SDLLightName</a></span><span class="p">,</span> <span class="nv">densityAvailable</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="nv">colorAvailable</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="nv">statusAvailable</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>name</dt>
      <dd><p>The name of a light or a group of lights</p></dd>
      <dt>densityAvailable</dt>
      <dd><p>light&rsquo;s density can be set remotely</p></dd>
      <dt>colorAvailable</dt>
      <dd><p>Light&rsquo;s color can be set remotely by using the RGB color space</p></dd>
      <dt>statusAvailable</dt>
      <dd><p>whether status is available</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>An instance of the SDLLightCapabilities class</p>
  </div>
  
  <h3 id="section-name">
      name
  </h3>
  
  <p>@abstract The name of a light or a group of lights</p>

<p>Required, SDLLightName</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLLightName.h@T@SDLLightName">SDLLightName</a></span> <span class="n">_Nonnull</span> <span class="n">name</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">name</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLLightName.h@T@SDLLightName">SDLLightName</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-densityAvailable">
      densityAvailable
  </h3>
  
  <p>@abstract  Indicates if the light&rsquo;s density can be set remotely (similar to a dimmer).</p>

<p>Optional, Boolean</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span>
    <span class="n">NSNumber</span><span class="o">&lt;</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="n">densityAvailable</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">densityAvailable</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> <span class="o">&amp;</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</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-colorAvailable">
      colorAvailable
  </h3>
  
  <p>@abstract Indicates if the light&rsquo;s color can be set remotely by using the RGB color space.</p>

<p>Optional, Boolean</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span>
    <span class="n">NSNumber</span><span class="o">&lt;</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="n">colorAvailable</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">colorAvailable</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> <span class="o">&amp;</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</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-statusAvailable">
      statusAvailable
  </h3>
  
  <p>@abstract Indicates if the status (ON/OFF) can be set remotely.
 App shall not use read-only values (RAMP_UP/RAMP_DOWN/UNKNOWN/INVALID) in a setInteriorVehicleData request.</p>

<p>Optional, Boolean</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span>
    <span class="n">NSNumber</span><span class="o">&lt;</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="n">statusAvailable</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">statusAvailable</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> <span class="o">&amp;</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</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>