Microphone  - AS3

Poziom dźwięku wykrywanego przez mikrofon. Wartości mieszczą się w przedziale od 0 (żaden dźwięk nie został wykryty) do 100 (wykryto bardzo głośny dźwięk) Wartość tej właściwości jest pomocna przy określaniu prawidłowej wartości przekazywanej do metody Microphone.setSilenceLevel().

Jeśli właściwość mikrofonu muted ma wartość true, wówczas wartość tej właściwości zawsze wynosi -1.

Powiązane elementy interfejsu API

Kodek używany dla kompresowania dźwięku. Dostępne są kodeki Nellymoser (domyślny) i Speex. Klasa zestawień SoundCodec zawiera różne wartości poprawne w przypadku właściwości codec.

Jeśli używany jest kodek Nellymoser, można ustawić częstotliwość próbkowania za pomocą metody Microphone.rate(). Jeśli używany jest kodek Speex, częstotliwość próbkowania jest ustawiona na 16 kHz.

Kodek Speex zawiera funkcję wykrywania głosu (VAD) i automatycznie zmniejsza używaną przepustowość, jeśli żaden głos nie jest wykrywany. W przypadku użycia kodeka Speex firma Adobe zaleca ustawienie poziomu ciszy na 0. W celu ustawienia poziomu ciszy należy użyć metody Microphone.setSilenceLevel().

Powiązane elementy interfejsu API

Włącza wykrywanie działania głosu Speex.

Jakość kodowanej mowy, gdy stosowany jest kodek Speex. Możliwe wartości należą do zakresu od 0 do 10. Wartością domyślną jest 6. Wyższe wartości określają wyższą jakość, ale wymagają większej przepustowości, co zostało przedstawione w poniższej tabeli. Wartości ilości bitów na sekundę reprezentują ilości netto i nie uwzględniają narzutu wynikającego z przesyłania pakietów.

Powiązane elementy interfejsu API

Steruje opcjami zaawansowanej obsługi mikrofonu. Więcej informacji zawiera opis klasy MicrophoneEnhancedOptions. Ta właściwość jest ignorowana w przypadku nieulepszonych wystąpień klasy Microphone.

Powiązane elementy interfejsu API

Liczba klatek głosu Speex przesłanych w pakiecie (w komunikacie). Długość każdej klatki to 20 ms. Domyślnie są to dwie klatki na pakiet.

Większa ilość klatek Speex w komunikacie przekłada się na mniejszą wymaganą przepustowość, ale większe opóźnienie podczas wysyłania komunikatu. Mniejsza ilość klatek Speex zwiększa wymaganą przepustowość, ale zmniejsza opóźnienie.

Wartość, o jaką mikrofon wzmacnia sygnał. Poprawne wartości należą do zakresu od 0 do 100. Wartością domyślną jest 50.

Powiązane elementy interfejsu API

Indeks mikrofonu, uzyskany z tablicy zwróconej przez właściwość Microphone.names.

Powiązane elementy interfejsu API

Właściwość isSupported ma wartość true, jeśli na bieżącej platformie jest obsługiwana klasa Microphone; w przeciwnym razie ma wartość false.

Określa, czy użytkownik zabronił dostępu do mikrofonu (true), czy zezwolił na dostęp (false). Jeśli wartość ulegnie zmianie, wywołane zostanie zdarzenie status. Aby uzyskać więcej informacji, należy zapoznać się z metodą Microphone.getMicrophone().

Powiązane elementy interfejsu API

Nazwa aktualnie używanego urządzenia do przechwytywania dźwięków (zgodnie z danymi przekazanymi przez to urządzenie).

Powiązane elementy interfejsu API

Tablica ciągów znaków zawierających nazwy wszystkich dostępnych urządzeń do przechwytywania dźwięku. Nazwy zwracane są bez konieczności wyświetlania użytkownikowi panelu ustawień prywatności w programie Flash Player. Tablica umożliwia indeksowanie (od zera) każdego urządzania do przechwytywania dźwięku i przechowuje liczbę tych urządzeń w systemie we właściwości Microphone.names.length. Aby uzyskać więcej informacji, należy zapoznać się z sekcją klasy Array.

Wywołanie właściwości Microphone.names wymaga rozszerzonego skanowania sprzętu, dlatego utworzenie tablicy może zając kilkanaście sekund. W większości przypadków istnieje możliwość skorzystania z domyślnego mikrofonu.

