AudioFocusRequestClass クラス

リファレンス

定義

名前空間:: Android.Media

アセンブリ:: Mono.Android.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

オーディオフォーカス要求に関する情報をカプセル化するクラス。

[Android.Runtime.Register("android/media/AudioFocusRequest", ApiSince=26, DoNotGenerateAcw=true)]
public sealed class AudioFocusRequestClass : Java.Lang.Object

[<Android.Runtime.Register("android/media/AudioFocusRequest", ApiSince=26, DoNotGenerateAcw=true)>]
type AudioFocusRequestClass = class
    inherit Object

継承: Object

Object
AudioFocusRequestClass

属性: RegisterAttribute

注釈

オーディオフォーカス要求に関する情報をカプセル化するクラス。 AudioFocusRequestインスタンスはによってBuilder構築され、とでそれぞれAudioManager#requestAudioFocus(AudioFocusRequest)AudioManager#abandonAudioFocusRequest(AudioFocusRequest)オーディオフォーカスを要求および破棄するために使用されます。

<h3>オーディオフォーカス<とは/h3>

オーディオフォーカスは、API 8 で導入された概念です。これは、ユーザーが一度に 1 つのオーディオストリーム (音楽やポッドキャストを聴くなど) にのみ集中できるが、同時には集中できないという事実を伝えるために使用されます。場合によっては、複数のオーディオストリームを同時に再生できますが、実際にリッスンする (フォーカスする) のは 1 つだけで、もう 1 つはバックグラウンドで再生されます。たとえば、音楽が音量を下げる (ダッキング) ときに、方向が読み上げられるなどです。

アプリケーションは、オーディオフォーカスを要求すると、オーディオを再生するためにオーディオフォーカスを "所有" する意図を表します。さまざまな種類のフォーカス要求、要求後の戻り値、および損失に対する応答を確認しましょう。 <p class="note">注: アプリケーションは、フォーカスが付与されるまで何も再生しないでください。

<h3>さまざまな種類のフォーカス要求</h3>

フォーカス要求の種類は 4 つあります。それぞれのフォーカス要求が成功すると、システムと、以前にオーディオフォーカスを保持していた他のアプリケーションによって異なる動作が生成されます。 <ul><li>AudioManager#AUDIOFOCUS_GAIN は、アプリケーションがユーザーがリッスンしている唯一のオーディオソースになったという事実を表します。オーディオ再生の継続時間は不明であり、非常に長くなる可能性があります。ユーザーがアプリケーションとの対話を完了した後、別のオーディオストリームが再開されるとは思われません。このフォーカスゲインの使用例は、ゲームやビデオプレーヤーの音楽再生です。</李>

<li>AudioManager#AUDIOFOCUS_GAIN_TRANSIENT は、アプリケーションが現在の所有者から一時的にフォーカスを取得していることがわかっているが、ユーザーは、アプリケーションがオーディオフォーカスを必要としなくなったら、再生が元の場所に戻ることを期待している場合に使用します。たとえば、アラームを再生したり、VoIP 通話中に再生したりします。再生は有限であることが知られています。アラームはタイムアウトするか無視されます。VoIP 呼び出しには開始と終了があります。これらのイベントのいずれかが終了し、ユーザーが開始時に音楽を聴いていた場合、ユーザーは音楽が再開することを期待しますが、両方を同時に聴くことを望んでいませんでした。</李>

<li>AudioManager#AUDIOFOCUS_GAIN_TRANSIENT_MAY_DUCK: このフォーカス要求の種類は、フォーカス要求の一時的な側面に似ています AUDIOFOCUS_GAIN_TRANSIENT が、また、フォーカスを所有している間に、別のアプリケーションが音量を小さくして "ducked" で再生し続けるという事実も表します。たとえば、道案内や通知を再生する場合は、音楽を再生し続けても問題ありませんが、方向が理解しにくくならないように十分な大きさではありません。 "ducked" アプリケーションによる一般的な減衰は、0.2f (または -14dB) の係数であり、たとえば、このクラスを再生に使用するときにと MediaPlayer.setVolume(0.2f) 適用できます。</李>

<li>AudioManager#AUDIOFOCUS_GAIN_TRANSIENT_EXCLUSIVE は一時的な要求用でもありますが、アプリケーションはデバイスが他の何も再生しないことを期待していることを表します。これは通常、オーディオ録音や音声認識を行っていて、その間にシステムで例の通知を再生したくない場合に使用されます。</li></ul>

