Skip to content

04. Settings for the Audio player

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

If you enable any mixin, (like Jonnitto.PrettyEmbedHelper:Mixin.Loop) 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.

Controls

If true, the browser will offer controls to allow the user to control audio playback, including volume, seeking, and pause/resume playback.

Jonnitto:
  PrettyEmbed:
    Audio:
      controls: false

Looping the audio

Whether to restart the audio automatically after reaching the end.

Jonnitto:
  PrettyEmbed:
    Audio:
      loop: false

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

Preload audio

This enumerated attribute is intended to provide a hint to the browser about what the author thinks will lead to the best user experience with regards to what content is loaded before the audio is played. It may have one of the following values:

none
Indicates that the audio should not be preloaded.

metadata
Indicates that only audio metadata (e.g. length) is fetched.

auto
Indicates that the whole audio file can be downloaded, even if the user is not expected to use it

Jonnitto:
  PrettyEmbed:
    Audio:
      preload: none

Crossorigin

This enumerated attribute indicates whether to use CORS to fetch the related audio. The allowed values are:

anonymous
Sends a cross-origin request without a credential. In other words, it sends the Origin: HTTP header without a cookie, X.509 certificate, or performing HTTP Basic authentication. If the server does not give credentials to the origin site (by not setting the Access-Control-Allow-Origin: HTTP header), the resource will be tainted, and its usage restricted.

use-credentials
Sends a cross-origin request with a credential. In other words, it sends the Origin: HTTP header with a cookie, a certificate, or performing HTTP Basic authentication. If the server does not give credentials to the origin site (through Access-Control-Allow-Credentials: HTTP header), the resource will be tainted and its usage restricted.

true
Setting the attribute name to an empty value, like crossorigin or crossorigin="", is the same as anonymous.

false
When not present, the resource is fetched without a CORS request.

Jonnitto:
  PrettyEmbed:
    Audio:
      crossorigin: false