docs/Classes/SDLLightControlCapabilities.html


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

<h1>SDLLightControlCapabilities Class Reference</h1>

<h3>Section Contents</h3>

<ul>
  <li><a href="#section--initWithModuleName:supportedLights:">-initWithModuleName:supportedLights:</a></li>
  <li><a href="#section--initWithModuleName:moduleInfo:supportedLights:">-initWithModuleName:moduleInfo:supportedLights:</a></li>
  <li><a href="#section-moduleName">moduleName</a></li>
  <li><a href="#section-supportedLights">supportedLights</a></li>
  <li><a href="#section-moduleInfo">moduleInfo</a></li>
</ul>

<h3>Overview</h3>

<p>Current light control capabilities.</p>

<p>@since RPC 5.0</p>


<section class="section task-group-section">
  <h3 id="section--initWithModuleName:supportedLights:">
      -initWithModuleName:supportedLights:
  </h3>
  
  <p>Constructs a newly allocated SDLLightControlCapabilities 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">initWithModuleName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">moduleName</span>
                           <span class="nf">supportedLights</span><span class="p">:</span>
                               <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLLightCapabilities.html">SDLLightCapabilities</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="p">)</span>
                                   <span class="n"><a href="../Classes/SDLLightControlCapabilities.html#/c:objc(cs)SDLLightControlCapabilities(py)supportedLights">supportedLights</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">moduleName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">supportedLights</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLLightCapabilities.html">SDLLightCapabilities</a></span><span class="p">])</span></code></pre>

  
  <h4>Parameters</h4>
  <dl>
      <dt>moduleName</dt>
      <dd><p>friendly name of the light control module</p></dd>
      <dt>supportedLights</dt>
      <dd><p>array of available LightCapabilities</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>An instance of the SDLLightControlCapabilities class</p>
  </div>
  
  <h3 id="section--initWithModuleName:moduleInfo:supportedLights:">
      -initWithModuleName:moduleInfo:supportedLights:
  </h3>
  
  <p>Constructs a newly allocated SDLLightControlCapabilities 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">initWithModuleName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">moduleName</span>
                                <span class="nf">moduleInfo</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLModuleInfo.html">SDLModuleInfo</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">moduleInfo</span>
                           <span class="nf">supportedLights</span><span class="p">:</span>
                               <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLLightCapabilities.html">SDLLightCapabilities</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="p">)</span>
                                   <span class="n"><a href="../Classes/SDLLightControlCapabilities.html#/c:objc(cs)SDLLightControlCapabilities(py)supportedLights">supportedLights</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">moduleName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">moduleInfo</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLModuleInfo.html">SDLModuleInfo</a></span><span class="p">?,</span> <span class="nv">supportedLights</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLLightCapabilities.html">SDLLightCapabilities</a></span><span class="p">])</span></code></pre>

  
  <h4>Parameters</h4>
  <dl>
      <dt>moduleName</dt>
      <dd><p>friendly name of the light control module</p></dd>
      <dt>moduleInfo</dt>
      <dd><p>information about a RC module, including its id</p></dd>
      <dt>supportedLights</dt>
      <dd><p>array of available LightCapabilities</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>An instance of the SDLLightControlCapabilities class</p>
  </div>
  
  <h3 id="section-moduleName">
      moduleName
  </h3>
  
  <p>@abstract  The short friendly name of the light control module.
 It should not be used to identify a module by mobile application.</p>

<p>Required, Max String length 100 chars</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">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">moduleName</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">moduleName</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  <h3 id="section-supportedLights">
      supportedLights
  </h3>
  
  <p>@abstract  An array of available LightCapabilities that are controllable.</p>

<p>Required, NSArray of type SDLLightCapabilities minsize=&ldquo;1&rdquo; maxsize=&ldquo;100&rdquo;</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">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLLightCapabilities.html">SDLLightCapabilities</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">supportedLights</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">supportedLights</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLLightCapabilities.html">SDLLightCapabilities</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-moduleInfo">
      moduleInfo
  </h3>
  
  <p>Information about a RC module, including its id.</p>

<p>Optional</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"><a href="../Classes/SDLModuleInfo.html">SDLModuleInfo</a></span> <span class="o">*</span><span class="n">moduleInfo</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">moduleInfo</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLModuleInfo.html">SDLModuleInfo</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>