new MovieAnnot()
A movie annotation contains animated graphics and sound to be presented on the computer screen and through the speakers. When the annotation is activated, the movie is played.
Methods
-
<static> create(doc, pos)
-
Creates a new Movie annotation in the specified document.
Parameters:
Name Type Description doc
PDFNet.SDFDoc A document to which the Movie annotation is added.
pos
PDFNet.rect A rectangle specifying the Movie annotation's bounds in default user space units.
Returns:
A promise that resolves to a newly created blank Movie annotation.
- Type
- PDFNet.MovieAnnot
-
<static> createFromAnnot(ann)
-
creates a Movie annotation and initializes it using given annotation object.
Parameters:
Name Type Description ann
PDFNet.Annot Annot object used to initialize the Movie annotation.
Returns:
A promise that resolves to an object of type: "MovieAnnot"
- Type
- PDFNet.MovieAnnot
-
<static> createFromObj(d)
-
creates a Movie annotation and initializes it using given Cos/SDF object.
Parameters:
Name Type Description d
PDFNet.Obj The Cos/SDF object to initialze the annotation with.
Returns:
A promise that resolves to an object of type: "MovieAnnot"
- Type
- PDFNet.MovieAnnot
-
getTitle()
-
Returns the title of the Movie Annotation.
Returns:
A promise that resolves to a string representing the title of the Movie Annotation.
- Type
- string
-
isToBePlayed()
-
Returns the option of whether the Movie is to be played.
Returns:
A promise that resolves to a boolean value indicating if the movie is to be played.
- Type
- boolean
-
setTitle(title)
-
sets the title of the Movie Annotation. (Optional)
Parameters:
Name Type Description title
string A string representing the title of the Movie Annotation.
-
setToBePlayed(isplay)
-
sets the option of whether the Movie is to be played. (Optional)
Parameters:
Name Type Description isplay
boolean A boolean value telling if the movie is to be played. Default value: true.