IKsJackDescription::GetJackDescription メソッド (devicetopology.h)
GetJackDescription メソッドは、オーディオ ジャックの説明を取得します。
構文
HRESULT GetJackDescription(
[in] UINT nJack,
[out] KSJACK_DESCRIPTION *pDescription
);
パラメーター
[in] nJack
ジャック インデックス。 接続が n 個のジャックで構成されている場合、ジャックの番号は 0 から n – 1 になります。 ジャックの数を取得するには、 IKsJackDescription::GetJackCount メソッドを呼び出します。
[out] pDescription
メソッドがジャックに関する情報を含む型 KSJACK_DESCRIPTION の構造体を書き込む呼び出し元によって割り当てられたバッファーへのポインター。 バッファー サイズは、少なくとも sizeof(KSJACK_DESCRIPTION) である必要があります。
戻り値
メソッドが成功した場合は、S_OK を返します。 エラーが発生した場合、次の表に示す値が、可能なリターン コードに含まれますが、これらに限定されません。
| リターン コード | 説明 |
|---|---|
|
パラメーター nJack が有効なジャック インデックスではありません。 |
|
ポインター pDescription は NULL です。 |
注釈
ユーザーがオーディオ エンドポイント デバイスをジャックに接続するかジャックから取り外す必要がある場合、オーディオ アプリケーションは、このメソッドから取得した説明情報を使用して、ユーザーがジャックを見つけるのに役立ちます。 この情報には、以下が含まれます。
- コンピューター シャーシまたは外部ボックスのジャックの物理的な位置。
- ジャックの色。
- ジャックに使用される物理コネクタの種類。
- ジャックへのチャネルのマッピング。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows Vista [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows Server 2008 [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | devicetopology.h |