Skip to content

04. Settings for the Vimeo player

Jon Uhlmann edited this page Dec 12, 2023 · 1 revision

If you enable any mixin, (like Jonnitto.PrettyEmbedHelper:Mixin.Controls) the settings will take no effect and the editor can choose it by himself. Of course, you can also add properties if you are missing a setting option. The property just needs to have the same name as the key in Settings.Jonnitto.yaml. It will then be activated automatically. No Fusion needs to be adapted for this.

GDPR message

You can alter the behavior on how the player should handle GDPR

If you set it to false no message will get shown, and the player starts the video immediately, if you set it to popup, the player open a popup with the link to the embedded player. The link will open with the rel="noopener external" attribute. Also will to popup set to the center of the window. So it is a kind of fake lightbox. If you set it true (default value), a message will be shown. If the user accept it, the player will start. But he will also get the chance to open the video in a new window. This link has the same behavior as the popup.

This is how the player look like without controls:

Screenshot of the GDPR message

On mouseover, a pause button will be shown

Jonnitto:
  PrettyEmbed:
    Vimeo:
      gdprHandling: true

Color of the playback controls

The hexadecimal accent color value of the playback controls, which is normally 00ADEF. The embed settings of the video might override this value.

Example: Set color to the Neos blue

Jonnitto:
  PrettyEmbed:
    Vimeo:
      color: 00adee

Controls

Whether to display the player's interactive elements, including the play bar and sharing buttons. Set this option to false for a chromeless experience.

Screenshot of the player without controls
Jonnitto:
  PrettyEmbed:
    Vimeo:
      controls: false

You can also enable the mixin Jonnitto.PrettyEmbedHelper:Mixin.Controls to let the editor choose.

Background mode

Whether the player is in background mode, which hides the playback controls, enables autoplay, and loops the video.

Jonnitto:
  PrettyEmbed:
    Vimeo:
      background: false

Looping the video

Whether to restart the video automatically after reaching the end.

Jonnitto:
  PrettyEmbed:
    Vimeo:
      loop: false

You can also enable the mixin Jonnitto.PrettyEmbedHelper:Mixin.Loop to let the editor choose.

Open video in a lightbox

Should the video be opened on a lightbox? Per default this is set via the node properties and the mixin Jonnitto.PrettyEmbedHelper:Mixin.Lightbox

Screenshot of a video opened in the lightbox
Jonnitto:
  PrettyEmbed:
    Vimeo:
      lightbox: false

Preserve aspect ratio (only on lightbox mode)

Sets if the image should preserve his aspect ratio when the lightbox is set. Per default this is set via the node properties and the mixin Jonnitto.PrettyEmbedHelper:Mixin.PreserveAspectRatio

Jonnitto:
  PrettyEmbed:
    Vimeo:
      preserveAspectRatio: true

Fallback aspect ratio

If no aspect ratio can be calcualted from the oembed service, you have the possibility to set a fallback aspect ratio.

Jonnitto:
  PrettyEmbed:
    Vimeo:
      fallbackAspectRatio: '16 / 9'