eessppeelllloo/hyper8
1
0
Fork 0
mirror of https://codeberg.org/simonrepp/hyper8.git synced 2026-08-14 13:45:27 +02:00
Code Issues Packages Projects Releases Wiki Activity

Improve video documentation

Browse Source
This commit is contained in:
Simon Repp
2024-03-23 21:07:03 +01:00
parent 1690ceb665
commit 0e4d7627ac
2 changed files with 54 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/docs/reference/03 Video.md
+54
View File
@@ -0,0 +1,54 @@
# Video
A video in Hyper 8 is, at its simplest, represented by a directory
that contains a single video file:
```
my_video/ <--- Video directory
└─ original.mp4 <--- Video file
```
The name of the directory (which may only contain alphanumeric characters, `-`
and `_`) determines the permalink for the video, that is, the URL/web address
under which the video will appear publicy on the web if you publish your site
online.
More widely speaking, a *video* in Hyper 8 is a single video-based media
artifact that can be (re)presented through different video (but also audio)
files to cover a range of qualities/formats. It can also be augmented with
subtitle files and a *poster* image that is shown in thumbnails and before
the video is played back. In fact, if there is on *poster* image, Hyper 8
will compute one automatically (by taking a frame from the video), always.
## Video files
Currently the extensions `m4v`, `mp4`, `mkv`, `mov` are supported.
## Subtitle files
Currently the extensions `srt` and `vtt` are supported.
By naming your subtitle files with a language code (in BCP 47 format), Hyper 8 can
automatically determine its language, for instance `en.srt` would indicate english
subtitles while `fr.vtt` would indicate french subtitles.
## The video.eno manifest
Manifest for tagging and configuring a video, which can be placed inside the
video directory. A video directory can be identified as a video directory
also by just placing a `video.eno` file inside it, regardless of whether
there is even already a video file in it.
```eno
poster:
file = episode_1.jpg
title: The pilot episode of the show
unlisted
-- description
An unsettling truth comes to light as three old friends
reunite at an unexpected gathering.
-- description
```
The `description` field supports markdown.
src/docs/reference/03 video.eno.md
-18
View File
@@ -1,18 +0,0 @@
# video.eno
Manifest for tagging and configuring a video, that is, a single video-based
media artifact that can be (re)presented through different video (but also audio)
files to cover a range of qualities/formats.
```eno
poster: episode_1.jpg
title: The pilot episode of the show
unlisted
-- description
An unsettling truth comes to light as three old friends
reunite at an unexpected gathering.
-- description
```
The `description` field supports markdown.