Skip to content

✨ Add volume attribute to amp-video for use in amp-story-page #36693

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.

Sign up for GitHub

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

Merged
gmajoulet merged 8 commits into from
Nov 2, 2021
Merged

✨ Add volume attribute to amp-video for use in amp-story-page #36693

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4fc40b5
Add volume support in amp-video for amp-story.
Oct 26, 2021
f80e2aa
Merge branch 'main' into volume
Oct 26, 2021
2bd8317
Parse volume string to float.
Oct 26, 2021
6d46cb1
Update regex for volume.
Nov 1, 2021
b5809eb
Merge branch 'main' into volume
Nov 1, 2021
03bc0ad
Update extensions/amp-story/1.0/media-pool.js
apatronl Nov 2, 2021
4dc16c6
Add validator test cases.
Nov 2, 2021
ef94f91
Merge branch 'main' into volume
Nov 2, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions extensions/amp-story/1.0/media-pool.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -850,6 +850,11 @@ export class MediaPool {
return Promise.resolve();
}

// When a video is muted, reset its volume to the default value of 1.
if (mediaType == MediaType.VIDEO) {
domMediaEl.volume = 1;
}

return this.enqueueMediaElementTask_(poolMediaEl, new MuteTask());
}

Expand All @@ -870,6 +875,16 @@ export class MediaPool {
return Promise.resolve();
}

if (mediaType == MediaType.VIDEO) {
const ampVideoEl = domMediaEl.parentElement;
if (ampVideoEl) {
const volume = ampVideoEl.getAttribute('volume');
if (volume) {
domMediaEl.volume = parseFloat(volume);
}
}
}

return this.enqueueMediaElementTask_(poolMediaEl, new UnmuteTask());
}

Expand Down
34 changes: 34 additions & 0 deletions extensions/amp-story/1.0/test/validator-amp-story-video-error.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,40 @@
</amp-video>
</amp-story-grid-layer>
</amp-story-page>
<amp-story-page id="2" background-audio="path/to/my.mp3" auto-advance-after="any-value">
<amp-story-grid-layer template="horizontal">
<!-- This should fail because amp-video volume should be within [0.1, 1]. -->
<amp-video width="480"
height="270"
poster="/foo.jpg"
src="/video/tokyo.mp4"
layout="responsive"
volume="0">
<div fallback>
<p>Your browser doesn't support HTML5 video.</p>
</div>
<source type="video/mp4" src="/video/tokyo.mp4">
<source type="video/webm" src="/video/tokyo.webm">
</amp-video>
</amp-story-grid-layer>
</amp-story-page>
<amp-story-page id="3" background-audio="path/to/my.mp3" auto-advance-after="any-value">
<amp-story-grid-layer template="horizontal">
<!-- This should fail because amp-video volume should be within [0.1, 1]. -->
<amp-video width="480"
height="270"
poster="/foo.jpg"
src="/video/tokyo.mp4"
layout="responsive"
volume="1.01">
<div fallback>
<p>Your browser doesn't support HTML5 video.</p>
</div>
<source type="video/mp4" src="/video/tokyo.mp4">
<source type="video/webm" src="/video/tokyo.webm">
</amp-video>
</amp-story-grid-layer>
</amp-story-page>
</amp-story>
</body>
</html>
40 changes: 39 additions & 1 deletion extensions/amp-story/1.0/test/validator-amp-story-video-error.out
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,44 @@ amp-story/1.0/test/validator-amp-story-video-error.html:23:8 The mandatory attri
| </amp-video>
| </amp-story-grid-layer>
| </amp-story-page>
| <amp-story-page id="2" background-audio="path/to/my.mp3" auto-advance-after="any-value">
| <amp-story-grid-layer template="horizontal">
| <!-- This should fail because amp-video volume should be within [0.1, 1]. -->
| <amp-video width="480"
>> ^~~~~~~~~
amp-story/1.0/test/validator-amp-story-video-error.html:38:8 The attribute 'volume' in tag 'amp-video' is set to the invalid value '0'. (see https://amp.dev/documentation/components/amp-video/)
| height="270"
| poster="/foo.jpg"
| src="/video/tokyo.mp4"
| layout="responsive"
| volume="0">
| <div fallback>
| <p>Your browser doesn't support HTML5 video.</p>
| </div>
| <source type="video/mp4" src="/video/tokyo.mp4">
| <source type="video/webm" src="/video/tokyo.webm">
| </amp-video>
| </amp-story-grid-layer>
| </amp-story-page>
| <amp-story-page id="3" background-audio="path/to/my.mp3" auto-advance-after="any-value">
| <amp-story-grid-layer template="horizontal">
| <!-- This should fail because amp-video volume should be within [0.1, 1]. -->
| <amp-video width="480"
>> ^~~~~~~~~
amp-story/1.0/test/validator-amp-story-video-error.html:55:8 The attribute 'volume' in tag 'amp-video' is set to the invalid value '1.01'. (see https://amp.dev/documentation/components/amp-video/)
| height="270"
| poster="/foo.jpg"
| src="/video/tokyo.mp4"
| layout="responsive"
| volume="1.01">
| <div fallback>
| <p>Your browser doesn't support HTML5 video.</p>
| </div>
| <source type="video/mp4" src="/video/tokyo.mp4">
| <source type="video/webm" src="/video/tokyo.webm">
| </amp-video>
| </amp-story-grid-layer>
| </amp-story-page>
| </amp-story>
| </body>
| </html>
| </html>
6 changes: 6 additions & 0 deletions extensions/amp-video/validator-amp-video.protoascii
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,12 @@ tags: { # <amp-video> in amp-story
name: "captions-id"
requires_extension: "amp-story-captions"
}
attrs: {
name: "volume"
# Disallow 0 to prevent shipping unnecessary audio track when the video is muted.
# Volume must be in the range [0.1, 1].
value_regex: "^((0?\.[1-9]+)?|1(\.0*)?)$"
Comment thread
apatronl marked this conversation as resolved.
}
attr_lists: "extended-amp-global"
attr_lists: "amp-video-common"
spec_url: "https://amp.dev/documentation/components/amp-video/"
Expand Down