diff --git a/src/docs/reference/03 Video.md b/src/docs/reference/03 Video.md new file mode 100644 index 0000000..c5830be --- /dev/null +++ b/src/docs/reference/03 Video.md @@ -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. \ No newline at end of file diff --git a/src/docs/reference/03 video.eno.md b/src/docs/reference/03 video.eno.md deleted file mode 100644 index 38ef328..0000000 --- a/src/docs/reference/03 video.eno.md +++ /dev/null @@ -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. \ No newline at end of file