Fix export of track-muted and set-track-muted. #986

jan-ivar · 2024-01-22T18:19:18Z

Fixes #985

@marcoscaceres is this correct syntax?

Preview | Diff

youennf · 2024-01-23T08:19:50Z

Fixes #985

youennf · 2024-01-23T08:29:48Z

We have other uses of data-export in the spec?
Should we update them as well?

jan-ivar · 2024-01-23T15:24:56Z

We have other uses of data-export in the spec?
Should we update them as well?

I briefly considered it, but then realized any export of generic terms like "source" might conflict with other specs.

I also considered that maybe we shouldn't export everything by default, and that it might be better to do so on a need-to basis.

alvestrand · 2024-02-08T15:54:21Z

Raising the @dontcallmedom signal for advice.

getusermedia.html

jan-ivar · 2024-02-08T15:59:42Z

Hmm that didn't work either

1275.12-1275.142: error: Attribute “for” not allowed on element “dfn” at this point.
"file:/home/runner/work/mediacapture-main/mediacapture-main.w3c/getusermedia.html":1294.15-1294.149: error: Attribute “for” not allowed on element “dfn” at this point.
❌ Not so good... please fix the issues above.

Trying @youennf's version next

dontcallmedom · 2024-02-08T16:00:47Z

for is for bikeshed, respec needs data-dfn-for; I'll look into fixing this PR more generally early next week

getusermedia.html

jan-ivar · 2024-02-08T16:03:01Z

@dontcallmedom ah thanks, will try that next

getusermedia.html

dontcallmedom · 2024-02-12T11:21:12Z

looking at fixing the markup, there is an ambiguity in the language of the spec: sometimes "muted" is applied to the concept of source (e.g. "If source is stopped or muted, abort these steps"), sometimes to the concept of track (e.g. "A track sourced by a camera or microphone may be forcibly muted").

The <dfn> seems to allude (obliquely) to the source: "Muted refers to the input to the MediaStreamTrack".

I can propose a fix once this is clarified.

alvestrand · 2024-02-12T12:45:26Z

I think the idea was that "muted" refers to something that happens at the source, and is JS-visible through the "muted" attribute of the track (the source is ~never JS-visible). So "a track is muted" should probably be reworded as "the muted attribute is set on the track".
I think "input of the MediaStreamTrack" should generally be replaced with "source".

jan-ivar · 2024-03-22T19:20:35Z

looking at fixing the markup, there is an ambiguity in the language of the spec: sometimes "muted" is applied to the concept of source (e.g. "If source is stopped or muted, abort these steps"), sometimes to the concept of track (e.g. "A track sourced by a camera or microphone may be forcibly muted").

I think that's largely an internal inconsistency, unrelated to exporting what to other specs is a track-related concept:

concept https://w3c.github.io/mediacapture-main/#track-muted

Error: ROR] WebIDL identifier muted for MediaStreamTrack is defined multiple times

The error seems to come from the desire to add data-dfn-for="MediaStreamTrack" which makes it clash with MediaStreamTrack's muted WebIDL attribute of the same name:

webidl https://w3c.github.io/mediacapture-main/#dom-mediastreamtrack-muted
"The muted attribute reflects whether the track is muted. It MUST return this.[[Muted]]."

Which reminds me there's also this.[[Muted]]:

internal slot https://w3c.github.io/mediacapture-main/#dfn-muted

This same triad also exists for enabled:

concept https://w3c.github.io/mediacapture-main/#track-enabled
webidl https://w3c.github.io/mediacapture-main/#dom-mediastreamtrack-enabled
internal slot https://w3c.github.io/mediacapture-main/#dfn-enabled

...which makes me question moving the muted concept to the source as a solution to the export problem.

How do other specs do this? E.g. HTML appears to have done away with internal slots? What's the state of the art here?

concept and internal slot https://html.spec.whatwg.org/multipage/media.html#concept-media-muted
webidl https://html.spec.whatwg.org/multipage/media.html#dom-media-muted

Error: ROR] Couldn't find "set a track's muted state" in this document or other cited documents: [dom], [html], [infra], [permissions], [permissions-policy], [webaudio], and [webidl].

