Adobe InDesign CS4 (6.0) Object Model JS: Sound

InDesign CS4

Class

Sound

 A sound clip.

QuickLinks

autoTag, bringForward, bringToFront, clearTransformations, convertShape, detach, duplicate, extractLabel, fit, getElements, insertLabel, markup, move, override, placeXML, redefineScaling, remove, removeOverride, select, sendBackward, sendToBack, store, toSource, toSpecifier, transform

Hierarchy

Oval | PageItem | Polygon | Rectangle
Sound
Image | Link

Properties

PropertyTypeAccessDescription
allowOverridesbool r/wIf true, the master page item can be overridden.
associatedXMLElementXMLItem readonlyThe XML element associated with the Sound.
descriptionstring r/wThe description of the Sound.
doNotPrintPosterbool r/wIf true, the sound poster does not print with the document.
embedInPDFbool r/wIf 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.
filePathFilestring r/wThe file path (colon delimited on the Mac OS). Can also accept: File.
geometricBoundsArray of Measurement Unit (Number or String) r/wThe 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.
horizontalScalenumber r/wThe horizontal scaling applied to the text as a percentage of its current size. (Range: 1 to 1000)
idnumber readonlyThe unique ID of the Sound.
imagesImages readonlyA collection of bitmap images in any bitmap file format (including TIFF, JPEG, or GIF).
indexnumber readonlyThe index of the Sound within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
itemLayerLayer r/wThe layer that the Sound is on.
itemLinkLink readonlyThe source file of the link.
labelstring r/wA property that can be set to any string.
namestring r/wThe name of the Sound.
overriddenbool readonlyIf 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.
overriddenMasterPageItemGraphic
Guide
Movie
PageItem
Sound
readonlyAn object that originated on a master page and has been overridden. Can return: PageItem, Guide, Graphic, Movie or Sound.
parentOval
PageItem
Polygon
Rectangle
readonlyThe parent of the Sound (a PageItem, Oval, Rectangle or Polygon).
playOnPageTurnbool r/wIf true, the movie plays automatically when a user views the page that contains the movie poster in the PDF document.
posterFilestring r/wThe poster file.
propertiesObject r/wA property that allows setting of several properties at the same time.
soundPosterTypeSoundPosterTypes:
SoundPosterTypes.NONE
SoundPosterTypes.STANDARD
SoundPosterTypes.PROXY_IMAGE
r/wThe type of sound poster.
verticalScalenumber r/wThe vertical scaling applied to the text as a percentage of its current size. (Range: 1 to 1000)
visibleBoundsArray of Measurement Unit (Number or String) r/wThe 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.

Methods

Instances

void autoTag ()
Tag the object or the parent story using default tags defined in XML preference.

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

void bringToFront ([reference: PageItem])
Brings the Sound to the front of its layer or in front of a particular item.

ParameterTypeDescription
referencePageItemThe reference object to bring the object in front of (must have same parent) (Optional)

void clearTransformations ()
Clears transformations from the Sound. Transformations include rotation, scaling, flipping, fitting, and shearing.

void convertShape (given: ConvertShapeOptions[, numberOfSides: number][, insetPercentage: number][, cornerRadius: Measurement Unit (Number or String)])
Converts the Sound to a different shape.

ParameterTypeDescription
givenConvertShapeOptions:
ConvertShapeOptions.CONVERT_TO_RECTANGLE
ConvertShapeOptions.CONVERT_TO_ROUNDED_RECTANGLE
ConvertShapeOptions.CONVERT_TO_BEVELED_RECTANGLE
ConvertShapeOptions.CONVERT_TO_INVERSE_ROUNDED_RECTANGLE
ConvertShapeOptions.CONVERT_TO_OVAL
ConvertShapeOptions.CONVERT_TO_TRIANGLE
ConvertShapeOptions.CONVERT_TO_POLYGON
ConvertShapeOptions.CONVERT_TO_LINE
ConvertShapeOptions.CONVERT_TO_STRAIGHT_LINE
ConvertShapeOptions.CONVERT_TO_OPEN_PATH
ConvertShapeOptions.CONVERT_TO_CLOSED_PATH
The Sound's new shape.
numberOfSidesnumber (range: 3 - 100)The number of sides for the resulting polygon. (Range: 3 to 100) (Optional)
insetPercentagenumber (range: 0 - 100)The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional)
cornerRadiusMeasurement Unit (Number or String) (range: 0 - 800)The corner radius of the resulting rectangle. (Optional)

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

ParameterTypeDescription
keystringThe key.

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

