-
Notifications
You must be signed in to change notification settings - Fork 75
Updating the Transcript Rules #2064
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
Changes from all commits
7c4e66c
5788d05
9e0300b
8132fb8
1392cfb
5123093
750beeb
cfc6f7a
7f6bc85
7d9331c
9c7cfc0
39a4cd8
20c5578
9c7b010
5011552
c910d8b
aa43f64
06f4fd9
11570c6
8c8453d
556f9e6
d5edac0
9322d9e
6fcaa73
920180f
460d2de
79003bf
6644945
4d86b8f
a6a7bc7
07d251d
32ef899
4460429
d4c436c
d8830b6
f282089
089d651
81ec312
6867ec7
3838d16
fae7ad0
4a26e0b
f1eb5ce
b0f435d
e6f966f
c366a7c
6651e1b
d89738c
0678b3f
7da5060
df3096f
efa4098
b7360ae
89ccdcd
62a5540
3cb5bf5
5f8a06a
6c39ab5
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,6 +5,10 @@ rule_type: atomic | |
description: | | ||
This rule checks that `audio` elements have a transcript that includes all auditory information. | ||
accessibility_requirements: | ||
wcag20:1.2.1: # Audio-only and Video-only (Prerecorded) (A) | ||
secondary: This success criterion is **less strict** than this rule. This is because the rule does not consider that the audio may be a media alternative for text. Some of the failed examples satisfy this success criterion. | ||
wcag20:1.3.1: # Info and Relationships (A) | ||
secondary: This success criterion is **more strict** than this rule. This is because the rule is not intended to test this requirement. Some of the passed examples do not satisfy this success criterion. | ||
input_aspects: | ||
- DOM Tree | ||
- CSS Styling | ||
|
@@ -13,6 +17,7 @@ input_aspects: | |
acknowledgments: | ||
authors: | ||
- Brian Bors | ||
- Helen Burge | ||
- Wilco Fiers | ||
funding: | ||
- WAI-Tools | ||
|
@@ -22,27 +27,29 @@ acknowledgments: | |
|
||
## Applicability | ||
|
||
This rule applies to every [non-streaming](#non-streaming-media-element) `audio` element that is: | ||
This rule applies to every [non-streaming](#non-streaming-media-element) `audio` element for which at least one of the following is true: | ||
|
||
- playing; or, | ||
- has a [play button][] that is [visible][] and [included in the accessibility tree][]. | ||
- the element has an [autoplay][] [attribute value][] of `true`; or | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Since autoplay here is referring to the HTML attribute I don't think it needs to link to the definition. |
||
- the element has a [play button][] that is [visible][] and [included in the accessibility tree][]. | ||
|
||
## Expectation | ||
|
||
The auditory information of each test target is available through a text transcript. That text transcript is [visible][] and [included in the accessibility tree][], either on the page or through a link. | ||
The auditory information of each test target is available through a text transcript. That text transcript is [visible][], either on the page or through a [clearly labeled location][]. | ||
|
||
**Note:** A "text transcript" in the context of this rule is defined in WCAG 2 as an [alternative for time based media](https://www.w3.org/TR/WCAG22/#dfn-alternative-for-time-based-media). | ||
|
||
## Assumptions | ||
|
||
There are no assumptions. | ||
If a transcript is present, it is assumed it is in the accessibility tree. In order to satisfy WCAG, transcripts need to be available for all users, not just sighted users. This rule does not test this, and it needs to be tested separately. | ||
|
||
## Accessibility Support | ||
|
||
There are no accessibility support issues known. | ||
|
||
## Background | ||
|
||
Some major browsers do not automatically play the 'video' unless it is muted, which makes the rule inapplicable in these browsers. The rule still applies to browsers that [autoplay][] an audible 'video'. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This one should link to the autoplay definition, but since it is being used in the Background section, the definition doesn't need to be objective. |
||
|
||
### Bibliography | ||
|
||
- [Understanding SC 1.2.1:Audio-only and Video-only (Prerecorded)](https://www.w3.org/WAI/WCAG22/Understanding/audio-only-and-video-only-prerecorded) | ||
|
@@ -81,7 +88,7 @@ This `audio` element has native player controls and an external transcript. | |
|
||
#### Passed Example 3 | ||
|
||
This `audio` element has an `autoplay` attribute and an external transcript. | ||
This `audio` element has an [autoplay][] attribute and an external transcript. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Since autoplay here is referring to the HTML attribute I don't think it needs to link to the definition. |
||
|
||
```html | ||
<html lang="en"> | ||
|
@@ -90,6 +97,22 @@ This `audio` element has an `autoplay` attribute and an external transcript. | |
</html> | ||
``` | ||
|
||
#### Passed Example 4 | ||
|
||
This `audio` element has native player controls and an internal transcript that is not exposed to the accessibility tree. | ||
|
||
```html | ||
<html lang="en"> | ||
<audio src="/test-assets/moon-audio/moon-speech.mp3" controls></audio> | ||
<p aria-hidden="true"> | ||
The above audio contains the following speech: We choose to go to the moon in this decade and do the other things, | ||
not because they are easy, but because they are hard, because that goal will serve to organize and measure the best | ||
of our energies and skills, because that challenge is one that we are willing to accept, one we are unwilling to | ||
postpone, and one which we intend to win, and the others, too. | ||
</p> | ||
</html> | ||
``` | ||
|
||
### Failed | ||
|
||
#### Failed Example 1 | ||
|
@@ -131,7 +154,7 @@ This `audio` element has native player controls and an incorrect external transc | |
|
||
#### Failed Example 4 | ||
|
||
This `audio` element has an `autoplay` attribute and an incorrect external transcript. | ||
This `audio` element has an [autoplay][] attribute and an incorrect external transcript. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Since autoplay here is referring to the HTML attribute I don't think it needs to link to the definition. |
||
|
||
```html | ||
<html lang="en"> | ||
|
@@ -156,22 +179,6 @@ This `audio` element has native player controls and a [non-visible][visible] int | |
</html> | ||
``` | ||
|
||
#### Failed Example 6 | ||
HelenBurge marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
This `audio` element has native player controls and an internal transcript that is not exposed to the accessibility tree. | ||
|
||
```html | ||
<html lang="en"> | ||
<audio src="/test-assets/moon-audio/moon-speech.mp3" controls></audio> | ||
<p aria-hidden="true"> | ||
The above audio contains the following speech: We choose to go to the moon in this decade and do the other things, | ||
not because they are easy, but because they are hard, because that goal will serve to organize and measure the best | ||
of our energies and skills, because that challenge is one that we are willing to accept, one we are unwilling to | ||
postpone, and one which we intend to win, and the others, too. | ||
</p> | ||
</html> | ||
``` | ||
|
||
### Inapplicable | ||
|
||
#### Inapplicable Example 1 | ||
|
@@ -194,6 +201,7 @@ This `audio` element has hidden native player controls. | |
</html> | ||
``` | ||
|
||
[included in the accessibility tree]: #included-in-the-accessibility-tree 'Definition of included in the accessibility tree' | ||
[play button]: #play-button 'Definition of play button' | ||
[visible]: #visible 'Definition of visible' | ||
[included in the accessibility tree]: #included-in-the-accessibility-tree 'Definition of included in the accessibility tree' | ||
[autoplay]: #autoplay 'Definition of autoplay' |
Uh oh!
There was an error while loading. Please reload this page.