summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLConfiguration.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/Classes/SDLConfiguration.html')
-rw-r--r--docs/Classes/SDLConfiguration.html156
1 files changed, 136 insertions, 20 deletions
diff --git a/docs/Classes/SDLConfiguration.html b/docs/Classes/SDLConfiguration.html
index c27a5f2eb..bf5a6a254 100644
--- a/docs/Classes/SDLConfiguration.html
+++ b/docs/Classes/SDLConfiguration.html
@@ -5,8 +5,12 @@
<ul>
<li><a href="#section-lifecycleConfig">lifecycleConfig</a></li>
<li><a href="#section-lockScreenConfig">lockScreenConfig</a></li>
- <li><a href="#section--initWithLifecycle:lockScreen:">-initWithLifecycle:lockScreen:</a></li>
- <li><a href="#section-+configurationWithLifecycle:lockScreen:">+configurationWithLifecycle:lockScreen:</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>
@@ -53,45 +57,83 @@
- <h3 id="section--initWithLifecycle:lockScreen:">
- -initWithLifecycle:lockScreen:
+ <h3 id="section-loggingConfig">
+ loggingConfig
</h3>
- <p>Create a new configuration to be passed into SDLManager.</p>
+ <p>The log configuration.</p>
+
+
+
+ <h4>Objective-C</h4>
+ <pre class="highlight"><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"><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"><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"><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"><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">nonnull</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="p">;</span></code></pre>
+ <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"><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></code></pre>
+ <pre class="highlight"><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>
+ <dd><p>The lifecycle configuration to be used.</p></dd>
<dt>lockScreenConfig</dt>
- <dd><p>The lockscreen configuration to be used. If nil, this will be <code>enabledConfiguration</code>.</p>
-</dd>
+ <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:">
- +configurationWithLifecycle:lockScreen:
+ <h3 id="section-+configurationWithLifecycle:lockScreen:logging:">
+ +configurationWithLifecycle:lockScreen:logging:
</h3>
- <p>Create a new configuration to be passed into SDLManager.</p>
+ <p>Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, and logging configuration.</p>
@@ -99,7 +141,8 @@
<pre class="highlight"><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">nonnull</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="p">;</span></code></pre>
+ <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>
@@ -107,16 +150,89 @@
<h4>Parameters</h4>
<dl>
<dt>lifecycleConfig</dt>
- <dd><p>The lifecycle configuration to be used.</p>
-</dd>
+ <dd><p>The lifecycle configuration to be used.</p></dd>
<dt>lockScreenConfig</dt>
- <dd><p>The lockscreen configuration to be used. If nil, this will be <code>enabledConfiguration</code>.</p>
-</dd>
+ <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"><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"><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"><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>