Zorn

A custom video player tailored for MinPluto.

Installation

To install Zorn for your Astro project, run the following:

npm install @minpluto/zorn --registry https://npm.sudovanilla.org

Zorn uses icons from Iconoir using their Vue package, you'll need to integrate Astro's Vue package if you want to use the custom controls.

Learn how: https://docs.astro.build/en/guides/integrations-guide/vue/#manual-install

Examples

Basic Usage

Import Zorn from the package and add it to your page.

---
import {Zorn} from '@minpluto/zorn'
---

<Zorn
	Poster="https://md.sudovanilla.org/images/eay-p-v.jpg"
	Video="https://md.sudovanilla.org/videos/webm/Ennie-and-Yoyki.webm"
	CustomControls
	Milieu
/>

With Separated Audio Source

Since Zorn is built for the MinPluto project, there are scenarios where the video source has no audio to get higher quality options, so Zorn has an option to add a seprated audio source to include.

---
import {Zorn} from '@minpluto/zorn'
---

<Zorn
	Poster="https://md.sudovanilla.org/images/wote-p-v.jpeg"
	Video="https://ocean.sudovanilla.org/media/videos/The%20Mark%20On%20The%20Wall/1080.mp4"
	Audio="https://ocean.sudovanilla.org/media/videos/The%20Mark%20On%20The%20Wall/audio.mp4"
	CustomControls
	VideoAttributes="muted"
	AudioAttributes=""
/>

Make sure to add muted to the VideoAttributes option, just in case.

References

Title - Title

When the video enters fullscreen, the title of the video will appear in the upper left corner of the screen.

<Zorn Title="Ennie and Yoyki: Non-Girly Games"/>

Poster - Poster

Setting a thumbnail for the video player is done using the poster attribute. Just use a valid URL.

<Zorn Poster="https://example.org/media/thumbnail.webp"/>

Video Source - Video

The main part of the video player, is of course the video. You can set any video source you want, local or remote.

Local:

<Zorn Video="/media/video.webm"/>

Use the /public/ folder in your Astro project.

Remote:

<Zorn Video="https://example.org/media/video.webm"/>

Audio Source - Audio

If you're in a scenario where the video source is missing audio, but you do have the audio itself, you can add that audio source to the video player. A separated <audio/> element is used, this will use a sync function in JavaScript to make sure the video and audio are synced. As before with the video source, it can be local or remote.

Local:

<Zorn Audio="/media/audio.ogg"/>

Use the /public/ folder in your Astro project.

Remote:

<Zorn Audio="https://example.org/media/audio.ogg"/>

Settings Menu - SettingsMenu

If you want to add additional settings to the player, you can enable the Settings button and add your own menu and sub-menus.

To enable the menu, add the SettingsMenu option:

<Zorn SettingsMenu/>

Then, as a slot, add your menu like so:

<Zorn SettingsMenu>
	<div id="settings" class="vc-menu">
		<button>Stats for Geeks</button>
		<hr/>
		<button>Open Video URL <ArrowUpRight/></button>
		<button>Download <ArrowUpRight/></button>
		<button>Embed <ArrowUpRight/></button>
		<hr/>
		<button id="has-switch">Milieu <SwitchOn/></button>
		<button>Close Captions <NavArrowRight/></button>
	</div>
</Zorn>

Use OpenZornMenu() as the open menu function. You can use the scripts provided in /test/ of this package.

You can also add sub-menus with additional scripts you'll need to add:

<Zorn SettingsMenu>
	<div id="settings" class="vc-menu">
		<button>Stats for Geeks</button>
		<hr/>
		<button>Open Video URL <ArrowUpRight/></button>
		<button>Download <ArrowUpRight/></button>
		<button>Embed <ArrowUpRight/></button>
		<hr/>
		<button id="has-switch">Milieu <SwitchOn/></button>
		<button>Close Captions <NavArrowRight/></button>
		<button onclick="PlayerMenu_Quality()">Quality <NavArrowRight/></button>
	</div>
    <div id="quality-changer" class="vc-menu">
        <button onclick="OpenZornMenu()"><span style="display: flex; align-items: center;"><NavArrowLeft/> Back</span></button>
        <button>1080p</button>
        <button>720p</button>
        <button>360p</button>
    </div>
</Zorn>

<script is:inline>
    function PlayerMenu_HideAll() {
        document.querySelector('.vc-menu#settings').style.display = 'none'
        document.querySelector('.vc-menu#quality-changer').style.display = 'none'
		document.querySelector('#open-zorn-settings-button').setAttribute('onclick', 'OpenZornMenu()')
    }
    function OpenZornMenu() {
        PlayerMenu_HideAll()
        document.querySelector('.vc-menu#settings').style.display = 'flex'
		document.querySelector('#open-zorn-settings-button').setAttribute('onclick', 'PlayerMenu_HideAll()')
    }
    function PlayerMenu_Quality() {
        PlayerMenu_HideAll()
        document.querySelector('.vc-menu#quality-changer').style.display = 'flex'
    }
</script>

Attributes - VideoAttributes / AudioAttributes

If you need to add an addition attribute to either the video and/or audio source, then you can with VideoAttributes and AudioAttributes.

<Zorn VideoAttributes="muted" AudioAttributes={'download="media.ogg"'}/>

Milieu - Milieu

The Milieu option is an attempt to copy YouTube's ambient player feature. Where it adds a blurry glow around the player. This uses two <canvas/>s behind the player to make a smooth transition when it changes.

<Zorn Milieu/>

Live - Live

Zorn can stream .m3u8 content with HLS support added. The HLS support is only added if you add the Live option.

Just add the Live option with an .m3u8 source.

<Zorn Live Video="https://example.org/cats.m3u8"/>

Compatibility

Web Browsers

Browser	Live Streams	Player	CSS	JavaScript
Other Browsers
FOSS Browser	✅	✅	❌	✅
Ladybird	🔘	🔘	🔘	🔘
WebKit Browsers
Safari	🔘	🔘	🔘	🔘
GNOME Web	✅	✅	✅*N	✅
DuckDuckGo	🔘	🔘	🔘	🔘
Electron Browsers
Min	🔘	✅	✅	✅
Chromium Browsers
Brave	✅	✅	✅	✅
Chromium	✅	✅	✅	✅
Google Chrome	✅	✅	✅	✅
Microsoft Edge	✅	✅	✅	✅
Opera	✅	✅	✅	✅
Vivaldi	✅	✅	✅	✅
Yandex	✅	❌	✅	❌
Firefox Browsers
Falkon	✅	✅	✅	✅
Firefox	✅	✅	✅	✅
Floorp	✅	✅	✅	✅
GNU/IceCat	✅	✅	✅	✅*IC
Librewolf	✅	✅	✅	✅
Mull	✅	✅	✅	✅
Mullvad	✅	✅	✅	✅
Tor	🔘	🔘	🔘	🔘
Waterfox	✅	✅	✅	✅
Outdated Browsers
Internet Explorer	🔘	🔘	🔘	🔘

All browsers are tested as-is out of box. Some functions with ❌ can probably work if you tweak the settings or interact with a built-in extension.

IC: By default, GNU/IceCat has the LibreJS extension installed, it will block all JS by default if it does not provide a valid license. Examples for settings menu do not provide one nor one is shown in the test version.

N: The backdrop blur does not work. This should not affect the function of the video player.

To Do

• Support HLS (HTTP Live Streaming)
• Touch gestures for mobile