A collection of sound clips.
Methods
Soundadd ([layer:
Layer][, at:
LocationOptions=UNKNOWN ][, reference:
any][, withProperties:
Object])
Creates a new Sound
| Parameter | Type | Description |
|---|---|---|
| layer | Layer | The layer on which to create the Sound. (Optional) |
| at | LocationOptions : BEFORE AFTER AT_END AT_BEGINNING UNKNOWN |
The location at which to insert the Sound relative to the reference object or within the container object. (Optional) (default: UNKNOWN ) |
| reference | Document Spread MasterSpread Page Layer PageItem |
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) |
SoundanyItem ()
Returns any Sound in the collection.
number count ()
Displays the number of elements in the Sound.
Array of SoundeveryItem ()
Returns every Sound in the collection.
SoundfirstItem ()
Returns the first Sound in the collection.
Sounditem (index:
any)
Returns the Sound with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer String |
The index or name. Can accept: Long Integer or String. |
SounditemByID (id:
number)
Returns the Sound with the specified ID.
| Parameter | Type | Description |
|---|---|---|
| id | number | The ID. |
SounditemByName (name:
string)
Returns the Sound with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array of SounditemByRange (from:
any, to:
any)
Returns the Sounds within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | Sound Long Integer String |
The Sound, index, or name at the beginning of the range. Can accept: Sound, Long Integer or String. |
| to | Sound Long Integer String |
The Sound, index, or name at the end of the range. Can accept: Sound, Long Integer or String. |
SoundlastItem ()
Returns the last Sound in the collection.
SoundmiddleItem ()
Returns the middle Sound in the collection.
SoundnextItem (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. |
SoundpreviousItem (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.