summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLPrimaryAudioSource.html
blob: c868fc0acb0bf22339ce378fcdb6ea1f187bc226 (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
239
240
241
242
243
244
245
246
<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">-&gt;</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">-&gt;</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">-&gt;</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">-&gt;</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">-&gt;</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">-&gt;</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">-&gt;</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">-&gt;</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">-&gt;</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>