You are here

README.txt in JW Player 7.2

Same filename and directory in other branches
  1. 8 README.txt
  2. 7 README.txt
JW Player module for Drupal.

SUMMARY
-----------------------------------------------
The JW Player module adds a new field for rendering video and audio files
in a JW Player.

For a full description visit the project page:
  http://drupal.org/project/jw_player
Bug reports, feature suggestions and latest developments:
  http://drupal.org/project/issues/jw_player


REQUIREMENTS
-----------------------------------------------
* This module depends on the File module, which is part of Drupal core, Chaos
  Tools (http://drupal.org/project/ctools) and the Libraries module
  (http://drupal.org/project/libraries, 2.x or greater).


INSTALLATION
-----------------------------------------------
* Install this module as described at http://drupal.org/node/895232.

* For a Cloud-Hosted Player, visit admin/config/media/jw_player/settings and
  configure your Cloud-Hosted player's URL.

* For a Self-Hosted Player:

  * Download the self-hosted version of JW Player from http://www.jwplayer.com/

  * Extract the zip file and put the contents of the extracted folder in
    libraries/jwplayer.
    E.g.: sites/all/libraries/jwplayer or sites/<sitename>/libraries/jwplayer

  * Visit admin/config/media/jw_player/settings and configure your Self-Hosted
    Player License Key.

* Go to Administration > Reports > Status reports (admin/reports/status) to
  check your configuration.


BASIC USAGE
-----------------------------------------------
In the majority of cases JW Player is used as a field formatter on a file
field. Before enabling JW Player on a field, visit /admin/config/media/jw_player
to configure one or more presets. A preset is a group of JW Player settings,
such as dimensions and skin, that can be re-used multiple times.

Once a preset has been defined visit /admin/structure/types and select "manage
display" for the content type you'd like to configure and select "JW player" as
the formatter on the relevant file field. At this point you will also need to
click on the cog beside the field to select the preset you'd like to apply to
the file. That's it - videos uploaded to this field should now be displayed
using JW Player!


CUSTOM SKINS
-----------------------------------------------
Custom skins should be placed in a folder called "jwplayer_skins" in your
libraries directory (for example, sites/all/libraries). For versions older than
JW Player 7, the skin file will have an extension of ".xml" or ".swf". For
JW Player 7 and newer, all skins are defined as CSS files, and should have an
extension of ".css".

For additional information on creating custom skins, see the "Player Styling"
section below. You can also see examples of JW Player 7 skins by downloading
a self-hosted copy of JW Player, and reviewing the files located in the "skins"
subdirectory in the jwplayer folder.


URL BASED SEEKING
-----------------------------------------------
You can create permanent links that make jWPlayer start playing at a given
time frame. The url must look like this:

 /path/to/site?seek=<TIME>#<PLAYER_ID>

<TIME> is the offset in seconds the player should start and <PLAYER_ID>
is the id of the player the seeking is targeted on. This enables seeking
for sites with multiple instances of jWPlayer on it.

Not that seeking only works if the server delivering the media file is
capable of doing so. If the Server does not support this the player will
always start at the beginning.


LIMITATIONS
-----------------------------------------------
1) It is not possible to have multiple JW Player cloud-based presets on the
   same page. In such a situation, each player will have its own Player Library
   URL. When loaded on the same page, there will be a conflict. The way to
   resolve this issue is use one Cloud Player Library URL (the default defined
   on the General Settings page at /admin/config/media/jw_player/settings), and
   set each preset used on the page to have Drupal-defined settings.

2) Autoplay, loop, and muted functionality does not work on all browsers. Please
   refer to this page for information on which browsers support the attributes:
   https://www.jwplayer.com/html5/autoloop/

File

README.txt
View source
  1. JW Player module for Drupal.
  2. SUMMARY
  3. -----------------------------------------------
  4. The JW Player module adds a new field for rendering video and audio files
  5. in a JW Player.
  6. For a full description visit the project page:
  7. http://drupal.org/project/jw_player
  8. Bug reports, feature suggestions and latest developments:
  9. http://drupal.org/project/issues/jw_player
  10. REQUIREMENTS
  11. -----------------------------------------------
  12. * This module depends on the File module, which is part of Drupal core, Chaos
  13. Tools (http://drupal.org/project/ctools) and the Libraries module
  14. (http://drupal.org/project/libraries, 2.x or greater).
  15. INSTALLATION
  16. -----------------------------------------------
  17. * Install this module as described at http://drupal.org/node/895232.
  18. * For a Cloud-Hosted Player, visit admin/config/media/jw_player/settings and
  19. configure your Cloud-Hosted player's URL.
  20. * For a Self-Hosted Player:
  21. * Download the self-hosted version of JW Player from http://www.jwplayer.com/
  22. * Extract the zip file and put the contents of the extracted folder in
  23. libraries/jwplayer.
  24. E.g.: sites/all/libraries/jwplayer or sites//libraries/jwplayer
  25. * Visit admin/config/media/jw_player/settings and configure your Self-Hosted
  26. Player License Key.
  27. * Go to Administration > Reports > Status reports (admin/reports/status) to
  28. check your configuration.
  29. BASIC USAGE
  30. -----------------------------------------------
  31. In the majority of cases JW Player is used as a field formatter on a file
  32. field. Before enabling JW Player on a field, visit /admin/config/media/jw_player
  33. to configure one or more presets. A preset is a group of JW Player settings,
  34. such as dimensions and skin, that can be re-used multiple times.
  35. Once a preset has been defined visit /admin/structure/types and select "manage
  36. display" for the content type you'd like to configure and select "JW player" as
  37. the formatter on the relevant file field. At this point you will also need to
  38. click on the cog beside the field to select the preset you'd like to apply to
  39. the file. That's it - videos uploaded to this field should now be displayed
  40. using JW Player!
  41. CUSTOM SKINS
  42. -----------------------------------------------
  43. Custom skins should be placed in a folder called "jwplayer_skins" in your
  44. libraries directory (for example, sites/all/libraries). For versions older than
  45. JW Player 7, the skin file will have an extension of ".xml" or ".swf". For
  46. JW Player 7 and newer, all skins are defined as CSS files, and should have an
  47. extension of ".css".
  48. For additional information on creating custom skins, see the "Player Styling"
  49. section below. You can also see examples of JW Player 7 skins by downloading
  50. a self-hosted copy of JW Player, and reviewing the files located in the "skins"
  51. subdirectory in the jwplayer folder.
  52. URL BASED SEEKING
  53. -----------------------------------------------
  54. You can create permanent links that make jWPlayer start playing at a given
  55. time frame. The url must look like this:
  56. /path/to/site?seek=
  57. is the id of the player the seeking is targeted on. This enables seeking
  58. for sites with multiple instances of jWPlayer on it.
  59. Not that seeking only works if the server delivering the media file is
  60. capable of doing so. If the Server does not support this the player will
  61. always start at the beginning.
  62. LIMITATIONS
  63. -----------------------------------------------
  64. 1) It is not possible to have multiple JW Player cloud-based presets on the
  65. same page. In such a situation, each player will have its own Player Library
  66. URL. When loaded on the same page, there will be a conflict. The way to
  67. resolve this issue is use one Cloud Player Library URL (the default defined
  68. on the General Settings page at /admin/config/media/jw_player/settings), and
  69. set each preset used on the page to have Drupal-defined settings.
  70. 2) Autoplay, loop, and muted functionality does not work on all browsers. Please
  71. refer to this page for information on which browsers support the attributes:
  72. https://www.jwplayer.com/html5/autoloop/