Méthode IKsJackDescription ::GetJackDescription (devicetopology.h)
La méthode GetJackDescription obtient une description d’une prise audio.
Syntaxe
HRESULT GetJackDescription(
[in] UINT nJack,
[out] KSJACK_DESCRIPTION *pDescription
);
Paramètres
[in] nJack
Index jack. Si la connexion se compose de n jacks, les prises sont numérotées de 0 à n– 1. Pour obtenir le nombre de prises, appelez la méthode IKsJackDescription ::GetJackCount .
[out] pDescription
Pointeur vers une mémoire tampon allouée par l’appelant dans laquelle la méthode écrit une structure de type KSJACK_DESCRIPTION qui contient des informations sur la prise jack. La taille de la mémoire tampon doit être au moins sizeof(KSJACK_DESCRIPTION).
Valeur retournée
Si la méthode réussit, retourne S_OK. En cas d’échec, les codes de retour possibles incluent, sans s’y limiter, les valeurs indiquées dans le tableau suivant.
| Code de retour | Description |
|---|---|
|
Le paramètre nJack n’est pas un index jack valide. |
|
Le pointeur pDescription a la valeur NULL. |
Remarques
Lorsqu’un utilisateur doit connecter un périphérique de point de terminaison audio à une prise jack ou le débrancher d’une prise jack, une application audio peut utiliser les informations descriptives qu’elle récupère à partir de cette méthode pour aider l’utilisateur à trouver la prise jack. Ces informations incluent :
- Emplacement physique de la prise jack sur le châssis de l’ordinateur ou la boîte externe.
- Couleur du jack.
- Type de connecteur physique utilisé pour la prise jack.
- Mappage des canaux à la prise jack.
Configuration requise
| Condition requise | Valeur |
|---|---|
| Client minimal pris en charge | Windows Vista [applications de bureau uniquement] |
| Serveur minimal pris en charge | Windows Server 2008 [applications de bureau uniquement] |
| Plateforme cible | Windows |
| En-tête | devicetopology.h |