Documentation for classes includes syntax, usage information, and code samples for methods, properties, and event handlers and listeners for those APIs that belong to a specific class in ActionScript. The classes are listed alphabetically. If you are not sure to which class a certain method or property belongs, you can look it up in the Index.
| Class | Package | Description | |
|---|---|---|---|
| BasicVaas
| com.acapela.vaas | The BasicVaas class is a simple all-in-one class that performs basic functions of the voice as a service API. | |
| BookmarkPosition
| com.acapela.vaas.advanced.synchro | A bookmark position associates a bookmark of the speech (generated by a \mrk=id\ tag in the text) to its id and the corresponding timestamp in the generated sound. | |
| BookmarkPositionEvent
| com.acapela.vaas.advanced.events | The event dispatched when a bookmark is hitten while playing the message - A bookmark is generated by a \mrk=id\ tag in the text. | |
| Connector
| com.acapela.vaas.advanced | The entry point of the VaaS Advanced API - responsible of authentication and communication with the platform. | |
| Equalizer
| com.acapela.vaas.advanced | Used to instruct the service to apply equalizer tunning to the message. | |
| Message
| com.acapela.vaas.advanced | The main parameter and result of the core functions - it contains the properties of a VaaS message. | |
| MessageEvent
| com.acapela.vaas.advanced.events | The event dispatched for each operation on a message (generation, retrieving, notification and deletation). | |
| MessageExt
| com.acapela.vaas.advanced | This class is an extension of the Message class - covers specific needs related to the Sound (other formats, compressions and details). | |
| MessageManager
| com.acapela.vaas.advanced | This class provides functions to manage the message stored by the service. | |
| MouthPosition
| com.acapela.vaas.advanced.synchro | A mouth position associates the characteristics of the mouth associated to a sequence in the speech and its corresponding timestamp in the generated sound. | |
| MouthPositionEvent
| com.acapela.vaas.advanced.events | The event dispatched for each mouth properties set associated to the message played. | |
| Player
| com.acapela.vaas.advanced |
Like Synthesizer it performs the core functions of the service but it adds MP3 sound playback synchronized with words, mouth and bookmarks positions. |
|
| PositionsManager
| com.acapela.vaas.advanced.synchro | Used to instuct the service to generate word, mouth and bookmark positions; then, when generated, it downloads and parses it. | |
| ProtocolEvent
| com.acapela.vaas.advanced.events | This "backdoor" event is used to modify requests or treat responses outside of the API classes : very unusualy needed. | |
| SoundEvent
| com.acapela.vaas.advanced.events | The events related to the status of sound downloading and playback. | |
| Synthesizer
| com.acapela.vaas.advanced | Performs the core functions of the service : generating messages and retrieving generated message - compliant with all sound types. | |
| VaasAS3
| Top Level | This class defines the VaaS ActionsScript 3 library (swc file) content. | |
| VaasError
| com.acapela.vaas.advanced | This class contains the details of an error reported by the API. | |
| VaasErrorEvent
| com.acapela.vaas.advanced.events |
The event dispatched by the Connector class when an error occurs. |
|
| VaasWarningEvent
| com.acapela.vaas.advanced.events |
The event dispatched by the Connector class when a warning is received (associated to a successfull request). |
|
| WordPosition
| com.acapela.vaas.advanced.synchro | A word position associates a word of the speech and its location in the text to the corresponding timestamp in the generated sound. | |
| WordPositionEvent
| com.acapela.vaas.advanced.events | The event dispatched for each word of the message played. |