Plugin Parameter
Das Plugin kann auf zwei Arten parametrisiert werden: Zunächst können in der Administrations-Oberfläche des Plugins die global gültigen Einstellungen vorgenommen werden. Diese Einstellungen gelten dann als Vorgaben für alle auf der Site eingebetteten Medien. Darüber hinaus können diese globalen Vorgaben individuell in jedem Tag überschrieben werden. Um Parameter individuell in einem Tag zu überschreiben, fügt man diese - getrennt durch Leerzeichen - innerhalb des ersten Teils des Tags ein: {flv width="180" height="150" autostart="true"}party{/flv}. Hierbei ist stets ein kleingeschriebener Attributs-Name, gefolgt von einem Gleichheitszeichen, gefolgt von dem Wert des Attributs in Doppelten Anführungszeichen zu verwenden.
Die folgende Tabelle listet die unterstützen Parameter (wie in der Administrations-Oberfläche angezeigt), die zugehörigen Attributs-Namen (Den Namen, der beim Überschreiben des Parameters zu verwenden ist.) sowie die möglichen Werte auf. Wie in der Tabelle der unterstützten lokalen Dateiformate beschrieben, werden für diverse Formate unterschiedliche Player verwendet. Der einzige Player welcher alle aufgelisteten Parameter unterstützt ist der JW Media Player. Alle anderen Player unterstützen üblicher Weise nur width, height sowie autoplay. Der YouTube Player stellt hier eine Ausnahme dar: Er unterstützt einige spezielle Attribute, welche in der Tabelle am Ende dieser Seite beschrieben werden. Anmerkung: Einige spezielle Attribute sind nicht in der Administrations-Oberfläche verfügbar, sondern können nur innerhalb eines Tags gesetzt werden. Diese Attribute werden in den anschliessenden Anmerkungen erläutert.
| Globale Sektion | Globaler Parameter-Name | Attribut-Name | Werte |
|---|---|---|---|
| Plugin-Parameter | Container Klasse | avcss | Beliebiger Klassen-Name |
| Plugin-Parameter | Standard Videobreite | width | Ein Pixelwert |
| Plugin-Parameter | Standard Videohöhe | height | Ein Pixelwert |
| Plugin-Parameter | iFilm Videobreite | iwidth | Ein Pixelwert |
| Plugin-Parameter | iFilm Videohöhe | iheight | Ein Pixelwert |
| Plugin-Parameter | Metacafe Videobreite | mwidth | Ein Pixelwert |
| Plugin-Parameter | Metacafe Videohöhe | mheight | Ein Pixelwert |
| Plugin-Parameter | Flash Anzeigemodus | wmode | window, transparent oder opaque |
| Plugin-Parameter | Flash Hintergrundfarbe | bgcolor | Ein Farbwert 1) |
| Plugin-Parameter | Standard Audioplayerbreite | awidth | Ein Pixelwert |
| Plugin-Parameter | Standard Audioplayerhöhe | aheight | Ein Pixelwert |
| Erweiterte Parameter | Bedienfeldfarbe | pbgcolor | Ein Farbwert 1) |
| Erweiterte Parameter | Bedienfeld-Textfarbe | pfgcolor | Ein Farbwert 1) |
| Erweiterte Parameter | Bedienfeld-Aktiv-Farbe | phicolor | Ein Farbwert 1) |
| Erweiterte Parameter | Videohintergrund | psccolor | Ein Farbwert 1) |
| Erweiterte Parameter | Autostart | autostart | true oder false |
| Erweiterte Parameters | Zeige Bedienfeld | shownav | true oder false |
| Erweiterte Parameter | Zeige Timer | showdigits | true oder false |
| Erweiterte Parameter | Zeige Symbole | showicons | true oder false |
| Erweiterte Parameter | Zeige Stop | showstop | true oder false |
| Erweiterte Parameter | Zeige Download | showdownload | true oder false 7) |
| Erweiterte Parameter | Zeige Vollbild-Knopf | usefullscreen | true oder false |
| Erweiterte Parameter | Scriptfähig | enablejs | true oder false 5) |
| Erweiterte Parameter | Logo | logo | Eine URL oder ein relativer Pfad 2) |
| Erweiterte Parameter | Video Anzeigemodus | screenmode | Ein Modus-Bezeichner 3) |
| Erweiterte Parameter | Playlist Größe | plsize | Ein Pixelwert 3) |
| Erweiterte Parameter | Inhalt anpassen | stretch | 0, 1, 2 oder 3 4) |
| Erweiterte Parameter | Minimale Flash Version | flashver | Drei Zahlen, getrennt durch Punkte 10) |
| Erweiterte Parameter | Zeige Equalizer | showeq | true oder false |
| Erweiterte Parameter | Zeige Suchfeld | searchbar | true oder false |
| Erweiterte Parameter | Such-Provider | searchlink | URL 12) |
| Erweiterte Parameter | Alternativ-Inhalt | alt | Beliebiger gültiger HTML-Code 13) |
| - | - | cfg | Eine URL 6) |
| - | - | displaywidth | Ein Pixelwert 3) |
| - | - | displayheight | Ein Pixelwert 3) |
| - | - | divid | Beliebige ID-Zeichenkette 5) |
| - | - | link | Eine URL 7) |
| - | - | linkfromdisplay | true oder false 7) |
| - | - | linktarget | Ein Fenstername (z.B. _blank) 7) |
| - | - | plthumbs | true oder false 8) |
| - | - | type | Ein Dateityp 9) |
| - | - | repeat | false, true oder list 8) |
| - | - | shuffle | true oder false 8) |
| - | - | autoscroll | true oder false 8) |
| - | - | recurl | Eine URL 11) |
| - | - | img | Eine URL 14) |
| - | - | volume | int 15) |
| - | - | menu | true oder false 16) |
| - | - | popup | true oder false 17) |
Anmerkungen:
1. Farbwerte können in einem der drei folgenden Formate angegeben werden und werden automatisch in das jeweils nötige Zielformat konvertiert:
- Ein 6-stelliger Hexadezimalwert mit vorangestelltem Hashzeichen (z.B.: #223344 wie in normaler HTML Syntax üblich)
- Ein 3-stelliger Hexadezimalwert mit vorangestelltem Hashzeichen (z.B.: #234 wie in CSS Kurznotation)
- Das Wort rgb, gefolgt von 3 Dezimalwerten im runden Klammern, getrennt durch Komma (z.B.: rgb(99,140,235) - wie in CSS rgb-Syntax)
- Ein 1-6-stelliger Hexadezimalwert, mit vorangestelltem 0x (z.B.: 0x2345 wie in JavaScript)
- Einer der 16 standardisierten Farbnamen wie in HTML 4.0.1 spezifiziert (z.B.: red)
2. Logos können entweder durch eine absolute URL (z.B.: http://host/logo.png) oder - falls lokal auf dem Server verfügbar - durch ihren lokalen Pfad (z.B.: /images/stories/logo2.png) spezifiziert werden. Das Logo sollte entweder ein PNG- (vorzugsweise) oder ein GIF-Bild sein, damit Transparenz unterstützt wird. Das Logo wird stets in der oberen, rechten Ecke des Videos eingeblendet. Wenn Sie eine andere Positionierung wünschen, kann diese Limitation durch Verwendung eines grösseren Bildes dessen oberer, rechter Bereich transparent gehalten wird, umgangen werden.
3. Das Attribut screenmode hat eine spezielle Bedeutung. Es stellt keinen eigentlichen Parameter für den JW MediaPlayer dar, sondern dient als Kürzel welches die Parameter displaywidth und displayheight des Players beeinflusst. (Diese beiden Parameter geben die Leinwandgrösse des Players an.) Die folgenden Modi sind verfügbar:
| Modus | Beschreibung | |
|---|---|---|
| default | Dieser Modus resultiert im Standard-Erscheinungsbild des Players. Hierbei wird die Leiste mit den Bedien-Elementen unterhalb der Leinwand positioniert. Da die Bedienleiste eine Höhe von 20 Pixeln hat, ergibt sich daraus eine nutzbare Leinwandgrösse von width × height - 20. | |
| coverlay | In diesem Modus werden displaywidth und displayheight auf die gleichen Werte wie width und height gesetzt. Dies hat zur Folge, dass die Bedienleiste nun transparent "schwebend" innerhalb der Leinwand angezeigt wird. Weiterhin wird die Bedienleiste nun sanft ausgeblendet falls der Mauszeiger die Leinwand verlässt. Sobald der Mauszeiger wieder die Leinwand erreicht, wird die Bedienleiste wieder eingeblendet. Die nutzbare Leinwandgrösse beträgt width × height. | |
| plbottom | Dieser Modus ist dazu gedacht, eine Playlist unterhalb der Bedienleiste anzuzeigen. Die Höhe des rollbaren Playlist-Fensters wird hierbei mit dem Attribut plsize bestimmt. Die nutzbare Leinwandgrösse beträgt hierbei width × height - 20 - plsize. | |
| plright | Wie plbottom, jedoch wird die Playlist oberhalb der Bedienleiste, rechts von der Leinwand angezeigt. Die Breite des rollbaren Playlist-Fensters wird hierbei mit dem Attribut plsize bestimmt. Die nutzbare Leinwandgrösse beträgt width - plsize × height - 20. | |
| floatcplright | Eine Kombination aus den Modi coverlay und plright. In diesem Modus beträgt die nutzbare Leinwandgrösse width - plsize × height. |
Anmerkung: Sobald eines der Attribute displaywidth oder displayheight innerhalb des Tags angegeben ist, wird der oben beschriebene Automatismus komplett deaktiviert.
4. Der stretch Modus definiert, ob und wie Videos an die Grösse der Leinwand angepasst werden. 1 skaliert das Video proportional so dass es die Leinwand füllt. 0 skaliert das Video bis es der Leinwandgrösse entspricht. 2 skaliert das Video nicht-proportional um es anzupassen. 3 belässt alle Elemente in ihrer Originalgrösse.
5. Wenn scripting aktiviert ist, kann der Player mit JavaScript gesteuert werden. Um den Player zu steuern (und um mehrere Player innerhalb einer Seite zu unterscheiden) ist er durch seine ID anzusprechen. Um Scripting zu erleichtern, kann diese ID (welche anderenfalls automatisch vom Plugin erzeugt wird) manuell Mit dem Attribut divid vorgegeben werden. Die daraus resultierende echte ID des Flash-Objekts welche von JavaScript zu verwenden ist, ergibt sich aus dem angegebenen Wert mit der vorangestellten Zeichenkette p_.
6. Wenn viele Attribute anzugeben sind, können sich hieraus recht längliche, unübersichtliche Tags ergeben. Als Alternative können deshalb alle Parameter in eine Konfigurationsdatei geschrieben, und dies Datei dann mit dem cfg Attribut referenziert werden. Die hierbei angegebene URL sollte auf eine XML-Datei zeigen. Die Variablennamen innerhalb dieser Datei können in einzelnen Fällen von den oben genannten Attributsnamen abweichen. Die Syntax dieser Datei ist nicht Bestandteil dieser Dokumentation. Als Referenz hierzu: Siehe JW Media Player documentation. Eine Beispieldatei gibt es hier.
7. Die im link Attribut angegebene URL wird normalerweise dazu benutzt einen Download-Link für die aktuellen Mediendaten oder verwandte Informationen bereitzustellen. Die URL wird beim Aktivieren des Download-Knopfes im Bedienfeld des Players aufgerufen. Wenn das Attribut linkfromdisplay auf true gesetzt ist, so hat ein Mausklick in die Leinwand des Players die gleiche Wirkung. (Normalerweise wird hiermit der Player zwischen Pause und Play umgeschaltet.). Das Attribut linktarget (Vorgabe: _blank) spezifiziert hierbei das Browserfenster, in dem die aufgerufene URL angezeigt werden soll.
8. Wenn plthumbs auf true gesetzt wird und eine Playlist mit eingebetteten image-Tags bereitgestellt wird, dann werden die dort angegebenen Bilder als Thumbnails in der Playlist angezeigt. Wenn autoscroll auf true gesetzt ist, dann rollt die Playlist automatisch bei jeder Mausbewegung. Andernfalls wird ein herkömmlicher Rollbalken verwendet. Das Attribut repeat gibt an, wie am Ende eines Medien-Strems zu verfahren ist: false bedeutet: Player anhalten, true bewirkt, dass der Strem von Neuem gespielt wird und list bewirkt, dass der nächste Eintrag aus der Playlist gestartet wird. In diesem Kontext wird der nächste Eintrag aus der Liste anhand des Attributs shuffle (default: true) ausgewählt. Ist dieses auf false gesetzt, so wird die Liste sequentially iteriert, ansonsten wir ein zufälliger Eintrag gewählt. Weitere Informationen zur Benutzung von Playlisten finden sich weiter unten.
9. Wenn die remote Variante eines Tags verwedet wird, können beliebige Dateien, sogar mit abweichenden Dateiendungen oder garkeiner Dateiendung referenziert werden. In diesem Fall kann es passieren, dass der JW Media Player nicht den korrekten Dateityp erkennt. Mit diesem Attribut kann daher der Typ manuell auf eines der unterstützten Formate gestzt werden.
10. Dieses Attribut erlaubt es, die minimal erforderliche Flash-Version für den eingebauten JW Media Player zu setzen. Der Player läuft mit mindestens Flash Version 7, jedoch sind dann verschiedene Features, wie "Anzeige von GIF/PNG Bildern", "ruckelfreies Skalieren", VP6 und H264 kodierte Videos, Scripting sowie Ziffernanzeige im Bedienfeld nicht verfügbar. Weiterhin wird für eine Vollbild-Anzeige mindestens Flash Version 9.0.28 benötigt und für das Abspeilen von H264-kodierten Videos wird mindestens Flash Version 9.0.98. Um einen sinnvollen Funktionsumfang zu erhalten, wird daher dringend empfohlen, hier mindestens Version 9.0.28 (mit Vollbild-Anzeige) oder Version 8 (ohne Vollbild-Anzeige) einzustellen.
11. Dieses Attribut stellt eine URL zu einer Empfehlungs-XML-Datei zur Verfügung. Eine Empfehlungs-XML-Datei enthält Titel, Thumbnails sowie URLs für empfohlenen anderen Inhalten die mit dem gerade abgespielten Video im Zusammenhang stehen. Ihr Inhalt wird angezeigt, sobald das Abspielen des Videos beendet ist (ähnlich wie bei YouTube). Eine Beispiel-XML-Datei gibt es hier.
12. Die hier angegebene URL definiert einen alternativen Suchdienst welcher verwendet wird wenn ein Anwender die Such-Funktion des Such-Feldes benutzt. Die Benutzereingabe wird hierbei an die URL angehängt. Beispiel: Wenn die URL http://youtube.com/results?search_query= ist, und der Anwender nach computer sucht, dann lautet die daraus resultierende Suchanfrage http://youtube.com/results?search_query=computer.
13. Standardmäßig stellt das Plugin zwei verschiedene Warnungen, für den Fall dass der Inhalt nicht angezeigt werden kann, zur Verfügung: Die erste Warnung wird angezeigt, wenn JavaScript nicht verfügbar ist. Eine weitere Warnung wird angezeigt, wenn JavaScript zwar arbeitet, aber das Flash-Plugin nicht verfügbar ist oder in einer älteren Version als im Parameter flashver angegeben vorliegt. Mit diesem Parameter kann die zweite Warnung durch eigenen Code ersetzt werden. Wir eigener Code angegeben, wird dadurch die erste Warnung komplett unterdrückt. Der eigen Code darf keine einfache Anführungszeichen oder schliessende geschweifte Klammern enthalten. Um diese darzustellen müssen sie als HTML entities codiert werden. Die vorgegebenen Warnungen sehen wie folgt aus:
Typisches Erscheinungsbild der standard JavaScript Warnung (Text ist im Live-System lokalisiert):
To display this content, you need a JavaScript capable browser.
Typisches Erscheinungsbild der standard Flash Warnung (Text ist im Live-System lokalisiert):
14. Dieses Attribut erlaubt es, ein Vorschau- (Thumbnail) Bild anzugeben, welches immer dann angezeigt wird, wenn der Player gestoppt ist. Wird hier ein relativer Pfad verwendet (ein Pfad der nicht mit einem Schrägstrich oder http:// oder https:// beginnt), dann wird hier automatisch der Standard-Bildpfad (Üblicherweise: images/stories) vorangestellt.
15. Die initiale Lautstärke in Prozent. Gültige Werte: 0 bis 100.
16. Dieses Attribut kann dazu verwendet werden das Kontext-Menü des Players zu manipulieren. Bei Flash-basierten Playern bewirkt das Setzen des Wertes false, dass nur das Standard-Menü angezeigt wird. Beim DivX Player wird hierduch das Menü komplett deaktiviert.
17. Wird dieses Attribut auf true gesetzt, dann wird der daraus resultierende Player unsichtbar und auf die Anzeige in einem Popup-Fenster oder in einer Lightbox mit Hilfe des Spezial-Tags avrpopup vorbereitet.
Spezielle Parameter des YouTube Players
Wenn das Tag {youtube}, verwendet wird, dann unterstützt der YouTube Player die folgenden zusätzlichen Attribute (Alle boolschen Werte haben false als Vorgabe):
| Globale Sektion | Globaler Parametername | Attributname | YouTube API Name | Werte |
|---|---|---|---|---|
| Erweiterte Parameter | Autostart | autostart | autoplay | true oder false |
| Erweiterte Parameter | Bedienfeldfarbe | pbgcolor | color1 | ein Farbwert |
| Erweiterte Parameter | Bedienfeld-Aktiv-Farbe | phicolor | color2 | ein Farbwert |
| - | - | ytborder | border | true oder false |
| - | - | ytegm | egm | true oder false |
| - | - | ytloop | loop | true oder false |
| - | - | ytrel | rel | true oder false |
Weitere Informationen über die Bedeutung dieser Attribute finden sich in der YouTube API Spezifikation hier.