Plugin Parameters
De plugin parameters kunnen op twee manieren ingesteld worden: De eerste optie, in de administratie backend van de plugin, Kun je de globale parameters instellen die op alle video's betrekking hebben. Als tweede optie, kun je deze globale instellingen overschrijven in iedere individuele tag. Indien je parameters wilt overschrijven, voeg je deze toe - gescheiden door spaties - binnen het eerste deel van de tag zoals op de manier: {flv width="180" height="150" autostart="true"}party{/flv}. Overschrijven maakt altijd gebruik van kleine letters attribuut naam, gevolgd door een is gelijk aan teken, gevolgd door de attribuut waarde tussen het dubbele aanhalingsteken.
De volgende tabel laat de ondersteunde parameter namen zien, hun attribuut instelling (de naam die gebruikt word bij overschrijving) en hun mogelijke waardes. Als omschreven in de tabel van ondersteunde lokale formaten, worden er verschillende spelers gebruikt for verschillende media formaten. De enige speler die alle alle parameters ondersteund is de JW Media Player. Alle andere spelers ondersteunen normaliter breedte, hoogte en automatsch afspelen alleen. De YouTube speler is een uitzondering. Deze ondersteunt enkele speciale attributen welke beschreven worden in de tabel aan het einde van deze pagina. Let op: Sommige speciale attributen zijn niet beschikbaar in de backend parameter pagina maar kunnen alleen worden ingesteld binnen de tag. Deze attributen worden uitgelegd in de opmerkingen.
| Globale sectie | Globale parameter naam | Attribuut naam | Waarden |
|---|---|---|---|
| Plugin Parameters | Container class | avcss | iedere class naam |
| Plugin Parameters | Hoofd video breedte | width | een pixel waarde |
| Plugin Parameters | Hoofd video hoogte | hight | een pixel waarde |
| Plugin Parameters | iFilm video breedte | iwidth | een pixel waarde |
| Plugin Parameters | iFilm video hoogte | ihight | een pixel waarde |
| Plugin Parameters | Metacafe video breedte | mwidth | een pixel waarde |
| Plugin Parameters | Metacafe video hoogte | mhight | een pixel waarde |
| Plugin Parameters | Flash mode tonen | wmode | window, transparant of opaque |
| Plugin Parameters | Flash achtergrond kleur | bgcolor | een kleur waarde 1) |
| Plugin Parameters | Hoofd audio breedte | awidth | een pixel waarde |
| Plugin Parameters | Hoofd audio hoogte | ahight | een pixel waarde |
| Geavenceerde Parameters | Kleur controle | pbgcolor | een kleur waarde 1) |
| Geavenceerde Parameters | Kleur tekst controle | pfgcolor | een kleur waarde 1) |
| Geavenceerde Parameters | Controle geaccentueerde kleur | phicolor | een kleur waarde 1) |
| Geavenceerde Parameters | Video achtergrond | psccolor | een kleur waarde 1) |
| Geavenceerde Parameters | Automatisch afspelen | autostart | true of false |
| Geavenceerde Parameters | Laat controle balk zien | shownav | true of false |
| Geavenceerde Parameters | Laat cijfers zien | showdigits | true of false |
| Geavenceerde Parameters | Laat icons zien | showicons | true of false |
| Geavenceerde Parameters | Laat stop zien | showstop | true of false |
| Geavenceerde Parameters | Laat download zien | showdownload | true of false 7) |
| Geavenceerde Parameters | Laat volledige scherm knop zien | usefullscreen | true of false |
| Geavenceerde Parameters | Aanpassen script | enablejs | true of false 5) |
| Geavenceerde Parameters | Logo | logo | URL/relatief pad 2) |
| Geavenceerde Parameters | Video venster mode | screenmode | Een mode identificator 3) |
| Geavenceerde Parameters | Afspeellijst grootte | plsize | Een pixel waarde 3) |
| Geavenceerde Parameters | Uittrekken inhoud | stretch | 0, 1, 2 of 3 4) |
| Geavenceerde Parameters | Minimale Flash Versie | flashver | Drie nummers, gescheiden door punten 10) |
| Geavenceerde Parameters | Toon equalizer | showeq | true of false |
| Geavenceerde Parameters | Toon zoek balk | searchbar | true of false |
| Geavenceerde Parameters | Zoek aanbieder | searchlink | URL 12) |
| Geavenceerde Parameters | Alternatieve inhoud | alt | any valid HTML 13) |
| - | - | cfg | URL 6) |
| - | - | displaywidth | Een pixel waarde 3) |
| - | - | displayheight | Een pixel waarde 3) |
| - | - | divid | Iedere ID waarde 5) |
| - | - | link | URL 7) |
| - | - | linkfromdisplay | true of false 7) |
| - | - | linktarget | Een doel naam (vb. _blank) 7) |
| - | - | plthumbs | true of false 8) |
| - | - | type | Een bestands type 9) |
| - | - | repeat | false, true of list 8) |
| - | - | shuffle | true of false 8) |
| - | - | autoscroll | true of false 8) |
| - | - | recurl | URL 11) |
| - | - | img | URL 14) |
| - | - | volume | int 15) |
| - | - | menu | true of false 16) |
| - | - | popup | true of false 17) |
Opmerkingen:
1. Kleurwaarden kunnen gespecificeerd worden in elk van de volgende formaten en worden automatisch omgezet naar het juiste formaat:
- Een 6-cijferig hexadecimale waarde, gevolgd door een hash teken (vb.: #223344 zoals gewone HTML code)
- Een 3-cijferig hexadecimale waarde, gevolgd door een hash teken (vb.: #234 zoals CSS verkorte code)
- 3 decimale waardes gevolgd door de rgb waarden ussen haakjes geplaatst (vb.: rgb(99,140,235) - zoals CSS rgb code)
- Een 1-6-cijferig hexadecimale waarde, gevolgd door 0x (vb.: 0x2345 zoals in JavaScript)
- Één van de 16 op zichzelf staande kleurennamen als gespecificeerd in HTML 4.0.1 (vb.: red)
2. Logo afbeeldingen kunnen gespecificeerd worden middels hun absolute URL (vb.: http://host/logo.png) of - indien lokaal opgeslagen op dezelfde server - middels hun lokale pad (vb.: /images/stories/logo2.png). Het logo zou een png moeten zijn (voorkeur) of een gif voor de ondersteuning van transparantie. Het logo is altijd gepositioneerd in de rechter bovenhoek van het video scherm. Indien je een andere positie wenst kun je dit bereiken door het maken van een grotere afbeelding waarvan het grootste deel van de afbeelding transparant is.
3. De parameter scherm mode is een beetje speciaal. Het is niet een actuele parameter voor JW mediaplayer maar een sneltoets die betrekking heeft hoe de spelers parameters displaywidth en displayheight (deze specificeren de grootte van de spelers video scherm) worden gecalculeerd door de plugin. De volgende modes zijn beschikbaar:
| Mode | Omschrijving | |
|---|---|---|
| default | Deze mode heeft betrekking op de standaard vertoning waar het controle paneel van de speler is gepositioneerd onderaan het scherm. Aangezien het controle paneel een hoogte heeft van 20 pixels, is de beschikbare scherm grootte breedte × hoogte - 20. | |
| coverlay | In deze mode, zijn de vertoonbreedte en vertoonhoogte gelijk aan de breedte en hoogte. Het resultaat is dat het controle paneel transparant getoond word binnen het scherm gebied. Verder verdwijnt het controle paneel langzaam, als de muis het scherm gebied verlaat en verschijnt opnieuw als de muis het scherm gebied weer ingaat. De beschikbare scherm grootte in deze mode is breedte × hoogte. | |
| plbottom | Deze mode is bedoeld om een afspeellijst te laten zien aan de onderkant van het controle paneel. De hoogte van dit schuifbaar scherm word gehaald uit de parameter plsize. De beschikbare scherm grootte in deze mode is breedte × hoogte - 20 - plsize. | |
| plright | Zoals plbottom, behalve dat de afspeellijst word afgebeeld aan de rechterzijde van het scherm. De breedte van dit schuifbaar scherm word gehaald uit de parameter plsize. De beschikbare scherm grootte in deze mode is breedte - plsize × hoogte - 20. | |
| floatcplright | Een combinatie van coverlay en plright. In deze mode, De beschikbare scherm grootte is breedte - plsize × hoogte. |
Notitie: Wanneer je vertoonbreedte of vertoonhoogte overschrijft in de tag, dan word de hele automatisch calculatie als boven omschreven uitgezet.
4. De uittrek mode definieert hoe movies uitgetrokken worden om ze passend te kunnen maken. 1 zal deze proportioneel uittrekken tot beeldvullend, 0 zal deze uitrekken tot passend. 2 zal deze onproportioneel uittrekken om zowel de hoogte en breedte passend te krijgen. 3 zal alles tonen in de originele dimensies.
5. Indien aangezet zal de speler gecontroleerd worden met JavaScript. Om dit te doen (en om meerdere spelers op één pagina te onderscheiden) moet het geadresseerd worden door zijn ID. Voor gemakkelijk gebruik, kan deze ID (welke anderszins automatisch word toegewezen door de plugin) handmatig ingesteld worden door gebruik te maken van het attribuut divid. De voortvloeiende ID van het flash voorwerp om te gebruiken binnen JavaScript is de gespecificeerde waarde, vooraf gegaan door p_.
6. Als meerdere parameters moeten worden gespecificeerd, zal je eindigen met behoorlijke lange tags. Als alternatief, kun je al deze parameters neerzetten in een configuratie bestand en dan simpel daaraan refereren. De URL, gespecificeerd in het cfg attribuut moet dan wijzen naar het configuratie XML bestand. De variabele namen in dat bestand kunnen afwijken van de attributen als boven aangegegeven. Zie de JW Media Speler documentatie voor een referentie. Een voorbeeld bestand kan hier worden gevonden.
7. De URL, gespecificeerd in het link attribuut word normaliter gebruikt voor het verstrekken van een download van de media of voor verwante informatie. Deze URL is aangehaald, wanneer de spelers download knop is geactiveerd. Bovendien, als het attribuut linkfromdisplay is ingesteld op waar, zal een klik in de spelers vertoning de URL aanhalen in plaats van afspelen/pauze. Het attribuut linktarget (standaard: _blank) specificeert het scherm waarin deze URL geopend zal worden.
8. Als plthumbs is ingesteld op waar en een afspeellijst is opgenomen welke voorzien is van afbeelding tags in de voorwaarden, zullen deze afbeeldingen als thumbnails worden afgebeeld in de afspeellijst. Als autoscroll is ingesteld op waar, zal de afspeellijst automatisch scrollen via muis bewegingen in plaats van gebruik te maken van een schuifbalk. Het attribuut repeat specificeert hoe word doorgegaan als de media stream is beëindigd: niet waar betekent stop de speler, waar betekent herhaal de stream vanaf het begin en lijst betekent begin met afspelen van het volgende item in de afspeellijst. In deze context, zal het volgende geselecteerde item afgespeeld worden afhankelijk van de parameter shuffle (standaard: waar). Als deze is ingesteld op niet waar, zal de afspeellijst opéénvolgend herhaald worden. Het gebruik van afspeellijsten word hieronder verder uitgelegd.
9. Indien gebruik word gemaakt van de remote variant van de media tag, kun je iedere media file refereren, zelfs met een verschillende extensie of zonder extensie. Indien dit het geval is, kan de JW Media Speler misschien niet het juiste bestand herkennen. Met dit attribuut kun je geforceerd het media type instellen naar één van de ondersteunde formaten.
10. Dit attribuut staat je toe de minimale Flash versie in te stellen, vereist voor de ingebouwde JW Media Speler. De speler vereist minimaal Flash versie 7. Echter, wanneer je een lagere versie gebruikt, de eigenschappen "laten zien van GIF/PNG afbeeldingen", "afvlakking van variabele afbeeldingen/video", VP6 en H264 gecodeerde video, javascripting en de cijfers in de controle balk zijn niet functioneel. Verder, voor de volledige scherm afbeelding, is minimaal Flash versie 9.0.28 verplicht en om H264 gecodeerde videos af te spelen, is tenminste Flash versie 9.0.98 vereist. Voor volledige functionaliteiten, is het daarom ook nadrukkelijk aanbevolen om minimaal versie 9.0.28 te gebruiken (indien je gebruik maakt van de volledig scherm mogelijkheid) of versie 8 (zonder gebruik te maken van volledig scherm).
11. Dit attribuut bepaald een URL voor een aanbevelings XML bestand. Een aanbevelings XML bestand bevat titels, thumbnails en URLs voor aanbevolen onderwerpen, gerelateerd aan de huidige video die word afgespeeld. De inhoud is te zien nadat de video klaar is met afspelen (Bijna hetzelfde als op YouTube). Een voorbeeld van een aanbevelings XML bestand kan hier worden gevonden.
12. De hier beschikbare URL definieert een alternatieve zoek aanbieder welke word gebruikt wanneer een gebruiker de zoek functie of de zoek balk gebruikt. De tekst ingetypt door de gebruiker is bijgevoegd aan deze URL. Voorbeeld: als de URL http://youtube.com/results?search_query= is en de gebruiker zoekt naar computer, dan is de resultaat query http://youtube.com/results?search_query=computer.
13. Standaard voorziet de plugin in twee verschillende waarschuwingen als de inhoud niet kan worden weergegeven: De eerste waarschuwing word weergegeven als JavaScript niet beschikbaar is. Een andere waarschuwing word weergegeven wanneer JavaScript werkt maar indien de flash plugin of niet beschikbaar is of de versie is te laag voor de waarde van de parameter flashver. Met deze parameter, de tweede waarschuwing kan worden vervangen met gewone inhoud. Indien gewone inhoud is voorzien zal de eerste waarschuwing compleet worden uitgezet. De gewone inhoud mag geen enkele quote of gesloten accolade bevatten. Om deze karakters af te kunnen beelden, moeten deze encoded zijn gebruik makend van html entiteiten. De standaard waarschuwingen zien er als volgt uit:
Typisch uiterlijk van de standaard JavaScript waarschuwing (gebruikt plaatselijke tekst):
Om deze inhoud te kunnen weergeven, heeft u een browser nodig welke JavaScript ondersteunt.
Typisch uiterlijk van de standaard Flash waarschuwing (gebruikt plaatselijke tekst):
14. Dit attribuut staat toe om een vooruitblik (thumbnail) afbeelding te specificeren welke word getoond iedere keer dat de speler word gestopt. Als een relatief pad is gespecificeerd (i.e. de waarde start niet met een slash of http:// of https://), dan word het voorvoegsel automatisch de standaard afbeelding directory (normaliter images/stories).
15. The initial volume. Unit is percent, which implies a valid range of 0 .. 100.
16. This attribute can be used to manipulate the context menu of the player. For flash based players, setting this to false restricts the menu to the basic entries. For the DivX player, this disables the menu completely.
17. When this attribute is set to true, then the resulting player will be invisible and prepared to be displayed in a popup window or lightbox by using the avrpopup special tag.
Speciale parameters voor de YouTube speler
Wanneer je de tag {youtube} gebruikt, ondersteunt de YouTube speler de volgende additionele attributen (Alle boolean attributen hebben een standaard waarde van false):
| Globale sectie | Globale parameter naam | Attribuut naam | YouTube API naam | Waarden |
|---|---|---|---|---|
| Geavenceerde Parameters | Automatisch afspelen | autostart | autoplay | true of false |
| Geavenceerde Parameters | Kleur controle | pbgcolor | color1 | een kleur waarde |
| Geavenceerde Parameters | Controle geaccentueerde kleur | phicolor | color2 | een kleur waarde |
| - | - | ytborder | border | true of false |
| - | - | ytegm | egm | true of false |
| - | - | ytloop | loop | true of false |
| - | - | ytrel | rel | true of false |
Meer informatie over de betekenis van deze attributen kan gevonden worden in de YouTube API specificatie op deze plaats.