summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLEqualizerSettings.html
blob: 88734ede5f67a633ee039d50013f4c64ee3836eb (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
<h1>SDLEqualizerSettings Class Reference</h1>

<h3>Section Contents</h3>

<ul>
  <li><a href="#section--initWithChannelId:channelSetting:">-initWithChannelId:channelSetting:</a></li>
  <li><a href="#section-channelName">channelName</a></li>
  <li><a href="#section-channelSetting">channelSetting</a></li>
  <li><a href="#section-channelId">channelId</a></li>
</ul>

<h3>Overview</h3>

<p>Defines the each Equalizer channel settings.</p>


<section class="section task-group-section">
  <h3 id="section--initWithChannelId:channelSetting:">
      -initWithChannelId:channelSetting:
  </h3>
  
  <p>Convenience init</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">initWithChannelId</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">channelId</span>
                           <span class="nf">channelSetting</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">channelSetting</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">channelId</span><span class="p">:</span> <span class="kt">UInt8</span><span class="p">,</span> <span class="nv">channelSetting</span><span class="p">:</span> <span class="kt">UInt8</span><span class="p">)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>channelId</dt>
      <dd><p>Read-only channel / frequency name</p></dd>
      <dt>channelSetting</dt>
      <dd><p>Reflects the setting, from 0%-100%.</p></dd>
  </dl>
  
  <h3 id="section-channelName">
      channelName
  </h3>
  
  <p>@abstract Read-only channel / frequency name
 (e.i. &ldquo;Treble, Midrange, Bass&rdquo; or &ldquo;125 Hz&rdquo;)</p>

<p>Optional, Max String length 50 chars</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">channelName</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">channelName</span><span class="p">:</span> <span class="kt">String</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-channelSetting">
      channelSetting
  </h3>
  
  <p>@abstract Reflects the setting, 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">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o">&lt;</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">channelSetting</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">channelSetting</span><span class="p">:</span> <span class="kt">NSNumber</span> <span class="o">&amp;</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-channelId">
      channelId
  </h3>
  
  <p>@abstract id of the channel.</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">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o">&lt;</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">channelId</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">channelId</span><span class="p">:</span> <span class="kt">NSNumber</span> <span class="o">&amp;</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
</section>