Microphone  - AS3

マイクが検知している音量です。値の範囲は 0（サウンドが検知されていない）～ 100（非常に大音量が検知されている）です。このプロパティ値に基づいて、Microphone.setSilenceLevel() メソッドに渡す適切な値を判断できます。

マイクの muted プロパティが true の場合、このプロパティの値は常に -1 です。

関連する API エレメント

音声を圧縮するために使用するコーデックです。使用できるコーデックは、Nellymoser（デフォルト）と Speex です。列挙クラス SoundCodec は、codec プロパティに対して有効な各値を含みます。

Nellymoser コーデックを使用する場合、Microphone.rate() を使用してサンプルレートを設定できます。Speex コーデックを使用する場合、サンプルレートは 16 kHz に設定されます。

Speex には Voice Activity Detection（VAD）が搭載されており、音声が検出されない場合は自動的に帯域幅を減らします。Speex コーデックを使用する場合は、サイレンスレベルを 0 に設定することをお勧めします。サイレンスレベルを設定するには、Microphone.setSilenceLevel() メソッドを使用します。

関連する API エレメント

Speex の音声アクティビティ検知機能を有効にします。

Speex コーデックを使用する場合の、エンコードされた音質です。指定できる値は、0 ～ 10 です。デフォルト値は 6 です。次の表に示すとおり、値が大きいほど質は高くなりますが、必要な帯域幅も増えます。リストされたビットレートの値はネットのビットレートを表し、パケットのオーバーヘッドは含まれません。

関連する API エレメント

拡張マイクのオプションを制御します。詳しくは、MicrophoneEnhancedOptions クラスを参照してください。このプロパティは、拡張された Microphone インスタンスに対してではない場合、無視されます。

関連する API エレメント

1 パケット（メッセージ）で送信される Speex 音声フレームの数です。各フレームの長さは 20 ミリ秒です。デフォルト値は、1 パケットあたり 2 フレームです。

メッセージ内の Speex フレームが増えるほど、必要な帯域幅は減りますが、メッセージの送信が遅れます。Speex フレームが少ないほど、必要な帯域幅は増えますが、遅延が軽減されます。

マイクが信号を増強する量です。指定できる値は 0 ～ 100 です。デフォルト値は 50 です。

関連する API エレメント

マイクのインデックスです。これは、Microphone.names から返される配列のインデックスと同じです。

関連する API エレメント

現在のプラットフォームで Microphone クラスがサポートされている場合、isSupported プロパティは true に設定されます。サポートされていない場合は、false に設定されます。

ユーザーがマイクへのアクセスを拒否しているか（true）、許可しているか（false）を指定します。この値が変わると、status イベントが送出されます。詳細については、Microphone.getMicrophone() を参照してください。

関連する API エレメント

サウンドキャプチャハードウェアから返される現在のサウンドキャプチャデバイスの名前です。

関連する API エレメント

使用可能なすべてのサウンドキャプチャデバイスの名前を含むストリングの配列です。この名前は、ユーザーに Flash Player 設定パネルの「プライバシー」を表示せずに返されます。この配列により、各サウンドキャプチャデバイスの 0 から始まるインデックスと、システム上の各サウンドキャプチャデバイスの数（Microphone.names.length プロパティ）を調べることができます。詳細については、Array クラスのエントリを参照してください。

Microphone.names プロパティを呼び出すと、ハードウェアを広範囲にわたって調べる必要があり、配列を作成するまでに数秒間かかることがあります。ほとんどの場合は、デフォルトのマイクをそのまま使用できます。

注意：現在のマイクの名前を調べるには、name プロパティを使用します。

関連する API エレメント

Speex エンコーダーで使用されるノイズの最大減衰（dB （負数））です。有効になっている場合、Speex 圧縮の前に Microphone からキャプチャされるサウンドにノイズ抑制が適用されます。ノイズ抑制を無効にするには、0 に設定します。ノイズ抑制は、デフォルトでは -30 dB の最大減衰で有効になっています。 Nellymoser コーデックが選択されると無視されます。

マイクを使用する権限をアプリケーションが付与されたかどうかを判定します。

関連する API エレメント

マイクがサウンドをキャプチャしているレート（kHz）です。使用できる値は 5、8、11、22、および 44 です。デフォルト値は 8 kHz ですが、サウンドキャプチャデバイスがこの値に対応している必要があります。対応していない場合、デフォルト値はそのサウンドキャプチャデバイスが対応している 8 kHz よりも高いレートのうち、8 kHz に最も近い値になります。通常は 11 kHz です。

注意： 実際のレートは次の表に記載されているように rate 値とは少し異なります。

関連する API エレメント

マイクを有効化したり、activity イベントを送出するために必要な音量です。デフォルト値は 10 です。

関連する API エレメント

マイクがサウンド検知を停止してから、activity イベントが送出されるまでの時間（ミリ秒単位）です。デフォルト値は 2000（2 秒）です。

この値を設定するには、Microphone.setSilenceLevel() メソッドを使用します。

関連する API エレメント

