Skip to content

AudioContext "interrupted" state #2611

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 11 commits into from
Mar 17, 2025
Merged

AudioContext "interrupted" state #2611

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
c4aeb15
Adding the interrupted state
gabrielsanbrito Oct 10, 2024
e1a5f2d
Adding algo steps for the interrupted state
gabrielsanbrito Nov 8, 2024
bcb20f4
improve algorithms
gabrielsanbrito Nov 9, 2024
ad456d0
Addressing formatting feedback
gabrielsanbrito Feb 24, 2025
00e44ab
Wrapping lines to be 80 char length
gabrielsanbrito Feb 24, 2025
8e8db2a
Only change 'Queue a media element task' for modified sections
gabrielsanbrito Feb 24, 2025
b13f923
remove unnecessary example
gabrielsanbrito Feb 25, 2025
b2562c9
Rewording text to better match with Audio Session spec
gabrielsanbrito Mar 4, 2025
075aad2
Add links to interruption definitions
gabrielsanbrito Mar 4, 2025
b297541
addressing review feedback
gabrielsanbrito Mar 15, 2025
08fb3cd
Rename internal slot to 'state before interruption'
gabrielsanbrito Mar 17, 2025
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
90 changes: 52 additions & 38 deletions index.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -709,10 +709,12 @@ Each {{BaseAudioContext}} has a unique
media element event task source</a>.
Additionally, a {{BaseAudioContext}} has several private slots <dfn attribute
for="BaseAudioContext">[[rendering thread state]]</dfn> and <dfn attribute
for="BaseAudioContext">[[control thread state]]</dfn> that take values from
{{AudioContextState}}, and that are both initially set to <code>"suspended"
</code>, and a private slot <dfn attribute for="BaseAudioContext">
[[render quantum size]]</dfn> that is an unsigned integer.
for="BaseAudioContext">[[control thread state]]</dfn> that take values
from {{AudioContextState}}, and that are both initially set to <code>"suspended"
</code>, <dfn attribute for="BaseAudioContext">[[interrupt end return state]]
</dfn> that also take values from {{AudioContextState}} and is initially set to
`null` and a private slot <dfn attribute for="BaseAudioContext">[[render quantum
size]]</dfn> that is an unsigned integer.

