FunkyPlayer - Dokumentation

Dokumentation






FunkyPlayer stylen und anpassen

Das gesamte Layout dieses Videoplayers ist konfigurierbar. Nehmen sie die Anpassungen in der XML-Datei vor, die im "skins" Verzeichnis enthalten ist. Alles was sie brauchen ist ein einfacher HTML-Editor. Achtung verwenden sie unter keinen Umständen ein Textverarbeitungsprogramm wie z.B. Word um die Konfigurationsdatei zu bearbeiten. Die beste Methode um das Verhalten der einzelnen Elemente zu erforschen ist mit ihnen herumzuspielen. Die meisten Elemente und Optionen sollten allein durch ihren Namen selbsterklärend sein. Es wird empfohlen die Standard XML-Datei vor dem Bearbeiten separat zu sichern, dann kann diese als Backup dienen, falls sie etwas falsch konfiguriert haben und nicht weiter wissen.



Anpassbare Elemente

Es gibt einige gemeinsame Optionen, die für alle Elemente gültig sind und einige spezielle die nur bei einzelnen Elementen funktionieren. In jedem Fall dürfen keine Elemente ganz aus der Konfigurationsdatei entfernt werden, auch wenn sie glauben, sie brauchen sie nicht. Bearbeiten sie daher immer nur die Werte der Elemente und niemals die Elementnamen. Entfernen sie keinen Elemente oder Optionen aus der Datei! Sie können Elemente anhand der "enable"-Option ein und ausschalten. Wenn sie sich nicht sicher sind, was die eine oder andere Option zu bedeuten hat, behalten sie die Sandardwerte.


  • <videoPlayerContainer>
  • <video>
  • <videoControllBar>
  • <timeDisplay>
  • <pauseButton>
  • <replayButton>
  • <stopButton>
  • <fullscreenButton>
  • <backwardButton>
  • <forwardButton>
  • <volumeControll>
  • <windTrack>
  • <waterMark>



















Beispiel Skin



Embed Optionen

Die Optionen zum Einbetten sind die Optionen, die sie direkt in das <object> and <embedd> tag schreiben wie hier beschrieben. Dies sind nicht die Syling-Optionen für das Erscheinungsbild des Players. Diese sind hier beschrieben. Sie müssen die Embed-Optionen (mit Ausnahme von width und height) in einer bestimmten Art und Weise notieren, nämlich als FlshVars-String. Hier ein Beispiel für eine solche Notation: attribute1=value1&attribute2=value2
Wie sie sehen, müssen sie "schlüssel=wert" Paare notieren, die durch ein Kaufmannsund "&" verbunden sind. Benutzen sie keine Sonderzeichen wie: ?,ß,ü,$,", ', & und keine Leerzeichen...
Erlaubte Zeichen sind: a-z, A-Z, 0-9, _, -, ., /, :.

Optionen:


  • skin
Der Pfad zur Konfigurationsdatei für das Erscheinungsbild (Skin).
Beispiel: skin=funkyplayer/skins/default/default.xml

  • autostart
Mögliche Werte: true | false
Wenn sie true verwenden startet der Player mit dem Abspielen automatisch.
Beispiel: autostart=true

  • buffertime
Nummer in Sekunden die die Vorladezeit definiert.
Example: buffertime=1

  • streamingType
Mögliche Werte: progressiveDownload | streamingServer
Verwenden sie progressiveDownload um Video-Dateien abzuspielen, die direkt auf ihrem Server liegen.
Verwenden sie streamingServer wenn sie einen StreamingServer betreiben oder ihre Videos auf einem entfernten StreamingServer liegen..
Beispiel: streamingType=progressiveDownload

  • progressiveDownloadFile
Der Pfad zur FLV Videodatei. Lassen sie den Wert frei, wenn sie streamingServer als streamingType spezifizieren.
Beispiel: progressiveDownloadFile=funkyplayer/videos/video.flv

  • streamingServer
Die URL zum StreamingServer. Lassen sie den Wert frei, wenn sie progressiveDownload als streamingType spezifizieren.
Beispiel: streamingServer=rtmp://myserver.com/

  • streamName
Der Name des Streams. Lassen sie den Wert frei, wenn sie progressiveDownload als streamingType spezifizieren.
Beispiel: streamName=video1

  • width
Breite des Players in Pixel.
Note: Dies muss der gleiche Wert sein wie <videoPlayerContainer width> in der Skin-Konfiguration.

  • height
Höhe des Players in Pixel.
Note: Dies muss der gleiche Wert sein wie <videoPlayerContainer height> in der Skin-Konfiguration.



FunkyPlayer in die Webseite einbetten

Entpacken sie den Download in ihr Webverzeichnis.
Öffnen sie eine beliebige Datei ihrer Webseite und fügen sie das unten zu sehende HTML-Snippet ein. Speichern sie und öffenen das Dokument dann im Browser. FunkyPlayer ist somit eingebettet.

 
<object>
  <embed bgcolor="#000000" width="580" height="440" name="FunkyPlayer" align="middle" 
    allowfullscreen="true" pluginspage="http://www.adobe.com/go/getflashplayer" 
    src="/funkyplayer/FunkyPlayer.swf?skin=/funkyplayer/skins/default/default.xml&streamingType=progre
ssiveDownload&progressiveDownloadFile=/funkyplayer/videos/ice-age.flv&streamingServer=&streamNa
me=&autostart=true" type="application/x-shockwave-flash">
  </embed>
</object>



<videoPlayerContainer>

Is the parent element of all other elements like buttons and display components. It is the wrapper for all elements.
Attributes
  • posX - a number in pixel to define the hotizontal position : default = 0
  • posY - a number in pixel to define the vertical position : default = 0
  • width - width of the container in pixel - this must be the same width like you specify in the embed tag.
  • height - height of the container in pixel - this must be the same height like you specify in the embed tag.
  • backgroundFile - path to image file, if you want to use an background-image for FunkyPlayer
  • backgroundColor1 - a hexadecimal color value, 0xFFFFFF = white
  • backgroundColor2 - define a different color if you like a gradient for the background
  • backgroundAlpha - transparency of background color or background image
  • borderWidth - the border width in pixel, set to 0 if you don't want a border
  • borderRadius - if you like rounded corners, define a border radius in pixel
  • borderColor - a hexadecimal color value, 0x000000 = black
  • borderAlpha - transparency of the border

<video>

Attributes
  • posX - hotizontal position, distance in pixel to the left border : default = 10
  • posY - vertical position, distance in pixel to the left border : default = 10
  • maxWidth - width of the video in pixel - proportions will be preserved.
  • maxHeight - height of the video in pixel - proportions will be preserved.
  • startImageFile - This image will be displayed at startup at the place where the video will be played (only if you choose autostart = false). It will also displayed after video playing is finished.

<videoControllBar>

Attributes
  • posX - hotizontal position, distance in pixel to the left border : default = 10
  • posY - vertical position, distance in pixel to the left border : default = 10
  • width - width in pixel
  • height - height in pixel
  • backgroundFile - path to image file, if you want to use an background-image for the videoControllBar
  • backgroundColor1 - a hexadecimal color value, 0xFFFFFF = white
  • backgroundColor2 - define a different color if you like a gradient for the background
  • backgroundAlpha - transparency of background color or background image
  • borderWidth - the border width in pixel, set to 0 if you don't want a border
  • borderRadius - if you like rounded corners, define a border radius in pixel
  • borderColor - a hexadecimal color value, 0x000000 = black
  • borderAlpha - transparency of the border

<timeDisplay>

Attributes
  • enabled - enables or disables the component values : true | false
  • posX - hotizontal position, distance in pixel to the left border
  • posY - vertical position, distance in pixel to the left border
  • backgroundFile - path to image file, if you want to use an background-image for the component
  • backgroundColor1 - a hexadecimal color value, 0xFFFFFF = white
  • backgroundColor2 - define a different color if you like a gradient for the background
  • backgroundAlpha - transparency of background color or background image
  • borderWidth - the border width in pixel, set to 0 if you don't want a border
  • borderRadius - if you like rounded corners, define a border radius in pixel
  • borderColor - a hexadecimal color value, 0x000000 = black
  • borderAlpha - transparency of the border
  • paddingTop - value in pixel - space to top
  • fontSize - number in pixel
  • fontColor - a hexadecimal color value, 0xFFFF00 = red
  • fontWeight - normal | bold

<pauseButton>

Attributes
  • enabled - enables or disables the component values : true | false
  • posX - hotizontal position, distance in pixel to the left border
  • posY - vertical position, distance in pixel to the left border
  • buttonFile - path to image file of the button
  • buttonHoverFile - path to image file on mouse over

<replayButton>

Attributes
  • enabled - enables or disables the component values : true | false
  • buttonFile - path to image file of the button
  • buttonHoverFile - path to image file of the button mouse over

<stopButton>

Attributes
  • enabled - enables or disables the component values : true | false
  • posX - hotizontal position, distance in pixel to the left border
  • posY - vertical position, distance in pixel to the left border
  • buttonFile - path to image file of the button
  • buttonHoverFile - path to image file on mouse over

<fullscreenButton>

Attributes
  • enabled - enables or disables the component values : true | false
  • posX - hotizontal position, distance in pixel to the left border
  • posY - vertical position, distance in pixel to the left border
  • buttonFile - path to image file of the button
  • buttonHoverFile - path to image file on mouse over

<backwardButton>

Attributes
  • enabled - enables or disables the component values : true | false
  • posX - hotizontal position, distance in pixel to the left border
  • posY - vertical position, distance in pixel to the left border
  • buttonFile - path to image file of the button
  • buttonHoverFile - path to image file on mouse over

<forwardButton>

Attributes
  • enabled - enables or disables the component values : true | false
  • posX - hotizontal position, distance in pixel to the left border
  • posY - vertical position, distance in pixel to the left border
  • buttonFile - path to image file of the button
  • buttonHoverFile - path to image file on mouse over

<volumeControll>

Attributes
  • enabled - enables or disables the component values : true | false
  • posX - hotizontal position, distance in pixel to the left border
  • posY - vertical position, distance in pixel to the left border
  • buttonFile - path to image file of the button
  • backgroundFile - path to image file, if you want to use an background-image for the component
  • backgroundColor1 - a hexadecimal color value, 0xFFFFFF = white
  • backgroundColor2 - define a different color if you like a gradient for the background
  • backgroundAlpha - transparency of background color or background image
  • borderWidth - the border width in pixel, set to 0 if you don't want a border
  • borderRadius - if you like rounded corners, define a border radius in pixel
  • borderColor - a hexadecimal color value, 0x000000 = black
  • borderAlpha - transparency of the border
  • sliderButtonFile - path to image file, of the volume slider
  • sliderButtonAlpha - transparency of the slider button

<volumeControll>

Attributes
  • enabled - enables or disables the component values : true | false
  • posX - hotizontal position, distance in pixel to the left border
  • posY - vertical position, distance in pixel to the left border
  • buttonFile - path to image file of the button
  • backgroundFile - path to image file, if you want to use an background-image for the component
  • backgroundColor1 - a hexadecimal color value, 0xFFFFFF = white
  • backgroundColor2 - define a different color if you like a gradient for the background
  • loadProgressColor1 - a hexadecimal color value, 0xFFFFFF = white
  • loadProgressColor2 - define a different color if like a gradient for the background
  • backgroundAlpha - transparency of background color or background image
  • borderWidth - the border width in pixel, set to 0 if you don't want a border
  • borderRadius - if you like rounded corners, define a border radius in pixel
  • borderColor - a hexadecimal color value, 0x000000 = black
  • borderAlpha - transparency of the border
  • sliderButtonFile - path to image file, of the volume slider
  • sliderButtonAlpha - transparency of the slider button

<waterMark>

Attributes
  • enabled - enables or disables the component values : true | false
  • posX - hotizontal position, distance in pixel to the left border
  • posY - vertical position, distance in pixel to the left border
  • watermarkFile - path to image file of your watermark
  • fullscreenAlign - values : top_right | top_left | bottom_right | bottom_left
  • fullscreenPosX - hotizontal position of waterMark in fullscreen
  • fullscreenPosY - vertical position of waterMark in fullscreen