FriendsOfREDAXO / Plyr

REDAXO-AddOn: Plyr

Das AddOn stellt den Video-/Audio-Player Plyr zur Verfügung.

Es können lokale Audio-Dateien (mp3), Videos und Youtube- sowie Vimeo-Videos eingebunden werden.
Wir haben uns bewusst gegen eine automatische Einbindung im Frontend entschieden um dem Entwickler alle Freiheiten zu lassen.

AddOn Features

• REX_PLYR[] Variable zur schnellen Ausgabe in einem Modul
• Statische PHP Methode zur Ausgabe des Videos
• Einbindung des Players im Backend
• Plyr bindet sich in die Detailseite des Medienpools ein
• Methoden zur Ermittlung des Videotyps
• Controls können je Ausgabe definiert werden
• Kein JQuery benötigt

Einbindung im Frontend

Die nötigen Dateien findet man im Assets-Ordner. Eigene CSS und JS sollten nach Möglichkeit an anderer Stelle abgelegt werden um Probleme nach einem Update zu vermeiden.

Plyr benötigigt 2 JS-Dateien und eine CSS. In der plyr_video.js wird der Player initialisiert.

CSS für Plyr

<link rel="stylesheet" href="<?= rex_url::base('assets/addons/plyr/vendor/plyr/dist/plyr.css') ?>">

JS für Plyr

<script src="<?= rex_url::base('assets/addons/plyr/vendor/plyr/dist/plyr.min.js') ?>"></script>
<script src="<?= rex_url::base('assets/addons/plyr/plyr_init.js') ?>"></script>

Alle Infos zur Konfiguration der Skripte oder der Controls der nachfolgenden Ausgaben, finden sich auf der GitHub-Site von Plyr.

Modul-Beispiel, hier mit MFORM CustomLink

Eingabe

$mform = new MForm();
$mform->addFieldset("Video");
$mform->addCustomLinkField("1", array('label'=>'Video', 'data-tel'=>'disable', 'data-mailto'=>'disable', 'data-formlink'=>'disable', 'data-intern'=>'disable'));
$mform->addMediaField(1, array('label'=>'Image'));
echo $mform->show();

Ausgabe über rex_plyr::outputMedia

$media = rex_plyr::outputMedia($url,$controls,$poster);

Beispiel:

$media = rex_plyr::outputMedia('REX_VALUE[1]','play-large,play,progress,airplay,pip','/media/cover/REX_MEDIA[1]');

Bei Medien aus dem Medienpool muss nur der Dateiname angegeben werden. Bei Youtube und Vimeo immer die vollständige URL. Diese Methode bietet sich an um evtl. mehrere Videos z.B. aus einer Datenbank oder Medialist zu verarbeiten.

Alternative Ausgabe per REX_PLYR

REX_PLYR[1]

oder mit Konfiguration der Player-Elemente:

REX_PLYR[id=1 controls="play,progress" poster="/media/poster.jpg"]

Alternative init.js

zur Änderung der Vollbildanzeige bei Orientierungsänderung des Geräts

document.addEventListener("DOMContentLoaded", function(){
const players = Plyr.setup('.rex-plyr',{
youtube: {
noCookie: true
},
fullscreen: {
enabled: true,
fallback: true,
iosNative: false }
});
});

const players = new Plyr('.rex-plyr');
players.on('play', event => {
const instance = event.detail.plyr;

screen.orientation.addEventListener("change", function() {
if(screen.orientation.type = 'landscape-primary') {
players.fullscreen.enter();
}
if(screen.orientation.type = 'portrait-primary') {
players.fullscreen.exit();
}
}, false);

window.addEventListener('orientationchange', function() {
if (window.orientation & 2) {
players.fullscreen.enter();
} else {
players.fullscreen.exit();
}

});

});

Hilfsmethoden in der rex_plyr class

checkUrl($url) Gibt sofern es sich um eine Mediapool-Datei handelt die URL zum Medium zurück.

checkYoutube($url) Prüft ob es sich um eine Youtube-URL handelt

getYoutubeId($url) Ermittelt die Youtube-ID eines Videos

checkVimeo($url) Prüft ob es sich um eine Vimeo-URL handelt

getVimeoId($url) Ermittelt die Vimeo-Id eines Videos

checkMedia($url) Überprüft ob es sich um ein MP4-Video aus dem Medienpool handelt

checkExternalMp4($url) Überprüft ob ein externes MP4-Video verlinkt ist.

checkVideo($url) Überprüft ob es sich um eine Video-Datei / eine Video-Url handelt die plyr abspielen kann.

checkAudio($url) Überprüft ob es sich um eine MP3-Audio-Datei aus dem Medienpool handelt

Beispiel

$plyr = new rex_plyr();
$id = $plyr->checkMedia($url);

Bugtracker

Du hast einen Fehler gefunden oder ein nettes Feature parat? Lege ein Issue an. Bevor du ein neues Issue erstellst, suche bitte ob bereits eines mit deinem Anliegen existiert.

Lizenz

siehe LICENSE.md

Plyr und Afterglow stehen unter MIT-Lizenz. Die Player bedienen sich jedoch teils unterschiedlicher Quellen, deren Lizenzen sich unterscheiden können.

Autor

Friends Of REDAXO

• http://www.redaxo.org
• https://github.com/FriendsOfREDAXO

Projekt-Lead Thomas Skerbis

Credits:

First Release: Christian Gehrke