Cues descriptor file format

MPlayer Module

Cues are moments in the video timeline where an action can be triggered.

The MPlayer module parses a Cue descirpion file as a flat text file with one cue information per line as follows.

A cue has four information:

The cue action timestamp: Specifies the time when the event fires calculated from the start of the clip. It is formatted as a hour:minutes:seconds expression.

the action URL: What URL to open when event fires.

Resume mode: What has to be done when user closes the action event popup. Usual actions are : “nothing”, “reset” or “continue”.

Optionnal: This informs the user that processing the required event is expected as a mandatory option or optional. (Experimental. At the moment is informative, but may have functional impact such as popup modality).

In discussion

Experimentations are investigating in accepting a first additional information that would be:

the clip index: Points to the clip the cue is defined for.

In that perspective, cues may be provided as a single file for all clips and not as a clip per clip file.

Cues file sample

00:12:00|http://my.moodle.com/mod/quiz/view?id=144|continue|mandatory
00:24:00|http://my.moodle.com/mod/glossary/view?id=122|continue|optional

The file should be UTF-8 encoded.

Return to the flowplayer user guide