Package com.itextpdf.text.pdf.richmedia
Class CuePoint
java.lang.Object
com.itextpdf.text.pdf.PdfObject
com.itextpdf.text.pdf.PdfDictionary
com.itextpdf.text.pdf.richmedia.CuePoint
- All Implemented Interfaces:
Serializable
A video file can contain cue points that are encoded in a video stream
or may be created by an associated ActionScript within the Flash content.
The CuePoint dictionary contains a state that relates the cue points to
an action that may be passed to the conforming application or may be used
to change the appearance. Cue points in the Flash content are matched to
the cue points declared in the PDF file by the values specified by the
Name or Time keys. (See ExtensionLevel 3 p91)
- Since:
- 5.0.0
- See Also:
-
Field Summary
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Sets an action dictionary defining the action that is executed if this cue point is triggered, meaning that the Flash content reached the matching cue point during its playback.void
Set the name of the cue point to match against the cue point within Flash content and for display purposes.void
setTime
(int time) Sets the time value of the cue point in milliseconds to match against the cue point within Flash content and for display purposes.Methods inherited from class com.itextpdf.text.pdf.PdfDictionary
checkType, clear, contains, get, getAsArray, getAsBoolean, getAsDict, getAsIndirectObject, getAsName, getAsNumber, getAsStream, getAsString, getDirectObject, getKeys, isCatalog, isFont, isOutlineTree, isPage, isPages, merge, mergeDifferent, put, putAll, putEx, remove, size, toPdf, toString
Methods inherited from class com.itextpdf.text.pdf.PdfObject
canBeInObjStm, getBytes, getIndRef, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, length, setContent, setIndRef, type
-
Constructor Details
-
CuePoint
Constructs a CuePoint object. ANavigation
cue point is an event encoded in a Flash movie (FLV). A chapter stop may be encoded so that when the user requests to go to or skip a chapter, a navigation cue point is used to indicate the location of the chapter. AnEvent
is a generic cue point of no specific significance other than a corresponding action is triggered.- Parameters:
subtype
- possible values: PdfName.NAVIGATION or PdfName.EVENT
-
-
Method Details
-
setName
Set the name of the cue point to match against the cue point within Flash content and for display purposes.- Parameters:
name
- the name of the cue point
-
setTime
public void setTime(int time) Sets the time value of the cue point in milliseconds to match against the cue point within Flash content and for display purposes.- Parameters:
time
- the time value of the cue point
-
setAction
Sets an action dictionary defining the action that is executed if this cue point is triggered, meaning that the Flash content reached the matching cue point during its playback.- Parameters:
action
- an action
-