loopback モードになっているとき、この microphone オブジェクトのサウンドを制御します。

エコー抑制が有効になっている場合は true、それ以外の場合は false に設定します。Flash Player 設定パネルの「マイク」でユーザーが「エコーを減らす」を選択していない限り、デフォルト値は false です。

関連する API エレメント

音声エコー除去機能を実行できる拡張された Microphone オブジェクトへの参照を返します。ヘッドセットを必要としないオーディオ／ビデオチャットアプリケーションを作成するには、音声エコー除去機能を使用します。

Microphone.getEnhancedMicrophone() メソッドおよび Microphone.getMicrophone() メソッドの index パラメーターは同様に動作します。

このメソッドを Android で使用するには、アプリケーション記述子の Android マニフェストを追加する部分で MODIFY_AUDIO_SETTINGS 権限を追加します。

重要：どの時点においても、存在できる拡張マイクデバイスのインスタンスは 1 つのみです。その他すべての Microphone インスタンスでは、オーディオデータの供給が停止され、code プロパティが Microphone.Unavailable の StatusEvent が発生します。拡張オーディオが初期化に失敗すると、このメソッドの呼び出しに null が返され、Microphone.enhancedOptions の値の設定は効果を持たず、既存の Microphone インスタンスはすべて従来と同様に機能します。

拡張された Microphone オブジェクトを設定するには、Microphone.enhancedOptions プロパティを設定します。次のコードでは、拡張された Microphone オブジェクトと、全二重の音声エコー除去機能をローカルテストで使用します。

	     var mic:Microphone = Microphone.getEnhancedMicrophone();
	     var options:MicrophoneEnhancedOptions = new MicrophoneEnhancedOptions();
	     options.mode = MicrophoneEnhancedMode.FULL_DUPLEX;
	     mic.enhancedOptions = options;
	     mic.setLoopBack(true);
	 

setUseEchoSuppression() メソッドは、音声エコー除去機能を使用する場合は無視されます。

SWF ファイルで Microphone.getEnhancedMicrophone() メソッドから返されたマイクにアクセスしようとすると（NetStream.attachAudio() を呼び出すなど）プライバシーダイアログボックスが表示され、そのマイクへのアクセスを許可するか拒否するかをユーザーが選択できます。ステージのサイズは必ず 215 × 138 ピクセル以上に設定してください。これは、ダイアログボックスを表示するために必要な最小サイズです。

パラメーター

関連する API エレメント

オーディオをキャプチャする Microphone オブジェクトの参照を返します。オーディオのキャプチャを開始するには、Microphone オブジェクトを NetStream オブジェクトに接続する必要があります。NetStream.attachAudio() のトピックを参照してください。

Microphone.getMicrophone() を複数回呼び出すと、同じマイクが参照されます。したがって、コードに mic1 = Microphone.getMicrophone() および mic2 = Microphone.getMicrophone() という行が含まれている場合、mic1 と mic2 は両方とも同じデフォルトのマイクを参照します。

通常は、index の値を渡さないでください。デフォルトのマイクを参照するには、単に air.Microphone.getMicrophone() を呼び出します。Flash Player 設定パネルの「マイク」セクションを使用して、アプリケーションで使用するデフォルトのマイクを指定できます。 （Flash Player 設定パネルには、Web ブラウザーで実行している Flash Player コンテンツを右クリックしてアクセスします。）index で値を渡すと、ユーザーが使用するのとは異なるマイクが参照される可能性があります。index を使用できるのは、アプリケーションで 2 つのマイクから同時にオーディオをキャプチャする場合など、特殊な場合です。Adobe AIR で実行されるコンテンツも Flash Player のデフォルトのマイクの設定を使用します。

現在の Microphone オブジェクトのインデックス値を取得するには、Microphone.index プロパティを使用します。次に、Microphone クラスの他のメソッドにこの値を渡します。

SWF ファイルで Microphone.getMicrophone() メソッドから返されたマイクにアクセスしようとすると（NetStream.attachAudio() を呼び出すなど）、プライバシーダイアログボックスが表示され、そのマイクへのアクセスを許可するか拒否するかをユーザーが選択できます。ステージのサイズは必ず 215 × 138 ピクセル以上に設定してください。これは、ダイアログボックスを表示するために必要な最小サイズです。

ユーザーがこのダイアログボックスに応答すると、ユーザーの応答を示す status イベントが送出されます。Microphone.muted プロパティを確認して、ユーザーがマイクへのアクセスを許可したか、拒否したかを判別することもできます。

Microphone.getMicrophone() が null を返した場合は、マイクが別のアプリケーションで使用されているか、そのシステムにマイクがインストールされていません。マイクがインストールされているかどうかを調べるには、Microphones.names.length を使用します。Flash Player の [マイク] パネルを表示して、Microphone.getMicrophone で参照するマイクをユーザーが選択できるようにするには、Security.showSettings() を使用します。

パラメーター

関連する API エレメント

var mic:Microphone = Microphone.getMicrophone();
mic.setLoopBack();
mic.addEventListener(StatusEvent.STATUS, mic_status);
 
