You are here

README.txt in MediaElement 7

Same filename and directory in other branches
  1. 7.2 README.txt
Media Element
--------------------------------------------------------------------------------

Provides HTML5 video and audio elements using Mediaelement.js for HTML4 browsers.

Installation
--------------------------------------------------------------------------------

1. Download MediaElement from http://mediaelementjs.com/
2. Unzip into a libraries directory as supported by the libraries module with
   the name mediaelement (e.g., /sites/all/libraries/mediaelement).
3. Install the libraries and mediaelement modules.

Usage
--------------------------------------------------------------------------------

Set a file field or link field to use video (or audio) as its display formatter.
Or use the media module (http://drupal.org/project/media) if you want to have your
file field display images and video.

API
--------------------------------------------------------------------------------
This module supplies the MediaElement library as a Drupal library and has some
helper functions if you want to use it independently of fields. To add the
library into a page use the command:

drupal_add_library('mediaelement', 'mediaelement');

If you want to use the helper scripts include the script mediaelement.js included
with the module. You can do it using a command like:

drupal_add_js(drupal_get_path('module', 'mediaelement') . '/mediaelement.js');

Then you need to add settings for the script. They are a selector for jQuery and
settings. For example:

$settings = array('mediaelement' => array(
  '.class-name' => array(
    'controls' => TRUE,
    'opts' => array(), // This is the mediaelement scripts options.
  )
));
drupal_add_js($settings, 'setting');

For more details on the MediaElement API see http://mediaelementjs.com

Changelog
--------------------------------------------------------------------------------
7.x-1.0:
- #1026050 Fixed issue with Preprocessing problems.

7.x-1.0 Beta 3:
- Fixed bug where mediaelement js was having options passed in that were not its
  own and were causing the script to break.

7.x-1.0 Beta 2:
- Updated to MediaElement.js changes.
- Updated to Drupal API changes.

7.x-1.0 Beta 1:
- Added download media option.
- Added support to disable the controls.
- Added link.module support.
- Added configurable classes for each formatter settings. This will aid in
  custom themeing for each place a formatter is used.

7.x-1.x Alpha 1:
- Provide a global option for video and audio tags.
- Provide file field formatter for video and audio.

File

README.txt
View source
  1. Media Element
  2. --------------------------------------------------------------------------------
  3. Provides HTML5 video and audio elements using Mediaelement.js for HTML4 browsers.
  4. Installation
  5. --------------------------------------------------------------------------------
  6. 1. Download MediaElement from http://mediaelementjs.com/
  7. 2. Unzip into a libraries directory as supported by the libraries module with
  8. the name mediaelement (e.g., /sites/all/libraries/mediaelement).
  9. 3. Install the libraries and mediaelement modules.
  10. Usage
  11. --------------------------------------------------------------------------------
  12. Set a file field or link field to use video (or audio) as its display formatter.
  13. Or use the media module (http://drupal.org/project/media) if you want to have your
  14. file field display images and video.
  15. API
  16. --------------------------------------------------------------------------------
  17. This module supplies the MediaElement library as a Drupal library and has some
  18. helper functions if you want to use it independently of fields. To add the
  19. library into a page use the command:
  20. drupal_add_library('mediaelement', 'mediaelement');
  21. If you want to use the helper scripts include the script mediaelement.js included
  22. with the module. You can do it using a command like:
  23. drupal_add_js(drupal_get_path('module', 'mediaelement') . '/mediaelement.js');
  24. Then you need to add settings for the script. They are a selector for jQuery and
  25. settings. For example:
  26. $settings = array('mediaelement' => array(
  27. '.class-name' => array(
  28. 'controls' => TRUE,
  29. 'opts' => array(), // This is the mediaelement scripts options.
  30. )
  31. ));
  32. drupal_add_js($settings, 'setting');
  33. For more details on the MediaElement API see http://mediaelementjs.com
  34. Changelog
  35. --------------------------------------------------------------------------------
  36. 7.x-1.0:
  37. - #1026050 Fixed issue with Preprocessing problems.
  38. 7.x-1.0 Beta 3:
  39. - Fixed bug where mediaelement js was having options passed in that were not its
  40. own and were causing the script to break.
  41. 7.x-1.0 Beta 2:
  42. - Updated to MediaElement.js changes.
  43. - Updated to Drupal API changes.
  44. 7.x-1.0 Beta 1:
  45. - Added download media option.
  46. - Added support to disable the controls.
  47. - Added link.module support.
  48. - Added configurable classes for each formatter settings. This will aid in
  49. custom themeing for each place a formatter is used.
  50. 7.x-1.x Alpha 1:
  51. - Provide a global option for video and audio tags.
  52. - Provide file field formatter for video and audio.