Uwaga: aby określić nazwę bieżącego mikrofonu, należy skorzystać z właściwości name.

Powiązane elementy interfejsu API

Maksymalne tłumienie hałasu w dB (liczba ujemna) stosowane dla kodera Speex. Jeśli jest włączone, wówczas tłumienie hałasu jest stosowane dla dźwięku przechwyconego z obiektu Microphone przed kompresją Speex. Aby wyłączyć tłumienie hałasu, należy ustawić wartość 0. Tłumienie hałasu jest domyślnie włączone z maksymalnym tłumieniem równym -30 dB. Ignorowane, gdy wybrany jest kodek Nellymoser.

Sprawdź, czy system otrzymał pozwolenie na dostęp do korzystania z mikrofonu.

Powiązane elementy interfejsu API

Częstotliwość, z jaką mikrofon przechwytuje dźwięk (w kHz). Dozwolone wartości: 5, 8, 11, 22 i 44. Wartością domyślną jest 8 kHz, jeśli urządzenie przechwytujące dźwięk obsługuje tę wartość. W innym wypadku wartością domyślną jest kolejna dostępna częstotliwość przechwytywania powyżej 8 kHz, która jest obsługiwana przez urządzenie użytkownika przechwytujące dźwięk, zazwyczaj 11 kHz.

Uwaga: Rzeczywista częstotliwość różni się nieznacznie od wartości rate, co ilustruje poniższa tabela:

Powiązane elementy interfejsu API

Poziom dźwięku wymagany do aktywowania mikrofonu i wywołania zdarzenia activity Wartością domyślną jest 10.

Powiązane elementy interfejsu API

Czas (w milisekundach), który musi upłynąć od momentu zaprzestania detekcji dźwięku przez mikrofon do momentu wywołania zdarzeniaactivity. Wartość domyślna to 2000 milisekund (2 sekundy).

Aby ustawić tę właściwość, należy skorzystać z metody Microphone.setSilenceLevel().

Powiązane elementy interfejsu API

Pozwala kontrolować dźwięk rejestrowany przez mikrofon, gdy urządzenie działa on w trybie pętli zwrotnej.

Ustawia wartość true, jeśli jest włączona funkcja blokady echa; w przeciwnym wypadku false. Wartością domyślną jest false, dopóki użytkownik nie zaznaczy opcji redukcji echa w panelu ustawień mikrofonu w programie Flash Player.

Powiązane elementy interfejsu API

Zwraca odniesienie do ulepszonego obiektu Microphone, który pozwala wyeliminować echo akustyczne. Funkcja eliminacji echa akustycznego pozwala tworzyć aplikacje do obsługi czatów dźwiękowych i wideo, które nie wymagają używania zestawów słuchawkowych.

Parametr index dla metody Microphone.getEnhancedMicrophone() działa tak samo jak dla metody Microphone.getMicrophone().

Aby użyć tej metody w systemie Android, należy dodać uprawnienie MODIFY_AUDIO_SETTINGS w dodatkach manifestu systemu Android w deskryptorze aplikacji.

Ważne: W danej chwili może istnieć tylko jedno wystąpienie ulepszonego urządzenia mikrofonu. Wszystkie inne wystąpienia klasy Microphone przestają wtedy udostępniać dane dźwiękowe i powodują odbieranie zdarzenia StatusEvent z właściwością code o wartości Microphone.Unavailable. W przypadku niepowodzenia inicjowania ulepszonej obsługi dźwięku wywołania tej metody zwracają wartość null, ustawienie wartości Microphone.enhancedOptions nie ma żadnych skutków, a wszystkie istniejące wystąpienia klasy Microphone działają tak samo jak dotąd.

Aby skonfigurować ulepszony obiekt Microphone, należy ustawić właściwość Microphone.enhancedOptions. W poniższym kodzie użyto ulepszonego obiektu Microphone i funkcji eliminacji echa akustycznego w trybie pełnego dupleksu na potrzeby testu lokalnego.

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

W przypadku korzystania z funkcji eliminacji echa akustycznego metoda setUseEchoSuppression() jest ignorowana.

