IAudioSessionEvents::OnDisplayNameChanged メソッド (audiopolicy.h)

  • [アーティクル]

OnDisplayNameChanged メソッドは、セッションの表示名が変更されたことをクライアントに通知します。

構文

HRESULT OnDisplayNameChanged(
  [in] LPCWSTR NewDisplayName,
  [in] LPCGUID EventContext
);

パラメーター

[in] NewDisplayName

セッションの新しい表示名。 このパラメーターは、新しい表示名を含む null で終わるワイド文字列を指します。 この文字列は、呼び出しの間は有効なままです。

[in] EventContext

イベント コンテキスト値。 これは、呼び出し元がセッションの表示名を変更した呼び出しで IAudioSessionControl::SetDisplayName に渡した値と同じです。 詳細については、「解説」を参照してください。

戻り値

メソッドが成功した場合は、S_OK を返します。 失敗した場合はエラー コードを返します。

解説

セッション マネージャーは、 IAudioSessionControl::SetDisplayName メソッドの呼び出しによってセッションの表示名が変更されるたびに、このメソッドを呼び出します。 Sndvol プログラムは、セッションの表示名を使用して、セッションのボリューム スライダーにラベルを付けます。

EventContext パラメーターは、クライアントが開始した表示名の変更と、他のクライアントが開始した変更を区別するための手段を提供します。 IAudioSessionControl::SetDisplayName メソッドを呼び出すと、クライアントは、OnDisplayNameChanged メソッドの実装で認識できる EventContext パラメーター値を渡します。

IAudioSessionEvents インターフェイスで メソッドを実装するコード例については、「オーディオ セッション イベント」を参照してください。

要件

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

こちらもご覧ください

IAudioSessionControl::SetDisplayName

IAudioSessionEvents インターフェイス