CortadoPlugin
This plugin allows one to add videos in a topic using the Cortado Java Applet.
Syntax Rules
-
%CORTADO{ "filename" web="Web" topic="Topic" width="int" height="int" CORTADO_OPTIONS }%
The
CORTADO_OPTIONS and other options except the
"filename" are optional. The
CORTADO_OPTIONS come from the
Cortado
README:
| Option: |
Type: |
Default: |
Description: |
| seekable |
boolean |
false |
Whether or not you can seek in the file. For live streams, this should be false; for on-demand files, this can be true. |
| duration |
int |
|
Length of clip in seconds. Needed when seekable is true, to allow the seek bar to work. |
| keepAspect |
boolean |
true |
Try to keep the natural aspect of the video when resizing the applet window. |
| video |
boolean |
true |
Use video. When not using video, this property will not create resources to play a video stream. |
| audio |
boolean |
true |
Use audio. When not using audio, this property will not create resources to play an audio stream. |
| statusHeight |
int |
12 |
The height of the status area |
| autoPlay |
boolean |
true |
Automatically start playback |
| showStatus |
enum (auto,show,hide) |
auto |
Controls how to make the status area visible. auto will show the status area when hovered over with the mouse. hide will only show the status area on error. show will always show the status area. |
| hideTimeout |
int |
0 |
Timeout in seconds to hide the status area when showStatus is auto. This timeout is to make sure that the status area is visible for the first timeout seconds of playback so that the user can see that there is a clickable status area too. |
| bufferSize |
int |
200 |
The size of the network buffer, in KB. A good value is max Kbps of the stream * 33 |
| bufferLow |
int |
10 |
Percentage of low watermark for buffer. Below this, the applet will stop playing and rebuffer until the high watermark is reached. |
| bufferHigh |
int |
70 |
Percentage of high watermark for buffer. At startup or when rebuffering, the applet will not play until this percentage of buffer fill status is reached. |
| userId |
string |
|
user id for basic authentication. |
| password |
string |
|
password for basic authentication. |
| debug |
int |
3 |
debug level, 0 - 4. Defaults to 3. Output goes to the Java console. |
Examples
-
%CORTADO{"video.ogg" web="Main" topic="MyTopic" width="320" height="240" autoPlay="false"}%
-
%CORTADO{"video.ogg" seekable="true" showStatus="show" audio="false" duration="272"}%
Plugin Settings
Plugin settings are stored in TWiki configuration.
$TWiki::cfg{Plugins}{CortadoPlugin}{DEBUG} = 1;
$TWiki::cfg{Plugins}{CortadoPlugin}{CortadoPath} = "/cortado-ovt-stripped-0.3.jar";
You may change them in the
configure script.
- Set SHORTDESCRIPTION = Embed videos in a topic using the Cortado Java Applet
Plugin Installation Instructions
Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the TWiki server.
- For an automated installation, run the configure script and follow "Find More Extensions" in the in the Extensions section.
- Or, follow these manual installation steps:
- Download the ZIP file from the Plugins home (see below).
- Unzip
CortadoPlugin.zip in your twiki installation directory. Content: | File: | Description: |
data/TWiki/CortadoPlugin.txt | Plugin topic |
lib/TWiki/Plugins/CortadoPlugin.pm | Plugin Perl module |
lib/TWiki/Plugins/CortadoPlugin/Config.spec | Plugin Config spec |
- Set the ownership of the extracted directories and files to the webserver user.
- Install the Cortado applet in the server:
- Plugin configuration and testing:
- Run the configure script, enable the plugin in the Plugins section, and configure the plugin in the Extensions section.
- Set the
{Plugins}{CortadoPlugin}{CortadoPath} setting to point to the plugin's attachment directory, such as https://twiki.org/p/pub/Plugins/CortadoPlugin/Plugins/CortadoPlugin/cortado-ovt-0.2.2.jar
- Test if the installation was successful: Attach a
.ogg file to a topic in the Sandbox web and a %CORTADO{}% variable.
Plugin Info
This work has been possible with the help of the following sponsors:
Related Topics: TWikiPlugins,
DeveloperDocumentationCategory,
AdminDocumentationCategory,
TWikiPreferences