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
|
<h1>SDLAudioControlData Class Reference</h1>
<h3>Section Contents</h3>
<ul>
<li><a href="#section--initWithSource:keepContext:volume:equalizerSettings:">-initWithSource:keepContext:volume:equalizerSettings:</a></li>
<li><a href="#section-source">source</a></li>
<li><a href="#section-keepContext">keepContext</a></li>
<li><a href="#section-volume">volume</a></li>
<li><a href="#section-equalizerSettings">equalizerSettings</a></li>
</ul>
<h3>Overview</h3>
<p>Undocumented</p>
<section class="section task-group-section">
<h3 id="section--initWithSource:keepContext:volume:equalizerSettings:">
-initWithSource:keepContext:volume:equalizerSettings:
</h3>
<p>Constructs a newly allocated SDLAudioControlData 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">initWithSource</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLPrimaryAudioSource.h@T@SDLPrimaryAudioSource">SDLPrimaryAudioSource</a></span><span class="p">)</span><span class="nv">source</span>
<span class="nf">keepContext</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">keepContext</span>
<span class="nf">volume</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">volume</span>
<span class="nf">equalizerSettings</span><span class="p">:</span>
<span class="p">(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLEqualizerSettings.html">SDLEqualizerSettings</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span>
<span class="n"><a href="../Classes/SDLAudioControlData.html#/c:objc(cs)SDLAudioControlData(py)equalizerSettings">equalizerSettings</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">source</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLPrimaryAudioSource.h@T@SDLPrimaryAudioSource">SDLPrimaryAudioSource</a></span><span class="p">?,</span> <span class="nv">keepContext</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> <span class="o">&</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="p">)?,</span> <span class="nv">volume</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> <span class="o">&</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="p">)?,</span> <span class="nv">equalizerSettings</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLEqualizerSettings.html">SDLEqualizerSettings</a></span><span class="p">]?)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>source</dt>
<dd><p>current primary audio source of the system.</p></dd>
<dt>keepContext</dt>
<dd><p>Whether or not application’s context is changed.</p></dd>
<dt>volume</dt>
<dd><p>Reflects the volume of audio.</p></dd>
<dt>equalizerSettings</dt>
<dd><p>list of supported Equalizer channels.</p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>An instance of the SDLAudioControlData class.</p>
</div>
<h3 id="section-source">
source
</h3>
<p>@abstract In a getter response or a notification,
it is the current primary audio source of the system.
In a setter request, it is the target audio source that the system shall switch to.
If the value is MOBILE_APP, the system shall switch to the mobile media app that issues the setter RPC.</p>
<p>Optional, SDLPrimaryAudioSource</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLPrimaryAudioSource.h@T@SDLPrimaryAudioSource">SDLPrimaryAudioSource</a></span> <span class="n">source</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">source</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLPrimaryAudioSource.h@T@SDLPrimaryAudioSource">SDLPrimaryAudioSource</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-keepContext">
keepContext
</h3>
<p>@abstract This parameter shall not be present in any getter responses or notifications.
This parameter is optional in a setter request. The default value is false.
If it is true, the system not only changes the audio source but also brings the default
infotainment system UI associated with the audio source to foreground and set the application to background.
If it is false, the system changes the audio source, but keeps the current application’s context.</p>
<p>Optional, Boolean</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span>
<span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">keepContext</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">keepContext</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> <span class="o">&</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</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-volume">
volume
</h3>
<p>@abstract Reflects the volume of audio, from 0%-100%.</p>
<p>Required, Integer 1 - 100</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">volume</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">volume</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> <span class="o">&</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</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-equalizerSettings">
equalizerSettings
</h3>
<p>@abstract Defines the list of supported channels (band) and their current/desired settings on HMI</p>
<p>Required, Array of SDLEqualizerSettings with minSize:1 maxSize:100</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span>
<span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLEqualizerSettings.html">SDLEqualizerSettings</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">equalizerSettings</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">equalizerSettings</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLEqualizerSettings.html">SDLEqualizerSettings</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>
|
