| Package | qnx.system |
| Class | public class AudioManager |
| Inheritance | AudioManager  flash.events.EventDispatcher |
AudioManager class provides the interface for controlling
the volume level for all connected audio inputs and outputs.
See also
| Property | Defined By | ||
|---|---|---|---|
| audioManager : AudioManager [static] [read-only]
Returns the Singleton instance of the AudioManager. | AudioManager | ||
| availableInputs : Array [read-only]
Returns the list of available audio inputs. | AudioManager | ||
| availableOutputs : Array [read-only]
Returns the list of available audio outputs. | AudioManager | ||
| connectedInput : String [read-only]
Returns the currently attached audio input. | AudioManager | ||
| connectedOutput : String [read-only]
Returns the currently attached audio output. | AudioManager | ||
| Method | Defined By | ||
|---|---|---|---|
Do not use this constructor to instantiate the AudioManager class. | AudioManager | ||
getInputLevel(type:String = null):Number
Returns the current input level of the requested or connected audio input. | AudioManager | ||
getInputMute(type:String = null):Boolean
Returns the current mute state of the requested or connected audio input. | AudioManager | ||
getOutputLevel(type:String = null):Number
Returns the current output level of the requested or connected audio output. | AudioManager | ||
getOutputMute(type:String = null):Boolean
Returns the current mute state of the requested or connected audio output. | AudioManager | ||
setInputLevel(val:int, type:String = null):void
Sets the input volume level. | AudioManager | ||
setInputMute(val:Boolean, type:String = null):void
Sets the input mute control. | AudioManager | ||
setOutputLevel(val:Number, type:String = null):void
Sets the output volume level. | AudioManager | ||
setOutputMute(val:Boolean, type:String = null):void
Sets the output mute control. | AudioManager | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when the list of available audio inputs has changed. | AudioManager | |||
| Dispatched when the list of available audio outputs has changed. | AudioManager | |||
| Dispatched when the connected audio input has changed. | AudioManager | |||
| Dispatched when the connected audio output has changed. | AudioManager | |||
| Dispatched when an input level has changed. | AudioManager | |||
| Dispatched when an input mute control has changed. | AudioManager | |||
| Dispatched when an output level has changed. | AudioManager | |||
| Dispatched when an output mute control has changed. | AudioManager | |||
| audioManager | property |
audioManager:AudioManager [read-only]
Returns the Singleton instance of the AudioManager.
You can only instantiate a single instance in an application.
Do not instantiate the AudioManager from its public
constructor.
public static function get audioManager():AudioManager| availableInputs | property |
availableInputs:Array [read-only] Returns the list of available audio inputs.
public function get availableInputs():ArraySee also
| availableOutputs | property |
availableOutputs:Array [read-only] Returns the list of available audio outputs.
public function get availableOutputs():ArraySee also
| connectedInput | property |
connectedInput:String [read-only] Returns the currently attached audio input.
public function get connectedInput():StringSee also
| connectedOutput | property |
connectedOutput:String [read-only] Returns the currently attached audio output.
public function get connectedOutput():StringSee also
| AudioManager | () | Constructor |
public function AudioManager()
Do not use this constructor to instantiate the AudioManager class.
Instead, use the AudioManager.audioManager property to
return the Singleton instance.
See also
| getInputLevel | () | method |
public function getInputLevel(type:String = null):NumberReturns the current input level of the requested or connected audio input.
Parameters
type:String (default = null)null the currently connected input is used,
otherwise it must be one of the values in qnx.system.AudioInput.
Note: An Error is thrown if the currently connected inputs are not found. |
Number — A Number representing the input value. The input level must be between 0 (min) to 1.0 (max).
|
See also
| getInputMute | () | method |
public function getInputMute(type:String = null):BooleanReturns the current mute state of the requested or connected audio input.
Parameters
type:String (default = null)null, the currently connected input is used,
otherwise it must be one of the values in qnx.system.AudiInput.
|
Boolean — A Boolean indicating the mute value.
|
| getOutputLevel | () | method |
public function getOutputLevel(type:String = null):NumberReturns the current output level of the requested or connected audio output.
Parameters
type:String (default = null)null the currently connected output is used,
otherwise it must be one of the values in qnx.system.AudioOutput.
Note: An Error is thrown if the currently connected outputs are not found. |
Number — A Boolean representing the output level. The output level retured is between 0 (min) to 1.0 (max)
|
| getOutputMute | () | method |
public function getOutputMute(type:String = null):BooleanReturns the current mute state of the requested or connected audio output.
Parameters
type:String (default = null)null, the currently connected output is used
otherwise it must be one of the values in qnx.system.AudioOutput.
|
Boolean — A Boolean indicating the mute value.
|
See also
| setInputLevel | () | method |
public function setInputLevel(val:int, type:String = null):voidSets the input volume level.
This function dispatches a qnx.events.AudioManagerEvent.INPUT_LEVEL_CHANGED event when the input changes.
Parameters
val:int — Indicates the input level value. Valid values are
0 (minumum audio input level) to 1 (maximun audio input level).
| |
type:String (default = null)null, currently connected inout is affected,
otherwise must be one of the values in qnx.system.AudioInput.
|
See also
| setInputMute | () | method |
public function setInputMute(val:Boolean, type:String = null):voidSets the input mute control.
This function dispatches a qnx.events.AudioManagerEvent.INPUT_MUTE_CHANGED
event when the input is muted.
Parameters
val:Boolean — true mutes input, false unmute input.
| |
type:String (default = null)null, the currently connected input is affected,
otherwise the vale must be one of the values in qnx.system.AudioInput.
|
See also
| setOutputLevel | () | method |
public function setOutputLevel(val:Number, type:String = null):voidSets the output volume level.
This function dispatches a qnx.events.AudioManagerEvent.OUTPUT_LEVEL_CHANGED
event when the output changes.
Parameters
val:Number — Indicates the output level value. Valid values are
0 (minumum audio output level) to 1 (maximun audio output level).
| |
type:String (default = null)null, the currently connected output is affected,
otherwise must be one of the values in qnx.system.AudioOutput.
|
See also
| setOutputMute | () | method |
public function setOutputMute(val:Boolean, type:String = null):voidSets the output mute control.
This function dispatches a qnx.events.AudioManagerEvent.OUTPUT_MUTE_CHANGED
event when the output it muted.
Parameters
val:Boolean — true mutes output, false unmute output.
| |
type:String (default = null)null, currently connected output is affected,
otherwise it must be one of the values in qnx.system.AudioOutput.
|
See also
| availableInputsChanged | Event |
qnx.events.AudioManagerEventqnx.events.AudioManagerEvent.AVAILABLE_INPUTS_CHANGEDDispatched when the list of available audio inputs has changed.
| availableOutputsChanged | Event |
qnx.events.AudioManagerEventqnx.events.AudioManagerEvent.AVAILABLE_OUTPUTS_CHANGEDDispatched when the list of available audio outputs has changed.
| connectedInputChanged | Event |
qnx.events.AudioManagerEventqnx.events.AudioManagerEvent.CONNECTED_INPUT_CHANGEDDispatched when the connected audio input has changed.
| connectedOutputChanged | Event |
qnx.events.AudioManagerEventqnx.events.AudioManagerEvent.CONNECTED_OUTPUT_CHANGEDDispatched when the connected audio output has changed.
| inputLevelChanged | Event |
qnx.events.AudioManagerEventqnx.events.AudioManagerEvent.INPUT_LEVEL_CHANGEDDispatched when an input level has changed.
| inputMuteChanged | Event |
qnx.events.AudioManagerEventqnx.events.AudioManagerEvent.INPUT_MUTE_CHANGEDDispatched when an input mute control has changed.
| outputLevelChanged | Event |
qnx.events.AudioManagerEventqnx.events.AudioManagerEvent.OUTPUT_LEVEL_CHANGEDDispatched when an output level has changed.
| outputMuteChanged | Event |
qnx.events.AudioManagerEventqnx.events.AudioManagerEvent.OUTPUT_MUTE_CHANGEDDispatched when an output mute control has changed.