Sounds

A collection of sound clips.

Methods:

add, count, item, itemByName, itemByID, itemByRange, firstItem, lastItem, middleItem, previousItem, nextItem, anyItem, everyItem, toSource, []

Property Listing

Property

Type

Access

Description

length

Number

readonly

The number of objects in the collection.

Method Listing

Sound [] (index:Number)

Returns the Sound with the specified index.

Parameter

Type

Description

index

Number

The index.

Sound add (layer:Layer, [at:LocationOptions=LocationOptions], reference:Varies, withProperties:Object)

Creates a new Sound

Parameter

Type

Description

layer

Layer

The layer on which to create the Sound. (Optional)

at

LocationOptions

LocationOptions.BEFORE

LocationOptions.AFTER

LocationOptions.AT_END

LocationOptions.AT_BEGINNING

LocationOptions.UNKNOWN

The location at which to insert the Sound relative to the reference object or within the container object. (Optional)

(default: LocationOptions.UNKNOWN)

reference

Varies

The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional)

withProperties

Object

Initial values for properties of the new Sound (Optional)

Sound anyItem ()

Returns any Sound in the collection.

Number count ()

Displays the number of elements in the Sound.

Sound everyItem ()

Returns every Sound in the collection.

Sound firstItem ()

Returns the first Sound in the collection.

Sound item (index:Varies)

Returns the Sound with the specified index or name.

Parameter

Type

Description

index

Varies

The index or name. Can accept: Long Integer or String.

Sound itemByID (id:Number)

Returns the Sound with the specified ID.

Parameter

Type

Description

id

Number

The ID.

Sound itemByName (name:String)

Returns the Sound with the specified name.

Parameter

Type

Description

name

String

The name.

Sound itemByRange (from:Varies, to:Varies)

Returns the Sounds within the specified range.

Parameter

Type

Description

from

Varies

The Sound, index, or name at the beginning of the range. Can accept: Sound, Long Integer or String.

to

Varies

The Sound, index, or name at the end of the range. Can accept: Sound, Long Integer or String.

Sound lastItem ()

Returns the last Sound in the collection.

Sound middleItem ()

Returns the middle Sound in the collection.

Sound nextItem (obj:Sound)

Returns the Sound whose index follows the specified Sound in the collection.

Parameter

Type

Description

obj

Sound

The Sound whose index comes before the desired Sound.

Sound previousItem (obj:Sound)

Returns the Sound with the index previous to the specified index.

Parameter

Type

Description

obj

Sound

The index of the Sound that follows the desired Sound.

String toSource ()

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

Object of

Oval.sounds

Rectangle.sounds

GraphicLine.sounds

Polygon.sounds

SplineItem.sounds

Page.masterPageItems