summaryrefslogtreecommitdiff
path: root/docs/Protocols/SDLAudioStreamManagerDelegate.html
blob: 6167c25296371ec2a92bf9f7eaec0d9a167433ef (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
<h1>SDLAudioStreamManagerDelegate Protocol Reference</h1>

<h3>Section Contents</h3>

<ul>
  <li><a href="#section--audioStreamManager:fileDidFinishPlaying:successfully:">-audioStreamManager:fileDidFinishPlaying:successfully:</a></li>
  <li><a href="#section--audioStreamManager:errorDidOccurForFile:error:">-audioStreamManager:errorDidOccurForFile:error:</a></li>
  <li><a href="#section--audioStreamManager:dataBufferDidFinishPlayingSuccessfully:">-audioStreamManager:dataBufferDidFinishPlayingSuccessfully:</a></li>
  <li><a href="#section--audioStreamManager:errorDidOccurForDataBuffer:">-audioStreamManager:errorDidOccurForDataBuffer:</a></li>
</ul>

<h3>Overview</h3>

<p>Undocumented</p>


<section class="section task-group-section">
  <h3 id="section--audioStreamManager:fileDidFinishPlaying:successfully:">
      -audioStreamManager:fileDidFinishPlaying:successfully:
  </h3>
  
  <p>Called when a file from the SDLAudioStreamManager finishes playing</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">audioStreamManager</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLAudioStreamManager.html">SDLAudioStreamManager</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">audioManager</span>
      <span class="nf">fileDidFinishPlaying</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSURL</span> <span class="o">*</span><span class="p">)</span><span class="nv">fileURL</span>
              <span class="nf">successfully</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">successfully</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">audioStreamManager</span><span class="p">(</span><span class="n">_</span> <span class="nv">audioManager</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLAudioStreamManager.html">SDLAudioStreamManager</a></span><span class="p">,</span> <span class="n">fileDidFinishPlaying</span> <span class="nv">fileURL</span><span class="p">:</span> <span class="kt">URL</span><span class="p">,</span> <span class="nv">successfully</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>audioManager</dt>
      <dd><p>A reference to the audio stream manager</p></dd>
      <dt>fileURL</dt>
      <dd><p>The URL that finished playing</p></dd>
      <dt>successfully</dt>
      <dd><p>Whether or not it was played successfully</p></dd>
  </dl>
  
  <h3 id="section--audioStreamManager:errorDidOccurForFile:error:">
      -audioStreamManager:errorDidOccurForFile:error:
  </h3>
  
  <p>Called when a file from the SDLAudioStreamManager could not play</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">audioStreamManager</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLAudioStreamManager.html">SDLAudioStreamManager</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">audioManager</span>
      <span class="nf">errorDidOccurForFile</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSURL</span> <span class="o">*</span><span class="p">)</span><span class="nv">fileURL</span>
                     <span class="nf">error</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSError</span> <span class="o">*</span><span class="p">)</span><span class="nv">error</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">audioStreamManager</span><span class="p">(</span><span class="n">_</span> <span class="nv">audioManager</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLAudioStreamManager.html">SDLAudioStreamManager</a></span><span class="p">,</span> <span class="n">errorDidOccurForFile</span> <span class="nv">fileURL</span><span class="p">:</span> <span class="kt">URL</span><span class="p">,</span> <span class="nv">error</span><span class="p">:</span> <span class="kt">Error</span><span class="p">)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>audioManager</dt>
      <dd><p>A reference to the audio stream manager</p></dd>
      <dt>fileURL</dt>
      <dd><p>The URL that failed</p></dd>
      <dt>error</dt>
      <dd><p>The error that occurred</p></dd>
  </dl>
  
  <h3 id="section--audioStreamManager:dataBufferDidFinishPlayingSuccessfully:">
      -audioStreamManager:dataBufferDidFinishPlayingSuccessfully:
  </h3>
  
  <p>Called when a data buffer from the SDLAudioStreamManager finishes playing</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">audioStreamManager</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLAudioStreamManager.html">SDLAudioStreamManager</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">audioManager</span>
    <span class="nf">dataBufferDidFinishPlayingSuccessfully</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">successfully</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">audioStreamManager</span><span class="p">(</span><span class="n">_</span> <span class="nv">audioManager</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLAudioStreamManager.html">SDLAudioStreamManager</a></span><span class="p">,</span> <span class="n">dataBufferDidFinishPlayingSuccessfully</span> <span class="nv">successfully</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>audioManager</dt>
      <dd><p>A reference to the audio stream manager</p></dd>
      <dt>successfully</dt>
      <dd><p>Whether or not the data buffer played successfully</p></dd>
  </dl>
  
  <h3 id="section--audioStreamManager:errorDidOccurForDataBuffer:">
      -audioStreamManager:errorDidOccurForDataBuffer:
  </h3>
  
  <p>Called when a data buffer from the SDLAudioStreamManager could not play</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">audioStreamManager</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLAudioStreamManager.html">SDLAudioStreamManager</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">audioManager</span>
    <span class="nf">errorDidOccurForDataBuffer</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSError</span> <span class="o">*</span><span class="p">)</span><span class="nv">error</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">audioStreamManager</span><span class="p">(</span><span class="n">_</span> <span class="nv">audioManager</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLAudioStreamManager.html">SDLAudioStreamManager</a></span><span class="p">,</span> <span class="n">errorDidOccurForDataBuffer</span> <span class="nv">error</span><span class="p">:</span> <span class="kt">Error</span><span class="p">)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>audioManager</dt>
      <dd><p>A reference to the audio stream manager</p></dd>
      <dt>error</dt>
      <dd><p>The error that occurred</p></dd>
  </dl>
  
</section>