Add playsinline option to Video media file formatter

Useful attributes.

'muted' can be shared by both 'video' and 'audio' but 'playsinline' is for 'video'

Why not update the 'field.formatter.settings.file_video' and formatter?

field.formatter.settings.file_video:
  type: file.formatter.media
  label: 'Video file display format settings'
  mapping:
    muted:
      type: boolean
      label: 'Muted'
    width:
      type: integer
      label: 'Width'
    height:
      type: integer
      label: 'Height'

The initial patch on this thread did work for Drupal < 8.7.2 but no longer works with drupal >= 8.7.2. Attached is an updated patch that also adds muted and playsinline attributes to video. It also implements a slightly different schema per Joseph Zhao's suggestion in #7

Just tested this on a site, works perfectly. Thank you for the patch.

Added these new parameters to the tests core/modules/file/tests/src/Functional/Formatter/FileVideoFormatterTest.php
For version 8.8.x works perfectly

We need a test case here for the changes.

Rerolled up to 8.9
And extended tests

+++ b/core/modules/file/tests/src/Functional/Formatter/FileVideoFormatterTest.php
@@ -98,6 +99,7 @@ public function testAttributes() {
+    $assert_session->elementExists('css', "video[playsinline='playsinline'] > source[src='$file_url'][type='video/mp4']");

Thanks for the test case.

@aleevas that patch looks good to me

1. +++ b/core/modules/file/src/Plugin/Field/FieldFormatter/FileMediaFormatterBase.php
   @@ -56,6 +58,16 @@ public function settingsForm(array $form, FormStateInterface $form_state) {
   +      'muted' => [
   +        '#title' => $this->t('Muted'),
   +        '#type' => 'checkbox',
   +        '#default_value' => $this->getSetting('muted'),
   +      ],
   

   muted is already part of FileVideoFormatter so do we need to remove it from there. Ie is it relevant for Audio? It looks like it is - according to https://developer.mozilla.org/en-US/docs/Web/HTML/Element/audio. However as video already has the muted option moving this to the base formatter should be a separate issue from the playsinline work.

2. +++ b/core/modules/file/src/Plugin/Field/FieldFormatter/FileMediaFormatterBase.php
   @@ -56,6 +58,16 @@ public function settingsForm(array $form, FormStateInterface $form_state) {
   +      'playsinline' => [
   +        '#title' => $this->t('Plays Inline'),
   +        '#type' => 'checkbox',
   +        '#default_value' => $this->getSetting('playsinline'),
   +      ],
   

   This is not part of the audio spec but it is part of the video spec so it should be part of \Drupal\file\Plugin\Field\FieldFormatter\FileVideoFormatter and not on the base class.

3. As we're adding new defaults we need an update function to update existing configuration

@alexpott thank you for review.
Ii this patch I've made fixes 1 and 2 points form previous comment.
But I'm not sure that I got the 3d point.
Could you please provide more information about this point?
Thanks!

+++ b/core/modules/file/config/schema/file.schema.yml
@@ -86,7 +86,9 @@ file.formatter.media:
       label: 'Display of multiple files'
-
+    playsinline:
+      type: boolean
+      label: 'Plays inline'
 field.formatter.settings.file_audio:

Let's keep the blank line in between schemas it makes them easier to read.

Re #19.3 with this change if you have a videa media field and you go to the field formatter configuration screen after applying the code update and press save your configuration will change without you making any changes. That's because we're adding a new default setting - playsinline => FALSE. So we need a post update function similar to field_post_update_email_widget_size_setting() (only in D8 code) that sets this new setting to the default value - ie. FALSE. We'll also need a test for the update function.

+++ b/core/modules/file/config/schema/file.schema.yml
@@ -86,7 +86,9 @@ file.formatter.media:
     multiple_file_display_type:
       type: string
       label: 'Display of multiple files'
-
+    playsinline:
+      type: boolean
+      label: 'Plays inline'

Actually now playsinline is not part of the base class this change is not necessary.

Fixing the attribute prepartion for playsinline.

Fixed Cspell issue

Since there's #3090641: Add 'muted' configuration to audio field formatter. for the muted part, shouldn't we reduce the scope of this issue and concentrate just on the playsinline attribute?

I have tested the issue with drupal 9.5.x dev. Drupal 9.5.x alreday have muted option, but playsinline option is not there.After applying the patch #28, playsline shown the Format list. Adding Screenshots for the reference

Verified and tested patch #28 on Drupal 9.5.x-dev. Patch applied successfully and looks good to me.
Muted Checkbox was already present on 9.5.x. Screenshot is attached for reference:
Testing steps:
1. Install Media and Media Library module.
2. Navigate to Structure > Media Types > Edit Video.
3. Click on manage display.
4. Open the setting of the video file.
5. Observe the plays inline option is missing.
6. Apply the patch.
7. Observe that the Plays inline option appears.
Testing Result:
1. After applying the patch the plays inline checkbox along with muted checkbox is present.
Can be move to RTBC

back to RTbC. Patch in D 10.1.x is green

Random test failure.

Applying patch from #25 worked in my case as well. Tested on Drupal 9.5.

It is also worth noting that this functionality is crucial in accessibility. I was specifically searching for the solution because my videos refused to play on iphone devices. Having "autoplay" and "muted" is apparently not not enough for iphones and instead of at least showing the video with play button it simply decides to not render video at all, leaving the space blank. Adding "playsinline" from the patch actually solved the problem.

This will change exported configuration for field formatters, but there's no update to keep things in sync. Needs a post update to update configuration in the database, but also the same logic should happen in hook_ENTITY_TYPE_presave() to cover importing default configuration from modules and profiles. Quite a few examples in core to look at, views or any other updates for config entities implement similar patterns.

The issue title mentions muted, but the patch doesn't, should it? #3090641: Add 'muted' configuration to audio field formatter. is for the audio formatter, not the video one.

@catch muted is already configurable in the video formatter. I guess, it wasn't, when the issue was created

Updated issue title and summary

Muted is already added, this ticket was renamed to deliver only playsinline setting.

Patch #28 applies cleanly in 11.x. Let's review everything and finally merge

Looking at #28 noticed we will need an upgrade path + tests for the upgrade because of the schema changes.

Drupal 10.2.0 stable was released on: 16 Dec 2023 by: xjm
https://www.drupal.org/project/drupal/releases/10.2.0

Re-roled the patch to work with Drupal 10.2.0

Patch #49 worked for me
Drupal 10.2.1

Attached a static patch file for Drupal core 2024-06-20 10.3.x branch MR 8471, to use with composer patches

Patch #54 works for me on Drupal 10.3.6.

Added a post update hook and an entity presave as per #43.

The Needs Review Queue Bot tested this issue. It no longer applies to Drupal core. Therefore, this issue status is now "Needs work".

This does not mean that the patch necessarily needs to be re-rolled or the MR rebased. Read the Issue Summary, the issue tags and the latest discussion here to determine what needs to be done.

Consult the Drupal Contributor Guide to find step-by-step guides for working with issues.

Changed the post update hook to actually update the field formatter settings.

Tests are green ✅ Ready for reviews

Updated IS

Small comment around upgrade path tests.

Added upgrade test

All feedback for this one appears to be addressed.

Applied the MR locally

Shouldn't the 2 checkboxes for "Muted" and "Plays inline" be above "Display of multiple files". almost missed them.

Re-roll merge request #8472

Re #66: I agree that the 2 checkboxes should be moved, but since it concerns not only the new "Plays inline" box which this issue is about, but also the already existing "Muted", I'd vote for creating a separate issue for this to avoid scope creep.

We've been using this patch for a long time in various projects, and from my point of view, it is good to go.

Rebased and resolved merge conflict.

tests are there. See #65

Agree that moving the checkboxes should be a follow up. Muted is already in core.

Added new images for the issue summary, to make the situation clear what is going to change.

Still think the form should be correct before merging. So will leave for others.

@smustgrave it's not as simple as moving the fields around. We need to merge the output from the parent \Drupal\file\Plugin\Field\FieldFormatter\FileMediaFormatterBase::settingsForm(). Trying to splice it into the middle is going to make it pretty fragile imo.

I've rebased this on 11.x. In my view this is ready.

Won't hold it up, just feel the form could use some love. That was the only outstanding thing from me.

Saving issue credit.

diff --git a/core/modules/file/tests/fixtures/update/post_update_playsinline-3046152-node-article.yml b/core/modules/file/tests/fixtures/update/post_update_playsinline-3046152-node-article.yml
index 99f1ae397ec..8657e1c7667 100644
--- a/core/modules/file/tests/fixtures/update/post_update_playsinline-3046152-node-article.yml
+++ b/core/modules/file/tests/fixtures/update/post_update_playsinline-3046152-node-article.yml
@@ -1,3 +1,4 @@
+# cspell:ignore autoplay
 uuid: 93ccb838-5462-45ee-862a-988b9bdc6e0f
 langcode: en
 status: true

Fixed on commit. Unfortunately #3420570: Misspellings in words used in schema files and elsewhere incorrectly removed autoplay from the dictionary.

Committed 46281c6 and pushed to 11.x. Thanks!

This added a file_file_video_presave() hook, but that's not a thing at all, because there's no such thing as a file_video entity type. It's also a legacy hook function.

I guess this should be a entity_view_display_presave() hook that checks for something using that formatter, but that's a lot of complexity for something as banal as fixing up a missing key in default config.

Hmm. If it's not a hook then I assume it's not getting called. We already have a post-update hook for setting default values, so I guess it's dead code. Created a follow up #3533291: file_file_video_presave() attempts to update shipped configuration but doesn't work to remove.

It's a bug in the upgrade path, reclassified #3533291: file_file_video_presave() attempts to update shipped configuration but doesn't work as a critical bug.

Rerolling the patch against Drupal 10.5 for those still using Drupal 10.

The content is the same as the last commit merged into 11.x, so the latest comments still apply, I guess.