Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Remove support for sounds from notifications
There are no implementations for this property, and the native
notification centers of various platforms make it hard to support this
properly.

  - Windows Action Center toasts have an <audio> element supports
    built-in sounds, as well as sounds included in an application's
    package, but not freeform path and/or URL support.
  - NSUserNotification (Mac OS and iOS) have a `soundName` property that
    will be resolved against files in various local system directories.
  - Android strongly prefers usage of the RingtoneManager for sounds.

Even though it could be supported on certain platforms, it's currently
underspecified: which codecs should be supported and what is the maximum
duration of the sound (if any), making it very unpredictable at best.

We can revisit supporting sounds if there is interest from
implementations.
  • Loading branch information
beverloo committed Feb 28, 2018
1 parent daf4b50 commit 459bf35
Showing 1 changed file with 11 additions and 48 deletions.
59 changes: 11 additions & 48 deletions notifications.bs
Expand Up @@ -99,14 +99,12 @@ not enough space to display the <a>notification</a> itself. It <em>may</em> also
the <a>notification</a>, but then it should have less visual priority than the
<a for=notification>image resource</a> and <a for=notification>icon resource</a>.

<p>A <a>notification</a> <em>can</em> have a <dfn for=notification id=sound-url>sound URL</dfn>,
<dfn for=notification id=sound-resource>sound resource</dfn>,
<p>A <a>notification</a> <em>can</em> have a
<dfn for=notification id=vibration-pattern>vibration pattern</dfn>.

<p class=note>Developers are encouraged to not convey information through an
<a for=notification lt="image resource">image</a>, <a for=notification lt="icon resource">icon</a>,
<a for=notification lt="badge resource">badge</a>,
<a for=notification lt="sound resource">sound</a>, or <a for=notification>vibration pattern</a> that
<a for=notification lt="badge resource">badge</a>, or <a for=notification>vibration pattern</a> that
is not otherwise accessible to the end user, especially since notification platforms that do not
support these features might ignore them.

Expand Down Expand Up @@ -167,8 +165,7 @@ these steps:
<p class=note><a>Actions</a> are only currently supported for
<a>persistent notifications</a>.

<li><p>If <var>options</var>'s <code>silent</code> is true, and either
<var>options</var>'s <code>sound</code> is present or <var>options</var>'s
<li><p>If <var>options</var>'s <code>silent</code> is true and <var>options</var>'s
<code>vibrate</code> is present, <a>throw</a> a <code>TypeError</code>
exception.

Expand Down Expand Up @@ -216,11 +213,6 @@ these steps:
return failure, set <var>notification</var>'s <a for=notification>badge URL</a> to the return
value. (Otherwise <a for=notification>badge URL</a> is not set.)

<li><p>If <var>options</var>'s <code>sound</code> is present,
<a lt="url parser">parse</a> it using <var>baseURL</var>, and if that does not
return failure, set <var>notification</var>'s <a for=notification>sound URL</a> to the return
value. (Otherwise <a for=notification>sound URL</a> is not set.)

