Video Easy Filter

Filters ::: filter_videoeasy
Maintained by Justin Hunt
VideoEasy is a filter to play mp4, mp3 and other media files with html5 players. It uses user editable templates to allow the admin to customize the appearance of existing players or to support new players. Predefined player templates support Video JS, JPlayer, JW Player, Flowplayer and MediaElement.js
Latest release:
871 sites
173 downloads
38 fans
Current versions available: 4

VideoEasy  replaces links to media files, with  html5 players. Primarily intended for html 5 video, it will also work for audio, youtube or rss links. The Video Easy filter uses templates to support multiple players, and allows the user to add new players or customize existing ones, all from the Video Easy filter settings pages. By default players are already defined, and can be used as is, for:

Video.js, JPlayer, JW Player, Flowplayer and MediaElement.js

But preset templates are available for other players, and you are encouraged to use the existing players and presets as examples, and make your own templates.

NB Questions and comments should be posted in the Video Easy forum thread.
https://moodle.org/mod/forum/discuss.php?d=382047

Installation

The easiest way to install is to use Moodle's automated plugin installer. However if you are uploading videoeasy via FTP, first expand the zip file and upload the videoeasy folder into:

[PATH TO MOODLE]/filters.


Then visit your Moodle server's Site Administration -> Notifications page. Moodle will guide you through the installation. On the final page of the installation you will be able to register templates. Since there are 15 template slots available, and each has a lot of fields. It is not practically possible to get much done here.  So ..... Just scroll to the bottom and press "save." 

After this each template has its own settings page. It is much easier to work with the settings that way. After installing you will need to enable the videoeasy filter. You can enable the videoeasy filter when you visit:

Site Administration / plugins / filters / manage filters

Finally you will need to associate a player/template with each of the file extensions, and select the file extensions that VideoEasy should handle. You can add/remove/edit the file extensions that VideoEasy can parse for, on the same page.

Do this at: Site Administration / plugins / filters / VideoEasy / General Settings

(NB JW Player requires you to register on their site, and you will be given a license code. You will need to enter that into the template for those players. See "Templates" in this document.)


Configuration

Configure the site wide settings  and define/edit templates at 

Site Administration / plugins / filters / Video Easy


On the general settings page you need to check the filetypes you wish the Video Easy filter to handle at the top of the settings page, and select the player template(drop down list) that will handle that file extension.


NB You should TURN OFF file handling for any extensions you select here in the Moodle Multi Media Plugins filter, and the PoodLL filter if they are installed.

Multi Media Plugins filter settings can be found at:

Site Administration / appearance / media embedding


PoodLL filter settings can be found at:

Site Administration / plugins / filters / PoodLL


Local Configuration

One of the strengths of Video Easy is that it makes use of the under utilized Moodle feature that allows you to configure filters at the course and at the activity level. Using this, for example, it is possible to display videos in a particular page using a different template/player to that used elsewhere. This would make it possible to make a page with 100 videos embedded, behave differently to a page with just a single video.

The rest of this document gets a bit technical. From here its not strictly necessary to read on.  

You might just watch this quick 5 minute introduction to VideoEasy.


Templates

There are several templates available to use. The first six are ready made, though they can be altered.They are: Video.js, JW Player, Flowplayer, MediaElement.js, and Youtube lightbox.


JW Player requires that you register with their site to get a personal javascript link. So you will need to do that first then enter it in the defaults field of the template before you can use them.

Each template has several fields, but only the name/key field is required:

1) required javascript url : The url of the JS file the html5 player requires.

2) required css url : The url of the CSS file the html5 player requires.

3) AMD : True or False. Since Moodle 2.9 certain libraries are loaded using Require.js. If the player library supports it, you will need to set this to true. Currently only VideoJS and JPlayer use this. 

4) Shim exports: For players that do not support AMD, but which you need to load with AMD you should specify here the name of the global object that they export. Then AMD will do fancy stuff to load it for you. And you can use the exported name in the load script.

5) template : The html that goes on the page. Often this is just a div , with a unique id. Sometimes it is html5 video tags.

6) load script : Any script which the player runs to load an individual player, usually with the unique id of a container div

7) defaults : Custom variables you may use in the template or load script, or default values for existing variables (ie width and height).

8) custom css: CSS that you need on the page, that can be edited here on the settings page.