The desire to add data-dfn-for="MediaStreamTrack" broke existing links in this spec (and other specs if we go ahead with it). Fixable by changing

- [=set a track's muted state=]
+ [=MediaStreamTrack/set a track's muted state=]

...in this spec and all other specs that reference it.

Choices here seem to be:

Export the existing definitions without data-dfn-for="MediaStreamTrack" (is that frowned on?)
adddata-dfn-for="MediaStreamTrack" and rename the concept to "muted state" or something (ugh).
Push back on mediaSession's need for the concept. E.g. could it say "A user agent MAY expose microphone and camera state to web pages via the {{MediaStreamTrack/muted}} attribute."?

Also creates (unexported) definition for muted source

dontcallmedom · 2024-03-25T09:57:02Z

exporting muted without a scope would be frowned upon, yes.

I've gone ahead and:

made muted exported while distinct from the IDL attribute (using data-dfn-type=dfn)
added a <dfn> for muted sources and used it in the couple of places where we had an autolink that didn't make sense in the context of MediaStreamTrack (which was the reason I raised this distinction in the first place)
aligned the enabled and ended state to use the same pattern as muted

This will break autolinks in specs that were relying on the definitions with their existing for scope:

mediacapture-fromelement (muted, enabled)
mediacapture-transform (muted)
mediasession (muted)
screen-capture (muted, ended)
captured-mouse-events (ended)
capture-handle-identity (ended)
webrtc (ended)

marcoscaceres · 2024-04-14T23:38:44Z

getusermedia.html

 [= source/stopped =].</p>
 <p>After the application has invoked the {{MediaStreamTrack/stop()}}
 method on a {{MediaStreamTrack}} object, or once the [=source=] of a
 {{MediaStreamTrack}} permanently ends production of live samples to its tracks,
 whichever is sooner, a {{MediaStreamTrack}} is said to be
- <dfn id="track-ended" data-dfn-for="track" data-export>ended</dfn>.</p>
+ <dfn id="track-ended" data-dfn-for="MediaStreamTrack" data-dfn-type="dfn" data-export>ended</dfn>.</p>


Suggested change

<dfn id="track-ended" data-dfn-for="MediaStreamTrack" data-dfn-type="dfn" data-export>ended</dfn>.

<dfn data-dfn-for="MediaStreamTrack" class="export">ended</dfn>.

the id is used in other specs, I see no reason to break it; the dfn-type is needed to distinguish it from the IDL attribute of the name and scope

Suggested change

<dfn id="track-ended" data-dfn-for="MediaStreamTrack" data-dfn-type="dfn" data-export>ended</dfn>.

<dfn id="track-ended" data-dfn-for="MediaStreamTrack" data-dfn-type="dfn" class=export>ended</dfn>.

Hmm... is it defined twice for the two kinds?

once per kind, yes

marcoscaceres · 2024-04-14T23:39:36Z

getusermedia.html

+ <p><dfn class="export" data-dfn-for="MediaStreamTrack" data-dfn-type="dfn" id=
 "track-muted">Muted</dfn> refers to the input to the


Suggested change

<dfn class="export" data-dfn-for="MediaStreamTrack" data-dfn-type="dfn" id=

"track-muted">Muted</dfn> refers to the input to the

<dfn class="export" data-dfn-for="MediaStreamTrack">Muted</dfn> refers to the input to the

likewise, dfn-type is needed to distinguish from the IDL attribute

Ok, I guess... feel free to resolve.

However, I think that might be confusing (even though it's correct)... Maybe there should be a "media stream track" concept?

marcoscaceres · 2024-04-14T23:41:21Z

getusermedia.html

@@ -954,7 +955,7 @@ <h4>Media Flow</h4>
 <var>track</var>.</p>
 </li>
 </ol>
- <p><dfn data-export id="track-enabled" data-lt="track enabled state|enabled" data-lt-noDefault>Enabled/disabled</dfn> on the other hand is
+ <p><dfn data-export id="track-enabled" data-dfn-for="MediaStreamTrack" data-dfn-type="dfn" data-lt="track enabled state|enabled" data-lt-noDefault>Enabled/disabled</dfn> on the other hand is


Suggested change

<dfn data-export id="track-enabled" data-dfn-for="MediaStreamTrack" data-dfn-type="dfn" data-lt="track enabled state|enabled" data-lt-noDefault>Enabled/disabled</dfn> on the other hand is

<dfn class="export" data-dfn-for="MediaStreamTrack" data-lt="track enabled state|enabled" data-lt-noDefault>Enabled/disabled</dfn> on the other hand is

@jan-ivar, the data-lt="track enabled state|enabled" doesn't make much sense. This should really be:

<dfn class="export" data-dfn-for="MediaStreamTrack">track state</dfn> can be either "enabled" or "disabled"...

See how HTML handles Document/visibility state:

which is either "hidden" or "visible", initially set to "hidden".

This is unchanged by this PR, and I'm not sure what's the current respec way of doing things. @dontcallmedom can I bother you to address the feedback from @marcoscaceres here?

Suggested change

<dfn data-export id="track-enabled" data-dfn-for="MediaStreamTrack" data-dfn-type="dfn" data-lt="track enabled state|enabled" data-lt-noDefault>Enabled/disabled</dfn> on the other hand is

The <dfn data-export id="track-enabled" data-dfn-for="MediaStreamTrack" data-dfn-type="dfn" >enabled</dfn> (resp. disabled) state on the other hand is

getusermedia.html

Co-authored-by: Marcos Cáceres <marcos@marcosc.com>

jan-ivar · 2024-04-15T17:48:49Z

Thanks @dontcallmedom for the commits!

getusermedia.html

Co-authored-by: Marcos Cáceres <marcos@marcosc.com>

Fix export of track-muted and set-track-muted.

fa57210

jan-ivar self-assigned this Jan 22, 2024

dontcallmedom mentioned this pull request Jan 22, 2024

Issue to collect reports in experimental deployment dontcallmedom/spec-check-hook#2

Closed

jan-ivar mentioned this pull request Jan 22, 2024

Make setMicrophoneActive and setCameraActive return promises. w3c/mediasession#312

Merged

youennf added the editorial label Jan 23, 2024

jan-ivar commented Feb 8, 2024

View reviewed changes

getusermedia.html Outdated Show resolved Hide resolved

s/data-dfn-for/for/

1130538

jan-ivar commented Feb 8, 2024

View reviewed changes

getusermedia.html Outdated Show resolved Hide resolved

s/data-dfn-for/for/

39c1412

alvestrand added the Editors can integrate label Feb 8, 2024

jan-ivar commented Feb 8, 2024

View reviewed changes

getusermedia.html Outdated Show resolved Hide resolved

getusermedia.html Outdated Show resolved Hide resolved

jan-ivar added 2 commits February 8, 2024 11:02

take 3

9f045ee

take 3

61cfeae

jan-ivar commented Feb 8, 2024

View reviewed changes

getusermedia.html Outdated Show resolved Hide resolved

getusermedia.html Outdated Show resolved Hide resolved

jan-ivar added 2 commits February 8, 2024 11:11

take 4

7b87cc8

take 4

87c97a4

Merge branch 'main' into export

4483ec3

dontcallmedom added 3 commits March 25, 2024 10:46

Fix export of muted state for mediastreamtrack

b3cd622

Also creates (unexported) definition for muted source

Align dfn of ended with muted

66d0801

Align dfn of enabled with muted

c198b10

dontcallmedom mentioned this pull request Mar 25, 2024

Detect breakage of autolinks dontcallmedom/spec-check-hook#14

Open

marcoscaceres reviewed Apr 14, 2024

View reviewed changes

getusermedia.html Outdated Show resolved Hide resolved

remove unneeded space

531f4f8

Co-authored-by: Marcos Cáceres <marcos@marcosc.com>

jan-ivar assigned dontcallmedom and unassigned jan-ivar Apr 15, 2024

marcoscaceres reviewed Apr 15, 2024

View reviewed changes

getusermedia.html Outdated Show resolved Hide resolved

remove unneeded whtiespace

1294bec

Co-authored-by: Marcos Cáceres <marcos@marcosc.com>

jan-ivar merged commit bf8dac0 into w3c:main Apr 25, 2024
2 checks passed

jan-ivar mentioned this pull request Apr 25, 2024

Reorder Media Flow and Life-cycle sections. #995

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix export of track-muted and set-track-muted. #986

Fix export of track-muted and set-track-muted. #986

jan-ivar commented Jan 22, 2024 •

edited by pr-preview bot

Loading

youennf commented Jan 23, 2024

youennf commented Jan 23, 2024

jan-ivar commented Jan 23, 2024

alvestrand commented Feb 8, 2024

jan-ivar commented Feb 8, 2024 •

edited

Loading

dontcallmedom commented Feb 8, 2024

jan-ivar commented Feb 8, 2024

dontcallmedom commented Feb 12, 2024

alvestrand commented Feb 12, 2024

jan-ivar commented Mar 22, 2024

dontcallmedom commented Mar 25, 2024 •

edited

Loading

marcoscaceres Apr 14, 2024

dontcallmedom Apr 15, 2024

marcoscaceres Apr 15, 2024

dontcallmedom Apr 22, 2024

marcoscaceres Apr 14, 2024

dontcallmedom Apr 15, 2024

marcoscaceres Apr 15, 2024 •

edited

Loading

marcoscaceres Apr 14, 2024

marcoscaceres Apr 14, 2024 •

edited

Loading

jan-ivar Apr 16, 2024

dontcallmedom Apr 22, 2024

jan-ivar commented Apr 15, 2024

	<dfn id="track-ended" data-dfn-for="MediaStreamTrack" data-dfn-type="dfn" data-export>ended</dfn>.</p>
	<dfn data-dfn-for="MediaStreamTrack" class="export">ended</dfn>.</p>

		<p><dfn class="export" data-dfn-for="MediaStreamTrack" data-dfn-type="dfn" id=
		"track-muted">Muted</dfn> refers to the input to the

	<p><dfn data-export id="track-enabled" data-dfn-for="MediaStreamTrack" data-dfn-type="dfn" data-lt="track enabled state\|enabled" data-lt-noDefault>Enabled/disabled</dfn> on the other hand is
	<p><dfn class="export" data-dfn-for="MediaStreamTrack" data-lt="track enabled state\|enabled" data-lt-noDefault>Enabled/disabled</dfn> on the other hand is

	<p><dfn data-export id="track-enabled" data-dfn-for="MediaStreamTrack" data-dfn-type="dfn" data-lt="track enabled state\|enabled" data-lt-noDefault>Enabled/disabled</dfn> on the other hand is
	<p>The <dfn data-export id="track-enabled" data-dfn-for="MediaStreamTrack" data-dfn-type="dfn" >enabled</dfn> (resp. disabled) state on the other hand is

Fix export of track-muted and set-track-muted. #986

Fix export of track-muted and set-track-muted. #986

Conversation

jan-ivar commented Jan 22, 2024 • edited by pr-preview bot Loading

youennf commented Jan 23, 2024

youennf commented Jan 23, 2024

jan-ivar commented Jan 23, 2024

alvestrand commented Feb 8, 2024

jan-ivar commented Feb 8, 2024 • edited Loading

dontcallmedom commented Feb 8, 2024

jan-ivar commented Feb 8, 2024

dontcallmedom commented Feb 12, 2024

alvestrand commented Feb 12, 2024

jan-ivar commented Mar 22, 2024

dontcallmedom commented Mar 25, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marcoscaceres Apr 15, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marcoscaceres Apr 14, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jan-ivar commented Apr 15, 2024

jan-ivar commented Jan 22, 2024 •

edited by pr-preview bot

Loading

jan-ivar commented Feb 8, 2024 •

edited

Loading

dontcallmedom commented Mar 25, 2024 •

edited

Loading

marcoscaceres Apr 15, 2024 •

edited

Loading

marcoscaceres Apr 14, 2024 •

edited

Loading