<li><p>If <var>options</var>'s <code>vibrate</code> is present,
<a>validate and normalize</a> it and set <var>notification</var>'s
<a for=notification>vibration pattern</a> to the return value. (Otherwise
Expand Down Expand Up @@ -452,27 +444,6 @@ interpreted as a language tag. Validity or well-formedness are not enforced. [[!
<var>action</var> has no <a for=action>icon resource</a>.)
</ol>
</li>

<li>
<p>If the notification platform supports sounds, and the <var>notification</var>
is either not <a>replaceable</a> or has the <a for=notification>renotify preference flag</a>
set, <a for=/>fetch</a> <var>notification</var>'s <a for=notification>sound URL</a> if it has
been set.

<p>Then, <a>in parallel</a>:

<ol>
<li><p>Wait for the <a for=/>response</a>.

<li><p>If the <a for=/>response</a>'s <a>internal response</a>'s <a for=response>type</a> is
"<code>default</code>", then attempt to decode the resource as sound.
<!-- XXX xref -->

<li><p>If the sound format is supported, set <var>notification</var>'s
<a>sound resource</a> to the decoded resource. (Otherwise
<var>notification</var> has no <a>sound resource</a>.)
</ol>
</li>
</ol>


Expand Down Expand Up @@ -584,10 +555,10 @@ must be run.

<ol>
<li><p>Wait for any <a for=/ lt=fetch>fetches</a> to complete and <var>notification</var>'s
<a for=notification>image resource</a> <a for=notification>icon resource</a>,
<a for=notification>badge resource</a>, and <a for=notification>sound resource</a> to be set
(if any), as well as the <a for=action>icon resources</a> for the <var>notification</var>'s
<a for=notification>actions</a> (if any).
<a for=notification>image resource</a> <a for=notification>icon resource</a>, and
<a for=notification>badge resource</a> to be set (if any), as well as the
<a for=action>icon resources</a> for the <var>notification</var>'s <a for=notification>actions</a>
(if any).

<li><p>Display <var>notification</var> on the device (e.g., by calling the
appropriate notification platform API).
Expand All @@ -605,10 +576,10 @@ must be run.

<ol>
<li><p>Wait for any <a for=/ lt=fetch>fetches</a> to complete and <var>notification</var>'s
<a for=notification>image resource</a> <a for=notification>icon resource</a>,
<a for=notification>badge resource</a>, and <a for=notification>sound resource</a> to be set
(if any), as well as the <a for=action>icon resources</a> for the <var>notification</var>'s
<a for=notification>actions</a> (if any).
<a for=notification>image resource</a> <a for=notification>icon resource</a>, and
<a for=notification>badge resource</a> to be set (if any), as well as the
<a for=action>icon resources</a> for the <var>notification</var>'s <a for=notification>actions</a>
(if any).

<li><p><a for=list>Replace</a> <var>old</var> with <var>new</var>, in the same position, in the
<a>list of notifications</a>.
Expand All @@ -634,8 +605,6 @@ or vibrating the device again, unless the <a for=notification>renotify preferenc
<var>notification</var> are:

<ol>
<li><p>Play the <var>notification</var>'s <a>sound resource</a>, if any.

<li><p><a>Perform vibration</a> using <var>notification</var>'s
<a for=notification>vibration pattern</a>, if any.
</ol>
Expand Down Expand Up @@ -665,7 +634,6 @@ interface Notification : EventTarget {
readonly attribute USVString image;
readonly attribute USVString icon;
readonly attribute USVString badge;
readonly attribute USVString sound;
[SameObject] readonly attribute FrozenArray&lt;unsigned long> vibrate;
readonly attribute DOMTimeStamp timestamp;
readonly attribute boolean renotify;
Expand All @@ -685,7 +653,6 @@ dictionary NotificationOptions {
USVString image;
USVString icon;
USVString badge;
USVString sound;
VibratePattern vibrate;
DOMTimeStamp timestamp;
boolean renotify = false;
Expand Down Expand Up @@ -878,10 +845,6 @@ the empty string if there is no <a>notification</a>'s <a for=notification>icon U
<a>notification</a>'s <a for=notification>badge URL</a>, <a lt="url serializer">serialized</a>, and
the empty string if there is no <a>notification</a>'s <a for=notification>badge URL</a> otherwise.

<p>The <dfn attribute for=Notification><code>sound</code></dfn> attribute's getter must return the
<a>notification</a>'s <a for=notification>sound URL</a>, <a lt="url serializer">serialized</a>, and
the empty string if there is no <a>notification</a>'s <a for=notification>sound URL</a> otherwise.

<p>The <dfn attribute for=Notification><code>vibrate</code></dfn> attribute's getter must return the
<a>notification</a>'s <a for=notification>vibration pattern</a>, if any, and the empty list
otherwise.
Expand Down

0 comments on commit 459bf35

Please sign in to comment.