Adobe InDesign CS2 (4.0) Object Model JS: Movie

InDesign CS2

Class

Movie

A movie.

QuickLinks

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

Hierarchy

Oval | PageItem | Polygon | Rectangle

Movie

Image | Link

Properties

Property	Type	Access	Description
associatedXMLElement	XMLItem	readonly	The XML element associated with the Movie.
description	string	r/w	The description of the Movie.
embedInPDF	bool	r/w	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	r/w	The full path to the file.
floatingWindow	bool	r/w	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.UPPER_LEFT FloatingWindowPosition.UPPER_MIDDLE FloatingWindowPosition.UPPER_RIGHT FloatingWindowPosition.CENTER_LEFT FloatingWindowPosition.CENTER FloatingWindowPosition.CENTER_RIGHT FloatingWindowPosition.LOWER_LEFT FloatingWindowPosition.LOWER_MIDDLE FloatingWindowPosition.LOWER_RIGHT	r/w	The position of the floating window that displays the movie.
floatingWindowSize	FloatingWindowSize: FloatingWindowSize.ONE_FIFTH FloatingWindowSize.ONE_FOURTH FloatingWindowSize.ONE_HALF FloatingWindowSize.FULL FloatingWindowSize.TWICE FloatingWindowSize.TRIPLE FloatingWindowSize.QUADRUPLE FloatingWindowSize.MAX	r/w	The size of the floating window that displays the movie.
geometricBounds	Array of Measurement Unit (Number or String)	r/w	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	r/w	The horizontal scaling applied to the text as a percentage of its current size. (Range: 1 to 1000)
id	number	readonly	The unique ID of the Movie.
images	Images	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	r/w	The layer that the Movie is on.
itemLink	Link	readonly	The source file of the link.
label	string	r/w	A property that can be set to any string.
moviePosterType	MoviePosterTypes: MoviePosterTypes.NONE MoviePosterTypes.STANDARD MoviePosterTypes.FROM_MOVIE MoviePosterTypes.PROXY_IMAGE	r/w	The type of poster for the movie.
name	string	r/w	The name of the Movie.
overridden	bool	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 PageItem Polygon Rectangle	readonly	The parent of the Movie (a PageItem, Oval, Rectangle or Polygon).
playMode	PlayMode: PlayMode.ONCE PlayMode.STAY_OPEN PlayMode.REPEAT_PLAY	r/w	The movie's playback mode.
playOnPageTurn	bool	r/w	If true, the movie plays automatically when a user views the page that contains the movie poster in the PDF document.
posterFile	string	r/w	The poster file.
properties	Object	r/w	A property that allows setting of several properties at the same time.
showControls	bool	r/w	If true, displays playback controls at the bottom of the movie display window.
url	string	r/w	The URL.
verticalScale	number	r/w	The vertical scaling applied to the text as a percentage of its current size. (Range: 1 to 1000)
visibleBounds	Array of Measurement Unit (Number or String)	r/w	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.

Methods

Instances

void bringForward ()
Brings the Movie forward one level in its layer.

void bringToFront ()
Brings the Movie to the front.

void 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.

void fit (given: FitOptions)
Applies the specified fit option to content in a frame.

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

Array of Object getElements ()
Resolves the object specifier, creating an array of object references.

void 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.

void markup (using: XMLElement)
Associates the page item with the specified XML element while preserving existing content.

Parameter	Type	Description
using	XMLElement	The XML element.

void move ([to: any][, by: Array of Measurement Unit (Number or String)][, transformingContent: bool=true])
Move Page Item to a new location. One of the 'To' or 'By' parameters is required.

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

any 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.

void remove ()
Deletes the Movie.

void removeOverride ()
Removes the override from a previously overridden master page item.

void 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.

void resize ([horizontalScale: number][, verticalScale: number][, around: any][, consideringCurrentScale: bool=false][, transformingContent: bool=true][, consideringParentsScale: bool=false])
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	AnchorPoint Array of 2 Units	The point to scale around. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)
consideringCurrentScale	bool	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	bool	If true then both the object and items within it are scaled (Optional) (default: true)
consideringParentsScale	bool	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)

void select ([existingSelection: SelectionOptions=SelectionOptions.REPLACE_WITH])
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)

void sendBackward ()
Sends the Movie back one level in its layer.

void 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.

bool 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.