REDAXO-AddOn: Plyr

🚨 Die Entwicklung dieses AddOns wurde eingestellt und wurde daher archiviert.

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

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

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.

Ausgabe eines Mediums

Die Ausgabe erfolgt über die Methode outputMedia().

Einzelmedium:

echo rex_plyr::outputMedia($fileOrUrl,$config,$poster);

oder über die REX_VALUE für Einzelmedien:

REX_PLYR[id=1 controls="play,progress"]

PlayLists werden wie folgt ausgegeben:

rex_plyr::outputMediaPlaylist($media_filenames,$setup)

Standard-Player

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ötigt 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 weiteren Infos zur Konfiguration der Skripte oder der Controls der Ausgaben, finden sich auf der GitHub-Site von Plyr.

Einfaches Modulbeispiel für lokale Videos mit Poster

Eingabe

<div class="form-horizontal">
    <div class="form-group">
        <label class="col-sm-2 control-label">Video</label>
            <div class="col-sm-10">
                 REX_MEDIA[id=1 widget=1 types=mp4]
            </div>
    </div>
    <div class="form-group">
        <label class="col-sm-2 control-label">Vorschaubild (optional)</label>
            <div class="col-sm-10">
                 REX_MEDIA[id=2 widget=1 types=jpg]
            </div>
    </div>       
</div>  

Ausgabe

<?php
$preview = $out = '';
if ('REX_MEDIA[2]'!='')
{
    $preview = rex_media_manager::getUrl('video_cover','REX_MEDIA[2]'); 
}
echo rex_plyr::outputMedia('REX_MEDIA[1]','play-large,play,fullscreen,mute,volume,progress,airplay,pip,nopreload',$preview);
?>

Modul-Beispiel mit MFORM CustomLink für externe und lokale Videos

Das CustomLink-Widget bietet sich an, weil die Redaktion damit lokale und externe Medien verlinken kann.

Eingabe

// mform ab 7.0 
$mform = MForm::factory()
->addFieldsetArea('Video', MForm::factory()
->addCustomLinkField("1", array('label'=>'Medium', 'data-tel'=>'disable', 'data-mailto'=>'disable', 'data-formlink'=>'disable', 'data-intern'=>'disable'))
->addMediaField(1, array('label'=>'Image'))
);
echo $mform->show();

Ausgabe über rex_plyr::outputMedia

echo rex_plyr::outputMedia('REX_VALUE[1]','play-large,play,fullscreen,mute,volume,progress,airplay,pip,autoplay,loop,nopreload','/media/cover/REX_MEDIA[1]');

Beispiel mit allen Parametern, die nicht gewünschten Parameter bitte entfernen

Playlist-Player

CSS für Playlist

Falls nicht bereits schon eingebunden:

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

und zusätzlich:

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

JS für Playlists

JS für Plyr Playlist lautet anders

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

Modul-Eingabe Playlist

REX_MEDIALIST[id="1" type="mp3,mp4" widget="1"]

Modul-Ausgabe Playlist

Die Ausgabe erfolgt über rex_plyr::outputMediaPlaylist

Modul-Ausgabe

$media_filenames = preg_grep('/^\s*$/s', explode(",", REX_MEDIALIST[1]), PREG_GREP_INVERT);
echo rex_plyr::outputMediaPlaylist($media_filenames,'play-large,play,progress,airplay,pip');

Plyr und Consent-Abfragen für Youtube und Vimeo

Das AddOn bietet Hilfs-Methoden zur Ausgabe von Consent-Meldungen an.

$video = rex_plyr::consent($url = '', $setup = null, $poster = null, $return_when_empty = '')

Prüft die Angegebene Url und gibt einen Consent Hinweis aus, wenn es sich um ein Vimeo- oder Youtube-Video handelt.
Die Ausgabe erfolgt über das Fragment consent.php. Es können Parameter zur Konfiguration der Player mitgegeben werden. Wird für $return_when_empty als Wert cke5 eingegeben wird bei nicht erfolgter Prüfung das originale oembed zurückgegeben.

$content = rex_plyr::oembed_replace(oembed_replace($string, $setup = null)) 

Ersetzt sofern zutreffend, Youtube und Vimeo- OEMBED-Tags vom CKE5 durch Plyr-Code und setzt die Consentmeldungen. Es können Parameter zur Konfiguration der Player mitgegeben werden.

rex_plyr::cke_oembed_helper($setup = null); 

Ruft einen Outputfilter auf der alle gefundenen CKE5-OEMBEDs in der Ausgabe ersetzt.

Im Consent-Manager muss beim jeweiligen Cookie das passende Script eingesetzt werden. Die nachfolgenden functions sollten auch nach einem Ajax request ausgeführt werden.

Vimeo Consent-Script

<script>
function setupPlyrVm() {
const playersvimeo = Plyr.setup('.rex-plyr_consent_vimeo', {
        youtube: {
            noCookie: true
        },
        vimeo: {
            dnt: false
        },
        iconUrl: '/assets/addons/plyr/vendor/plyr/dist/plyr.svg',
        blankVideo: '/assets/addons/plyr/vendor/plyr/dist/blank.mp4'
    });
    if (document.querySelector('.rex-plyr_consent_vimeo')) {
        playersvimeo.forEach(function (player) {
            player.on('play', function () {
                var others = playersvimeo.filter(other => other != player)
                others.forEach(function (other) {
                    other.pause();
                })
            });
        });
    }
 }
 setupPlyrVm();
