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

  • [アーティクル]

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

構文

HRESULT OnIconPathChanged(
  [in] LPCWSTR NewIconPath,
  [in] LPCGUID EventContext
);

パラメーター

[in] NewIconPath

セッションの新しい表示アイコンのパス。 このパラメーターは、新しいアイコンのパスを含む文字列を指します。 文字列ポインターは、呼び出し中のみ有効です。

[in] EventContext

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

戻り値

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

解説

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

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

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

要件

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

こちらもご覧ください

IAudioSessionControl::SetIconPath

IAudioSessionEvents インターフェイス