Movie

A movie.

Go to Property Listing | Method Listing

Methods:

bringForward, bringToFront, detach, duplicate, extractLabel, fit, getElements, insertLabel, markup, move, override, remove, removeOverride, resetScaling, resize, select, sendBackward, sendToBack, store, toSource, toSpecifier, verifyURL

Objects:

Boolean, File, FloatingWindowPosition, FloatingWindowSize, Graphic, Guide, Images, Layer, Link, Movie, MoviePosterTypes, Number, Object, PageItem, PlayMode, Sound, String, XMLItem

Property Listing

Property	Type	Access	Description
associatedXMLElement	XMLItem	readonly	The XML element associated with the Movie.
description	String	read/write	The description of the Movie.
embedInPDF	Boolean	read/write	If true, the file is embedded in the PDF. If false, the file is linked to the PDF. Note: To embed movie files, acrobat compatibility must be acrobat 6 or higher.
filePath	File	read/write	The full path to the file.
floatingWindow	Boolean	read/write	If true, opens a new window to play the movie. If false, plays the movie in the poster frame on the PDF document page.
floatingWindowPosition	FloatingWindowPosition FloatingWindowPosition.CENTER FloatingWindowPosition.CENTER_LEFT FloatingWindowPosition.CENTER_RIGHT FloatingWindowPosition.LOWER_LEFT FloatingWindowPosition.LOWER_MIDDLE FloatingWindowPosition.LOWER_RIGHT FloatingWindowPosition.UPPER_LEFT FloatingWindowPosition.UPPER_MIDDLE FloatingWindowPosition.UPPER_RIGHT	read/write	The position of the floating window that displays the movie.
floatingWindowSize	FloatingWindowSize FloatingWindowSize.FULL FloatingWindowSize.MAX FloatingWindowSize.ONE_FIFTH FloatingWindowSize.ONE_FOURTH FloatingWindowSize.ONE_HALF FloatingWindowSize.QUADRUPLE FloatingWindowSize.TRIPLE FloatingWindowSize.TWICE	read/write	The size of the floating window that displays the movie.
geometricBounds	Array of Number Array of String	read/write	The bounds of the Movie excluding the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box.
horizontalScale	Number	read/write	The horizontal scaling applied to the Movie.
id	Number	readonly	The unique ID of the Movie.
images	Images Image	readonly	A collection of bitmap images in any bitmap file format (including TIFF, JPEG, or GIF).
index	Number	readonly	The index of the Movie within its containing object.
itemLayer	Layer	read/write	The layer that the Movie is on.
itemLink	Link	readonly	The source file of the link.
label	String	read/write	A property that can be set to any string.
moviePosterType	MoviePosterTypes MoviePosterTypes.FROM_MOVIE MoviePosterTypes.NONE MoviePosterTypes.PROXY_IMAGE MoviePosterTypes.STANDARD	read/write	The type of poster for the movie.
name	String	read/write	The name of the Movie.
overridden	Boolean	readonly	If true, the object originated on a master spread and was overridden. If false, the object either originated on a master spread and was not overridden, or the object did not originate on a master page.
overriddenMasterPageItem	Graphic Guide Movie PageItem Sound	readonly	An object that originated on a master page and has been overridden. Can return: PageItem, Guide, Graphic, Movie or Sound.
parent	Oval Rectangle PageItem Polygon	readonly	The parent of the Movie (a PageItem, Oval, Rectangle or Polygon).
playMode	PlayMode PlayMode.ONCE PlayMode.REPEAT_PLAY PlayMode.STAY_OPEN	read/write	The movie's playback mode.
playOnPageTurn	Boolean	read/write	If true, the movie plays automatically when a user views the page that contains the movie poster in the PDF document.
posterFile	String	read/write	The poster file.
properties	Object	read/write	A property that allows setting of several properties at the same time.
showControls	Boolean	read/write	If true, displays playback controls at the bottom of the movie display window.
url	String	read/write	The URL.
verticalScale	Number	read/write	The vertical scaling applied to the Movie.
visibleBounds	Array of Number Array of String	read/write	The bounds of the Movie including the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box.

Method Listing

undefined bringForward ()

Brings the Movie forward one level in its layer.

undefined bringToFront ()

Brings the Movie to the front.

undefined detach ()

Detaches an overridden master page item from the master page.

Movie duplicate ()

Duplicates the Movie.

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter	Type	Description
key	String	The key.

undefined fit (given:FitOptions)

Applies the specified fit option to content in a frame.

Parameter	Type	Description
given	FitOptions FitOptions.CENTER_CONTENT FitOptions.CONTENT_TO_FRAME FitOptions.FILL_PROPORTIONALLY FitOptions.FRAME_TO_CONTENT FitOptions.PROPORTIONALLY	The fit option to use.

