Hyper 8 Video System 0.18

Playlist

A playlist is, at its simplest, a directory that contains a file called playlist.eno that identifies it as a playlist:

my_playlist/                  <--- Playlist directory
└─ playlist.eno                 <--- Playlist manifest

The name of the directory (which may only contain alphanumeric characters, - and _) determines the permalink for the playlist, that is, the URL/web address under which the playlist will appear publicy on the web if you publish your site online.

Naturally, an empty playlist is not much of a playlist, so in reality you will have video directories inside the playlist directory as well, but note that the presence of video directories itself does not make the directory a playlist by itself, because by default a directory containing video directories will be interpreted as a Collection. The playlist.eno manifest is thus mandatory for every playlist.

Generally speaking, a playlist is a list of videos primarily intended for sequential playback.

The playlist.eno manifest

All options at a glance: banner, copy_link, description, download, embedding, link, offline, order, platform_integration, title, unlisted

Manifest for tagging and configuring a playlist.

banner:
description = Colorful flags in the wind
file = my_poster.jpg

download: enabled
embedding: enabled
offline
order: release_date_asc
platform_integration: link_previews
title: All episodes from the show
unlisted

link:
label = My Website
url = https://example.com

link:
label = My Social Media
url = https://social.example.com
verification = rel-me

-- description
This playlist includes all episodes from the show,
including the long-lost original three pilots.
-- description

banner

Heads up: This is implemented in the backend but not yet displayed in the interface.

banner:
description = Colorful flags in the wind
file = my_poster.jpg

copy_link

To disable the "Copy link" button for videos (by default it's enabled) you can use the copy_link option, with either enabled or disabled as value. This is inherited by videos, but can be changed on a granular basis in their manifests.

copy_link: disabled

description

Stand-alone URLs inside the description field are automatically converted to links, and you can additionally use markdown-style inline links such as [Example](https://example.com) to customize the text of a link (Note that no other markdown syntax is supported inside description though). Any number of empty lines in the description field separates paragraphs in the text.

download

This opt-in setting enables download buttons on video pages, openly inviting and allowing visitors to conveniently choose and download a specific version of a video to their computer.

download: enabled

Note that the absence of a download button (i.e. the default setting of this option) does not mean that it is not possible to download your videos - this is always easily possible for anyone with some technical knowledge. Enabling download buttons however is an invitation to your visitors that you want them to be easily able to do so, and inversely, not enabling it - as on every other website - simply implies that you do not openly invite downloads, and visitors will have to research or inquire about your video's license before making any use of it beyond watching it on your site.

embedding

This allows visitors/you to copy embed codes (html) that they/you can use to embed your videos on their/your own sites.

Embedding is disabled by default. If you want to enable it you also need to set the site's base_url (embeds work by displaying something from your site on another site, for this the other site needs to point to your site's address), and then set embedding: enabled, either at the collection, playlist or video level. If you set it enabled at the catalog or playlist level, you can also use disabled at a lower level to disable it again for specific playlists or videos.

embedding: enabled

link

Any number of link fields can be given. The label for a link is optional. The verification attribute refers to to the rel="me" mechanism, its value can be either rel-me to add the rel="me" attribute to the link or rel-me-hidden to add the attribute and additionally hide the link from the site, thereby making it only visible to servers that want to verify you are the owner of the site through this attribute.

link: https://example.com

link:
label = My Website
url = https://example.com

link:
label = My Social Media
url = https://social.example.com
verification = rel-me

offline

The offline flag, if given, indicates that the playlist should not be included in the built site, and therefore also not deployed to the server.

offline

order

The order field controls in which order the videos appear in the playlist on the site. By default, videos are first ordered by their sort_number ascending, falling back to release_date ascending if there are no sort numbers, and given neither of those the order will be random. This field can be set to one of the following:

order: release_date_asc

platform_integration

This opt-in feature adds metadata on your pages that is crawled and harvested by many platforms in order to present your page (when it is being linked to) using a uniform "card" design pattern inside social feeds and timelines.

To enable metadata that platforms use to generate link previews (this is based on Facebook's Open Graph protocol), specify the link_previews setting like this:

platform_integration: link_previews

To enable link previews plus additional metadata that lets platforms directly embed your audiovisual content into their timelines through embedded players (this utilizes Facebook's Open Graph protocol, "player card" metadata declarations that were originally introduced by twitter, as well as Hyper 8's native embed widgets) specify the content_embeds setting like this:

platform_integration: content_embeds

To disable this feature, either remove the option (it is disabled by default) or explicitly specify disabled if you want to override it somewhere:

platform_integration: disabled

title

The title of the playlist.

title: All episodes from the show

unlisted

The unlisted flag, if given, indicates that the playlist should not appear or be linked to on any of the public pages, i.e. only those that are given the link to them, will know of their existence.

unlisted
Next page: Video