9) upload css: It is possible to upload a CSS file for inclusion on the page. This is probably in the case that the file is not available online to be be simply linked to. 

10) upload js: It is possible to upload a JS file for inclusion on the page. This is probably in the case that the file is not available online to be be simply linked to. 

11) shim exports. As for 4) but with regards the uploaded js


Presets

Each template's page contains a drop down with a number of "preset" templates. (template templates ..I guess).  Using these you can quickly make new templates, or use as a starting point for your own template. The current presets are:

Video.js, JW Player, Flowplayer, MediaElement.js,Youtube Lightbox

In order to keep VideoEasy small, there are no actual JS players bundled. Flowplayer, JPlayer etc are all included on the page via CDN hosting sources. In some cases, it will work better if you have those players installed on your own web server. Notably if they have a flash fallback that has flash components, which are sensitive to crossdomain hosting issues. 


The Video Easy Variables

Variables are used to replace placeholders in the template and load scripts. A placeholder for a variable looks like this: @@VARIABLE@@ (variable name surrounded by @@ marks.)


These variables are generated by Video Easy after parsing the media link on the Moodle page. You can define your own in the defaults section if you wish. 

NB Video Easy supports the ?d=[width]x[height] notation that Moodle's multi media plugins filter uses, for all extensions, but not for Youtube links. But since almost nobody ever uses it, in most cases you will want to specify a width and height in the defaults section for the template. The variables WIDTH and HEIGHT are populated with the values from the url param when d=[width]x[height] is set.

Video Easy also supports passing in variable values via the video url. So if the url of the video was :

h.ttp://somewhere.com/video.mp4?color=green&subtitles=no

The template could access the variables "color" and "subtitles" and they would contain the values "green" and "no."


VideoEasy provides the following ready made variables for use in your template:

AUTOMIME = video file mime type determined by file extension.

FILENAME = filename of video

AUTOPNGFILENAME = the video filename but with a png extension

AUTOJPGFILENAME = the video filename but with a jpg extension

VIDEOURL = the url of the video

URLSTUB = the url of the video minus the file extension. 

AUTOPOSTERURLJPG = the full video url but with a jpg extension

AUTOPOSTERURLPNG = the full video url but with a png extension

DEFAULTPOSTERURL = url to a default poster image. VideoEasy ships with  bland grey image. But you can upload your own default poster image on the Video Easy general settings page.

TITLE = the video title (from linked text)

AUTOID = an auto generated id to use in the container div or elsewhere

CSSLINK = used internally to load a CSS file if needed.

PLAYER = the type of player (videojs, flowplayer ...etc)

WIDTH = the width of video

HEIGHT = the height of video

FILEEXT = the video file extension

COURSEID = the id of the current course

COURSECONTEXTID = the id of the current course context