Jeśli plik SWF usiłuje uzyskać dostęp do obiektu zwróconego przez metodę Microphone.getEnhancedMicrophone() — na przykład w wywołaniu metody NetStream.attachAudio() — program Flash Player wyświetla okno dialogowe Prywatność, które umożliwia użytkownikowi określenie, czy zezwolić na dostęp do mikrofonu, czy odmówić dostępu. Należy się upewnić, że rozmiar stołu montażowego ma wymiary przynajmniej 215 x 138 pikseli; jest to minimalny rozmiar wymagany przez program Flash Player w celu poprawnego wyświetlania okna dialogowego.

Parametry

Powiązane elementy interfejsu API

Zwraca odwołanie do obiektu Microphone odpowiedzialnego za przechwytywanie audio. Aby rozpocząć przechwytywanie audio, należy dołączyć obiekt Microphone do obiektu NetStream (szczegóły można znaleźć w opisie metody NetStream.attachAudio()).

Wielokrotne wywołania metody Microphone.getMicrophone() odwołują się do tego samego mikrofonu. Jeśli zatem kod zawiera wiersza mic1 = Microphone.getMicrophone() i mic2 = Microphone.getMicrophone(), wówczas mic1 oraz mic2 odwoływać się będą do tego samego (domyślnego) mikrofonu.

Na ogół nie należy przekazywać wartości właściwości index. Wywołanie air.Microphone.getMicrophone() zwróci odwołanie do domyślnego mikrofonu. Za pomocą sekcji ustawień mikrofonu w panelu ustawień programu Flash Player użytkownik może określić domyślny mikrofon, z którego powinna korzystać aplikacja. (Dostęp do panelu ustawień programu Flash Player można uzyskać poprzez kliknięcie prawym przyciskiem myszy treści Flash Player działającej w przeglądarce WWW). Przekazanie wartość właściwości index może spowodować odwołanie się do innego mikrofonu, niż wybrany przez użytkownika. W rzadkich sytuacjach można użyć właściwości index — na przykład jeśli aplikacja przechwytuje audio z dwóch mikrofonów jednocześnie. Treść działająca w środowisku Adobe AIR również korzysta z ustawień programu Flash Player dla domyślnego mikrofonu.

Aby pobrać wartość indeksu bieżącego obiektu Microphone, należy skorzystać z właściwości Microphone.index. Wartość tę można następnie przekazać pozostałym metodom klasy Microphone.

Jeśli plik SWF usiłuje uzyskać dostęp do obiektu zwróconego przez metodę Microphone.getMicrophone() — na przykład w wywołaniu metody NetStream.attachAudio() — program Flash Player wyświetli okno dialogowe Prywatność, które umożliwi użytkownikowi wybranie, czy zezwolić, czy odmówić dostępu do mikrofonu. (Należy się upewnić, że rozmiar stołu montażowego ma wymiary przynajmniej 215 x 138 pikseli; jest to minimalny rozmiar wymagany przez program Flash Player w celu poprawnego wyświetlania okna dialogowego).

W momencie odpowiadania użytkownika w oknie dialogowym, wywoływane jest zdarzenie status, które wskazuje jego odpowiedź. Można również sprawdzić właściwość Microphone.muted, aby określić, czy użytkownik zezwolił, czy odmówił dostępu do mikrofonu.

Jeśli metoda Microphone.getMicrophone() zwróci wartość null, oznacza to, że z mikrofonu korzysta inna aplikacja lub nie ma żadnych kamer zainstalowanych w systemie. Aby określić, czy w systemie są zainstalowane mikrofony, należy skorzystać z właściwości Microphones.names.length. Aby wyświetlić panel ustawień mikrofonu programu Flash Player, który umożliwia użytkownikowi wybieranie kamery, do której będzie się odwoływać metoda Microphone.getMicrophone, należy skorzystać z metodySecurity.showSettings().

Parametry

Powiązane elementy interfejsu 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;
    }
}

Wysyła żądanie pozwolenia aplikacji na dostęp do mikrofonu.

Kieruje dźwięk przechwycony przez mikrofon do głośników lokalnych.

Parametry

Pozwala określić minimalny poziom sygnału wejściowego interpretowanego jako dźwięk, a także (opcjonalnie) czas, po upływie którego brak sygnału jest interpretowany jako cisza.

