Skip to content

Fix #948: Move close() to AudioContext #974

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 15, 2016
Merged

Fix #948: Move close() to AudioContext #974

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
149 changes: 72 additions & 77 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1060,83 +1060,6 @@ <h2 id="BaseAudioContext">
</li>
</ol>
</dd>
<dt>
Promise&lt;void&gt; close()
</dt>
<dd>
<p>
Closes the <a>BaseAudioContext</a>, <a>releasing the system
resources</a> it's using. This will not automatically release all
<a>AudioContext</a>-created objects, but will suspend the
progression of the <a><code>AudioContext</code></a>'s <a href=
"#widl-AudioContext-currentTime">currentTime</a>, and stop
processing audio data.
</p>
<p>
<span class="synchronous">When close is called, execute these
steps:</span>
</p>
<ol>
<li>Let <em>promise</em> be a new Promise.
</li>
<li>If this <a>BaseAudioContext</a> is an
<a>OfflineAudioContext</a>, reject <em>promise</em> with
<code>NotSupportedError</code>, return it, and abort these steps.
</li>
<li>If the <em>control thread state</em> flag on the
<a>AudioContext</a> is <code>closed</code> reject the promise
with <code>InvalidStateError</code>, abort these steps, returning
<em>promise</em>.
</li>
<li>If the <a href="#widl-AudioContext-state">state</a> attribute
of the <a>AudioContext</a> is already <code>closed</code>,
resolve <em>promise</em>, return it, and abort these steps.
</li>
<li>Set the <em>control thread state</em> flag on the
<a>AudioContext</a> to <code>closed</code>.
</li>
<li>
<a href="#queue">Queue a control message</a> to the
<a>AudioContext</a>.
</li>
<li>Return <em>promise</em>.
</li>
</ol>
<p>
Running a <a>control message</a> to close an
<a>BaseAudioContext</a> means running these steps on the
<a>rendering thread</a>:
</p>
<ol>
<li>Attempt to <a>release system resources</a>.
</li>
<li>Queue a task on the <a>control thread</a>'s event loop, to
execute these steps:
<ol>
<li>Resolve <em>promise</em>.
</li>
<li>If the <a href="#widl-audiocontext-state">state</a>
attribute of the <a>AudioContext</a> is not already
<code>closed</code>:
<ol>
<li>Set the <a href="#widl-audiocontext-state">state</a>
attribute of the <a>AudioContext</a> to
<code>closed</code>.
</li>
<li>Queue a task to fire a simple event named
<code>statechange</code> at the <a>AudioContext</a>
</li>
</ol>
</li>
</ol>
</li>
</ol>
<p class="note">
When an <a>BaseAudioContext</a> has been closed, implementation
can choose to aggressively release more resources than when
suspending.
</p>
</dd>
<dt>
attribute EventHandler onstatechange
</dt>
Expand Down Expand Up @@ -1879,6 +1802,78 @@ <h2 id="AudioContext">
attribute should be used instead.
</p>
</dd>
<dt>
Promise&lt;void&gt; close()
</dt>
<dd>
<p>
Closes the <a>AudioContext</a>, <a>releasing the system
resources</a> it's using. This will not automatically release all
<a>AudioContext</a>-created objects, but will suspend the
progression of the <a><code>AudioContext</code></a>'s <a href=
"#widl-AudioContext-currentTime">currentTime</a>, and stop
processing audio data.
</p>
<p>
<span class="synchronous">When close is called, execute these
steps:</span>
</p>
<ol>
<li>Let <em>promise</em> be a new Promise.
</li>
<li>If the <em>control thread state</em> flag on the
<a>AudioContext</a> is <code>closed</code> reject the promise
with <code>InvalidStateError</code>, abort these steps, returning
<em>promise</em>.
</li>
<li>If the <a href="#widl-AudioContext-state">state</a> attribute
of the <a>AudioContext</a> is already <code>closed</code>,
resolve <em>promise</em>, return it, and abort these steps.
</li>
<li>Set the <em>control thread state</em> flag on the
<a>AudioContext</a> to <code>closed</code>.
</li>
<li>
<a href="#queue">Queue a control message</a> to the
<a>AudioContext</a>.
</li>
<li>Return <em>promise</em>.
</li>
</ol>
<p>
Running a <a>control message</a> to close an <a>AudioContext</a>
means running these steps on the <a>rendering thread</a>:
</p>
<ol>
<li>Attempt to <a>release system resources</a>.
</li>
<li>Queue a task on the <a>control thread</a>'s event loop, to
execute these steps:
<ol>
<li>Resolve <em>promise</em>.
</li>
<li>If the <a href="#widl-audiocontext-state">state</a>
attribute of the <a>AudioContext</a> is not already
<code>closed</code>:
<ol>
<li>Set the <a href="#widl-audiocontext-state">state</a>
attribute of the <a>AudioContext</a> to
<code>closed</code>.
</li>
<li>Queue a task to fire a simple event named
<code>statechange</code> at the <a>AudioContext</a>
</li>
</ol>
</li>
</ol>
</li>
</ol>
<p class="note">
When an <a>AudioContext</a> has been closed, implementation can
choose to aggressively release more resources than when
suspending.
</p>
</dd>
<dt>
MediaElementAudioSourceNode createMediaElementSource()
</dt>
Expand Down