Sound

A sound clip.

Go to Property Listing | Method Listing

Objects:

Boolean, File, Graphic, Guide, Images, Layer, Link, Movie, Number, Object, PageItem, Sound, SoundPosterTypes, String, XMLItem

Property Listing

Property	Type	Access	Description
allowOverrides	Boolean	read/write	If true, the master page item can be overridden.
associatedXMLElement	XMLItem	readonly	The XML element associated with the Sound.
description	String	read/write	The description of the Sound.
doNotPrintPoster	Boolean	read/write	If true, the sound poster does not print with the document.
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	String File	read/write	The file path (colon delimited on the Mac OS). Can also accept: File.
geometricBounds	Array of Number Array of String	read/write	The bounds of the Sound 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 Sound.
id	Number	readonly	The unique ID of the Sound.
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 Sound within its containing object.
itemLayer	Layer	read/write	The layer that the Sound is on.
itemLink	Link	readonly	The source file of the link.
label	String	read/write	A property that can be set to any string.
name	String	read/write	The name of the Sound.
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 Sound (a PageItem, Oval, Rectangle or Polygon).
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.
soundPosterType	SoundPosterTypes SoundPosterTypes.NONE SoundPosterTypes.PROXY_IMAGE SoundPosterTypes.STANDARD	read/write	The type of sound poster.
verticalScale	Number	read/write	The vertical scaling applied to the Sound.
visibleBounds	Array of Number Array of String	read/write	The bounds of the Sound 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 autoTag ()

Tag the object or the parent story using default tags defined in XML preference.

undefined bringForward ()

Brings the Sound forward one level in its layer.

undefined bringToFront ()

Brings the Sound to the front.

undefined clearTransformations ()

Clears transformations from the Sound. Transformations include rotation, scaling, flipping, fitting, and shearing.

undefined convertShape (given:ConvertShapeOptions, numberOfSides:Number, insetPercentage:Number, cornerRadius:Number String)

Converts the Sound to a different shape.

Parameter	Type	Description
given	ConvertShapeOptions ConvertShapeOptions.CONVERT_TO_BEVELED_RECTANGLE ConvertShapeOptions.CONVERT_TO_CLOSED_PATH ConvertShapeOptions.CONVERT_TO_INVERSE_ROUNDED_RECTANGLE ConvertShapeOptions.CONVERT_TO_LINE ConvertShapeOptions.CONVERT_TO_OPEN_PATH ConvertShapeOptions.CONVERT_TO_OVAL ConvertShapeOptions.CONVERT_TO_POLYGON ConvertShapeOptions.CONVERT_TO_RECTANGLE ConvertShapeOptions.CONVERT_TO_ROUNDED_RECTANGLE ConvertShapeOptions.CONVERT_TO_STRAIGHT_LINE ConvertShapeOptions.CONVERT_TO_TRIANGLE	The Sound's new shape.
numberOfSides	Number (range 3 - 100)	The number of sides for the resulting polygon. (Range: 3 to 100) (Optional)
insetPercentage	Number (range 0 - 100)	The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional)
cornerRadius	Number String	The corner radius of the resulting rectangle. (Optional)

undefined detach ()

Detaches an overridden master page item from the master page.

Sound duplicate ()

Duplicates the Sound.

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.

Sound 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)

Moves the Sound to a new location. Note: Either the 'to' or 'by' parameter is required; if both parameters are defined, only the to value is used.

Parameter	Type	Description
to	Array of 2 Units Page Spread Layer	The new location of the Sound,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional)
by	Array of Number Array of String	The amount (in measurement units) to move the Sound relative to its current position, in the format (x, y). (Optional)

Parameter

Type

Description

Array of 2 Units

Page

Spread

Layer

The new location of the Sound,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional)

Array of Number

Array of String

The amount (in measurement units) to move the Sound relative to its current position, in the format (x, y). (Optional)

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 placeXML (using:XMLElement)

Places XML content into the specified object. Note: Replaces any existing content.

Parameter	Type	Description
using	XMLElement	The XML element whose content you want to place.

undefined redefineScaling (to:Array of Number)

Apply an item's scaling to its content if possible.

Parameter	Type	Description
to	Array of Number	The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional)

undefined remove ()

Deletes the Sound.

undefined removeOverride ()

Removes the override from a previously overridden master page item.

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 Sound 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 Sound in relation to previously selected objects. (Optional)

(default: SelectionOptions.REPLACE_WITH)

undefined sendBackward ()

Sends the Sound back one level in its layer.

undefined sendToBack ()

Sends the Sound to the back.

Asset store (using:Library, withProperties:Object)

Stores the object in the specified library.

Parameter	Type	Description
using	Library	The library in which to store the object.
withProperties	Object	Initial values for properties of the new Sound (Optional)

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

undefined transform (in:CoordinateSpaces, from:Array of Varies AnchorPoint AnchorPoints 2 Reals BoundingBoxLimitss CoordinateSpacess Arrays of 2 Reals LongIntegers, withMatrix:Array of Varies 6 Reals TransformationMatrix, replacingCurrent:Array of Varies MatrixContent enumerators MatrixContent LongInteger, [consideringRulerUnits:Boolean=Boolean])

Transform the page item.

Parameter	Type	Description
in	CoordinateSpaces CoordinateSpaces.INNER_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.PASTEBOARD_COORDINATES	The coordinate space to use
from	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 AnchorPoints AnchorPoint Array of 2 Reals BoundingBoxLimitss BoundingBoxLimits CoordinateSpacess CoordinateSpaces Array of Arrays of 2 Reals LongIntegers	The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.
withMatrix	Array of 6 Reals TransformationMatrix	Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix.
replacingCurrent	Array of MatrixContent enumerators MatrixContent MatrixContent.ROTATION_VALUE MatrixContent.SCALE_VALUES MatrixContent.SHEAR_VALUE MatrixContent.TRANSLATION_VALUES LongInteger	Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional)
consideringRulerUnits	Boolean	If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) (default: false)