AudioFocusRequestインスタンスには、上記の 4 種類の要求のいずれかが常に含まれます。コンストラクター AudioFocusRequest.Builder#Builder(int)でビルダーを使用してインスタンスをAudioFocusRequestビルドするとき、または AudioFocusRequest.Builder#setFocusGain(int) を使用して既存のBuilderインスタンスをコピーした後にを使用してインスタンスAudioFocusRequest.Builder#Builder(AudioFocusRequest)を構築するときに渡されます。

<h3>フォーカス要求<を修飾する/h3><h4>フォーカス要求<を必要とするユースケース/h4>

フォーカス要求は、要求に AudioAttributes 従うオーディオユースケース (成功または許可された後) を記述する ( を参照 Builder#setAudioAttributes(AudioAttributes)) によって修飾されます。要求には、オーディオ/メディア再生に使用する属性と同じもの AudioAttributes を使用することをお勧めします。 <br>属性が設定されていない場合は、の AudioAttributes#USAGE_MEDIA 既定の属性が使用されます。

<h4>遅延フォーカス</h4>

電話中、デバイスが接続されている車が緊急メッセージを再生する場合など、さまざまな理由で、システムによってオーディオフォーカスが "ロック" される可能性があります。このような状況をサポートするために、アプリケーションは、要求が満たされたときに通知を受け取るように要求できます。要求に遅延フォーカス Builder#setAcceptsDelayedFocusGain(boolean)を受け入れるようにフラグを設定します。 <br>システムによってロックされている間にフォーカスが要求された場合、 AudioManager#requestAudioFocus(AudioFocusRequest) はを返します AudioManager#AUDIOFOCUS_REQUEST_DELAYED。フォーカスがロックされなくなった場合は、または Builder#setOnAudioFocusChangeListener(OnAudioFocusChangeListener, Handler) でBuilder#setOnAudioFocusChangeListener(OnAudioFocusChangeListener)設定されたフォーカスリスナーが呼び出され、オーディオフォーカスが所有されているアプリケーションに通知されます。

<h4>一時停止とダッキング</h4>

アプリケーションがでオーディオフォーカスを AudioManager#AUDIOFOCUS_GAIN_TRANSIENT_MAY_DUCK要求すると、システムは現在のフォーカス所有者をアヒルします。 <p class="note">注: この動作は Android O</b> の新>しい動作ですが<、API 25 までの SDK レベルを対象とするアプリケーションでは、のフォーカス損失AudioManager#AUDIOFOCUS_LOSS_TRANSIENT_CAN_DUCKを受け取ったときにダッキング自体を実装する必要がありました。

しかし、ダッキングは常にユーザーが期待する動作であるとは限りません。一般的な例は、ユーザーがオーディオブックまたはポッドキャストを聞いている間にデバイスが走行方向を再生し、ナビゲーションプロンプトと音声コンテンツを同時に理解するのが難しいため、アヒルの代わりにオーディオ再生が一時停止することを想定している場合です。したがって、システムは、それが話されたコンテンツをダッキングすることを検出したときに自動的にアヒルされることはありません:そのようなコンテンツは、プレーヤーのがによってAudioAttributes#CONTENT_TYPE_SPEECH修飾されたときにAudioAttributes検出されます。オーディオブック、ポッドキャスト用のメディア再生アプリケーションを作成している場合は、とを参照AudioAttributes.Builder#setContentType(int)MediaPlayer#setAudioAttributes(AudioAttributes)してください。システムは音声を再生するアプリケーションを自動的に実行しないため、代わりにフォーカスリスナーを呼び出してを通知AudioManager#AUDIOFOCUS_LOSS_TRANSIENT_CAN_DUCKし、代わりに一時停止できるようにします。この動作は、の使用とは無関係ですが、の AudioFocusRequest使用 AudioAttributesに関連付けられていることに注意してください。

音声を再生する以外の理由で、アプリケーションでダッキングの代わりに一時停止する必要がある場合は、を使用 Builder#setWillPauseWhenDucked(boolean)して宣言することもできます。これにより、システムは自動的にダッキングするのではなく、フォーカスリスナーを呼び出すことができます。

次の例では、オーディオを再生し、オーディオフォーカスを使用するすべてのアプリケーションで見つかる次の手順について説明します。ここではオーディオブックを再生します。アプリケーションは、フォーカスが失われるときにアヒルではなく一時停止することを目的としています。これらの手順は、<再生とフォーカス要求に使用される ul><li>Creating AudioAttributes で構成されます。</li li>><目的のフォーカス動作をAudioFocusRequest定義するインスタンスの構成と作成。</li li><>オーディオフォーカスを要求し、リターンコードを確認して、再生がすぐに行われるか、遅延しているかどうかを確認します。</li li><>フォーカスの増減に対応するためのフォーカス変更リスナーの実装。</li></ul>

// initialization of the audio attributes and focus request
            mAudioManager = (AudioManager) Context.getSystemService(Context.AUDIO_SERVICE);
            mPlaybackAttributes = new AudioAttributes.Builder()
                    .setUsage(AudioAttributes.USAGE_MEDIA)
                    .setContentType(AudioAttributes.CONTENT_TYPE_SPEECH)
                    .build();
            mFocusRequest = new AudioFocusRequest.Builder(AudioManager.AUDIOFOCUS_GAIN)
                    .setAudioAttributes(mPlaybackAttributes)
                    .setAcceptsDelayedFocusGain(true)
                    .setWillPauseWhenDucked(true)
                    .setOnAudioFocusChangeListener(this, mMyHandler)
                    .build();
            mMediaPlayer = new MediaPlayer();
            mMediaPlayer.setAudioAttributes(mPlaybackAttributes);
            final Object mFocusLock = new Object();

            boolean mPlaybackDelayed = false;

            // requesting audio focus
            int res = mAudioManager.requestAudioFocus(mFocusRequest);
            synchronized (mFocusLock) {
                if (res == AudioManager.AUDIOFOCUS_REQUEST_FAILED) {
                    mPlaybackDelayed = false;
                } else if (res == AudioManager.AUDIOFOCUS_REQUEST_GRANTED) {
                    mPlaybackDelayed = false;
                    playbackNow();
                } else if (res == AudioManager.AUDIOFOCUS_REQUEST_DELAYED) {
                   mPlaybackDelayed = true;
                }
            }

            // implementation of the OnAudioFocusChangeListener
            &#64;Override
            public void onAudioFocusChange(int focusChange) {
                switch (focusChange) {
                    case AudioManager.AUDIOFOCUS_GAIN:
                        if (mPlaybackDelayed || mResumeOnFocusGain) {
                            synchronized (mFocusLock) {
                                mPlaybackDelayed = false;
                                mResumeOnFocusGain = false;
                            }
                            playbackNow();
                        }
                        break;
                    case AudioManager.AUDIOFOCUS_LOSS:
                        synchronized (mFocusLock) {
                            // this is not a transient loss, we shouldn't automatically resume for now
                            mResumeOnFocusGain = false;
                            mPlaybackDelayed = false;
                        }
                        pausePlayback();
                        break;
                    case AudioManager.AUDIOFOCUS_LOSS_TRANSIENT:
                    case AudioManager.AUDIOFOCUS_LOSS_TRANSIENT_CAN_DUCK:
                        // we handle all transient losses the same way because we never duck audio books
                        synchronized (mFocusLock) {
                            // we should only resume if playback was interrupted
                            mResumeOnFocusGain = mMediaPlayer.isPlaying();
                            mPlaybackDelayed = false;
                        }
                        pausePlayback();
                        break;
                }
            }

            // Important:
            // Also set "mResumeOnFocusGain" to false when the user pauses or stops playback: this way your
            // application doesn't automatically restart when it gains focus, even though the user had
            // stopped it.

の Java ドキュメント android.media.AudioFocusRequest。

このページの一部は、によって作成および共有され、に記載されている条件に従って使用される作業に基づく変更です。

プロパティ

AudioAttributes	この `AudioFocusRequest`のセットを`AudioAttributes`返します。何も設定されていない場合は既定の属性を返します。
Class	この `Object`のランタイムクラスを返します。 (継承元 Object)
FocusGain	この `AudioFocusRequest`に対して構成されたオーディオフォーカス要求の種類を返します。
Handle	基になる Android インスタンスへのハンドル。 (継承元 Object)
JniIdentityHashCode	オーディオフォーカス要求に関する情報をカプセル化するクラス。 (継承元 Object)
JniPeerMembers	オーディオフォーカス要求に関する情報をカプセル化するクラス。
PeerReference	オーディオフォーカス要求に関する情報をカプセル化するクラス。 (継承元 Object)
ThresholdClass	この API は Android 用 Mono インフラストラクチャをサポートしており、コードから直接使用することを意図したものではありません。 (継承元 Object)
ThresholdType	この API は Android 用 Mono インフラストラクチャをサポートしており、コードから直接使用することを意図したものではありません。 (継承元 Object)

メソッド

AcceptsDelayedFocusGain()	これを `AudioFocusRequest` 使用するアプリケーションが、一時的な要求エラーの後に付与されるフォーカスをサポートするかどうかを返します。
Clone()	このオブジェクトのコピーを作成して返します。 (継承元 Object)
Dispose()	オーディオフォーカス要求に関する情報をカプセル化するクラス。 (継承元 Object)
Dispose(Boolean)	オーディオフォーカス要求に関する情報をカプセル化するクラス。 (継承元 Object)
Equals(Object)	他のオブジェクトがこのオブジェクトと "等しい" かどうかを示します。 (継承元 Object)
GetHashCode()	オブジェクトのハッシュコード値を返します。 (継承元 Object)
JavaFinalize()	ガベージコレクションがオブジェクトへの参照がなくなったと判断したときに、オブジェクトのガベージコレクターによって呼び出されます。 (継承元 Object)
Notify()	このオブジェクトのモニターで待機している 1 つのスレッドをウェイクアップします。 (継承元 Object)
NotifyAll()	このオブジェクトのモニターで待機しているすべてのスレッドをウェイクアップします。 (継承元 Object)
SetHandle(IntPtr, JniHandleOwnership)	Handle プロパティを設定します。 (継承元 Object)
ToArray<T>()	オーディオフォーカス要求に関する情報をカプセル化するクラス。 (継承元 Object)
ToString()	オブジェクトの文字列形式を返します。 (継承元 Object)
UnregisterFromRuntime()	オーディオフォーカス要求に関する情報をカプセル化するクラス。 (継承元 Object)
Wait()	現在のスレッドが起動するまで待機します。通常<>は、通知</em> または <em>割り込み</em によって待機します>。 (継承元 Object)
Wait(Int64)	現在のスレッドが起動するまで待機します。通常<>は、通知</em> または>< em 割り込み</em>、または一定のリアルタイムが経過するまで待機します。 (継承元 Object)
Wait(Int64, Int32)	現在のスレッドが起動するまで待機します。通常<>は、通知</em> または>< em 割り込み</em>、または一定のリアルタイムが経過するまで待機します。 (継承元 Object)
WillPauseWhenDucked()	これを `AudioFocusRequest` 使用するアプリケーションが、duck に要求されたときに一時停止するかどうかを返します。

明示的なインターフェイスの実装

IJavaPeerable.Disposed()	オーディオフォーカス要求に関する情報をカプセル化するクラス。 (継承元 Object)
IJavaPeerable.DisposeUnlessReferenced()	オーディオフォーカス要求に関する情報をカプセル化するクラス。 (継承元 Object)
IJavaPeerable.Finalized()	オーディオフォーカス要求に関する情報をカプセル化するクラス。 (継承元 Object)
IJavaPeerable.JniManagedPeerState	オーディオフォーカス要求に関する情報をカプセル化するクラス。 (継承元 Object)
IJavaPeerable.SetJniIdentityHashCode(Int32)	オーディオフォーカス要求に関する情報をカプセル化するクラス。 (継承元 Object)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)	オーディオフォーカス要求に関する情報をカプセル化するクラス。 (継承元 Object)
IJavaPeerable.SetPeerReference(JniObjectReference)	オーディオフォーカス要求に関する情報をカプセル化するクラス。 (継承元 Object)

拡張メソッド

JavaCast<TResult>(IJavaObject)	Android ランタイムチェック型変換を実行します。
JavaCast<TResult>(IJavaObject)	オーディオフォーカス要求に関する情報をカプセル化するクラス。
GetJniTypeName(IJavaPeerable)	オーディオフォーカス要求に関する情報をカプセル化するクラス。

適用対象