diff options
Diffstat (limited to 'docs/Classes/SDLPrimaryAudioSource.html')
| -rw-r--r-- | docs/Classes/SDLPrimaryAudioSource.html | 246 |
1 files changed, 0 insertions, 246 deletions
diff --git a/docs/Classes/SDLPrimaryAudioSource.html b/docs/Classes/SDLPrimaryAudioSource.html deleted file mode 100644 index c868fc0ac..000000000 --- a/docs/Classes/SDLPrimaryAudioSource.html +++ /dev/null @@ -1,246 +0,0 @@ -<h1>SDLPrimaryAudioSource Class Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section-+valueOf:">+valueOf:</a></li> - <li><a href="#section-+values">+values</a></li> - <li><a href="#section-+NO_SOURCE_SELECTED">+NO_SOURCE_SELECTED</a></li> - <li><a href="#section-+USB">+USB</a></li> - <li><a href="#section-+USB2">+USB2</a></li> - <li><a href="#section-+BLUETOOTH_STEREO_BTST">+BLUETOOTH_STEREO_BTST</a></li> - <li><a href="#section-+LINE_IN">+LINE_IN</a></li> - <li><a href="#section-+IPOD">+IPOD</a></li> - <li><a href="#section-+MOBILE_APP">+MOBILE_APP</a></li> -</ul> - -<h3>Overview</h3> - -<p>Reflects the current primary audio source of SDL (if selected).</p> - -<p>@since SDL 2.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>@abstract get SDLPrimaryAudioSource according value string</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLPrimaryAudioSource</span> <span class="o">*</span><span class="p">)</span><span class="nf">valueOf</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">value</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">value</span><span class="p">(</span><span class="n">of</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="o">!</span><span class="p">)</span> <span class="o">-></span> <span class="kt">SDLPrimaryAudioSource</span><span class="o">!</span></code></pre> - - - - <h4>Parameters</h4> - <dl> - <dt>value</dt> - <dd><p>String value to retrieve the object enum for</p> -</dd> - </dl> - <div> - <h4>Return Value</h4> - <p>SDLPrimaryAudioSource object</p> - - </div> - - <h3 id="section-+values"> - +values - </h3> - - <p>@abstract declare an array to store all possible SDLPrimaryAudioSource values -- returns: the array</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">NSArray</span> <span class="o">*</span><span class="p">)</span><span class="n">values</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">values</span><span class="p">()</span> <span class="o">-></span> <span class="p">[</span><span class="kt">Any</span><span class="p">]</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>the array</p> - - </div> - - <h3 id="section-+NO_SOURCE_SELECTED"> - +NO_SOURCE_SELECTED - </h3> - - <p>@abstract Currently no source selected -- returns: the current primary audio source: <em>NO_SOURCE_SELECTED</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLPrimaryAudioSource</span> <span class="o">*</span><span class="p">)</span><span class="n">NO_SOURCE_SELECTED</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">no_SOURCE_SELECTED</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLPrimaryAudioSource</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>the current primary audio source: <em>NO_SOURCE_SELECTED</em></p> - - </div> - - <h3 id="section-+USB"> - +USB - </h3> - - <p>@abstract USB is current source -- returns: the current primary audio source: <em>USB</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLPrimaryAudioSource</span> <span class="o">*</span><span class="p">)</span><span class="n">USB</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">usb</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLPrimaryAudioSource</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>the current primary audio source: <em>USB</em></p> - - </div> - - <h3 id="section-+USB2"> - +USB2 - </h3> - - <p>@abstract USB2 is current source -- returns: the current primary audio source: <em>USB2</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLPrimaryAudioSource</span> <span class="o">*</span><span class="p">)</span><span class="n">USB2</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">usb2</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLPrimaryAudioSource</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>the current primary audio source: <em>USB2</em></p> - - </div> - - <h3 id="section-+BLUETOOTH_STEREO_BTST"> - +BLUETOOTH_STEREO_BTST - </h3> - - <p>@abstract Bluetooth Stereo is current source -- returns: the current primary audio source: <em>BLUETOOTH_STEREO_BTST</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLPrimaryAudioSource</span> <span class="o">*</span><span class="p">)</span><span class="n">BLUETOOTH_STEREO_BTST</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">bluetooth_STEREO_BTST</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLPrimaryAudioSource</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>the current primary audio source: <em>BLUETOOTH_STEREO_BTST</em></p> - - </div> - - <h3 id="section-+LINE_IN"> - +LINE_IN - </h3> - - <p>@abstract Line in is current source -- returns: the current primary audio source: <em>LINE_IN</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLPrimaryAudioSource</span> <span class="o">*</span><span class="p">)</span><span class="n">LINE_IN</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">line_IN</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLPrimaryAudioSource</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>the current primary audio source: <em>LINE_IN</em></p> - - </div> - - <h3 id="section-+IPOD"> - +IPOD - </h3> - - <p>@abstract iPod is current source -- returns: the current primary audio source: <em>IPOD</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLPrimaryAudioSource</span> <span class="o">*</span><span class="p">)</span><span class="n">IPOD</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">ipod</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLPrimaryAudioSource</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>the current primary audio source: <em>IPOD</em></p> - - </div> - - <h3 id="section-+MOBILE_APP"> - +MOBILE_APP - </h3> - - <p>@abstract Mobile app is current source -- returns: the current primary audio source: <em>MOBILE_APP</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLPrimaryAudioSource</span> <span class="o">*</span><span class="p">)</span><span class="n">MOBILE_APP</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">mobile_APP</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLPrimaryAudioSource</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>the current primary audio source: <em>MOBILE_APP</em></p> - - </div> - -</section> |