Packagevegas.media
Classpublic class MicrophoneExpert
InheritanceMicrophoneExpert Inheritance MediaExpert Inheritance CoreModelObject Inheritance CoreModel Inheritance CoreEventDispatcher Inheritance Object

This expert manage all Microphone reference in the application.



Public Properties
 PropertyDefined By
 Inheritedchannel : String
[read-only] Indicates the channel of this dispatcher if this instance is global.
CoreEventDispatcher
  DEFAULT_SETTING : MicrophoneVO
[static] The default settings of the Microphone objects.
MicrophoneExpert
 Inheritedid : *
Returns the id of this IModelObject.
CoreModel
  microphone : Microphone
[read-only] Returns the Microphone client reference.
MicrophoneExpert
 Inheritedsecurity : Boolean = true
This property defined if the setCurrentVO method can accept the same vo in argument as the current one.
CoreModelObject
  setting : *
Determinates the settings of the current Microphone object with a MicrophoneVO object.
MicrophoneExpert
 Inheritedverbose : Boolean = true
Indicates if the expert use verbose debug mode or not.
MediaExpert
Public Methods
 MethodDefined By
  
MicrophoneExpert(setting:MicrophoneVO = null, index:int = 0, global:Boolean = false, channel:String = null, id:* = null)
Creates a new MicrophoneExpert instance.
MicrophoneExpert
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0.0, useWeakReference:Boolean = false):void
Allows the registration of event listeners on the event target.
CoreEventDispatcher
 Inherited
clear():void
Clear the model.
CoreModelObject
 Inherited
Returns and creates a new empty ModelObjectEvent.
CoreModelObject
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
CoreEventDispatcher
 Inherited
Returns the current ValueObject selected in this model.
CoreModelObject
 Inherited
Returns the internal system.events.EventDispatcher reference.
CoreEventDispatcher
 Inherited
Returns the event name use in the setCurrentVO method before is changed.
CoreModelObject
 Inherited
Returns the event name use in the setVO method.
CoreModelObject
 Inherited
Returns the event name use in the clear method.
CoreModelObject
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
CoreEventDispatcher
 Inherited
[override] This method is invoked in the constructor of the class to initialize all events.
MediaExpert
 Inherited
isGlobal():Boolean
Indicates if the dispatcher use a global event flow.
CoreEventDispatcher
 Inherited
isLocked():Boolean
Returns true if the object is locked.
CoreEventDispatcher
 Inherited
lock():void
Locks the object.
CoreEventDispatcher
 Inherited
Notify a ModelObjectEvent before the current ValueObject selected in the model is changed.
CoreModelObject
 Inherited
Notify a ModelObjectEvent when a ValueObject change in the model.
CoreModelObject
 Inherited
Notify a ModelObjectEvent when the model is cleared.
CoreModelObject
 Inherited
registerEventListener(type:String, listener:*, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Allows the registration of event listeners on the event target (Function or EventListener).
CoreEventDispatcher
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
CoreEventDispatcher
 Inherited
run(... arguments):void
Run the first process with this model.
CoreModel
 Inherited
Sets the current ValueObject selected in this model.
CoreModelObject
 Inherited
Sets the internal EventDispatcher reference.
CoreEventDispatcher
 Inherited
setEventTypeACTIVITY(type:String):void
Sets the event name when the Camera activity change.
MediaExpert
 Inherited
setEventTypeBEFORE_CHANGE(type:String):void
Returns the event name use in the setCurrentVO method before is changed.
CoreModelObject
 Inherited
setEventTypeCHANGE(type:String):void
Returns the event name use in the setVO method.
CoreModelObject
 Inherited
setEventTypeCLEAR(type:String):void
Returns the event name use in the clear method.
CoreModelObject
 Inherited
setEventTypeMUTED(type:String):void
Sets the event name when the Camera is muted.
MediaExpert
 Inherited
setEventTypeUNMUTED(type:String):void
Sets the event name when the Camera is unmuted.
MediaExpert
 Inherited
setGlobal(flag:Boolean = false, channel:String = null):void
Sets if the instance use a global system.events.EventDispatcher to dispatch this events, if the flag value is false the instance use a local EventDispatcher.
CoreEventDispatcher
  
setMicrophone(index:int = 0):void
Sets the camera reference of the expert.
MicrophoneExpert
  
supports(value:*):Boolean
[override] Returns true if the IValidator object validate the value.
MicrophoneExpert
 Inherited
unlock():void
Unlocks the display.
CoreEventDispatcher
 Inherited
unregisterEventListener(type:String, listener:*, useCapture:Boolean = false):void
Removes a listener (Function or EventListener object) from the EventDispatcher object.
CoreEventDispatcher
  
update():void
[override] Updates the Microphone settings.
MicrophoneExpert
 Inherited
validate(value:*):void
Evaluates the specified value and throw a TypeError object if the value is not valid.
CoreModelObject
 Inherited
willTrigger(type:String):Boolean
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
CoreEventDispatcher
Protected Methods
 MethodDefined By
 Inherited
Creates and returns the internal EventDispatcher reference (this method is invoked in the constructor).
CoreEventDispatcher
 Inherited
onActivity(e:ActivityEvent = null):void
Invoked when the microphone starts or stops detecting sound.
MediaExpert
 Inherited
onStatus(e:StatusEvent = null):void
Invoked when the microphone status change.
MediaExpert
Property Detail
DEFAULT_SETTINGproperty
public static var DEFAULT_SETTING:MicrophoneVO

The default settings of the Microphone objects.

microphoneproperty 
microphone:Microphone  [read-only]

Returns the Microphone client reference.


Implementation
    public function get microphone():Microphone
settingproperty 
setting:*

Determinates the settings of the current Microphone object with a MicrophoneVO object.


Implementation
    public function get setting():*
    public function set setting(value:any):void
Constructor Detail
MicrophoneExpert()Constructor
public function MicrophoneExpert(setting:MicrophoneVO = null, index:int = 0, global:Boolean = false, channel:String = null, id:* = null)

Creates a new MicrophoneExpert instance.

Parameters
setting:MicrophoneVO (default = null) — The MicrophoneVO reference to set the current Microphone object.
 
index:int (default = 0) — The index value of the microphone.
 
global:Boolean (default = false) — the flag to use a global event flow or a local event flow.
 
channel:String (default = null) — the name of the global event flow if the bGlobal argument is true.
 
id:* (default = null) — the id of the model.
Method Detail
setMicrophone()method
public function setMicrophone(index:int = 0):void

Sets the camera reference of the expert.

Parameters

index:int (default = 0) — The name of the camera to use (default null to use the default system Camera object).

supports()method 
override public function supports(value:*):Boolean

Returns true if the IValidator object validate the value. Overrides this method in your concrete IModelObject class.

Parameters

value:* — the object to test.

Returns
Booleantrue is this specific value is valid.
update()method 
override public function update():void

Updates the Microphone settings.