<pre class="idl">
enum AudioContextState {
Expand Down Expand Up @@ -1549,6 +1551,8 @@ Constructors</h4>

1. Set a {{[[rendering thread state]]}} to <code>suspended</code> on
|context|.

1. Set {{[[interrupt end return state]]}} to `null` on |context|.

1. Let |messageChannel| be a new {{MessageChannel}}.

Expand Down Expand Up @@ -1980,15 +1984,19 @@ Methods</h4>
returning <var>promise</var>.

1. Set {{[[suspended by user]]}} to <code>false</code>.

1. If the context's {{BaseAudioContext/state}} attribute is
"{{AudioContextState/suspended}}" and the context's
{{[[control thread state]]}} is
"{{AudioContextState/interrupted}}", then:

1. If the {{[[control thread state]]}} on the {{AudioContext}} is
<code>suspended</code> and there is an ongoing
[=interruption=]:

1. Queue a media element task</a> to execute the following steps:
1. <a>Queue a media element task</a> to execute the following steps:

1. Set the {{BaseAudioContext/state}} attribute of the
{{AudioContext}} to "{{AudioContextState/interrupted}}".

1. Set the {{[[interrupt end return state]]}} slot to
"{{AudioContextState/running}}".

1. [=Queue a media element task=] to [=fire an event=] named
{{BaseAudioContext/statechange}} at the {{AudioContext}}.
Expand Down Expand Up @@ -2105,14 +2113,19 @@ Methods</h4>

1. Attempt to <a>release system resources</a>.

2. Set the {{[[rendering thread state]]}} on the {{AudioContext}} to <code>suspended</code>.
1. If the {{[[rendering thread state]]}} on the {{AudioContext}} is
"{{AudioContextState/interrupted}}", <a>queue a media element
task</a> to set the {{[[interrupt end return state]]}} slot to
"{{AudioContextState/suspended}}".

3. <a href="https://html.spec.whatwg.org/multipage/media.html#queue-a-media-element-task">
queue a media element task</a> to execute the following steps:
1. Set the {{[[rendering thread state]]}} on the {{AudioContext}} to
"{{AudioContextState/suspended}}".

1. <a>Queue a media element task</a> to execute the following steps:

1. Resolve <var>promise</var>.

2. If the {{BaseAudioContext/state}}
1. If the {{BaseAudioContext/state}}
attribute of the {{AudioContext}} is not already "{{AudioContextState/suspended}}":

1. Set the {{BaseAudioContext/state}} attribute of the {{AudioContext}} to "{{AudioContextState/suspended}}".
Expand Down Expand Up @@ -11993,70 +12006,69 @@ to halt audio playback for an {{AudioContext}}. For example, The user agent may
create an interruption when another application requests exclusive access to the
audio output hardware.

When an [=interruption=] happens, the user agent must <a>queue a control message</a>
When an [=interruption=] happens, the user agent MUST <a>queue a control message</a>
to interrupt the {{AudioContext}}.

Running a <a>control message</a> to <dfn attribute for="AudioContext"
lt="interruption-start">interrupt an {{AudioContext}}</dfn> |context|
means running these steps on the <a>rendering thread</a>:

1. If the |context|'s {{[[rendering thread state]]}} is <code>closed</code>
or <code>interrupted</code>:

1. Abort these steps.
1. If the |context|'s {{[[rendering thread state]]}} is
{{AudioContextState/closed}} or {{AudioContextState/interrupted}}, abort
these steps.

1. If the |context|'s {{[[rendering thread state]]}} is
<code>running</code>:
{{AudioContextState/running}}:

1. Attempt to <a>release system resources</a>.

1. [=Queue a media element task=] to execute the following steps:

1. Set the |context|'s {{[[control thread state]]}} to
<code>interrupted</code>.
{{AudioContextState/interrupted}}.

1. Set the |context|'s {{[[interrupt end return state]]}} slot to
"{{AudioContextState/running}}".

1. [=Fire an event=] named {{BaseAudioContext/statechange}} at the
|context|.

1. If the |context|'s {{[[rendering thread state]]}} is
<code>suspended</code>:
{{AudioContextState/suspended}}:

1. [=Queue a media element task=] to execute the following steps:

1. Set the |context|'s {{[[control thread state]]}} to
<code>interrupted</code>.
{{AudioContextState/interrupted}}.

1. Set the |context|'s {{[[interrupt end return state]]}} slot to
"{{AudioContextState/suspended}}".

1. Set the |context|'s {{[[rendering thread state]]}} to
<code>interrupted</code>.
{{AudioContextState/interrupted}}.

Note: If the {{AudioContext}} is <code>suspended</code> a
Note: If the {{AudioContext}} is {{AudioContextState/suspended}} a
{{BaseAudioContext/statechange}} event is not fired for privacy reasons to avoid
over-sharing user activity - e.g. when a phone call comes in or when the screen
gets locked.

When an [=interruption=] ends, the user agent must <a>queue a control message</a>
When an [=interruption=] ends, the user agent MUST <a>queue a control message</a>
to <dfn attribute for="AudioContext" lt="interruption-end">end the
{{AudioContext}} interruption</dfn>.

<dfn lt="linear PCM">Linear pulse code modulation</dfn>

Running a <a>control message</a> to end an {{AudioContext}} |context|
[=interruption=] means running these steps on the <a>rendering thread</a>:

1. If the |context|'s {{[[rendering thread state]]}} is not
<code>interrupted</code>:
{{AudioContextState/interrupted}}, abort these steps.

1. Abort these steps.

1. If the |context|'s {{[[rendering thread state]]}} was
<code>running</code> before the [=interruption=] or if the the
|context|'s {{[[rendering thread state]]}} was <code>suspended</code>
and {{AudioContext/resume}} was called during the [=interruption=]:
1. If the |context|'s {{[[interrupt end return state]]}} is
"{{AudioContextState/running}}":

1. Attempt to <a href="#acquiring">acquire system resources</a>.

1. Set the {{[[rendering thread state]]}} on the {{AudioContext}} to
<code>running</code>.
"{{AudioContextState/running}}".

1. Start <a href="#rendering-loop">rendering the audio graph</a>.

Expand All @@ -12066,13 +12078,13 @@ Running a <a>control message</a> to end an {{AudioContext}} |context|
is not already "{{AudioContextState/running}}":

1. Set the |context|'s {{[[control thread state]]}} to
<code>running</code>.
"{{AudioContextState/running}}".

1. [=Fire an event=] named {{BaseAudioContext/statechange}} at the
|context|.

1. If the |context|'s {{[[rendering thread state]]}} was
<code>suspended</code> before the [=interruption=]:
1. If the |context|'s {{[[interrupt end return state]]}} is
"{{AudioContextState/suspended}}"

1. Set the {{[[rendering thread state]]}} on the {{AudioContext}} to
<code>suspended</code>.
Expand All @@ -12082,6 +12094,8 @@ Running a <a>control message</a> to end an {{AudioContext}} |context|
1. Set the |context|'s {{[[control thread state]]}} to
<code>suspended</code>.

1. Set the |context|'s {{[[interrupt end return state]]}} to `null`.

<h3 id="error-handling-on-a-running-audio-context">
Handling an error from System Audio Resources on the {{AudioContext}}</h3>

Expand Down