com.acapela.vaas.advanced.Connector

Package	com.acapela.vaas.advanced
Class	public class Connector
Inheritance	Connector flash.events.EventDispatcher

The entry point of the VaaS Advanced API - responsible of authentication and communication with the platform.

This class handles the connection to the service and gives access to its features.

The message generation is made by the Synthesizer instance accessible from synthesizer of this class.

All the potential errors/warnings reported by the API are also dispatched by this class.

Note about authentication :

Our service is constantly evolving and we do our best to maintain backward compliance.
That is why there is different ways to proceed with authentication:

using an evaluation account: your account is in fact an application of the EVAL_VAAS main account, see bellow.
using an application login (recommended): you set your main account login, the application login and the application password.
using an account created before the end of 2009: use your password as login and password (let the application empty).

This logins and passwords are setted using the accountLogin, applicationLogin and password parameters of the constructor.

If you receveived a service URL from Acapela (optional), you will have to set it using the serviceURL parameters.

See also related documents: Overview and Basic/Advanced comparison

Public Properties

	Property		Defined by
		messageManager : MessageManager [read-only] the `MessageManager instance associated to this Connector instance.`	Connector
		player : Player [read-only] the `Player instance associated to this Connector instance.`	Connector
		positionsManager : PositionsManager [read-only] the `PositionsManager instance associated to this Connector instance.`	Connector
		synthesizer : Synthesizer [read-only] the `Synthesizer instance associated to this Connector instance.`	Connector

	Method	Defined by
		Connector(accountLogin:String, applicationLogin:String, password:String, serviceURL:String = null) Create a new connector object instance.	Connector

	Event	Summary	Defined by
		error	Dispatched when an error was reported as a result to a request.	Connector
		warning	Dispatched when an warning was reported as a result to a request.	Connector

Property detail

messageManager

property

messageManager:MessageManager [read-only]

the MessageManager instance associated to this Connector instance.

It allows for generating deleting/notifying messages.


  Implementation


    public function get messageManager():MessageManager





player property  



player:Player  [read-only]
  
  the Player instance associated to this Connector instance.
  
It allows for generating and retrieving message with position managers options.

  Implementation


    public function get player():Player






positionsManager property  



positionsManager:PositionsManager  [read-only]
  
  the PositionsManager instance associated to this Connector instance.
  
It allows for generating the word-positions, bookmark-positions, and mouth-positions.

  Implementation


    public function get positionsManager():PositionsManager






synthesizer property  



synthesizer:Synthesizer  [read-only]
  the Synthesizer instance associated to this Connector instance.
  
It allows for generating new messages and retrieve existing ones.

  Implementation


    public function get synthesizer():Synthesizer



See also


com.acapela.vaas.advanced.Synthesizer



Constructor detail



Connector () constructor



public function Connector(accountLogin:String, applicationLogin:String, password:String, serviceURL:String = null)
  Create a new connector object instance.
  
Parameters


accountLogin:String — your main account login (received from Acapela).
  


 


applicationLogin:String — the login of your application (received from Acapela / created by you), pass null or "" if you don't have an application.
  


 


password:String — the password associated to the application or, if no application, the password of the account.
  


 


serviceURL:String (default = null) — If you receive a service URL from acapela, copy it here (do not forget the ending slash "/" is there is one).
If not, ommit this parameter, the default URL will be used.
   



See also


"Note about authentication" in class main description for furthers details.


Event detail



error event 



Event object type: com.acapela.vaas.advanced.events.VaasErrorEvent


VaasErrorEvent.type property = com.acapela.vaas.advanced.events.VaasErrorEvent.ERROR


   Dispatched when an error was reported as a result to a request.
   You can access to the corresponding VaasError instance using error property of this event.
   

   The VaasErrorEvent.ERROR constant defines the value of the type  property of an error event object.
   

   This event has the following properties: 
   
   Property Description
    bubbles false
    cancelable false
    error The VaasError instance corresponding to this event
    target The Connector instance that generated it.
   
        
   



warning event   



Event object type: com.acapela.vaas.advanced.events.VaasWarningEvent


VaasWarningEvent.type property = com.acapela.vaas.advanced.events.VaasWarningEvent.WARNING


   Dispatched when an warning was reported as a result to a request.
   You can access to the corresponding warning using warning property of this event.
   

  The VaasErrorEvent.ERROR constant defines the value of the type  property of an error event object.
   

   This event has the following properties: 
   
   Property Description
    warning The warning corresponding to this event
    bubbles false
    cancelable false   
    target The Connector instance that generated it.
   
     
   








All rights reserved to acapela group

Voice as a Service API (AS 3.0)	All Packages \| All Classes \| Index \| Frames No Frames
Class Connector	Properties \| Methods \| Events

	`accountLogin:String` — your main account login (received from Acapela).

	`applicationLogin:String` — the login of your application (received from Acapela / created by you), pass `null or "" if you don't have an application.`

	`password:String` — the password associated to the application or, if no application, the password of the account.

	`serviceURL:String` (default = `null`) — If you receive a service URL from acapela, copy it here (do not forget the ending slash "/" is there is one). If not, ommit this parameter, the default URL will be used.

Property	Description
bubbles	false
cancelable	false
error	The VaasError instance corresponding to this event
target	The `Connector` instance that generated it.

Property	Description
warning	The warning corresponding to this event
bubbles	false
cancelable	false
target	The `Connector` instance that generated it.