Note that while the template replacement is a simple swap out of the placeholder text, the loader script replacement is a little different. The loader script replacement will remove surrounding quotes as well as the placeholder, and put a JS variable in their place.

 eg

 template: <video id="@@AUTOID@@" 

 becomes: <video id="123456"

 

 loader script: player{ id: "@@AUTOID@@"

 becomes: player{ id: opts['AUTOID']

 

And a final caution, Video Easy generates a loader script from the template (if required) but this will be cached by Moodle in most cases. Thats a good thing too. But it means you will need to run Moodle "purge all caches" after making changes to anything on the Video Easy filter settings page.

NB Questions and comments should be posted in the Video Easy forum thread.
https://moodle.org/mod/forum/discuss.php?d=382047



Enjoy

Screenshots

Screenshot #0
Screenshot #1
Screenshot #2
Screenshot #3
Screenshot #4
Screenshot #5
Screenshot #6

Contributors

Justin Hunt (Lead maintainer)
Please login to view contributors details and/or to contact them

Comments RSS

Comments

  • Wed, Oct 7, 2015, 9:21 PM
    Hi! I have the same problem as Pascal. If I add more than one sound (I use mp3 files), only the first one is showing. If I add second file after the first one, it's not showing it or any other content after that sound. I don't think it's the problem with the template because I've tried all of them, even made a custom one, and the result is the same.
  • Sat, Oct 10, 2015, 10:04 PM
    There was indeed a problem with multiple links in the same passage of html. But it should be fixed in the latest version
  • Tue, Dec 1, 2015, 7:43 PM
    Hi. If I would use the plugin for rtmp and for example flowplayer, is it possible?
    Is this plugin suitable for rtmp stream? (flowplayer engine is ok).
    Thanks
  • Wed, Dec 2, 2015, 10:07 AM
    I do not see any reason why you could not do that. Please try.
  • Fri, Dec 4, 2015, 5:58 AM
    I just downloaded VE to solve an auto-play problem I have, and it did that job nicely - so bravo there!

    Unfortunately the video no longer auto-resizes when the browser window size is changed - is there a way to fix that in the VE world?
  • Fri, Dec 4, 2015, 2:25 PM
    Hi Tim. All the players are just templates in VE. So fiddling with the JS , HTML and CSS in the templates gives you the power to turn the videos upside down if you want. Try removing the fixed width on the player template you are using or replace it with 100% and see what happens.

    Many of the players are responsive by default these days, but I put widths in the templates just because I thought people wanted them.
  • Wed, Jan 6, 2016, 3:05 PM
    Hello,
    Is it possible to create a playlist with this plugin?
  • Wed, Jan 6, 2016, 3:16 PM
    Yes. But depending on how you want to go about it, it might be easier to use Generico. An example of a Generico video playlist is here: http://demo.poodll.com/mod/page/view.php?id=146 . But you could do the same thing with videoeasy. The simplest way would be to use flowplayer or some other player's playlist functionality, and detail the media files in an xml or csv file. If you registered that file's extension to the playlist template then you could just upload/link to the file in an html area.
  • Mon, Jan 11, 2016, 7:15 AM
    Hey there,
    We have just upgraded to Moodle 3.0 (debian 3.2, php 5.4.45) and have started having problems with the Video Easy filter. It is not displaying videos and the following error is popping up in the browser console when loading a page with a video on it:

    http://imgur.com/VFm3TUz

    Any ideas what might be causing it?

    Thanks in advance!
    Bob Gilmore
  • Mon, Jan 11, 2016, 12:08 PM
    Yes. It looks like jquery is not available to the template. What version of Moodle/VideoEasy did you upgrade from? If you are using flowplayer, then you should try unchecking "Flowplayer needs jquery" in the template, and instead check "Load via AMD"

    I will have to review the way the existing preset templates are set up, they are probably not up to date with the new AMD stuff in some cases.
  • Mon, Jan 11, 2016, 10:44 PM
    Thanks for the reply!

    We switched from 2.8.something to 3.0.1 and video easy has pretty much been kept up-to-date as new releases come out.

    I made the changes you recommended to the flow player template as well as trying with Load via AMD on and off. I am no longer getting an error, but the video still fails to load. It does download the flowplayer.min.js and minimalist.css from releases.flowplayer.org but doesn't display the player. It does work correctly if I use another player / template, in this case Video JS. This is probably a workable solution for us, but I'll have to check with our users.

    Thanks again for your time helping get this sorted!
  • Tue, Jan 12, 2016, 8:06 AM
    Rather than fill this up with my issues, I've created a forum post: https://moodle.org/mod/forum/view.php?f=27
  • Fri, Jan 29, 2016, 4:15 PM
    Hi Justin, I have 2 moodle. One for production and one for testing. The test is a copy of the production and they work well.
    I update my moodle test from 2.8.10 to 3.02 and I have problem with video easy and jw player. On production everything is OK. But now on my test I have don't see any video.
    If I use another player like flowplayer or video JS, no problem, I see my video.
    When I loock inside, I have a javascript error : Uncaught ReferenceError: jwplayer is not defined
    Jquery is loaded, my key for jw player is OK.
    Have you some idea ?
    Best regards, Pascal
  • Sat, Jan 30, 2016, 5:47 PM
    I would check that the javascript for the JW player is loading ok. You need to use your jw player registration key in the URL for the jw player javascript library. It might be that your test server has not been registered. Login at jwplayer.com and confirm it is registered.
  • Mon, Feb 1, 2016, 1:53 AM
    Hi Justin,
    I use my jw player registration key in the URL as needed. When I inspect the code I see the jwplayer code. Here is 2 screenshots :
    http://test_www.elesi.eu/jwp_1.png
    http://test_www.elesi.eu/jwp_2.png
    Thank's
Please login to post comments