Parameter

Type

Description

given

FitOptions

FitOptions.CENTER_CONTENT

FitOptions.CONTENT_TO_FRAME

FitOptions.FILL_PROPORTIONALLY

FitOptions.FRAME_TO_CONTENT

FitOptions.PROPORTIONALLY

The fit option to use.

Object getElements ()

Resolves the object specifier, creating an array of object references.

undefined insertLabel (key:String, value:String)

Sets the label to the value associated with the specified key.

Parameter	Type	Description
key	String	The key.
value	String	The value.

undefined markup (using:XMLElement)

Associates the page item with the specified XML element while preserving existing content.

Parameter	Type	Description
using	XMLElement	The XML element.

undefined move (to:Array of Varies 2 Units Page Spread Layer, by:Array of Number String, [transformingContent:Boolean=Boolean])

Move Page Item to a new location. One of the 'To' or 'By' parameters is required.

Parameter	Type	Description
to	Array of 2 Units Page Spread Layer	The new location of the object. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional)
by	Array of Number Array of String	Amount by which to move the object relative to its current position (Optional)
transformingContent	Boolean	If true then both the object and items within it are moved (Optional) (default: true)

Parameter

Type

Description

Array of 2 Units

Page

Spread

Layer

The new location of the object. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional)

Array of Number

Array of String

Amount by which to move the object relative to its current position (Optional)

transformingContent

Boolean

If true then both the object and items within it are moved (Optional)

(default: true)

Varies override (destinationPage:Page)

Overrides a master page item and places the item on the document page as a new object.

Parameter	Type	Description
destinationPage	Page	The document page that contains the master page item to override.

undefined remove ()

Deletes the Movie.

undefined removeOverride ()

Removes the override from a previously overridden master page item.

undefined resetScaling ()

Resets the Movie's scaling to 100%. Note: This does not change the size of the Movie. Instead, it makes the current size of the Movie the basis for future scaling.

undefined resize (horizontalScale:Number, verticalScale:Number, around:Array of Varies 2 Units AnchorPoint, [consideringCurrentScale:Boolean=Boolean], [transformingContent:Boolean=Boolean], [consideringParentsScale:Boolean=Boolean])

Resize the page item. You must specify either horizontal scale or vertical scale or both.

Parameter	Type	Description
horizontalScale	Number	The percentage of horizontal scale (Optional)
verticalScale	Number	The percentage of vertical scale (Optional)
around	Array of 2 Units AnchorPoint AnchorPoint.BOTTOM_CENTER_ANCHOR AnchorPoint.BOTTOM_LEFT_ANCHOR AnchorPoint.BOTTOM_RIGHT_ANCHOR AnchorPoint.CENTER_ANCHOR AnchorPoint.LEFT_CENTER_ANCHOR AnchorPoint.RIGHT_CENTER_ANCHOR AnchorPoint.TOP_CENTER_ANCHOR AnchorPoint.TOP_LEFT_ANCHOR AnchorPoint.TOP_RIGHT_ANCHOR	The point to scale around. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)
consideringCurrentScale	Boolean	If true then the object's current scale and new scale will be combined. If false then the new value is absolute. The default value is false. (Optional) (default: false)
transformingContent	Boolean	If true then both the object and items within it are scaled (Optional) (default: true)
consideringParentsScale	Boolean	If true then the object is scaled relative to its parent page item. If false it is scaled relative to the spread. (Optional) (default: false)

undefined select ([existingSelection:SelectionOptions=SelectionOptions])

Selects the object.

Parameter	Type	Description
existingSelection	SelectionOptions SelectionOptions.ADD_TO SelectionOptions.REMOVE_FROM SelectionOptions.REPLACE_WITH	The selection status of the Movie in relation to previously selected objects. (Optional) (default: SelectionOptions.REPLACE_WITH)

Parameter

Type

Description

existingSelection

SelectionOptions

SelectionOptions.ADD_TO

SelectionOptions.REMOVE_FROM

SelectionOptions.REPLACE_WITH

The selection status of the Movie in relation to previously selected objects. (Optional)

(default: SelectionOptions.REPLACE_WITH)

undefined sendBackward ()

Sends the Movie back one level in its layer.

undefined sendToBack ()

Sends the Movie to the back.

Asset store (using:Library)

Store a page item in a library

Parameter	Type	Description
using	Library	The library in which to store

String toSource ()

Generates a string which, if executed, will return the Movie.

String toSpecifier ()

Retrieves the object specifier.

Boolean verifyURL ()

Verifies that the specified URL is valid and contains the specified movie file. Valid only when the movie file is specified by a URL rather than a file path.