Issue #1894656 by corvus_ch: Allow seeking by url paramters.
[project/jw_player.git] / README.txt
1 -- SUMMARY --
2
3 The JW Player module adds a new field for displaying video files in a JW Player.
4
5 For a full description visit the project page:
6   http://drupal.org/project/jw_player
7 Bug reports, feature suggestions and latest developments:
8   http://drupal.org/project/issues/jw_player
9
10
11 -- REQUIREMENTS --
12
13 * This module depends on the File module, which is part of Drupal core, Chaos
14   Tools (http://drupal.org/project/ctools) and the Libraries module
15   (http://drupal.org/project/libraries).
16
17
18 -- INSTALLATION --
19
20 * Download either the latest commercial or the latest non-commercial JW
21   Player at http://www.longtailvideo.com/players/jw-flv-player/.
22
23 * Extract the zip file and put the contents of the extracted folder in
24   libraries/jwplayer. 
25   E.g.: sites/all/libraries/jwplayer or sites/<sitename>/libraries/jwplayer
26         
27 * Install this module as described at http://drupal.org/node/895232.
28
29 * Go to Administration > Reports > Status reports (admin/reports/status) to
30   check your configuration.
31
32
33 -- BASIC USAGE --
34
35 In that majority of cases JW Player is used as a field formatter on a file
36 field. Before enabling JW Player on a field visit /admin/config/media/jw_player
37 to configure one or more presets. A preset is a group of JW Player settings,
38 such as dimentions and skin, that can be re-used multiple times.
39
40 Once a preset has been defined visit /admin/structure/types and select "manage
41 display" for the content type you'd like to configure and select "JW player" as
42 the formatter on the relevant file field. At this point you will also need to
43 click on the cog beside the field to select the preset you'd like to apply to
44 the file. That's it - videos uploaded to this field should now be displayed
45 using JW Player!
46
47 -- URL BASED SEEKING --
48
49 You can create permanent links that make jWPlayer start playing at a given
50 time frame. The url must look like this:
51
52  /path/to/site?seek=<TIME>#<PLAYER_ID>
53
54 <TIME> is the offset in seconds the player should start and <PLAYER_ID>
55 is the id of the player the seeking is targeted on. This enables seeking
56 for sites with multiple instances of jWPlayer on it.
57
58 Not that seeking only works if the server delivering the media file is
59 capable of doing so. If the Server does not support this the player will
60 always start at the beginning.