summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLConfiguration.html
blob: 8cf87a88cb646d61202987ce1cfc4f23ea9953a1 (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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
<h1>SDLConfiguration Class Reference</h1>

<h3>Section Contents</h3>

<ul>
  <li><a href="#section-lifecycleConfig">lifecycleConfig</a></li>
  <li><a href="#section-lockScreenConfig">lockScreenConfig</a></li>
  <li><a href="#section-loggingConfig">loggingConfig</a></li>
  <li><a href="#section-streamingMediaConfig">streamingMediaConfig</a></li>
  <li><a href="#section--initWithLifecycle:lockScreen:logging:">-initWithLifecycle:lockScreen:logging:</a></li>
  <li><a href="#section-+configurationWithLifecycle:lockScreen:logging:">+configurationWithLifecycle:lockScreen:logging:</a></li>
  <li><a href="#section--initWithLifecycle:lockScreen:logging:streamingMedia:">-initWithLifecycle:lockScreen:logging:streamingMedia:</a></li>
  <li><a href="#section-+configurationWithLifecycle:lockScreen:logging:streamingMedia:">+configurationWithLifecycle:lockScreen:logging:streamingMedia:</a></li>
</ul>

<h3>Overview</h3>

<p>Undocumented</p>


<section class="section task-group-section">
  <h3 id="section-lifecycleConfig">
      lifecycleConfig
  </h3>
  
  <p>The lifecycle configuration.</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span>
    <span class="n"><a href="../Classes/SDLLifecycleConfiguration.html">SDLLifecycleConfiguration</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">lifecycleConfig</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="kd">@NSCopying</span> <span class="k">var</span> <span class="nv">lifecycleConfig</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLifecycleConfiguration.html">SDLLifecycleConfiguration</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-lockScreenConfig">
      lockScreenConfig
  </h3>
  
  <p>The lock screen configuration.</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span>
    <span class="n"><a href="../Classes/SDLLockScreenConfiguration.html">SDLLockScreenConfiguration</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">lockScreenConfig</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="kd">@NSCopying</span> <span class="k">var</span> <span class="nv">lockScreenConfig</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLockScreenConfiguration.html">SDLLockScreenConfiguration</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-loggingConfig">
      loggingConfig
  </h3>
  
  <p>The log configuration.</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span>
    <span class="n"><a href="../Classes/SDLLogConfiguration.html">SDLLogConfiguration</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">loggingConfig</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="kd">@NSCopying</span> <span class="k">var</span> <span class="nv">loggingConfig</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLogConfiguration.html">SDLLogConfiguration</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-streamingMediaConfig">
      streamingMediaConfig
  </h3>
  
  <p>The configuration</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span>
    <span class="n"><a href="../Classes/SDLStreamingMediaConfiguration.html">SDLStreamingMediaConfiguration</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">streamingMediaConfig</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="kd">@NSCopying</span> <span class="k">var</span> <span class="nv">streamingMediaConfig</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLStreamingMediaConfiguration.html">SDLStreamingMediaConfiguration</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section--initWithLifecycle:lockScreen:logging:">
      -initWithLifecycle:lockScreen:logging:
  </h3>
  
  <p>Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, and logging configuration.</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">initWithLifecycle</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLLifecycleConfiguration.html">SDLLifecycleConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">lifecycleConfig</span>
       <span class="nf">lockScreen</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLLockScreenConfiguration.html">SDLLockScreenConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">lockScreenConfig</span>
          <span class="nf">logging</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLLogConfiguration.html">SDLLogConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">logConfig</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="n">lifecycle</span> <span class="nv">lifecycleConfig</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLifecycleConfiguration.html">SDLLifecycleConfiguration</a></span><span class="p">,</span> <span class="n">lockScreen</span> <span class="nv">lockScreenConfig</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLockScreenConfiguration.html">SDLLockScreenConfiguration</a></span><span class="p">?,</span> <span class="n">logging</span> <span class="nv">logConfig</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLogConfiguration.html">SDLLogConfiguration</a></span><span class="p">?)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>lifecycleConfig</dt>
      <dd><p>The lifecycle configuration to be used.</p></dd>
      <dt>lockScreenConfig</dt>
      <dd><p>The lockscreen configuration to be used, or <code>enabledConfiguration</code> if nil.</p></dd>
      <dt>logConfig</dt>
      <dd><p>The logging configuration to be used, or <code>defaultConfiguration</code> if nil.</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>The configuration</p>
  </div>
  
  <h3 id="section-+configurationWithLifecycle:lockScreen:logging:">
      +configurationWithLifecycle:lockScreen:logging:
  </h3>
  
  <p>Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, and logging configuration.</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">configurationWithLifecycle</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLLifecycleConfiguration.html">SDLLifecycleConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">lifecycleConfig</span>
                <span class="nf">lockScreen</span><span class="p">:</span>
                    <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLLockScreenConfiguration.html">SDLLockScreenConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">lockScreenConfig</span>
                   <span class="nf">logging</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLLogConfiguration.html">SDLLogConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">logConfig</span><span class="p">;</span></code></pre>

  
  
  
  <h4>Parameters</h4>
  <dl>
      <dt>lifecycleConfig</dt>
      <dd><p>The lifecycle configuration to be used.</p></dd>
      <dt>lockScreenConfig</dt>
      <dd><p>The lockscreen configuration to be used, or <code>enabledConfiguration</code> if nil.</p></dd>
      <dt>logConfig</dt>
      <dd><p>The logging configuration to be used, or <code>defaultConfiguration</code> if nil.</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>The configuration</p>
  </div>
  
  <h3 id="section--initWithLifecycle:lockScreen:logging:streamingMedia:">
      -initWithLifecycle:lockScreen:logging:streamingMedia:
  </h3>
  
  <p>Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, logging, and streaming media configuration.</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">initWithLifecycle</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLLifecycleConfiguration.html">SDLLifecycleConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">lifecycleConfig</span>
       <span class="nf">lockScreen</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLLockScreenConfiguration.html">SDLLockScreenConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">lockScreenConfig</span>
          <span class="nf">logging</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLLogConfiguration.html">SDLLogConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">logConfig</span>
   <span class="nf">streamingMedia</span><span class="p">:</span>
       <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLStreamingMediaConfiguration.html">SDLStreamingMediaConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">streamingMediaConfig</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="n">lifecycle</span> <span class="nv">lifecycleConfig</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLifecycleConfiguration.html">SDLLifecycleConfiguration</a></span><span class="p">,</span> <span class="n">lockScreen</span> <span class="nv">lockScreenConfig</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLockScreenConfiguration.html">SDLLockScreenConfiguration</a></span><span class="p">?,</span> <span class="n">logging</span> <span class="nv">logConfig</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLogConfiguration.html">SDLLogConfiguration</a></span><span class="p">?,</span> <span class="n">streamingMedia</span> <span class="nv">streamingMediaConfig</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLStreamingMediaConfiguration.html">SDLStreamingMediaConfiguration</a></span><span class="p">?)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>lifecycleConfig</dt>
      <dd><p>The lifecycle configuration to be used.</p></dd>
      <dt>lockScreenConfig</dt>
      <dd><p>The lockscreen configuration to be used, or <code>enabledConfiguration</code> if nil.</p></dd>
      <dt>logConfig</dt>
      <dd><p>The logging configuration to be used, or <code>defaultConfiguration</code> if nil.</p></dd>
      <dt>streamingMediaConfig</dt>
      <dd><p>The streaming media configuration to be used, or nil because it is not needed.</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>The configuration</p>
  </div>
  
  <h3 id="section-+configurationWithLifecycle:lockScreen:logging:streamingMedia:">
      +configurationWithLifecycle:lockScreen:logging:streamingMedia:
  </h3>
  
  <p>Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, logging, and streaming media configuration.</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">configurationWithLifecycle</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLLifecycleConfiguration.html">SDLLifecycleConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">lifecycleConfig</span>
                <span class="nf">lockScreen</span><span class="p">:</span>
                    <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLLockScreenConfiguration.html">SDLLockScreenConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">lockScreenConfig</span>
                   <span class="nf">logging</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLLogConfiguration.html">SDLLogConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">logConfig</span>
            <span class="nf">streamingMedia</span><span class="p">:</span>
                <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLStreamingMediaConfiguration.html">SDLStreamingMediaConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">streamingMediaConfig</span><span class="p">;</span></code></pre>

  
  
  
  <h4>Parameters</h4>
  <dl>
      <dt>lifecycleConfig</dt>
      <dd><p>The lifecycle configuration to be used.</p></dd>
      <dt>lockScreenConfig</dt>
      <dd><p>The lockscreen configuration to be used, or <code>enabledConfiguration</code> if nil.</p></dd>
      <dt>logConfig</dt>
      <dd><p>The logging configuration to be used, or <code>defaultConfiguration</code> if nil.</p></dd>
      <dt>streamingMediaConfig</dt>
      <dd><p>The streaming media configuration to be used, or nil because it is not needed.</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>The configuration</p>
  </div>
  
</section>