By TravisCarden: Updated Wistia codec to support API change.
[project/video_filter.git] / README.txt
1
2 This is a highly flexible and easy extendable filter module to embed any type
3 of video in your site using a simple tag. Other modules can add video
4 sites/formats (called codecs) using an easy plug-in architecture.
5
6 ========= Installation =========
7
8 Enable the module on the modules page.
9
10 Go to admin/config/content/formats and configure the text format(s) that should
11 be allowed to use this filter. Check the box to enable Video Filter and save.
12 Some simple settings are available if you configure the text format. There you
13 can change the default size and auto play settings.
14
15 Make sure that Video Filter is processed before "Convert URLs to links".
16 You can do this by dragging and dropping Video Filter to the top of the
17 processing order list. Do this even if it's allready on top, just to make sure!
18
19 If you're using the "Limit allowed HTML tags" filter, make sure Video Filter is
20 processed after that filter.
21
22 To enable WYSIWYG support, go to the WYSIWYG settings for each input format and
23 enable the Video Filter button.
24
25 ========= Usage =========
26
27 Single video: [video:url]
28 This will output the video using the default settings.
29
30 Random video from multiple URL's: [video:url,url]
31 This will output one of the specified videos each time.
32
33 You can also set some parameters in the call:
34
35 [video:url width:X height:Y align:left/right autoplay:1/0]
36 This will override the default settings for this video.
37
38 ========= Developers =========
39
40 This module calls hook_codec_info(), so you can add your own codecs.
41
42 Example:
43
44 function MODULE_codec_info() {
45   $codecs = array();
46   // You can offer multiple video formats in one module.
47   $codecs['youtube'] = array(
48     // Will be used some day in user information.
49     'name' => t('YouTube'),
50
51     // Special instructions for end users. Optional.
52     'instructions' => t('Any special instructions that users need to know about
53     to get this codec working correctly.'),
54
55     // The callback that will output the right embed code.
56     'callback' => 'MODULE_youtube',
57
58     // HTML5 callback, for returning something that's device agnostic.
59     // @SEE video_filter_youtube_html5.
60     'html5_callback' => 'MODULE_service_html5',
61
62     // Regexp can be an array. $video['codec']['delta'] will be set to the key.
63     'regexp' => '/youtube\.com\/watch\?v=([a-z0-9]+)/i',
64
65     // Ratio for resizing within user-given width and height (ratio = width / height)
66     'ratio' => 425 / 355,
67   );
68   return $codecs;
69 }
70
71 And this will be your callback function:
72
73 function MODULE_youtube($video) {
74   // $video contains the video URL in source, the codec (as above) and also
75   // [code][matches] with the result of the regexp and [codec][delta] with the
76   // key of the matched regexp.
77   $video['source'] = 'http://www.youtube.com/v/' . $video['codec']['matches'][1] . ($video['autoplay'] ? '&autoplay=1' : '');
78
79   // Outputs a general <object...> for embedding flash players. Needs width,
80   // height, source and optionally align (left or right) and params (a list of
81   // <param...> attributes)
82   return video_filter_flash($video);
83 }
84
85 ========= Troubleshooting =========
86
87 If videos don't show up, try disabling any browser plugins, such as AdBlock.