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

  • [アーティクル]

GetSessionIdentifier メソッドは、オーディオ セッション識別子を取得します。

構文

HRESULT GetSessionIdentifier(
  [out] LPWSTR *pRetVal
);

パラメーター

[out] pRetVal

オーディオ セッション識別子を受け取る null で終わるワイド文字列のアドレスへのポインター。 文字列はこのメソッドによって割り当てられ、 CoTaskMemFree を呼び出して呼び出し元によって解放される必要があります。 CoTaskMemFree の詳細については、Windows SDK のドキュメントを参照してください。

戻り値

メソッドが成功した場合は、S_OK を返します。 エラーが発生した場合、次の表に示す値が、可能なリターン コードに含まれますが、これらに限定されません。

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

注釈

各オーディオ セッションは、識別子文字列によって識別されます。 このセッション識別子文字列は、すべてのインスタンスで一意ではありません。 アプリケーションの 2 つのインスタンスが再生されている場合、両方のインスタンスのセッション識別子が同じになります。 GetSessionIdentifier によって取得される識別子は、すべてのセッションで一意であるセッション インスタンス識別子とは異なります。 セッション インスタンス識別子を取得するには、 IAudioSessionControl2::GetSessionInstanceIdentifier を呼び出します。

GetSessionIdentifier は、セッションが既定のデバイスで切断されているかどうかを確認します。 デバイスのオーディオ クライアントによってキャッシュされる識別子文字列を取得します。 セッション識別子が見つからない場合、このメソッドはオーディオ エンジンからセッション識別子を取得します。

要件

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

こちらもご覧ください

IAudioSessionControl2