A sound.
sound elements
| Name | Refer to By |
|---|---|
| images | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
sound properties
| Property | Type | Access | Description |
|---|---|---|---|
| associated XML element | XML item | read | The XML element associated with the object. |
| class | integer | read | The class descriptor type. |
| description | string | r/w | Description. |
| do not print poster | boolean | r/w | Does not print the sound poster. |
| embed in PDF | boolean | r/w | Embed content in PDF. |
| file path | alias or string | r/w | The file path. |
| geometric bounds | list of 4 numbers or strings | r/w | The bounds of the page item excluding the stroke width, in the form (top, left, bottom, right). |
| horizontal scale | fixed | r/w | The horizontal scaling percentage applied to the object, including the scaling applied to its containing object(s). |
| id | integer | read | A unique number identifying the object. |
| index | integer | read | Index of the object within its parent object. |
| item layer | layer | r/w | The layer the object is on. |
| item link | link | read | Link to a placed file. |
| label | string | r/w | A label that can be set to any string. |
| name | string | r/w | The name of the object. |
| object reference | object | read | An object reference for this object. |
| overridden | boolean | read | If true, this object originated on a master spread, was overridden, and is still linked to the object on the master spread. |
| overridden master page item | page item, guide, graphic, movie, sound | read | A reference to the original object on the master spread (for overridden objects). |
| parent | object | read | The parent of the object. |
| play on page turn | boolean | r/w | Play on page turn. |
| poster file | string | r/w | Poster file. |
| properties | record | r/w | Property that allows setting of several properties at the same time. |
| sound poster type | sound poster types enumeration | r/w | Current poster type (‘proxy image’ is read-only). |
| vertical scale | fixed | r/w | The vertical scaling percentage applied to the object, including the scaling applied to its containing object(s). |
| visible bounds | list of 4 numbers or strings | r/w | The bounds of the page item, including the stroke width, in the form (top, left, bottom, right). |
sound methods
| Method | Returns | Description |
|---|---|---|
| bring forward | Nothing | Brings the object forward. |
| bring to front | Nothing | Brings object to the front. |
| delete | Nothing | Delete the object. |
| detach | Nothing | Detaches an overridden page item from the master page item. |
| duplicate | object | Duplicates the object. |
| extract label | string | Gets the content of the label associated with the specified key (name). |
| fit | Nothing | Applies fitting options to the content of a frame. |
| insert label | Nothing | Sets the content of the label associated with the specified key (name), creating the label if it does not already exist. |
| markup | Nothing | Mark up layout content with XML preserving the existing content. |
| move | Nothing | Move Page Item to a new location. One of the ‘To’ or ‘By’ parameters is required. |
| override | page item, guide, graphic, movie or sound | Overrides an item from the master page and places it on the page. |
| remove override | Nothing | Removes a locally overridden master page item. |
| reset scaling | Nothing | Resets the scaling to 100%. Note that this does not change the size of the object; instead, it makes the current size of the object the basis for future scaling. |
| resize | Nothing | Resizes the object. |
| select | Nothing | Selects the object. |
| send backward | Nothing | Send object backward. |
| send to back | Nothing | Send object to the back. |
| store | asset | Stores the object in a library. |