var tf:TextField = new TextField();
tf.autoSize = TextFieldAutoSize.LEFT;
tf.text = "Detecting microphone...";
addChild(tf);
 
function mic_status(evt:StatusEvent):void {
    tf.text = "Microphone is muted?: " + mic.muted;
    switch (evt.code) {
        case "Microphone.Unmuted":
            tf.appendText("\n" + "Microphone access was allowed.");
            break;
        case "Microphone.Muted":
            tf.appendText("\n" + "Microphone access was denied.");
            break;
    }
}

アプリケーションからマイクを使用する権限を要求します。

マイクによってキャプチャされたオーディオをローカルスピーカーに転送します。

パラメーター

サウンドと見なす最小入力レベルと、実際に無音状態が始まったと見なすまでの無音時間の長さを設定します。後者は省略可能です。

• マイクがサウンドをまったく検知しないようにするには、silenceLevel に値 100 を渡します。こうすると、activity イベントが送出されることはありません。
• マイクが現在検知している音量を調べるには、Microphone.activityLevel を使用します。

Speex には Voice Activity Detection（VAD）が搭載されており、音声が検出されない場合は自動的に帯域幅を減らします。Speex コーデックを使用する場合は、サイレンスレベルを 0 に設定することをお勧めします。

アクティビティ検知とは、人が話していることをオーディオレベルに基づいて検知する機能のことです。誰も話していないときは、関連付けられているオーディオストリームを送信する必要がないので、帯域幅を節約できます。この情報を利用して、ユーザー（または他の誰か）が話していないことを視覚的なフィードバックとして示すこともできます。

サイレンス値はアクティビティ値に直接対応します。完全なサイレンスのアクティビティ値は 0 です。継続的な大音量（現在のゲイン設定に基づく最大の音量）のアクティビティ値は 100 です。ゲイン（増幅率）を適切に調整すると、話していないときにはアクティビティ値がサイレンス値よりも小さくなります。話しているときには、アクティビティ値はサイレンス値よりも大きくなります。

このメソッドは Camera.setMotionLevel() に似ています。どちらのメソッドも、activity イベントの送出タイミングを指定するために使用します。ただし、パブリッシュするストリームに対する影響という点では、この 2 つのメソッドは大きく異なります。

• Camera.setMotionLevel() はモーションを検知し、使用する帯域幅には影響しないように設計されています。ビデオストリームでモーションが検知されない間も、ビデオは送信されます。
• Microphone.setSilenceLevel() は帯域幅を最適化するように設計されています。オーディオストリームが無音と考えられる場合には、オーディオデータは送信されません。代わりに、無音状態が始まったことを示すメッセージが送信されます。

パラメーター

関連する API エレメント

オーディオコーデックのエコー抑制機能を使用するかどうかを指定します。Flash Player 設定パネルの「マイク」でユーザーが「エコーを減らす」を選択していない限り、デフォルト値は false です。

エコー抑制とは、スピーカーから出たサウンドが同じシステムのマイクによって拾われるオーディオフィードバックの影響を減らす機能のことです。（これは、フィードバックを完全に除去する音声エコー除去機能とは異なります。setUseEchoSuppression() メソッドは、getEnhancedMicrophone() メソッドを呼び出して音声エコー除去機能を使用する場合は無視されます）。

一般に、キャプチャするサウンドをヘッドセットではなくスピーカーで再生する場合には、エコー抑制機能を使用することが推奨されます。サウンド出力デバイスをユーザーが選択できるようにした SWF ファイルでは、ユーザーがスピーカーを選択し、マイクも使用する場合に Microphone.setUseEchoSuppression(true) を呼び出すことをお勧めします。

ユーザーは、Flash Player 設定パネルの「マイク」でこれらの設定を調整することもできます。

パラメーター

関連する API エレメント

2 つのリスナーは、activity および status のイベントを受け取ります。activity イベントはセッションの開始時と終了時（存在する場合）に送出され、activityHandler() メソッドによって捕捉されます。このメソッドはイベントの情報をトレースします。status イベントは、関連付けられた Microphone オブジェクトがステータス情報をレポートした場合に送出され、statusHandler() メソッドを使用して捕捉、トレースされます。

注意：この例を正しく機能させるには、コンピューターにマイクを接続しておく必要があります。

package {
    import flash.display.Sprite;
    import flash.events.*;
    import flash.media.Microphone;
    import flash.system.Security;

    public class MicrophoneExample extends Sprite {
        public function MicrophoneExample() {
            var mic:Microphone = Microphone.getMicrophone();
            Security.showSettings("2");
            mic.setLoopBack(true);
                    
            if (mic != null) {
                mic.setUseEchoSuppression(true);
                mic.addEventListener(ActivityEvent.ACTIVITY, activityHandler);
                mic.addEventListener(StatusEvent.STATUS, statusHandler);
            }
        }

        private function activityHandler(event:ActivityEvent):void {
            trace("activityHandler: " + event);
        }

        private function statusHandler(event:StatusEvent):void {
            trace("statusHandler: " + event);
        }
    }
}