[invokers] Media mute action ambiguous

[lukewarlow]

Currently the invokers explainer says that video and audio support a mute action which actually toggles the muted property.

I think this action should be renamed to clarify that it's a toggle action. muteunmute would match playpause, alternatively toggleMute might be better?

[css-meeting-bot]

The Open UI Community Group just discussed [invokers] Media mute action ambiguous, and agreed to the following:

• RESOLVED: Rename "mute" action to "toggleMuted".

The full IRC log of that discussion

<gregwhitworth> q+
<masonf_> q+
<keithamus> Luke_W: Various actions related to audio/video elements; playpause (debatable) but clear it's separate from play or pause. The mute action is toggle though. We need a better name for it, or it does one thing. I propose muteunmute or togglemute
<brecht_dr> q+
<gregwhitworth> ack gregwhitworth
<keithamus> gregwhitworth: we should speak to the media working group for insights. I can take that as an action item
<masonf_> ack mason
<masonf_> ack brecht
<keithamus> masonf_: roughly the same as modal; I like toggle as a name because it aligns with the other APIs. On playpause I think the same thing for auto; it does a magical thing with no alias.
<keithamus> brecht_dr: muteunmute itself feels one I'll misstype a lot. playpause is also strange to type. toggleMute is a little tricky because we're getting back to toggle again. muteunmute is just odd to pronounce and type.
<keithamus> q+
<bkardell_> q+
<keithamus> masonf_: I think toggle being core to the switching of things is nice, you add mute, popover, but toggle is core
<masonf_> ack keith
<masonf_> ack bkardell
<keithamus> brecht_dr: I agree
<brecht_dr> q+
<keithamus> bkardell_: there have been a few other proposals which this conversation reminds me of; CSS toggles. The keyword there was cycle - you provide a wraparound list of things this does... is there an opportunity to do something similar here? When I think of play/pause/mute... the answer is unclear... it depends. There's buttons I literally want to
<keithamus> toggle play/pause, but I feel mute might want to pause the video too?
<keithamus> q+
<masonf_> ack brecht
<bkardell_> my cycle comment doesn't help here I guess with that one :)
<keithamus> brecht_dr: e.g. if you have playpause it says both - it either plays or pauses, it doesn't depend on the state. When you're playing a video if you're toggling mute, it changes the starting state of the video - so you're using the term togglemute but the video was already muted when it started playing. Should it depend on how the video started?
<masonf_> ack keith
<masonf_> q+
<keithamus> keithamus: the design was to follow video controls so mute/unmute does as you describe. Are we discussing naming or semantics?
<keithamus> brecht_dr: so if the video was muted perhaps the name should be toggleUnmute, because the video was muted. The starting state of the video depends on if you're calling this toggleMute or toggleUnmute. Playpause says both the things, so maybe toggleMute/unmute is the wrong words?
<keithamus> masonf_,: togglemuted?
<bkardell_> yes, toggle the state name is what I was going to say
<keithamus> Luke_W: togglemuted works
<keithamus> masonf_: it gets around the question.
<masonf_> q?
<keithamus> masonf_: there are lots of questions around this... dialog... I wonder if we want to de-risk the project and defer some of these for later?
<masonf_> ack mason
<keithamus> q+
<keithamus> Luke_W: I feel like if we solve namespacing, we can, but if we ship without key features like video I feel people might implement themselves and clobber namespaces.
<Luke_W> Proposed Resolution: Rename "mute" action to "toggleMuted".
<masonf_> ack keith
<keithamus> keithamus: I'm uneasy about namespacing...
<masonf_> q?
<keithamus> masonf_: we can perhaps bring up namespacing
<keithamus> +1
<bkardell_> I think I will not actually, but thanks :)
<bkardell_> the more I think about it the more I think there is not really there there
<Luke_W> RESOLVED: Rename "mute" action to "toggleMuted".

[lukewarlow]

This has also been fixed in the browser implementation.