Sound
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| allowOverrides | bool | r/w | If true, the master page item can be overridden. |
| associatedXMLElement | XMLItem | readonly | The XML element associated with the Sound. |
| description | string | r/w | The description of the Sound. |
| doNotPrintPoster | bool | r/w | If true, the sound poster does not print with the document. |
| 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 | string | r/w | The file path (colon delimited on the Mac OS). Can also accept: File. |
| geometricBounds | Array of Measurement Unit (Number or String) | r/w | 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 | 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 Sound. |
| 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 Sound within its containing object. |
| itemLayer | Layer | r/w | The layer that the Sound is on. |
| itemLink | Link | readonly | The source file of the link. |
| label | string | r/w | A property that can be set to any string. |
| name | string | r/w | The name of the Sound. |
| 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 | GraphicGuide 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 Sound (a PageItem, Oval, Rectangle or Polygon). |
| 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. |
| soundPosterType | SoundPosterTypes: SoundPosterTypes.NONE SoundPosterTypes.STANDARD SoundPosterTypes.PROXY_IMAGE |
r/w | The type of sound poster. |
| 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 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 ()
Brings the Sound to the front.
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.
| Parameter | Type | Description |
|---|---|---|
| given | ConvertShapeOptions: 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. |
| 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 | Measurement 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.
| 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 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.
| 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)])
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 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) |
| by | Array 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.
| Parameter | Type | Description |
|---|---|---|
| destinationPage | Page | The 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.
| Parameter | Type | Description |
|---|---|---|
| using | XMLElement | The XML element whose content you want to place. |
void 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) |
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.
| 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) |
void sendBackward ()
Sends the Sound back one level in its layer.
void 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.
void transform (in:
CoordinateSpaces, from:
any, withMatrix:
any[, replacingCurrent:
any][, consideringRulerUnits:
bool=false])
Transform the page item.
| Parameter | Type | Description |
|---|---|---|
| in | CoordinateSpaces: CoordinateSpaces.PASTEBOARD_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.INNER_COORDINATES | The coordinate space to use |
| from | AnchorPoint 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. |
| withMatrix |
Array
of 6 Reals TransformationMatrix | Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. |
| replacingCurrent |
Array
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) |
| consideringRulerUnits | bool | 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) |
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.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, 27-Jun-2010 v3.0.3d | Contents :: Index |