K4 InDesign Javascript API Documentation

Interactive ElementsSounds

A collection of sound clips.

Instance Properties

Name Description Access
length number The number of objects in the collection. read-only

Methods

add(
[layer] ​[, at], reference ​[, withProperties])
  → Sound
anyItem(
)
  → Sound
count(
)
  → number
everyItem(
)
  → Sound
firstItem(
)
  → Sound
item(
index)
  → Sound
itemByID(
id)
  → Sound
itemByName(
name)
  → Sound
itemByRange(
from, to)
  → Sound
lastItem(
)
  → Sound
middleItem(
)
  → Sound
nextItem(
obj)
  → Sound
previousItem(
obj)
  → Sound
toSource(
)
  → string
add(
[layer] ​[, at=LocationOptions.UNKNOWN], reference ​[, withProperties])
  → Sound
Creates a new Sound
layer Layer The layer on which to create the Sound. (Optional)
at LocationOptions The location at which to insert the Sound relative to the reference object or within the container object. (Optional)
reference 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)
anyItem(
)
  → Sound
Returns any Sound in the collection.
count(
)
  → number
Displays the number of elements in the Sound.
everyItem(
)
  → Sound
Returns every Sound in the collection.
firstItem(
)
  → Sound
Returns the first Sound in the collection.
item(
index)
  → Sound
Returns the Sound with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
  → Sound
Returns the Sound with the specified ID.
id number The ID.
itemByName(
name)
  → Sound
Returns the Sound with the specified name.
name string The name.
itemByRange(
from, to)
  → Sound
Returns the Sounds within the specified range.
from The Sound, index, or name at the beginning of the range. Can accept: Sound, Long Integer or String.
to The Sound, index, or name at the end of the range. Can accept: Sound, Long Integer or String.
lastItem(
)
  → Sound
Returns the last Sound in the collection.
middleItem(
)
  → Sound
Returns the middle Sound in the collection.
nextItem(
obj)
  → Sound
Returns the Sound whose index follows the specified Sound in the collection.
obj Sound The Sound whose index comes before the desired Sound.
previousItem(
obj)
  → Sound
Returns the Sound with the index previous to the specified index.
obj Sound The index of the Sound that follows the desired Sound.
toSource(
)
  → string
Generates a string which, if executed, will return the Sound.