From f0f2b1947e5137b4e769ca02e105d4ccd6e4f297 Mon Sep 17 00:00:00 2001 From: Hongchan Choi Date: Wed, 27 Mar 2024 21:36:22 +0000 Subject: [PATCH 01/17] initial commit --- index.bs | 66 +++++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 49 insertions(+), 17 deletions(-) diff --git a/index.bs b/index.bs index 3a55bb255..aac64c79e 100644 --- a/index.bs +++ b/index.bs @@ -1694,8 +1694,10 @@ enum AudioSinkType { Add AudioRenderCapacity Interface
Issue 2400 Access to a different output device + + Issue 2567 Device-related error reporting via AudioContext
- + [Exposed=Window] interface AudioContext : BaseAudioContext { @@ -1714,7 +1716,7 @@ enum AudioSinkType { }; - + [Exposed=Window] interface AudioContext : BaseAudioContext { @@ -1724,6 +1726,7 @@ enum AudioSinkType { [SecureContext] readonly attribute (DOMString or AudioSinkInfo) sinkId; [SecureContext] readonly attribute AudioRenderCapacity renderCapacity; attribute EventHandler onsinkchange; + attribute EventHandler onerror; AudioTimestamp getOutputTimestamp (); Promise<undefined> resume (); Promise<undefined> suspend (); @@ -1947,8 +1950,10 @@ Constructors</h4> <span class="marker">Proposed Addition</span><br> <a href="https://github.com/WebAudio/web-audio-api/issues/2400">Issue 2400</a> Access to a different output device + <a href="https://github.com/WebAudio/web-audio-api/issues/2567" id="c2567-1"> + Issue 2567</a> Device-related error reporting via AudioContext <div class="amendment-buttons"></div> - <del cite=#2400> + <del cite=#2400 #c2567> 1. Attempt to <a href="#acquiring">acquire system resources</a>. In case of failure, abort the following steps. @@ -1963,7 +1968,7 @@ Constructors</h4> queue a media element task</a> to <a spec="dom" lt="fire an event">fire an event </a> named {{BaseAudioContext/statechange}} at the {{AudioContext}}. </del> - <ins cite=#2400> + <ins cite=#2400 #2567> 1. Attempt to <a href="#acquiring">acquire system resources</a> to use a following audio output device based on {{AudioContext/[[sink ID]]}} for rendering: @@ -1971,7 +1976,12 @@ Constructors</h4> * The default audio output device for the empty string. * A audio output device identified by {{AudioContext/[[sink ID]]}}. - In case of failure, abort the following steps. + Upon failure of resource acquisition, + <a href="https://html.spec.whatwg.org/multipage/media.html#queue-a-media-element-task"> + queue a media element task</a> to + <a spec="dom" lt="fire an event">fire an event</a> named + {{AudioContext/error}} at the {{AudioContext}}, and abort + the following steps. 1. Set the {{[[rendering thread state]]}} to <code>running</code> on the {{AudioContext}}. @@ -1986,10 +1996,6 @@ Constructors</h4> {{BaseAudioContext/statechange}} at the {{AudioContext}}. </ins> </div> - Note: It is unfortunately not possible to programatically notify authors - that the creation of the {{AudioContext}} failed. User-Agents are - encouraged to log an informative message if they have access to a logging - mechanism, such as a developer tools console. </div> <div class="addition proposed" id="c2456-2"> @@ -2042,7 +2048,7 @@ Attributes</h4> <div class="correction proposed" id="c2450-6"> <span class="marker">Proposed addition - <a href="https://github.com/WebAudio/web-audio-api/issues/2450">Issue 2450</a>-1. + <a href="https://github.com/WebAudio/web-audio-api/issues/2450">Issue 2450</a>. </span> Allow specifying a different render quantum size <div class="amendment-buttons"> @@ -2080,16 +2086,15 @@ Attributes</h4> is running or the associated audio output device changes. It is useful to query this value frequently when accurate synchronization is required. + <div class="correction proposed" id="c2444-2"> <span class="marker">Proposed Addition <a href="https://github.com/WebAudio/web-audio-api/issues/2444">Issue 2444</a>. </span> Add AudioRenderCapacity Interface - <div class="amendment-buttons"> - Buttons here - </div> - <ins cite=#c2444> + <div class="amendment-buttons"></div> + <ins cite=#c2444> : <dfn>renderCapacity</dfn> :: Returns an {{AudioRenderCapacity}} instance associated with @@ -2099,9 +2104,11 @@ Attributes</h4> </div> <div class="addition proposed" id="c2400-6"> - <span class="marker">Proposed Addition</span><br> + <span class="marker">Proposed Addition <a href="https://github.com/WebAudio/web-audio-api/issues/2400">Issue - 2400</a> Access to a different output device + 2400</a>. + </span> + Access to a different output device <div class="amendment-buttons"></div> <ins cite=#2400> : <dfn>sinkId</dfn> @@ -2121,7 +2128,32 @@ Attributes</h4> is available to check the readiness of the initial output device. </ins> - </dl> +</div> + +<div class="addition proposed" id="c2567-3"> + <span class="marker">Proposed Addition + <a href="https://github.com/WebAudio/web-audio-api/issues/2567"> + Issue 2567</a>. + </span> + Device-related error reporting via AudioContext + <div class="amendment-buttons"></div> + <ins cite=#2567> + : <dfn>onerror</dfn> + :: + An [=event handler=] for any <dfn event>error</dfn> {{Event}} dispatched from an + {{AudioContext}}. The user agent can dispatch this event in the + following cases: + + * The process of initializing and activiating the selected audio + devie encounters an issue. + * The audio output from a {{AudioContextState/running}} + {{AudioContext}} unexpectedly interrupted or the device is + disconnected. + + </ins> +</div> + +</dl> <h4 id="AudioContext-methods"> Methods</h4> From 55457866782210630770812e7ff62eec3a62559b Mon Sep 17 00:00:00 2001 From: Hongchan Choi <hongchan.choi@gmail.com> Date: Wed, 27 Mar 2024 21:44:10 +0000 Subject: [PATCH 02/17] fixing XML errors --- index.bs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/index.bs b/index.bs index aac64c79e..c12056ffe 100644 --- a/index.bs +++ b/index.bs @@ -1953,7 +1953,7 @@ Constructors</h4> <a href="https://github.com/WebAudio/web-audio-api/issues/2567" id="c2567-1"> Issue 2567</a> Device-related error reporting via AudioContext <div class="amendment-buttons"></div> - <del cite=#2400 #c2567> + <del cite="#2400 #2567"> 1. Attempt to <a href="#acquiring">acquire system resources</a>. In case of failure, abort the following steps. @@ -1968,7 +1968,7 @@ Constructors</h4> queue a media element task</a> to <a spec="dom" lt="fire an event">fire an event </a> named {{BaseAudioContext/statechange}} at the {{AudioContext}}. </del> - <ins cite=#2400 #2567> + <ins cite="#2400 #2567"> 1. Attempt to <a href="#acquiring">acquire system resources</a> to use a following audio output device based on {{AudioContext/[[sink ID]]}} for rendering: From 40ffe155ac3642e90ffa68f7c5d2f42fe4d3c9bc Mon Sep 17 00:00:00 2001 From: Hongchan Choi <hongchan.choi@gmail.com> Date: Thu, 28 Mar 2024 17:52:05 +0000 Subject: [PATCH 03/17] adding section 2.5 --- index.bs | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/index.bs b/index.bs index c12056ffe..6ddd827ff 100644 --- a/index.bs +++ b/index.bs @@ -2145,7 +2145,7 @@ Attributes</h4> following cases: * The process of initializing and activiating the selected audio - devie encounters an issue. + device encounters an issue. * The audio output from a {{AudioContextState/running}} {{AudioContext}} unexpectedly interrupted or the device is disconnected. @@ -12871,6 +12871,34 @@ running the algorithm for an {{AudioNode}}, using an <a>input buffer</a> and the value(s) of the {{AudioParam}}(s) of this {{AudioNode}} as the input for this algorithm. + +<h3 id="error-handling-on-a-running-audio-context"> + Error Handling for System Audio Resources on a running AudioContext</h3> + +In the event of an audio system resource error, the <a>rendering thread</a> +performs the following steps upon receiving the error: + +1. Set {{[[rendering thread state]]}} of the {{AudioContext}} to + "{{AudioContextState/suspended}}". + +1. <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. <a spec="dom" lt="fire an event">fire an event</a> named + {{AudioContext/error}} at the associated {{AudioContext}}. + + 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}}". + + 1. <a spec="dom" lt="fire an event">Fire an event</a> named + {{BaseAudioContext/statechange}} at the associated {{AudioContext}}. + +Note: An example of such a case would be when an external or wireless audio + device becomes disconnected during the active rendering of the AudioContext. + <h3 id="unloading-a-document">Unloading a document</h3> Additional <a href= "https://html.spec.whatwg.org/#unloading-document-cleanup-steps">unloading From f52c26c5387a765ca97e49ee5600eaceba6e54cb Mon Sep 17 00:00:00 2001 From: Hongchan Choi <hongchan.choi@gmail.com> Date: Thu, 25 Apr 2024 16:20:50 +0000 Subject: [PATCH 04/17] fixed markup for better alignment --- index.bs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/index.bs b/index.bs index 6ddd827ff..4a4de2181 100644 --- a/index.bs +++ b/index.bs @@ -1693,7 +1693,7 @@ enum AudioSinkType { <a href="https://github.com/WebAudio/web-audio-api/issues/2444">Issue 2444 </a> Add AudioRenderCapacity Interface <br> <a href="https://github.com/WebAudio/web-audio-api/issues/2400" id="c2400-2"> - Issue 2400</a> Access to a different output device + Issue 2400</a> Access to a different output device <br> <a href="https://github.com/WebAudio/web-audio-api/issues/2567" id="c2567-2"> Issue 2567</a> Device-related error reporting via AudioContext <div class="amendment-buttons"></div> @@ -1949,7 +1949,7 @@ Constructors</h4> <div class="addition proposed" id="c2400-5"> <span class="marker">Proposed Addition</span><br> <a href="https://github.com/WebAudio/web-audio-api/issues/2400">Issue - 2400</a> Access to a different output device + 2400</a> Access to a different output device <br> <a href="https://github.com/WebAudio/web-audio-api/issues/2567" id="c2567-1"> Issue 2567</a> Device-related error reporting via AudioContext <div class="amendment-buttons"></div> From 2e7abaaca443d4bcbb90fe8254e2d45568eea04d Mon Sep 17 00:00:00 2001 From: Hongchan Choi <hongchan.choi@gmail.com> Date: Sat, 27 Apr 2024 00:19:04 +0000 Subject: [PATCH 05/17] add notes for fallback behavior --- index.bs | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/index.bs b/index.bs index 4a4de2181..77a132dbb 100644 --- a/index.bs +++ b/index.bs @@ -1996,6 +1996,26 @@ Constructors</h4> {{BaseAudioContext/statechange}} at the {{AudioContext}}. </ins> </div> + + <div class="correction proposed" id="c2567-2"> + <span class="marker">Proposed Correction</span> + <a href="https://github.com/WebAudio/web-audio-api/issues/2567"> + Issue 2567</a> Device-related error reporting via AudioContext + <div class="amendment-buttons"></div> + <del> + Note: It is unfortunately not possible to programatically notify authors + that the creation of the {{AudioContext}} failed. User-Agents are + encouraged to log an informative message if they have access to a logging + mechanism, such as a developer tools console. + </del> + <ins> + NOTE: In cases where an AudioContext is constructed with no + arguments and resource acquisition fails, the User-Agent must + attempt to silently render the audio graph using a mechanism that + emulates an audio output device. + </ins> + </div> + </div> <div class="addition proposed" id="c2456-2"> @@ -2135,7 +2155,7 @@ Attributes</h4> <a href="https://github.com/WebAudio/web-audio-api/issues/2567"> Issue 2567</a>. </span> - Device-related error reporting via AudioContext + Device-related error reporting via AudioContext <div class="amendment-buttons"></div> <ins cite=#2567> : <dfn>onerror</dfn> From 92bab64a09b20208af779d2c57b869e572620cdf Mon Sep 17 00:00:00 2001 From: Hongchan Choi <hongchan.choi@gmail.com> Date: Sat, 27 Apr 2024 01:17:56 +0000 Subject: [PATCH 06/17] fix typo --- index.bs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.bs b/index.bs index 77a132dbb..d9f3c509b 100644 --- a/index.bs +++ b/index.bs @@ -1997,7 +1997,7 @@ Constructors</h4> </ins> </div> - <div class="correction proposed" id="c2567-2"> + <div class="correction proposed" id="c2567-3"> <span class="marker">Proposed Correction</span> <a href="https://github.com/WebAudio/web-audio-api/issues/2567"> Issue 2567</a> Device-related error reporting via AudioContext From d105de84ff61735ebec0b9be3ac7bb32e973dcd8 Mon Sep 17 00:00:00 2001 From: Hongchan Choi <hongchan.choi@gmail.com> Date: Mon, 29 Apr 2024 16:57:55 +0000 Subject: [PATCH 07/17] fix duplicate id --- index.bs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.bs b/index.bs index d9f3c509b..ceb4f936c 100644 --- a/index.bs +++ b/index.bs @@ -2150,7 +2150,7 @@ Attributes</h4> </ins> </div> -<div class="addition proposed" id="c2567-3"> +<div class="addition proposed" id="c2567-4"> <span class="marker">Proposed Addition <a href="https://github.com/WebAudio/web-audio-api/issues/2567"> Issue 2567</a>. From 0827e59615e92a8f1fa56e7105ea019944b4d402 Mon Sep 17 00:00:00 2001 From: Hongchan Choi <hongchan.choi@gmail.com> Date: Mon, 29 Apr 2024 18:20:46 +0000 Subject: [PATCH 08/17] fix amendment button bug --- index.bs | 112 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 62 insertions(+), 50 deletions(-) diff --git a/index.bs b/index.bs index ceb4f936c..7eb2fec18 100644 --- a/index.bs +++ b/index.bs @@ -182,6 +182,7 @@ window.addEventListener('load', (event) => { ListAmendments("c2400", "Proposed Addition", "change-list-2400"); ListAmendments("c2512", "Proposed Addition", "change-list-2512"); ListAmendments("c2450", "Proposed Addition", "change-list-2450"); + ListAmendments("c2567", "Proposed Addition", "change-list-2567"); }); </script> <style> @@ -1694,8 +1695,8 @@ enum AudioSinkType { </a> Add AudioRenderCapacity Interface <br> <a href="https://github.com/WebAudio/web-audio-api/issues/2400" id="c2400-2"> Issue 2400</a> Access to a different output device <br> - <a href="https://github.com/WebAudio/web-audio-api/issues/2567" id="c2567-2"> - Issue 2567</a> Device-related error reporting via AudioContext + <a href="https://github.com/WebAudio/web-audio-api/issues/2567" id="c2567-1"> + Issue 2567</a>. Device-related error reporting via AudioContext <div class="amendment-buttons"></div> <del cite="#c2444 #c2400 #c2567"> <xmp class="idl extract" data-no-idl> @@ -1946,61 +1947,73 @@ Constructors</h4> Sending a <a>control message</a> to start processing means executing the following steps: - <div class="addition proposed" id="c2400-5"> - <span class="marker">Proposed Addition</span><br> - <a href="https://github.com/WebAudio/web-audio-api/issues/2400">Issue - 2400</a> Access to a different output device <br> - <a href="https://github.com/WebAudio/web-audio-api/issues/2567" id="c2567-1"> - Issue 2567</a> Device-related error reporting via AudioContext - <div class="amendment-buttons"></div> - <del cite="#2400 #2567"> - 1. Attempt to <a href="#acquiring">acquire system resources</a>. - In case of failure, abort the following steps. - - 3. Set the {{[[rendering thread state]]}} to <code>running</code> on the {{AudioContext}}. + <div class="addition proposed"> + <div class="addition proposed" id="c2400-5" style="border:0; margin:0; padding:0"> + <span class="marker">Proposed Addition + <a href="https://github.com/WebAudio/web-audio-api/issues/2400">Issue 2400</a>. + </span> + Access to a different output device + <div class="amendment-buttons"></div> + </div> + <div class="addition proposed" id="c2567-2" style="border:0; margin:0; padding:0"> + <span class="marker">Proposed Addition + <a href="https://github.com/WebAudio/web-audio-api/issues/2567">Issue 2567</a>. + </span> + Device-related error reporting via AudioContext + <div class="amendment-buttons"></div> + </div> - 1. <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: + <del cite="#2400 #2567"> + 1. Attempt to <a href="#acquiring">acquire system resources</a>. + In case of failure, abort the following steps. - 1. Set the {{BaseAudioContext/state}} attribute of the {{AudioContext}} to "{{AudioContextState/running}}". + 3. Set the {{[[rendering thread state]]}} to <code>running</code> on the {{AudioContext}}. 1. <a href="https://html.spec.whatwg.org/multipage/media.html#queue-a-media-element-task"> - queue a media element task</a> to <a spec="dom" lt="fire an event">fire an event - </a> named {{BaseAudioContext/statechange}} at the {{AudioContext}}. - </del> - <ins cite="#2400 #2567"> - 1. Attempt to <a href="#acquiring">acquire system resources</a> to use a - following audio output device based on {{AudioContext/[[sink ID]]}} for - rendering: - - * The default audio output device for the empty string. - * A audio output device identified by {{AudioContext/[[sink ID]]}}. - - Upon failure of resource acquisition, - <a href="https://html.spec.whatwg.org/multipage/media.html#queue-a-media-element-task"> - queue a media element task</a> to - <a spec="dom" lt="fire an event">fire an event</a> named - {{AudioContext/error}} at the {{AudioContext}}, and abort - the following steps. + queue a media element task</a> to execute the following steps: + + 1. Set the {{BaseAudioContext/state}} attribute of the {{AudioContext}} to "{{AudioContextState/running}}". - 1. Set the {{[[rendering thread state]]}} to <code>running</code> on the - {{AudioContext}}. + 1. <a href="https://html.spec.whatwg.org/multipage/media.html#queue-a-media-element-task"> + queue a media element task</a> to <a spec="dom" lt="fire an event">fire an event + </a> named {{BaseAudioContext/statechange}} at the {{AudioContext}}. + </del> + <ins cite="#2400 #2567"> + 1. Attempt to <a href="#acquiring">acquire system resources</a> to use a + following audio output device based on {{AudioContext/[[sink ID]]}} for + rendering: - 1. <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: + * The default audio output device for the empty string. + * A audio output device identified by {{AudioContext/[[sink ID]]}}. + + Upon failure of resource acquisition, + <a href="https://html.spec.whatwg.org/multipage/media.html#queue-a-media-element-task"> + queue a media element task</a> to + <a spec="dom" lt="fire an event">fire an event</a> named + {{AudioContext/error}} at the {{AudioContext}}, and abort + the following steps. - 1. Set the {{BaseAudioContext/state}} attribute of the {{AudioContext}} - to "{{AudioContextState/running}}". + 1. Set the {{[[rendering thread state]]}} to <code>running</code> on the + {{AudioContext}}. - 1. <a spec="dom" lt="fire an event">Fire an event</a> named - {{BaseAudioContext/statechange}} at the {{AudioContext}}. - </ins> + 1. <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 {{BaseAudioContext/state}} attribute of the {{AudioContext}} + to "{{AudioContextState/running}}". + + 1. <a spec="dom" lt="fire an event">Fire an event</a> named + {{BaseAudioContext/statechange}} at the {{AudioContext}}. + </ins> + + </div> </div> - <div class="correction proposed" id="c2567-3"> - <span class="marker">Proposed Correction</span> - <a href="https://github.com/WebAudio/web-audio-api/issues/2567"> - Issue 2567</a> Device-related error reporting via AudioContext + <div class="proposed addition" id="c2567-3"> + <span class="marker">Proposed Addition + <a href="https://github.com/WebAudio/web-audio-api/issues/2567">Issue 2567</a>. + </span> + Device-related error reporting via AudioContext <div class="amendment-buttons"></div> <del> Note: It is unfortunately not possible to programatically notify authors @@ -2150,10 +2163,9 @@ Attributes</h4> </ins> </div> -<div class="addition proposed" id="c2567-4"> +<div class="proposed addition" id="c2567-4"> <span class="marker">Proposed Addition - <a href="https://github.com/WebAudio/web-audio-api/issues/2567"> - Issue 2567</a>. + <a href="https://github.com/WebAudio/web-audio-api/issues/2567">Issue 2567</a>. </span> Device-related error reporting via AudioContext <div class="amendment-buttons"></div> From b9760fc2e37ffac9894d017b86f6220384f271be Mon Sep 17 00:00:00 2001 From: Hongchan Choi <hongchan.choi@gmail.com> Date: Tue, 30 Apr 2024 16:45:15 +0000 Subject: [PATCH 09/17] handling 2 cases --- index.bs | 49 +++++++++++++++++++++++++++++++++---------------- 1 file changed, 33 insertions(+), 16 deletions(-) diff --git a/index.bs b/index.bs index 7eb2fec18..6c4772b51 100644 --- a/index.bs +++ b/index.bs @@ -12905,30 +12905,47 @@ buffer</a> and the value(s) of the {{AudioParam}}(s) of this <h3 id="error-handling-on-a-running-audio-context"> - Error Handling for System Audio Resources on a running AudioContext</h3> + Handling an error from System Audio Resources on the {{AudioContext}}</h3> -In the event of an audio system resource error, the <a>rendering thread</a> -performs the following steps upon receiving the error: +The <a>rendering thread</a> performs the following steps in the event of an +audio system resource error. -1. Set {{[[rendering thread state]]}} of the {{AudioContext}} to - "{{AudioContextState/suspended}}". +1. If the {{[[rendering thread state]]}} of the {{AudioContext}} is + <code>running</code>. -1. <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. Attempt to <a>release system resources</a>. - 1. <a spec="dom" lt="fire an event">fire an event</a> named - {{AudioContext/error}} at the associated {{AudioContext}}. - - 1. If the {{BaseAudioContext/state}} attribute of the {{AudioContext}} is - not already "{{AudioContextState/suspended}}": + 1. Set {{[[rendering thread state]]}} of the {{AudioContext}} to + <code>suspended</code>. + + 1. <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 {{[[suspended by user]]}} of the {{AudioContext}} to <code>false</code>. - 1. Set the {{BaseAudioContext/state}} attribute of the {{AudioContext}} - to "{{AudioContextState/suspended}}". + 1. Set {{[[control thread state]]}} of the {{AudioContext}} to <code>suspended</code>. + + 1. Set the {{BaseAudioContext/state}} attribute of the {{AudioContext}} to + "{{AudioContextState/suspended}}". 1. <a spec="dom" lt="fire an event">Fire an event</a> named - {{BaseAudioContext/statechange}} at the associated {{AudioContext}}. + {{AudioContext/error}} at the {{AudioContext}}. + + 1. Abort these substeps. + +1. If the {{[[rendering thread state]]}} of the {{AudioContext}} is + <code>suspended</code>. + + 1. <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. <a spec="dom" lt="fire an event">Fire an event</a> named + {{AudioContext/error}} at the {{AudioContext}}. + + 1. Abort these substeps. + -Note: An example of such a case would be when an external or wireless audio +Note: An example of system audio resource errors would be when an external or wireless audio device becomes disconnected during the active rendering of the AudioContext. <h3 id="unloading-a-document">Unloading a document</h3> From 29605b945ec83f8f6f31ffe026715f9bb7afda6f Mon Sep 17 00:00:00 2001 From: Hongchan Choi <hongchan.choi@gmail.com> Date: Tue, 30 Apr 2024 18:05:10 +0000 Subject: [PATCH 10/17] clean up --- index.bs | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/index.bs b/index.bs index 6c4772b51..e74a9629c 100644 --- a/index.bs +++ b/index.bs @@ -12931,7 +12931,7 @@ audio system resource error. 1. <a spec="dom" lt="fire an event">Fire an event</a> named {{AudioContext/error}} at the {{AudioContext}}. - 1. Abort these substeps. + 1. Abort these steps. 1. If the {{[[rendering thread state]]}} of the {{AudioContext}} is <code>suspended</code>. @@ -12941,9 +12941,6 @@ audio system resource error. 1. <a spec="dom" lt="fire an event">Fire an event</a> named {{AudioContext/error}} at the {{AudioContext}}. - - 1. Abort these substeps. - Note: An example of system audio resource errors would be when an external or wireless audio device becomes disconnected during the active rendering of the AudioContext. From d1ffe7633ac2b1946a93df40fa2a9711f8c9357f Mon Sep 17 00:00:00 2001 From: Hongchan Choi <hongchan.choi@gmail.com> Date: Thu, 2 May 2024 20:14:09 +0000 Subject: [PATCH 11/17] fire two events --- index.bs | 29 ++++++++++++++++++++--------- 1 file changed, 20 insertions(+), 9 deletions(-) diff --git a/index.bs b/index.bs index e74a9629c..d2f7ae9fb 100644 --- a/index.bs +++ b/index.bs @@ -2081,7 +2081,7 @@ Attributes</h4> <div class="correction proposed" id="c2450-6"> <span class="marker">Proposed addition - <a href="https://github.com/WebAudio/web-audio-api/issues/2450">Issue 2450</a>. + <a href="https://github.com/WebAudio/web-audio-api/issues/2450">Issue 2450</a>-1. </span> Allow specifying a different render quantum size <div class="amendment-buttons"> @@ -2119,7 +2119,6 @@ Attributes</h4> is running or the associated audio output device changes. It is useful to query this value frequently when accurate synchronization is required. - <div class="correction proposed" id="c2444-2"> <span class="marker">Proposed Addition <a href="https://github.com/WebAudio/web-audio-api/issues/2444">Issue @@ -2137,11 +2136,9 @@ Attributes</h4> </div> <div class="addition proposed" id="c2400-6"> - <span class="marker">Proposed Addition + <span class="marker">Proposed Addition</span><br> <a href="https://github.com/WebAudio/web-audio-api/issues/2400">Issue - 2400</a>. - </span> - Access to a different output device + 2400</a> Access to a different output device <div class="amendment-buttons"></div> <ins cite=#2400> : <dfn>sinkId</dfn> @@ -12904,6 +12901,14 @@ buffer</a> and the value(s) of the {{AudioParam}}(s) of this {{AudioNode}} as the input for this algorithm. +<div class="addition proposed" id="c2567-5"> + <span class="marker">Proposed addition + <a href="https://github.com/WebAudio/web-audio-api/issues/2567">Issue 2567</a>. + </span> + Device-related error reporting via AudioContext + <div class="amendment-buttons"></div> + <ins> + <h3 id="error-handling-on-a-running-audio-context"> Handling an error from System Audio Resources on the {{AudioContext}}</h3> @@ -12921,6 +12926,9 @@ audio system resource error. 1. <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. <a spec="dom" lt="fire an event">Fire an event</a> named {{AudioContext/error}} at the + {{AudioContext}}. + 1. Set {{[[suspended by user]]}} of the {{AudioContext}} to <code>false</code>. 1. Set {{[[control thread state]]}} of the {{AudioContext}} to <code>suspended</code>. @@ -12929,7 +12937,7 @@ audio system resource error. "{{AudioContextState/suspended}}". 1. <a spec="dom" lt="fire an event">Fire an event</a> named - {{AudioContext/error}} at the {{AudioContext}}. + {{BaseAudioContext/statechange}} at the {{AudioContext}}. 1. Abort these steps. @@ -12939,12 +12947,15 @@ audio system resource error. 1. <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. <a spec="dom" lt="fire an event">Fire an event</a> named - {{AudioContext/error}} at the {{AudioContext}}. + 1. <a spec="dom" lt="fire an event">Fire an event</a> named {{AudioContext/error}} at the + {{AudioContext}}. Note: An example of system audio resource errors would be when an external or wireless audio device becomes disconnected during the active rendering of the AudioContext. + </ins> +</div> + <h3 id="unloading-a-document">Unloading a document</h3> Additional <a href= "https://html.spec.whatwg.org/#unloading-document-cleanup-steps">unloading From 87b0ff52aced10b70e4c881e21fc128d0ad6cdb6 Mon Sep 17 00:00:00 2001 From: Hongchan Choi <hongchan.choi@gmail.com> Date: Thu, 30 May 2024 17:42:26 +0000 Subject: [PATCH 12/17] addressing comments --- index.bs | 72 +++++++++++++++++++++++--------------------------------- 1 file changed, 29 insertions(+), 43 deletions(-) diff --git a/index.bs b/index.bs index d2f7ae9fb..16e249cc1 100644 --- a/index.bs +++ b/index.bs @@ -1967,37 +1967,33 @@ Constructors</h4> 1. Attempt to <a href="#acquiring">acquire system resources</a>. In case of failure, abort the following steps. - 3. Set the {{[[rendering thread state]]}} to <code>running</code> on the {{AudioContext}}. + 1. Set the {{[[rendering thread state]]}} to <code>running</code> on the {{AudioContext}}. 1. <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 {{BaseAudioContext/state}} attribute of the {{AudioContext}} to "{{AudioContextState/running}}". - 1. <a href="https://html.spec.whatwg.org/multipage/media.html#queue-a-media-element-task"> - queue a media element task</a> to <a spec="dom" lt="fire an event">fire an event - </a> named {{BaseAudioContext/statechange}} at the {{AudioContext}}. + 1. [=Queue a media element task=] to [=fire an event=] named + {{BaseAudioContext/statechange}} at the {{AudioContext}}. + </del> <ins cite="#2400 #2567"> - 1. Attempt to <a href="#acquiring">acquire system resources</a> to use a - following audio output device based on {{AudioContext/[[sink ID]]}} for - rendering: + 1. Attempt to [=acquire system resources=] to use a following audio output device + based on {{AudioContext/[[sink ID]]}} for rendering: * The default audio output device for the empty string. * A audio output device identified by {{AudioContext/[[sink ID]]}}. Upon failure of resource acquisition, - <a href="https://html.spec.whatwg.org/multipage/media.html#queue-a-media-element-task"> - queue a media element task</a> to - <a spec="dom" lt="fire an event">fire an event</a> named - {{AudioContext/error}} at the {{AudioContext}}, and abort - the following steps. + [=queue a media element task=] to [=fire an event=] named + {{AudioContext/error}} at the {{AudioContext}}, and abort the following + steps. - 1. Set the {{[[rendering thread state]]}} to <code>running</code> on the + 1. Set [=this=] {{[[rendering thread state]]}} to <code>running</code> on the {{AudioContext}}. - 1. <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. [=Queue a media element task=] to execute the following steps: 1. Set the {{BaseAudioContext/state}} attribute of the {{AudioContext}} to "{{AudioContextState/running}}". @@ -2022,10 +2018,9 @@ Constructors</h4> mechanism, such as a developer tools console. </del> <ins> - NOTE: In cases where an AudioContext is constructed with no - arguments and resource acquisition fails, the User-Agent must - attempt to silently render the audio graph using a mechanism that - emulates an audio output device. + NOTE: In cases where an {{AudioContext}} is constructed with no arguments and resource + acquisition fails, the User-Agent will attempt to silently render the audio graph using + a mechanism that emulates an audio output device. </ins> </div> @@ -2169,9 +2164,8 @@ Attributes</h4> <ins cite=#2567> : <dfn>onerror</dfn> :: - An [=event handler=] for any <dfn event>error</dfn> {{Event}} dispatched from an - {{AudioContext}}. The user agent can dispatch this event in the - following cases: + An [=event handler=] for any <a event for="AudioContext">error</a> {{Event}} dispatched + from an {{AudioContext}}. The user agent can dispatch this event in the following cases: * The process of initializing and activiating the selected audio device encounters an issue. @@ -12915,43 +12909,35 @@ buffer</a> and the value(s) of the {{AudioParam}}(s) of this The <a>rendering thread</a> performs the following steps in the event of an audio system resource error. -1. If the {{[[rendering thread state]]}} of the {{AudioContext}} is - <code>running</code>. +1. If the |audioContext|'s {{[[rendering thread state]]}} is <code>running</code>: 1. Attempt to <a>release system resources</a>. - 1. Set {{[[rendering thread state]]}} of the {{AudioContext}} to - <code>suspended</code>. + 1. Set the |audioContext|'s {{[[rendering thread state]]}} to <code>suspended</code>. - 1. <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. [=Queue a media element task=] to execute the following steps: - 1. <a spec="dom" lt="fire an event">Fire an event</a> named {{AudioContext/error}} at the - {{AudioContext}}. + 1. [=Fire an event=] at the |audioContext|'s {{AudioContext/error}}. - 1. Set {{[[suspended by user]]}} of the {{AudioContext}} to <code>false</code>. + 1. Set the |audioContext|'s {{[[suspended by user]]}} to <code>false</code>. - 1. Set {{[[control thread state]]}} of the {{AudioContext}} to <code>suspended</code>. + 1. Set the |audioContext|'s {{[[control thread state]]}} to <code>suspended</code>. - 1. Set the {{BaseAudioContext/state}} attribute of the {{AudioContext}} to + 1. Set the |audioContext|'s {{BaseAudioContext/state}} attribute to "{{AudioContextState/suspended}}". - 1. <a spec="dom" lt="fire an event">Fire an event</a> named - {{BaseAudioContext/statechange}} at the {{AudioContext}}. + 1. [=Fire an event=] at the |audioContext|'s {{BaseAudioContext/statechange}}. 1. Abort these steps. -1. If the {{[[rendering thread state]]}} of the {{AudioContext}} is - <code>suspended</code>. +1. If the |audioContext|'s {{[[rendering thread state]]}} is <code>suspended</code>: - 1. <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. [=Queue a media element task=]to execute the following steps: - 1. <a spec="dom" lt="fire an event">Fire an event</a> named {{AudioContext/error}} at the - {{AudioContext}}. + 1. [=Fire an event=] at the |audioContext|'s {{AudioContext/error}}. -Note: An example of system audio resource errors would be when an external or wireless audio - device becomes disconnected during the active rendering of the AudioContext. +Note: An example of system audio resource errors would be when an external or wireless audio device + becoming disconnected during the active rendering of the {{AudioContext}}. </ins> </div> From 165685a69e21ae458a8740f838f52801ce6bf3ef Mon Sep 17 00:00:00 2001 From: Hongchan Choi <hongchan.choi@gmail.com> Date: Thu, 30 May 2024 17:48:36 +0000 Subject: [PATCH 13/17] addressing comments --- index.bs | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/index.bs b/index.bs index 16e249cc1..b767f58a6 100644 --- a/index.bs +++ b/index.bs @@ -2164,14 +2164,13 @@ Attributes</h4> <ins cite=#2567> : <dfn>onerror</dfn> :: - An [=event handler=] for any <a event for="AudioContext">error</a> {{Event}} dispatched + An [=event handler=] for any <dfn event>error</dfn> {{Event}} dispatched from an {{AudioContext}}. The user agent can dispatch this event in the following cases: - * The process of initializing and activiating the selected audio - device encounters an issue. - * The audio output from a {{AudioContextState/running}} - {{AudioContext}} unexpectedly interrupted or the device is - disconnected. + * The process of initializing and activiating the selected audio device encounters an + issue. + * The audio output from a {{AudioContextState/running}} {{AudioContext}} unexpectedly + interrupted or the device is disconnected. </ins> </div> From f70a8cf092ec5af9caa464b0381cf89d9b35bbee Mon Sep 17 00:00:00 2001 From: Hongchan Choi <hongchan.choi@gmail.com> Date: Sat, 1 Jun 2024 03:47:39 +0000 Subject: [PATCH 14/17] addressing more comments --- index.bs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/index.bs b/index.bs index b8cd1e9af..fc8be2621 100644 --- a/index.bs +++ b/index.bs @@ -12930,8 +12930,8 @@ buffer</a> and the value(s) of the {{AudioParam}}(s) of this <h3 id="error-handling-on-a-running-audio-context"> Handling an error from System Audio Resources on the {{AudioContext}}</h3> -The <a>rendering thread</a> performs the following steps in the event of an -audio system resource error. +The {{AudioContext}} |audioContext| performs the following steps on <a>rendering thread</a> in the + event of an udio system resource error. 1. If the |audioContext|'s {{[[rendering thread state]]}} is <code>running</code>: From eb3c47d14ba2f83ec5063dabbd73c837cd5d453d Mon Sep 17 00:00:00 2001 From: Hongchan Choi <hongchan.choi@gmail.com> Date: Sat, 1 Jun 2024 16:50:36 +0000 Subject: [PATCH 15/17] add ErrorEvent and minor fixes --- index.bs | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/index.bs b/index.bs index fc8be2621..ee61d39f4 100644 --- a/index.bs +++ b/index.bs @@ -2011,9 +2011,9 @@ Constructors</h4> * A audio output device identified by {{AudioContext/[[sink ID]]}}. Upon failure of resource acquisition, - [=queue a media element task=] to [=fire an event=] named - {{AudioContext/error}} at the {{AudioContext}}, and abort the following - steps. + [=queue a media element task=] to [=fire an event=] using {{ErrorEvent}} + at the {{AudioContext/error}} of the {{AudioContext}}, and abort the + following steps. 1. Set [=this=] {{[[rendering thread state]]}} to <code>running</code> on the {{AudioContext}}. @@ -2023,8 +2023,8 @@ Constructors</h4> 1. Set the {{BaseAudioContext/state}} attribute of the {{AudioContext}} to "{{AudioContextState/running}}". - 1. <a spec="dom" lt="fire an event">Fire an event</a> named - {{BaseAudioContext/statechange}} at the {{AudioContext}}. + 1. [=fire an event=] named {{BaseAudioContext/statechange}} at the + {{AudioContext}}. </ins> </div> @@ -12941,7 +12941,7 @@ The {{AudioContext}} |audioContext| performs the following steps on <a>rendering 1. [=Queue a media element task=] to execute the following steps: - 1. [=Fire an event=] at the |audioContext|'s {{AudioContext/error}}. + 1. [=Fire an event=] using {{ErrorEvent}} at the |audioContext|'s {{AudioContext/error}}. 1. Set the |audioContext|'s {{[[suspended by user]]}} to <code>false</code>. @@ -12958,7 +12958,7 @@ The {{AudioContext}} |audioContext| performs the following steps on <a>rendering 1. [=Queue a media element task=]to execute the following steps: - 1. [=Fire an event=] at the |audioContext|'s {{AudioContext/error}}. + 1. [=Fire an event=] using {{ErrorEvent}} at the |audioContext|'s {{AudioContext/error}}. Note: An example of system audio resource errors would be when an external or wireless audio device becoming disconnected during the active rendering of the {{AudioContext}}. From 5b5fe3da01e7a54e6a5f1ce7a7e605e36b192437 Mon Sep 17 00:00:00 2001 From: Hongchan Choi <hongchan.choi@gmail.com> Date: Sat, 1 Jun 2024 17:15:55 +0000 Subject: [PATCH 16/17] more ErrorEvent fix --- index.bs | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/index.bs b/index.bs index ee61d39f4..970f64350 100644 --- a/index.bs +++ b/index.bs @@ -2189,13 +2189,14 @@ Attributes</h4> <ins cite=#2567> : <dfn>onerror</dfn> :: - An [=event handler=] for any <dfn event>error</dfn> {{Event}} dispatched - from an {{AudioContext}}. The user agent can dispatch this event in the following cases: - - * The process of initializing and activiating the selected audio device encounters an - issue. - * The audio output from a {{AudioContextState/running}} {{AudioContext}} unexpectedly - interrupted or the device is disconnected. + An [=event handler=] for the {{ErrorEvent}} dispatched from an {{AudioContext}}. The event + type of this handler is <dfn event for=AudioContext>error</dfn> and the user agent can + dispatch this event in the following cases: + + * When initializing and activating a selected audio device encounters failures. + * When the audio output device associated with an {{AudioContext}} is disconnected while + the context is {{AudioContextState/running}}. + * When the operating system reports an audio device malfunction. </ins> </div> From 8776c752f5c82bba21d410db85b96478c31d5249 Mon Sep 17 00:00:00 2001 From: Hongchan Choi <hongchan.choi@gmail.com> Date: Tue, 9 Jul 2024 18:41:48 +0000 Subject: [PATCH 17/17] added step for policy check --- index.bs | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/index.bs b/index.bs index 970f64350..35f423b5b 100644 --- a/index.bs +++ b/index.bs @@ -2004,16 +2004,23 @@ Constructors</h4> </del> <ins cite="#2400 #2567"> + 1. Let |document| be the [=current settings object=]'s [=relevant global object=]'s + [=associated Document=]. + 1. Attempt to [=acquire system resources=] to use a following audio output device based on {{AudioContext/[[sink ID]]}} for rendering: * The default audio output device for the empty string. * A audio output device identified by {{AudioContext/[[sink ID]]}}. - Upon failure of resource acquisition, - [=queue a media element task=] to [=fire an event=] using {{ErrorEvent}} - at the {{AudioContext/error}} of the {{AudioContext}}, and abort the - following steps. + 1. If resource acquisition fails, execute the following steps: + + 1. If |document| is not allowed to use the feature identified by + <code>"speaker-selection"</code>, abort these substeps. + + 1. [=queue a media element task=] to [=fire an event=] using {{ErrorEvent}} + at the {{AudioContext/error}} of the {{AudioContext}}, and abort the + following steps. 1. Set [=this=] {{[[rendering thread state]]}} to <code>running</code> on the {{AudioContext}}.