• Aby całkowicie uniemożliwić wykrywanie dźwięku przez mikrofon, należy przekazać wartość 100 w parametrze silenceLevel; zdarzenie activity nigdy nie zostanie wywołane.
• Aby określić poziom dźwięku, który w danym momencie wykrywa mikrofon, należy skorzystać z właściwości Microphone.activityLevel.

Kodek Speex zawiera funkcję wykrywania głosu (VAD) i automatycznie zmniejsza używaną przepustowość, jeśli żaden głos nie jest wykrywany. W przypadku użycia kodeka Speex firma Adobe zaleca ustawienie poziomu ciszy na 0.

Wykrywanie aktywności to zdolność do wykrywania dźwięku w momentach, gdy jego poziom sugeruje, że użytkownik·mówi. Jeśli użytkownik nic nie mówi, można wówczas zmniejszyć użycie szerokości pasma, ponieważ nie ma potrzeby przesyłania skojarzonego strumienia audio. Tej informacji można użyć w celu utworzenia wizualnej odpowiedzi, która pokaże użytkownikom, że na wejściu nie ma żadnego dźwięku.

Wartości ciszy bezpośrednio odpowiadają wartościom aktywności. Całkowita cisza to aktywność o wartości 0. Stały, głośny szum (najgłośniejszy możliwy do zarejestrowania na podstawie bieżącego ustawienia wzmocnienia) odpowiada wartości aktywności równej 100. Po właściwym ustawieniu wzmocnienia, wartość aktywności jest mniejsza, niż wartość ciszy w momencie, kiedy użytkownik nic nie mówi; kiedy użytkownik zaczyna mówić, wartość aktywności przewyższa wartość ciszy.

Metoda jest·podobna do metody Camera.setMotionLevel(); obie metody są używane do określania, kiedy należy wywołać zdarzenie activity. Jednak obie metody mają znacząco różny wpływ na publikowanie strumieni:

• Metoda Camera.setMotionLevel() została zaprojektowana w celu wykrywania ruchu i nie ma żadnego wpływu na użycie szerokości pasma. Nawet jeśli w strumieniu wideo nie jest wykrywany ruch, wideo jest nadal przesyłane.
• Metoda Microphone.setSilenceLevel() została zaprojektowana w celu optymalizacji szerokości pasma. Jeśli strumień audio zostanie uznany za cichy, żadne dane audio nie będą przesyłane. W zamian przesłany zostanie komunikat informujący o rozpoczęciu się ciszy.

Parametry

Powiązane elementy interfejsu API

Określa, czy będzie używana funkcja kodera-dekodera audio odpowiedzialna za blokowanie echa. Wartością domyślną jest false, dopóki użytkownik nie zaznaczy opcji redukcji echa w panelu ustawień mikrofonu w programie Flash Player.

Tłumienie echa jest próbą zmniejszenia efektów dźwiękowego sprzężenia zwrotnego, którego wynikiem jest podnoszenie się dźwięku wydobywającego się z głośnika powodowanego przez mikrofon tego samego komputera. Mechanizm ten różni się od anulowania echa akustycznego, które całkowicie usuwa sprzężenie zwrotne. Metoda setUseEchoSuppression() jest ignorowana po wywołaniu metody getEnhancedMicrophone() w celu eliminacji echa akustycznego.

Ogólnie tłumienie echa jest wskazane, gdy przechwytywany dźwięk jest odtwarzany za pomocą głośników — zamiast przez słuchawki. Jeśli plik SWF umożliwia użytkownikom określenie wyjściowego urządzenia dźwiękowego, może pojawić się chęć wywołania metody Microphone.setUseEchoSuppression(true), jeśli użytkownicy wskażą, że korzystają z głośników i będą używać także mikrofonów.

Użytkownicy mogą również dostosowywać te ustawienia w panelu ustawień mikrofonu w programie Flash Player.

Parametry

Powiązane elementy interfejsu API

Dwa detektory nasłuchują zdarzenia activity i status. Zdarzenie activity wywoływane jest na początku i na końcu (jeśli istnieje) sesji i jest przechwytywane przez metodę activityHandler(), która śledzi informacje o zdarzeniu. Zdarzenie status wywoływane jest, gdy podłączony obiekt mikrofonu zgłosi jakąkolwiek informację o stanie; jest przechwytywane i śledzone za pomocą metody statusHandler().

Uwaga: Aby ten przykład zadziałał prawidłowo, należy podłączyć mikrofon do komputera.

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);
        }
    }
}