Packagecom.aispeech.device
Classpublic class MicrophoneDevice
InheritanceMicrophoneDevice Inheritance flash.events.EventDispatcher

MicrophoneDevice is a singleton Note that, MicrophoneDevice instance does not response show up System panel when the microphone device is muted. Refer to AISpeechAPI_AS_SDK_Test::TestMicrophoneDevice.mxml for test cases


Public Properties
 PropertyDefined By
  actualSampleRate : Number
[read-only]
MicrophoneDevice
  micGain : Number
get mic gain
MicrophoneDevice
  micInstance : Microphone
[read-only]
MicrophoneDevice
  state : String
MicrophoneDevice
Public Methods
 MethodDefined By
  
MicrophoneDevice(singleMade:SingleMade)
Singleton constructor
MicrophoneDevice
  
addSampleDataEventListener():void
Add SampleDataEvent listener to the microphone instance
MicrophoneDevice
  
getInstance():MicrophoneDevice
[static] Get a MicrophoneDevice (singleton) instance
MicrophoneDevice
  
init(encodingType:String, sampleRate:Number = 22):void
Initialise the Microphone device
MicrophoneDevice
  
removeSampleDataEventListener():void
Remove SampleDataEvent listener from the microphone instance
MicrophoneDevice
  
setSampleRate(value:Number, isLocalService:Boolean = false):void
set microphone device sample rate
MicrophoneDevice
Public Constants
 ConstantDefined By
  DEFAULT_ENCODING_TYPE : String = NellyMoser
[static]
MicrophoneDevice
  DEFAULT_MICROPHONE_GAIN : int = 75
[static]
MicrophoneDevice
  DEFAULT_SAMPLE_RATE : Number = 22
[static]
MicrophoneDevice
Property Detail
actualSampleRateproperty
actualSampleRate:Number  [read-only]


Implementation
    public function get actualSampleRate():Number
micGainproperty 
micGain:Number

get mic gain


Implementation
    public function get micGain():Number
    public function set micGain(value:Number):void
micInstanceproperty 
micInstance:Microphone  [read-only]


Implementation
    public function get micInstance():Microphone
stateproperty 
state:String


Implementation
    public function get state():String
    public function set state(value:String):void
Constructor Detail
MicrophoneDevice()Constructor
public function MicrophoneDevice(singleMade:SingleMade)

Singleton constructor

Parameters
singleMade:SingleMade
Method Detail
addSampleDataEventListener()method
public function addSampleDataEventListener():void

Add SampleDataEvent listener to the microphone instance

getInstance()method 
public static function getInstance():MicrophoneDevice

Get a MicrophoneDevice (singleton) instance

Returns
MicrophoneDevice — MicrophoneDevice singleton instance
init()method 
public function init(encodingType:String, sampleRate:Number = 22):void

Initialise the Microphone device

Parameters

encodingType:String (default = NaN) — Acceptable values are SoundCodec.NELLYMOSER or SoundCodec.SPEEX. The default is NellyMoser
 
sampleRate:Number (default = 22) — In kHZ, Acceptable values are 5, 8, 11, 22, and 44. The default value is 22 kHz

removeSampleDataEventListener()method 
public function removeSampleDataEventListener():void

Remove SampleDataEvent listener from the microphone instance

setSampleRate()method 
public function setSampleRate(value:Number, isLocalService:Boolean = false):void

set microphone device sample rate

Parameters

value:Number — support: 8, 11, 22, 44 (NellyMoser) and 16 (SpeeX and Local Service)
 
isLocalService:Boolean (default = false)

Constant Detail
DEFAULT_ENCODING_TYPEConstant
public static const DEFAULT_ENCODING_TYPE:String = NellyMoser

DEFAULT_MICROPHONE_GAINConstant 
public static const DEFAULT_MICROPHONE_GAIN:int = 75

DEFAULT_SAMPLE_RATEConstant 
public static const DEFAULT_SAMPLE_RATE:Number = 22




Copyright 2011-2012 AI Speech Ltd

Tue Mar 26 2013, 01:05 PM +08:00