CuePoints

Description

When the CalculateCuePoints property is set to True, information on "CuePoints" in the movie is written into the CuePoints parameter. If CalculateCuePoints has not been set to True, the CuePoints property is empty.

Cue Points are places in the movie where it pauses to wait for user input, such as a 'click to continue' textbox or button. It can be useful to have this information in XML format, to be able to implement interactivity in video playback software. For example, the XML can be passed in a parameter to JW Player and processed by a custom plugin to implement interactivity in MP4 movies played back in a web browser.

Syntax

[C#/C++]
public BSTR CuePoints;

[VB.NET]
Public Property CuePoints As String

Remarks

The format of the XML is:

<cuePoints>
  <cuePoint type="event" time="timestamp" data="cuepoint_description"/>
    ...more cue points...
</cuePoints>

The "time" attribute is the number of milliseconds from the start of the movie, as a decimal value.

The "data" attribute holds information about the object triggering the cuepoint. Its format is:

fb;<object id>;<object type>;<other object properties separated by ';'>

<object id> is the unique id value for that object in the movie

<object type> is a value specifying the type of object - see below for the values

TextBox:
fb;<id>;10;0|1 (display or do not display pause graphic)

Arrow:
fb;<id>;48;0|1 (display or do not display pause graphic)

Marker:
fb;<id>;9;0|1 (display or do not display pause graphic)

Pause:
fb;<id>;50;0|1 (display or do not display pause graphic);0|1 (wait click);int_duration_ms

Highlight:
fb;<id>;41;0|1 (display or do not display pause graphic)

Image:
fb;<id>;33;0|1 (display or do not display pause graphic)

Button:
fb;<id>;36;0|1 (display or do not display pause graphic);int_pause;int_origin_x;int_origin_y;int_width;int_height;int_duration;int_action;str_url_or_script_or_jumpto_or_playafter

 

So a full example of the cuepoint XML could be:

<cuePoints>
 <cuePoint type="event" time="2500" data="fb;1;33;0"/>
</cuePoints>

This describes a pause at 2.5 seconds into the movie to show an image. The default pause graphic is not displayed.

See Also

FBExportToMP4Params::CalculateCuePoints