Macromedia flash media server 2-client-side actionscript language reference for flash media server 2 ユーザーズマニュアル

ページ / 156
Microphone class
43
Microphone.get()
Availability
Flash Player 6.
Flash Media Server (not required).
Usage
public static get([index:Number]) : Microphone
Parameters
index
  An optional zero-based integer that specifies which microphone to get, as determined 
from the array returned by 
To get the default microphone (which is 
recommended for most applications), omit this parameter. 
Returns
If 
index
 is not specified, this method returns a reference to the default microphone, or if 
it is not available, to the first available microphone. If no microphones are available or 
installed, the method returns 
null
.
If 
index
 is specified, this method returns a reference to the requested microphone, or 
null
 if it is not available. 
Description
Method; returns a reference to a Microphone object for capturing audio. To actually begin 
capturing the audio, you must attach the Microphone object either to a MovieClip object (see 
) or to a NetStream object (see 
(The NetStream object is available only with Flash Media Server.)
Unlike objects that you create using the 
new
 constructor, multiple calls to 
reference the same microphone. Thus, if your script contains the lines 
mic1 = Microphone.get()
 and 
mic2 = Microphone.get()
, both 
mic1
 and 
mic2
 reference 
the same (default) microphone.
In general, you shouldn’t pass a value for 
index
; simply use the 
Microphone.get()
 method 
to return a reference to the default microphone. By means of the Microphone Settings panel 
(discussed later in this section), the user can specify the default microphone Flash should use. 
If you pass a value for 
index
, you might be trying to reference a microphone other than the 
one the user prefers. You might use 
index
 in rare cases—for example, if your application is 
capturing audio from two microphones at the same time.
NO
T
E
The correct syntax is 
Microphone.get()
. To assign the Microphone object to a variable, 
use syntax like 
var active_mic:Microphone
 = 
Microphone.get()
.