IAudioSessionControl2::SetDuckingPreference メソッド (audiopolicy.h)

  • [アーティクル]

SetDuckingPreference メソッドは、システムによって提供される既定のストリーム減衰エクスペリエンス (自動ダッキング) を有効または無効にします。

構文

HRESULT SetDuckingPreference(
  [in] BOOL optOut
);

パラメーター

[in] optOut

システムの自動ダッキングを有効または無効にする BOOL 変数。

戻り値

メソッドが成功した場合は、S_OK を返します。 失敗した場合、次の表に示す値が含まれますが、これに限定されません。

戻り値 説明
AUDCLNT_E_DEVICE_INVALIDATED
 オーディオ セッションは、既定のオーディオ デバイスで切断されます。

注釈

既定では、システムは、システムが通信セッションを開始し、既定の通信デバイスで新しい通信ストリームを受信したときに、現在再生されているすべてのサウンドの音量を調整します。 この機能の詳細については、「 通信デバイスの使用」を参照してください。

アプリケーションが optOut で TRUE を渡した場合、システムは既定のダッキング エクスペリエンスを無効にします。 詳細については、「 既定のダッキング エクスペリエンスの無効化」を参照してください。

カスタム実装を提供するには、アプリケーションが通信ストリームを開くか閉じるときにシステムから通知を受け取る必要があります。 通知を受信するには、 アプリケーションで IAudioSessionManager2::RegisterForDuckNotification を呼び出して登録する前に、このメソッドを呼び出す必要があります。 詳細とコード例については、「 ダッキング イベントの取得」を参照してください。

アプリケーションが optOut で FALSE を渡した場合、アプリケーションはシステムによって提供される既定のストリーム減衰エクスペリエンスを提供します。

ストリームの作成時にアプリケーションで SetDuckingPreference を 呼び出することをお勧めします。 ただし、このメソッドは、セッション中に動的に呼び出して、初期設定を変更できます。

要件

要件 値
サポートされている最小のクライアント Windows 7 [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2008 R2 [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー audiopolicy.h

こちらもご覧ください

IAudioSessionControl2