Skip to content
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.

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

Enhance Video Controls for Video Audio Description #6080

Merged
merged 11 commits into from May 10, 2022

Conversation

amandadupell
Copy link
Contributor

@amandadupell amandadupell commented Apr 20, 2022

What does this PR do?

Adds the ability to pass in a video audio description for video controls.

Where should the reviewer start?

Video.js

What testing has been done on this PR?

Manual Storybook testing

How should this be manually tested?

Storybook

Do Jest tests follow these best practices?

  • screen is used for querying.
  • The correct query is used. (Refer to this list of queries)
  • userEvent is used in place of fireEvent.
  • asFragment() is used for snapshot testing.

Any background context you want to provide?

What are the relevant issues?

#6059

Screenshots (if appropriate)

Do the grommet docs need to be updated?

Yes

Should this PR be mentioned in the release notes?

Yes

Is this change backwards compatible or is it a breaking change?

Compatible, new feature

@@ -66,6 +67,9 @@
"pauseButton": "pause",
"playButton": "play",
"volumeDown": "volume down",
"volumeUp": "volume up"
"volumeUp": "volume up",
"description": "video audio description",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we are referring to it as "Video description" below, should we just say "video description" here? OR you mentioned that "Audio description" is more common, should we be saying that across the board?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Leaning towards "Audio description" myself after doing some quick googling.

@@ -66,6 +67,9 @@
"pauseButton": "pause",
"playButton": "play",
"volumeDown": "volume down",
"volumeUp": "volume up"
"volumeUp": "volume up",
"description": "video audio description",
Copy link
Collaborator

@taysea taysea Apr 20, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we call this key audioDescription to tie in with the accessibility language?

@@ -1683,6 +1684,7 @@ export const generate = (baseSpacing = 24, scale = 6) => {
play: Play,
reduceVolume: VolumeLow,
volume: Volume,
description: AssistListening,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems like there is a standard icon for Audio Description -- should we add that to grommet-icons to be able to use here?
Screen Shot 2022-04-20 at 10 53 20 AM

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes this icon would be preferred. what is the timeline/process for getting this added to grommet icons?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would create an issue for this on grommet-icons and add it to the backlog

Copy link
Collaborator

@taysea taysea left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From some research I was doing on where "Audio Descriptions" have already been successfully implemented (Netflix, among others), it seems like it's more of a supplemental audio track that is announced real time with the video as opposed to text on the screen like we are doing here.

For users who are deaf, closed captioning is helpful to show what is being said.
For users who are blind, audio descriptions are helpful to describe what is being shown.

The behavior seems somewhat standardized and so showing text on the screen like we are in this PR seems to deviate from that and we would want to instead support the option for someone to add an audio description track and for a user to be able to toggle that on/off in the controls. However, did any of this come up in your discussion w Bill and what he expects from an Audio Description?

@amandadupell
Copy link
Contributor Author

for testing, i updated the Video/Controls Below story to include a <track kind="descriptions" /> for the video. this is current industry best practice, but has varied support across browsers. i've tried to find a chart that demonstrates the support but have just read and tested this one my own (not supported in VO). because of this, we are implementing our own system for announcing the active audio description for the video.

to test:

  1. open Controls Below story
  2. using keyboard, navigate to new "audio description" button in controls menu pop-up
  3. play the video
  4. audio descriptions will be announced when active

things to note:

  • announce is missing from the dependency array; this is to prevent re-announcing of active tracks when inBounds for a long time
  • we should update the audio description icon to align with other systems as taylor mentioned above
  • we should consider moving the icon outside of the menu pop-up and include it as a part of the bar next to the menu button; i think this aligns more with industry standards

Copy link
Collaborator

@jcfilben jcfilben left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a minor comment, otherwise looks good

Comment on lines 73 to 74
"showDescription": "Video description opened below video",
"hideDescription": "Video description closed"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we still need these?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removed!

Copy link
Collaborator

@jcfilben jcfilben left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@ericsoderberghp ericsoderberghp merged commit 76b0551 into grommet:master May 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants