====== FlowPlayer Plugin ======

---- plugin ----
description: Allows to embed a flash video into Wiki pages
author     : Alexey Markov 
email      : redrat@mail.ru 
type       : syntax
lastupdate : 2013-05-18
compatible : Elenor of Tsort, Rincewind, Angua, Adora Belle, Weatherwax, Frusterick Manners, Greebo, !Hogfather
depends    : 
conflicts  : 
similar    : flowplay2, flashplayer
tags       : !obsolete, flash, video, embed, media

downloadurl: https://github.com/RedRat/flowplayer/zipball/master
bugtracker : https://github.com/RedRat/flowplayer/issues
sourcerepo : https://github.com/RedRat/flowplayer/
----

Flash is not available anymore in browsers. Video functionality is included in DokuWiki, see the [[wiki:syntax#media_files|media syntax description]] and [[:video]] options including adding subtitles.

===== Description =====

Using this plugin, you can embed audio and video files into your wiki pages. This is accomplished by using of <OBJECT> tag together with [[http://flowplayer.org/|FlowPlayer]]. Feel free to correct any info on this page, because my English is really bad.

===== Download and Installation =====

Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.

===== Syntax and Usage =====

<code>{{flowplayer>mediafile [width,height] [[no]param] [param:value]}}</code>

Mediafile may be specified by absolute URL or relative one. Width and height has defaults of 320 and 240 respectively. Also there is default parameter of 'noautoPlay' to prevent undesirable behaviour of player.

  * Parameter looking like 'width,height' sets the width and height of the player.
  * Parameter looking like 'param:value' sets any non-Boolean parameter to 'value'.
  * Parameter looking like 'param' sets the Boolean parameter to 'true'.
  * Parameter looking like 'noparam' set the Boolean parameter to 'false'.
 
List of all available parameters you can get [[http://flowplayer.org/documentation/configuration/clips.html|here]].

Examples:

<code>{{flowplayer>http://mydomain.tld/myfolder/mymedia.flv 320,240 noautoPlay}}</code>

<code>{{flowplayer>namespace:subnamespace:file.flv 400,300 autoBuffering}}</code>

===== Changelog =====

**2013-05-18 Version 0.5:**
  * FlowPlayer updated to version 3.2.16

**2012-09-12 Version 0.4:**
  * Fixed installation to the wrong folder by adding valid plugin.info.txt file
  * FlowPlayer updated to version 3.2.15
  * Some cosmetic changes in the code

**2011-08-08 Version 0.3:**
  * Fixed potential vulnerability in parsing of malicious URLs
  * Improved parameters parsing routine
  * ID attribute of OBJECT tag is pseudo-random now
  * Some cosmetic changes in generated HTML code

**2011-08-04 Version 0.2:**
  * FlowPlayer updated to version 3.2.7
  * Added default values "scaling:fit" and "urlEncoding:true"
  * Removed non-working patch for non-Latin filenames (there is long-standing bug in the FlowPlayer)
  * Fixed bug with quotes around values

**2010-03-24 Version 0.1:**
  * Initial release. It uses latest FlowPlayer 3.1.5 and works with non-Latin filenames.

===== Discussion =====

==== Captions possibility ====
> Is that possible to use Captions/Subtitles in Dokuwiki with flashplayer?
> K.S.

==== Full screen scaling ====

> Nice work!
> 
> To get proper scaling in full screen mode, add the 'scaling' parameter:
> 
> <code php>
    function handle($match, $state, $pos, &$handler){
        $width = 320;
        $height = 240 + 24;
	$params['scaling'] = '"fit"';
        $params['autoPlay'] = 'false';
</code>
> You can see a sample of this player here: [[http://arnowelzel.de/wiki/en/playground]]
> 
> //(Arno Welzel)//

Added as default value in the current version of plugin.
==== An uups with ACL ====

>> Too bad - it does not work for me, it just does not recognise the syntax. Even the plugin-info is missing so I cannot email the programmer for short. I got no idea how to come by. Does anyone got a good hint for me? 
>>
>>// feiler at uni-hohenheim.de // 
>
> My e-mail is specified at the top of this page, and this plugin is works for sure (at least on two different sites). Can you describe your problem at greater length?

MEA CULPA! - The plugin is **really** great. I just mixed some file-attributes (yes, php-savemode really checks file-ownership). The problem  here was, that wiki did'nt gave even a trace of a sign to me. I accidently found that issue by doing something total different.
Since I fixed the ownership  all works out just fine. -- Thank You Alexey.

// feiler at uni-hohenheim.de // 

==== DW-syntax path doesn't work for me, normal URL ok ====

> I have some videos that contain some company-sensitive info, which I want to play through a closed Wiki. I can play the video fine if I:
> <code>
cd /my/dokuwiki/root
ln -s ./media/video ./video
</code>
> and make my video link:
> <code>
{{flowplayer>https://url.to.wiki/media/video/MP4_video_filename.mp4}}
</code>
> (Note that I'm using H.264/MP4 video files, and accessing the wiki via HTTPS.)
> 
> However, the problem with that is that that makes my videos accessible to the outside world at https://url.to.wiki/media/video/ of course.
> 
> Linking as:
> <code>
{{flowplayer>media:video:MP4_video_filename.mp4}}
</code>
> always seems to lead to a Flowplayer error:
> <code>
200, Stream not found, NetStream.Play.StreamNotFound, clip: '[Clip] '/wiki/lib/exe/fetch.php/media:video:MP4_video_filename.mp4''
</code>
> Can anyone shed any light on what I'm missing, why dokuwiki-syntax doesn't seem to work for me?
> 
> Thanks!
> 
> //Tom Green//
> 
> **EDIT: SOLVED**.
> 
> I think there may be an error in the code example above: on my wiki, this code does NOT work:
> <code>
{{flowplayer>media:video:clip1.mp4}}
</code>
> but this does:
> <code>
{{flowplayer>video:clip1.mp4}}
</code>

It's not error but rather bad choice of example. Actually, "media:video" is an imaginary namespace for mediafiles, not a real "media" folder of DokuWiki installation. To avoid further misunderstandings I have changed namespaces in the example.

==== Error 'null' is null or not an object ====

> Very nice plugin! Thank you.
> 
> When i use the plugin with IE8, I get the error message: '''null' is null or not an object'' \\ 
> Anyhow, the player works. Does anyone know the matter of this error message? \\ 
> best regards, Dietmar //(grasboeck dot dietmar at fronius dot com)//
> 
> **Fix**
> 
> To fix this problem edit the syntax.php file in the plugin folder flowplayer
> 
> Change line 65 from:
>
> <code php>
$renderer->doc .= '<object type="application/x-shockwave-flash"';
</code>
> To:
> <code php>
$renderer->doc .= '<object id="'.$data['url'].'" type="application/x-shockwave-flash"';
</code>
I am using IE8 too, but never saw this error. <del>Anyway, I will apply suggested changes in the next version of plugin</del>. Something similar was made in version 0.3 of plugin.  --- [[user>RedRat|Alexey Markov]] //2012/09/12 14:13//
       
==== Red dotted line of death ====
> not having any luck with the flowplayer plugin (or the mp3play for that matter). Get a red, underlined link when embedding the code into a page. i.e. <code>{{flowplayer>wiki:some_mp3.mp3}}</code> doesn't actually render the flowplayer, just produces an incorrect anchor element by basically just appending "flowplayer_" to the _media link (i.e. http://example.com/_media/flowplayer_wiki:some_mp3.mp3).
>
> Had another plugin installed ok, so I believe my plugin directory permissions are ok.  Using latest stable release of Dokuwiki.

It seems like Flowplayer tag doesn't rendered at all, but I can't say why - it's definitely a local problem. Can you send me a URL with a problem page?  --- [[user>RedRat|Alexey Markov]] //2012/09/12 14:24//
==== Installation into wrong folder ====

**FIX 12/6/2011**

>> I'm not sure why, but if you install this by using the DokuWiki installer, it puts the installed files into a weird folder /lib/plugins/RedRat-flowplayer-xxxxxxx.  The README says this folder should be named /lib/plugins/flowplayer.  Make sure you don't have a folder with the same name, do the DokuWiki installer from the Download link above, and then rename the folder to /lib/plugins/flowplayer and it worked for me.

> That's because the plugin is missing the required [[devel:plugin_info|plugin.info.txt]]. That's needed for the plugin installer to know into which folder to install a plugin (if the plugin's folder is called something else, like in this case as it's downloaded from github). --- [[user>ach|Anika Henke]] //2011/12/07 23:59//

Fixed in the current version by adding valid plugin.info.txt file.  --- [[user>RedRat|Alexey Markov]] //2012/09/12 14:16//
==== Changing the Controls? ====
> If you go to http://flowplayer.org/setup/index.html you can modify the look of the controls on the player. If you click on "Standalone Page" and then view the source, the part that generates the flowplayer looks something like this:
>
> <code>
<script language="JavaScript">
	flowplayer("player", "http://releases.flowplayer.org/swf/flowplayer-3.2.7.swf", {"clip":{"provider":"pseudostreaming","url":"http://vod01.netdna.com/vod/demo.flowplayer/Extremists.flv"},"screen":{"height":"100pct","top":0},"plugins":{"controls":{"timeColor":"#ffffff","borderRadius":"0px","buttonOffColor":"rgba(130,130,130,1)","bufferGradient":"none","sliderColor":"#000000","zIndex":1,"backgroundColor":"rgba(0, 0, 0, 0)","scrubberHeightRatio":0.6,"tooltipTextColor":"#ffffff","volumeSliderGradient":"none","sliderGradient":"none","spacing":{"time":6,"volume":8,"all":2},"timeBorderRadius":20,"timeBgHeightRatio":0.8,"volumeSliderHeightRatio":0.6,"progressGradient":"none","height":26,"volumeColor":"rgba(253, 207, 0, 1)","name":"controls","timeSeparator":" ","tooltips":{"marginBottom":5,"buttons":false},"volumeBarHeightRatio":0.2,"opacity":1,"timeFontSize":12,"left":"50pct","tooltipColor":"rgba(0, 0, 0, 0)","bufferColor":"#a3a3a3","border":"0px","volumeSliderColor":"#ffffff","buttonColor":"#ffffff","durationColor":"rgba(253, 207, 0, 1)","autoHide":{"enabled":true,"hideDelay":500,"mouseOutDelay":500,"hideStyle":"fade","hideDuration":400,"fullscreenOnly":true},"backgroundGradient":"none","width":"100pct","display":"block","sliderBorder":"1px solid rgba(128, 128, 128, 0.7)","buttonOverColor":"#ffffff","url":"flowplayer.controls-3.2.5.swf","progressColor":"rgba(253, 207, 0, 1)","timeBorder":"0px solid rgba(0, 0, 0, 0.3)","timeBgColor":"rgb(0, 0, 0, 0)","scrubberBarHeightRatio":0.2,"bottom":0,"builtIn":false,"volumeBorder":"1px solid rgba(128, 128, 128, 0.7)","margins":[2,12,2,12]},"rtmp":{"netConnectionUrl":"rtmp://vod01.netdna.com/play","url":"http://builds.flowplayer.netdna-cdn.com/flowplayer.rtmp-3.2.3.swf"}}});
</script>
</code>
> Is there a way to modify the syntax.php file so the plugin always uses some modified controls like that?

Yes, of course! You can add any needed parameters right into the function render() in the syntax.php file.  --- [[user>RedRat|Alexey Markov]] //2012/09/12 14:21//


==== French language ====

<code php>
<?php
/**
 * French language file
 *
 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
 * @author     Fabrice Dejaigher <fabrice@chtiland.com>
 */

$lang['GetFlash'] = 'Vous devez installer <a href="http://get.adobe.com/flashplayer/">Flash Player</a> pour voir cette vidéo !';
</code>

 --- [[user>Chtiland|chtiland]] //2013/12/30 19:02//