You are here

Home » API reference » jPlayer 6

README.txt in jPlayer 6

Same filename and directory in other branches
  1. 7.2 README.txt
The jPlayer module provides a wrapper around the jPlayer JavaScript library.
This library provides an HTML5-based player, that uses a Flash fallback for
browsers that do not support it. This module provides a default presentation
for the player, as well as integration with CCK file fields. This makes it
possible to easily convert the display of any file field into an audio player.

This player will only work with MP3 files, so please be sure to restrict the
file upload extensions on your file fields to only allow the mp3 extension.

jPlayer module was written by Nate Haug.

This Module Made by Robots: http://www.lullabot.com

Dependencies
------------

* CCK (Content module)
* FileField

Install
-------

1) Copy the jplayer folder to the modules folder in your installation. Usually
   this is sites/all/modules.

2) Download jPlayer from http://www.happyworm.com/jquery/jplayer/download.htm.
   The downloaded directory only contains 2 files, jplayer.jquery.js and
   Jplayer.swf. Place these two files in sites/all/libraries/jplayer.

3) In your Drupal site, enable the module under Administer -> Site building ->
   Modules (/admin/build/modules).

4) Add or configure a FileField under Administer -> Content management ->
   Content types -> [type] -> Manage Fields
   (admin/content/node-type/[type]/fields). Restrict the upload extension to
   only allow the mp3 extension. It's also a good idea to enable the Description
   option, as this can be used to label your files when they are displayed in
   the playlist.

5) Configure the display of your FileField to use "jPlayer player". If your want
   to have a multi-file field display as a playlist of songs, you may use the
   "jPlayer multi-file playlist" formatter.

6) Create a piece of content with the configured field. Give the file a
   description that will be used as the file label in the playlist.

Support
-------

Many issues you may have may be caused by jPlayer library itself, rather than
the Drupal module. Check with the jPlayer support pages for issues with Flash
warnings or the player behaving oddly:
http://www.happyworm.com/jquery/jplayer/support.htm
http://www.happyworm.com/jquery/jplayer/latest/developer-guide.htm#jPlayer-compatibility

If the problem is with the jPlayer Drupal module, please file a support request
at http://drupal.org/project/issues/jplayer.

File

README.txt
View source 
  1. 

  2. The jPlayer module provides a wrapper around the jPlayer JavaScript library.

  3. This library provides an HTML5-based player, that uses a Flash fallback for

  4. browsers that do not support it. This module provides a default presentation

  5. for the player, as well as integration with CCK file fields. This makes it

  6. possible to easily convert the display of any file field into an audio player.

  7. 

  8. This player will only work with MP3 files, so please be sure to restrict the

  9. file upload extensions on your file fields to only allow the mp3 extension.

  10. 

  11. jPlayer module was written by Nate Haug.

  12. 

  13. This Module Made by Robots: http://www.lullabot.com

  14. 

  15. Dependencies

  16. ------------

  17. 

  18. * CCK (Content module)

  19. * FileField

  20. 

  21. Install

  22. -------

  23. 

  24. 1) Copy the jplayer folder to the modules folder in your installation. Usually

  25.    this is sites/all/modules.

  26. 

  27. 2) Download jPlayer from http://www.happyworm.com/jquery/jplayer/download.htm.

  28.    The downloaded directory only contains 2 files, jplayer.jquery.js and

  29.    Jplayer.swf. Place these two files in sites/all/libraries/jplayer.

  30. 

  31. 3) In your Drupal site, enable the module under Administer -> Site building ->

  32.    Modules (/admin/build/modules).

  33. 

  34. 4) Add or configure a FileField under Administer -> Content management ->

  35.    Content types -> [type] -> Manage Fields

  36.    (admin/content/node-type/[type]/fields). Restrict the upload extension to

  37.    only allow the mp3 extension. It's also a good idea to enable the Description

  38.    option, as this can be used to label your files when they are displayed in

  39.    the playlist.

  40. 

  41. 5) Configure the display of your FileField to use "jPlayer player". If your want

  42.    to have a multi-file field display as a playlist of songs, you may use the

  43.    "jPlayer multi-file playlist" formatter.

  44. 

  45. 6) Create a piece of content with the configured field. Give the file a

  46.    description that will be used as the file label in the playlist.

  47. 

  48. Support

  49. -------

  50. 

  51. Many issues you may have may be caused by jPlayer library itself, rather than

  52. the Drupal module. Check with the jPlayer support pages for issues with Flash

  53. warnings or the player behaving oddly:

  54. http://www.happyworm.com/jquery/jplayer/support.htm

  55. http://www.happyworm.com/jquery/jplayer/latest/developer-guide.htm#jPlayer-compatibility

  56. 

  57. If the problem is with the jPlayer Drupal module, please file a support request

  58. at http://drupal.org/project/issues/jplayer.