Documentation Index

Fetch the complete documentation index at: https://documentation.deltatre.com/llms.txt

Use this file to discover all available pages before exploring further.

VESPER Playlist modules

Prev Next

Editorial purpose

The VESPER playlist modules present a curated set of VODs grouped as a playlist.

Module variants

Native Support for VESPER Geo-Blocking

These modules provide native support for VESPER geo-blocking. Any entity marked as geo-blocked is automatically excluded from the list.

  • Vesper Playlist: Displays a VESPER Playlist. Use Vesper playlist to render the playlist detail page, where users can view playlist metadata and browse the videos in that playlist.

    Subscription-related module

    When a subscription or user login is needed to access the playlist, this module presents a stepper within a full-screen dialog, featuring the brand logo in the upper left corner.

    Either the Subscription Logo Tag parameter or, when this parameter is empty, or the Account Subscription Logo Tag metadata sets the logo.

  • Vesper Playlist Row: Displays a VESPER Playlist in a row format. Use Vesper playlist row to promote a playlist within a page section, using a horizontal row of cards that lets users discover playlist content from landing pages or related-content areas.

Standard parameters

Common parameters

  • Visual

    • Hide module: Toggle on to temporarily prevent the module from displaying in the front end.

    • Color schema: Specify whether the module appears in light or dark mode. Allowed values: Light and Dark.

    • Remove top spacing: Toggle on to remove top spacing from the module.

    • Remove bottom spacing: Toggle on to remove bottom spacing from the module.

  • Animation

    • Enable animation: Toggle on to enable module animation.

  • Sponsor

    • Sponsor label: Label displayed for the sponsor, such as “Presented by” or “Sponsored by”.

  • Data

    • Slug:

      • For Vesper playlist: Slug of the Vesper playlist entity that feeds the module.

      • For Vesper playlist row: Slug of the Vesper playlist that feeds the row module.

  • Link rules (aka Navigation Rules)

Vesper Playlist

Required page structure

Playlist detail view: ~/folder/{playlistid}/index

Playlist detail view with video player full screen for video detail: ~/folder/{playlistid}/watch/{videoid}

In the structure above, you can change only the watch folder name by setting the new name in the Path Folder for Video Detail parameter.

Required navigation rules (aka link rules)

Entity → vesper-playlist

Attribute → fields.playlistid has a value

Page → e.g. ~/vesper/playlists/{playlistid}/index

  • Visual

    • Hide tags: Toggle on to hide the tags.

    • Hide ShareBar: Toggle on to hide the share bar.

    • Subscription Logo Tag: Tag for the GAD asset that serves as the logo in the upper left corner of the subscription stepper.

  • Data

    • Vesper playlist video videoId: Video ID of one of the videos in the playlist. When configured, the specified video automatically opens in the video detail view in full screen on top of the playlist detail.

  • SEO

    • Prevent setting metadata: Toggle on to prevent overriding setting metadata.

    • Title heading level: Select the heading level used for the title in the front end. Allowed values: H1, H2, H3, H4, and H5. The default value is H2, or H1 when Prevent setting metadata is not enabled.

Vesper Playlist Row

  • Visual

    • Full screen view: Toggle on to display the module in full-screen view.

    • Background image from GAD: Specify the tag of the GAD asset to use as the background image.

    • Background image from GAD for not desktop view: Specify the tag of the GAD asset to use as the background image for non-desktop views. This overrides Background image from GAD for those views.

    • Add background image fade effect from the background color if the image not fill all the area. Works only if the background image is set from the GAD.: Toggle on to add a fade effect from the background color to the background image when the image does not fill the available area.

    • Remove default Forge background image. If not set, the default Forge background image will be used when no background image is set from the GAD.: Toggle on to remove the default Forge background image.

    • Card size: Select the card size. Available values are Small, Medium default, and Large.

    • Card aspect ratio: Select the card aspect ratio. Allowed values: 1/1, 2/3 (default), and 16/9.

  • SEO & Accessibility

    • Header title heading level: Select the heading level used for the header title in the front end. Allowed values: H1, H2 (default), H3, H4, and H5.

    • Remove background image opacity: Toggle on to display the background image without opacity. Use this option carefully to keep text readable against the background image.

  • Sponsor

    • Sponsor asset: Slug of the sponsor entity used to retrieve the sponsor image and URL.