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

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

構文

HRESULT GetSessionInstanceIdentifier(
  [out] LPWSTR *pRetVal
);

パラメーター

[out] pRetVal

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

戻り値

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

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

注釈

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

GetSessionInstanceIdentifier は、セッションが既定のデバイスで切断されているかどうかを確認します。 デバイスのオーディオ クライアントによってキャッシュされる識別子文字列を取得します。 セッション インスタンス識別子が見つからない場合、このメソッドはオーディオ エンジンからそれを取得します。 セッション インスタンス識別子の取得に関するコード例については、「 通信デバイスからの Ducking イベントの取得」を参照してください。

要件

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

こちらもご覧ください

IAudioSessionControl2

通信デバイスの使用