| Package | com.acapela.vaas.advanced |
| Class | public class MessageExt |
| Inheritance | MessageExt  Message |
You may use it for advanced tunning of the audio format.
This class enables you for:
When you need one of this features you create and configure a MessageExt instead of a Message.
Then you pass it to generate/retrieveMessage.
The Message instance sent as a result of this functions will be in fact a MessageExt instance.
As for the Message class, the read-write properties can be setted by you when generating a message or by the API when retrieving one.
One exception: the downloadAltSnd property that is never retrieved by the service as it is an instruction for the Synthesizer class.
| Property | Defined by | ||
|---|---|---|---|
 | accessCounter : Number
Number of times that this message was accessed (using
retrieveMessage function). | Message | |
| altCompression : String
The compression of an alternative sound to associate to the message.
| MessageExt | ||
| altSoundFileExtension : String
The extension of the altenative sound file associated to the message.
| MessageExt | ||
| altSoundFileType : String
The format of the alternative sound file associated to the message.
| MessageExt | ||
| altSoundSize : Number [read-only]
Size in octets of the alternative sound associated to the message.
| MessageExt | ||
| altSoundURL : String [read-only]
URL of the alternative sound associated to the message.
| MessageExt | ||
| comment : String
The comment associated to a message.
| Message | |
| compression : String
The compression of the sound associated to the message.
| MessageExt | ||
| downloadAltSnd : Boolean
set to true to ask the
Synthesizer to dowload the alternative sound instead of the main one. | MessageExt | ||
| equalizer : Equalizer
The equalizer settings of the sound associated to the message
| Message | |
| id : String
The identifier of the message.
| Message | |
| shaping : Number
The shaping of the sound associated to the message
| Message | |
| sound : Sound
The instance of
Sound | Message | |
| soundFileExtension : String
The extension of the sound file associated to the message.
| MessageExt | ||
| soundFileType : String
The format of the sound file associated to the message.
| MessageExt | ||
| soundLength : Number
Duration in milliseconds of the sound associated to the message.
| Message | |
| soundSize : Number
Size in octets of the sound associated to the message.
| Message | |
| soundURL : String
URL of the sound associated to the message.
| Message | |
| speed : Number
The speed of the sound associated to the message
| Message | |
| text : String
The text of the message that will be synthesized.
| Message | |
| voice : String
The voice used to synthesize the text of the message.
| Message | |
| volume : Number
The volume of the sound associated to the message
| Message | |
| Method | Defined by | ||
|---|---|---|---|
|
constuctor
| MessageExt | ||
| Constant | Defined by | ||
|---|---|---|---|
| CBR_16_MP3_COMPRESSION : String = "CBR_16" [static]
Constant bit rate 16 kbits per seconds MP3 compression.
| MessageExt | ||
| CBR_24_MP3_COMPRESSION : String = "CBR_24" [static]
Constant bit rate 24 kbits per seconds MP3 compression.
| MessageExt | ||
| CBR_32_MP3_COMPRESSION : String = "CBR_32" [static]
Constant bit rate 32 kbits per seconds MP3 compression.
| MessageExt | ||
| CBR_48_MP3_COMPRESSION : String = "CBR_48" [static]
Constant bit rate 48 kbits per seconds MP3 compression.
| MessageExt | ||
| CBR_8_MP3_COMPRESSION : String = "CBR_8" [static]
Constant bit rate 8 kbits per seconds MP3 compression.
| MessageExt | ||
| DEFAULT_MP3_COMPRESSION : String = "" [static]
Default value for (alternative) compression - Will let the service choose the compression to use.
| MessageExt | ||
| SOUND_FILE_TYPE_MP3 : String = "MP3" [static]
File type of the sound in format MP3.
| MessageExt | ||
| SOUND_FILE_TYPE_RAW : String = "RAW" [static]
File type of the sound in format RAW.
| MessageExt | ||
| SOUND_FILE_TYPE_WAV : String = "WAV" [static]
File type of the sound in format WAV.
| MessageExt | ||
| VBR_5_MP3_COMPRESSION : String = "VBR_5" [static]
Variable bit rate MP3 compression - Quality level = 5 (9=min, 5=max)
| MessageExt | ||
| VBR_6_MP3_COMPRESSION : String = "VBR_6" [static]
Variable bit rate MP3 compression - Quality level = 6 (9=min, 5=max)
| MessageExt | ||
| VBR_7_MP3_COMPRESSION : String = "VBR_7" [static]
Variable bit rate MP3 compression - Quality level = 7 (9=min, 5=max)
| MessageExt | ||
| VBR_8_MP3_COMPRESSION : String = "VBR_8" [static]
Variable bit rate MP3 compression - Quality level = 8 (9=min, 5=max)
| MessageExt | ||
| VBR_9_MP3_COMPRESSION : String = "VBR_9" [static]
Variable bit rate MP3 compression - Quality level = 9 (9=min, 5=max)
| MessageExt | ||
| altCompression | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesaltCompression:String [read-write]The compression of an alternative sound to associate to the message.
Using an alternative sound is needed only when you cannot use a single format for all the targets of your application
For instance you may want to deploy you application on PCs and Mobile Phones and select an appropriate for each target:
VBR_5 for PCs users assuming they have a fast internet connection.CBBR_16 for mobile phone users assuming they have a slow internet connection.The default value is DEFAULT_MP3_COMPRESSION.
public function get altCompression():String
public function set altCompression(value:String):void
| altSoundFileExtension | property |
altSoundFileExtension:String [read-write]The extension of the altenative sound file associated to the message.
for example : ".mp3"
When left empty, the service will use a default extension.
If this value is null, the service will choose the extension of the sound file to generate follow the file type format.
Implementation public function get altSoundFileExtension():String
public function set altSoundFileExtension(value:String):void
| altSoundFileType | property |
altSoundFileType:String [read-write]The format of the alternative sound file associated to the message.
Specifying the format of the sound file is needed only when you need to generate two sound formats for one message.
If this value is null, no alternative sound will be generated.
The default value is SOUND_FILE_TYPE_MP3.
public function get altSoundFileType():String
public function set altSoundFileType(value:String):void
| altSoundSize | property |
altSoundSize:Number [read-only]Size in octets of the alternative sound associated to the message.
Implementation public function get altSoundSize():Number
| altSoundURL | property |
altSoundURL:String [read-only]
URL of the alternative sound associated to the message.
Warning:
This URL is valid only for an immediat usage.
Please store/share only the message ID and use retrieveMessage to get the URL.
public function get altSoundURL():String
| compression | property |
compression:String [read-write]The compression of the sound associated to the message.
Specifying the compression is needed only when the default settings are not matching your expectations.
The default value is DEFAULT_MP3_COMPRESSION.
public function get compression():String
public function set compression(value:String):void
| downloadAltSnd | property |
downloadAltSnd:Boolean [read-write]
set to true to ask the Synthesizer to dowload the alternative sound instead of the main one.
When using RESPONSE_AS_STREAMING / RESPONSE_AS_SOUND response type the service will respond with the alternative file.
The default value is false.
public function get downloadAltSnd():Boolean
public function set downloadAltSnd(value:Boolean):void
| soundFileExtension | property |
soundFileExtension:String [read-write]The extension of the sound file associated to the message.
for example : ".mp3"
When left empty, the service will use a default extension.
If this value is null, the service will choose the extension of the sound file to generate follow the file type format.
Implementation public function get soundFileExtension():String
public function set soundFileExtension(value:String):void
| soundFileType | property |
soundFileType:String [read-write]The format of the sound file associated to the message.
Specifying the format of the sound file is needed only when the default settings are not matching your expectations.
If this value is null, the sound will be in format MP3.
The default value is SOUND_FILE_TYPE_MP3.
public function get soundFileType():String
public function set soundFileType(value:String):void
| MessageExt | () | constructor |
public function MessageExt()constuctor
| CBR_16_MP3_COMPRESSION | constant |
public static const CBR_16_MP3_COMPRESSION:String = "CBR_16"Constant bit rate 16 kbits per seconds MP3 compression.
| CBR_24_MP3_COMPRESSION | constant |
public static const CBR_24_MP3_COMPRESSION:String = "CBR_24"Constant bit rate 24 kbits per seconds MP3 compression.
| CBR_32_MP3_COMPRESSION | constant |
public static const CBR_32_MP3_COMPRESSION:String = "CBR_32"Constant bit rate 32 kbits per seconds MP3 compression.
| CBR_48_MP3_COMPRESSION | constant |
public static const CBR_48_MP3_COMPRESSION:String = "CBR_48"Constant bit rate 48 kbits per seconds MP3 compression.
| CBR_8_MP3_COMPRESSION | constant |
public static const CBR_8_MP3_COMPRESSION:String = "CBR_8"Constant bit rate 8 kbits per seconds MP3 compression.
| DEFAULT_MP3_COMPRESSION | constant |
public static const DEFAULT_MP3_COMPRESSION:String = ""Default value for (alternative) compression - Will let the service choose the compression to use.
| SOUND_FILE_TYPE_MP3 | constant |
public static const SOUND_FILE_TYPE_MP3:String = "MP3"File type of the sound in format MP3.
| SOUND_FILE_TYPE_RAW | constant |
public static const SOUND_FILE_TYPE_RAW:String = "RAW"File type of the sound in format RAW.
| SOUND_FILE_TYPE_WAV | constant |
public static const SOUND_FILE_TYPE_WAV:String = "WAV"File type of the sound in format WAV.
| VBR_5_MP3_COMPRESSION | constant |
public static const VBR_5_MP3_COMPRESSION:String = "VBR_5"Variable bit rate MP3 compression - Quality level = 5 (9=min, 5=max)
| VBR_6_MP3_COMPRESSION | constant |
public static const VBR_6_MP3_COMPRESSION:String = "VBR_6"Variable bit rate MP3 compression - Quality level = 6 (9=min, 5=max)
| VBR_7_MP3_COMPRESSION | constant |
public static const VBR_7_MP3_COMPRESSION:String = "VBR_7"Variable bit rate MP3 compression - Quality level = 7 (9=min, 5=max)
| VBR_8_MP3_COMPRESSION | constant |
public static const VBR_8_MP3_COMPRESSION:String = "VBR_8"Variable bit rate MP3 compression - Quality level = 8 (9=min, 5=max)
| VBR_9_MP3_COMPRESSION | constant |
public static const VBR_9_MP3_COMPRESSION:String = "VBR_9"Variable bit rate MP3 compression - Quality level = 9 (9=min, 5=max)