IKsJackDescription ::GetJackDescription, méthode (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 jacks sont numérotés de 0 à n– 1. Pour obtenir le nombre de jacks, 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. La taille de la mémoire tampon doit être au moins sizeof(KSJACK_DESCRIPTION).

Valeur de retour

Si la méthode réussit, elle retourne S_OK. En cas d’échec, les codes de retour possibles incluent, mais ne sont pas limités, les valeurs indiquées dans le tableau suivant.

Remarques

Lorsqu’un utilisateur doit brancher un périphérique de point de terminaison audio dans un jack ou le déconnecter d’une prise, une application audio peut utiliser les informations descriptives qu’il récupère à partir de cette méthode pour aider l’utilisateur à trouver la prise. Ces informations incluent :

• Emplacement physique du jack sur le châssis de l’ordinateur ou de la boîte externe.
• Couleur du jack.
• Type de connecteur physique utilisé pour le jack.
• Mappage des canaux au jack.

Exigences

Voir aussi

interface IKsJackDescription

IKsJackDescription ::GetJackCount

KSJACK_DESCRIPTION