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
public class CuePoint
- extends PdfDictionary
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
Fields inherited from class com.itextpdf.text.pdf.PdfObject |
ARRAY, BOOLEAN, bytes, DICTIONARY, INDIRECT, indRef, NAME, NOTHING, NULL, NUMBER, STREAM, STRING, TEXT_PDFDOCENCODING, TEXT_UNICODE, type |
Constructor Summary |
CuePoint(PdfName subtype)
Constructs a CuePoint object. |
Method Summary |
void |
setAction(PdfObject action)
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 |
setName(PdfString name)
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 |
CuePoint
public CuePoint(PdfName subtype)
- Constructs a CuePoint object.
A
Navigation
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.
An Event
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
setName
public void setName(PdfString name)
- 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
public void setAction(PdfObject action)
- 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
Copyright © 2015. All Rights Reserved.