</script>

Youtube Consent-Script

<script>
function setupPlyrYt() {
    const playersyoutube = Plyr.setup('.rex-plyr_consent_youtube', {
        youtube: {
            noCookie: true,
        },
        iconUrl: '/assets/addons/plyr/vendor/plyr/dist/plyr.svg'
    });
    if (document.querySelector('.rex-plyr_consent_youtube')) {
        playersyoutube.forEach(function (player) {
            player.on('play', function () {
                var others = playersyoutube.filter(other => other != player)
                others.forEach(function (other) {
                    other.pause();
                })
            });
        });
    }

}
setupPlyrYt();
    
</script>

CSS-Helferlein für Consent-Platzhalter

Ermöglicht den Platzhalter im 16:9-Format darzustellen.

 .aspect-ratio-16-9 {
  display: flow-root;
  position: relative;
}

.aspect-ratio-16-9::before {
  content: '';
  float: left;
  padding-bottom: 56.25%;
}

REX_PLYR

REX_PLYR nimmt eine einfache REX_VAR an. z.B. REX_VALUE[1] aus der Moduleingabe wäre in der Ausgabe REX_PLYR[1] Es nimmt keine REX_MEDIA Daten an. Daher empfiehlt sich dafür als Eingabe Custom URL Widget aus mform. Damit kann man Medien und Urls einfach übergeben.

Zur Ausgabe einzelner Medien steht auch eine REDAXO-Variable zur Verfügung.

REX_PLYR[1]

oder mit Konfiguration der Controls:

REX_PLYR[id=1 controls="play,progress"]

init.js Orientierungsänderung Beispiel:

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

document.addEventListener("DOMContentLoaded", function () {
    const players = Plyr.setup('.rex-plyr', {
        youtube: {
            noCookie: true
        },
        iconUrl: '/assets/addons/plyr/vendor/plyr/dist/plyr.svg',
        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();
        }

    });

});

youtube vimeo playlist

Erlaubt das gemischte Abspielen von Youtube und Vimeo-Videos.

Beipspiel für Bootstrap 4

CSS

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

und zusätzlich:

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

JS

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

• JQuery wird benötigt.

Modul

Eingabe

<?php 
$id = 1;
$mform = MForm::factory()
    ->addFieldsetArea('Video-Liste', MForm::factory()
    ->addCustomLinkField("$id.0.1", ['label' => 'Link', 'data-media'=>'disable', 'data-mailto'=>'disable', 'data-intern'=>'disable','data-extern'=>'enable'])
    ->addTextField("$id.0.title", array('label'=>'titel'))
    );
echo MBlock::show($id, $mform->show(), array('min'=>1,'max'=>40)); 

Ausgabe

<?php 
$data = rex_var::toArray("REX_VALUE[1]"); 
$video1 = $playlist = '';
foreach ($data as $value) {
 
   if ($video1 == '') {
      $video1 = $value[1];
   }
    
   $playlist .= '{
        type: "vimeo",
        title: "'.$value['title'].'",
        author: "",
        sources: [{
            src: "'.$value[1].'",
            type: "vimeo"
        }],
        poster: ""
    },';
    
    
}    

?>


<div class="container-fluid">
<div class="row">

  <div id="player1-REX_SLICE_ID" class="player order-md-first order-lg-last col-sm-12 col-md-7">
    <div class="js-player-REX_SLICE_ID" data-plyr-provider="vimeo" data-plyr-embed-id="<?=$video1?>" data-plyr-config='{"controls":["play","progress","airplay","pip","volume","mute","fullscreen"]}'>     
   </div>
  </div>

  </div>  
  </div>  

<script>
var waitForJQuery = setInterval(function () {
    if (typeof $ != 'undefined') {


/* PLAYLIST  */
$(document).ready(function () {
var myPlaylist = [
 <?php echo $playlist; ?>
];

var target = ".js-player-REX_SLICE_ID";
var id = '#player1-REX_SLICE_ID';
var listclass = "col-sm-12 col-md-5";
var limit = 30;


    loadPlaylist(target, myPlaylist, id, listclass, limit);  // LOAD VIDEO LIST

}); 
 clearInterval(waitForJQuery);
    }
}, 10);

</script>    

Methoden in der rex_plyr class

rex_plyr::outputMedia($url,$setup,$poster,$consent) Erstellt einen Player annhand einer Mediendatei oder URL.

rex_plyr::outputMediaPlaylist($media_filenames,$setup) Erstellt eine Playlist anhand des übergebenen Arrays

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);

Tricks

Sobald ich ein Poster einblende und "nopreload" nicht(!) ausgewählt ist, wird in Safari kein Poster angezeigt. Lässt sich mit dem folgenden Fix beheben: <style>.plyr__video-wrapper{z-index: 0;}</style>

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 steht 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 PlayLists: Tobias Krais