ParameterTypeDescription
givenFitOptions:
FitOptions.CONTENT_TO_FRAME
FitOptions.CENTER_CONTENT
FitOptions.PROPORTIONALLY
FitOptions.FRAME_TO_CONTENT
FitOptions.FILL_PROPORTIONALLY
FitOptions.APPLY_FRAME_FITTING_OPTIONS
The fit option to use.

Array of Sound 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.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

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

ParameterTypeDescription
usingXMLElementThe XML element.

void move ([to: any][, by: Array of Measurement Unit (Number or 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.

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

any override (destinationPage: Page)
Overrides a master page item and places the item on the document page as a new object.

ParameterTypeDescription
destinationPagePageThe document page that contains the master page item to override.

void placeXML (using: XMLElement)
Places XML content into the specified object. Note: Replaces any existing content.

ParameterTypeDescription
usingXMLElementThe XML element whose content you want to place.

void redefineScaling ([to: Array of number])
Apply an item's scaling to its content if possible.

ParameterTypeDescription
toArray of numberThe scale factors to be left on the item. The default is {1.0, 1.0}. (Optional)

void remove ()
Deletes the Sound.

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

void select ([existingSelection: SelectionOptions=SelectionOptions.REPLACE_WITH])
Selects the object.

ParameterTypeDescription
existingSelectionSelectionOptions:
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)

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

void sendToBack ([reference: PageItem])
Sends the Sound to the back of its layer or behind a particular item (must have same parent).

ParameterTypeDescription
referencePageItemThe reference object to send the object behind (Optional)

Asset store (using: Library[, withProperties: Object])
Stores the object in the specified library.

ParameterTypeDescription
usingLibraryThe library in which to store the object.
withPropertiesObjectInitial 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.

void transform (in: CoordinateSpaces, from: any, withMatrix: any[, replacingCurrent: any][, consideringRulerUnits: bool=false])
Transform the page item.

ParameterTypeDescription
inCoordinateSpaces:
CoordinateSpaces.PASTEBOARD_COORDINATES
CoordinateSpaces.PARENT_COORDINATES
CoordinateSpaces.INNER_COORDINATES
CoordinateSpaces.SPREAD_COORDINATES
The coordinate space to use
fromAnchorPoint
AnchorPoint
Array of 2 Reals
Array of Arrays of 2 Reals
BoundingBoxLimits
CoordinateSpaces
Long Integers
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.
withMatrixArray of 6 Reals
TransformationMatrix
Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix.
replacingCurrentArray of MatrixContent
Long Integer
MatrixContent
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)
consideringRulerUnitsboolIf 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)

Element of

Button.overriddenMasterPageItem

EPS.overriddenMasterPageItem

FormField.overriddenMasterPageItem

Graphic.overriddenMasterPageItem

GraphicLine.overriddenMasterPageItem

Group.overriddenMasterPageItem

Guide.overriddenMasterPageItem

Image.overriddenMasterPageItem

ImportedPage.overriddenMasterPageItem

Link.parent

Movie.overriddenMasterPageItem

Oval.overriddenMasterPageItem

PDF.overriddenMasterPageItem

PICT.overriddenMasterPageItem

PageItem.overriddenMasterPageItem

Polygon.overriddenMasterPageItem

Rectangle.overriddenMasterPageItem

Sound.overriddenMasterPageItem

SoundBehavior.soundItem

TextFrame.overriddenMasterPageItem

WMF.overriddenMasterPageItem

XMLElement.xmlContent

Used in:

array of Sound Sounds.itemByRange (from: any, to: any)

Sound Sounds.nextItem (obj: Sound)

Sound Sounds.previousItem (obj: Sound)

void XMLElement.markup (using: any)

void XMLElement.placeXML (using: any)

XMLElement XMLElements.add (markupTag: any[, xmlContent: any][, withProperties: Object])

Return

Sound Sound.duplicate ()

Array of Sound Sound.getElements ()

Sound Sounds.[] (index: number)

Sound Sounds.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])

Sound Sounds.anyItem ()

Array of Sound Sounds.everyItem ()

Sound Sounds.firstItem ()

Sound Sounds.item (index: any)

Sound Sounds.itemByID (id: number)

Sound Sounds.itemByName (name: string)

Array of Sound Sounds.itemByRange (from: any, to: any)

Sound Sounds.lastItem ()

Sound Sounds.middleItem ()

Sound Sounds.nextItem (obj: Sound)

Sound Sounds.previousItem (obj: Sound)

Jongware, 20-Jun-2010 v3.0.3dContents :: Index