Méthode IMiniportAudioSignalProcessing ::GetModes (portcls.h)

  • Article

La méthode GetModes récupère les modes de traitement du signal audio pris en charge par une broche audio.

Syntaxe

NTSTATUS GetModes(
  [in]            ULONG Pin,
  [out, optional] GUID  *SignalProcessingModes,
  [in, out]       ULONG *NumSignalProcessingModes
);

Paramètres

[in] Pin

Index de la broche audio.

[out, optional] SignalProcessingModes

Ce paramètre est facultatif. Il retourne un tableau de GUID qui identifient les modes de traitement du signal pris en charge par le paramètre Pin .

[in, out] NumSignalProcessingModes

Lorsqu’il est utilisé comme entrée, il spécifie le nombre d’éléments pouvant être écrits dans la mémoire tampon spécifiée dans SignalProcessingModes. Lorsqu’il est utilisé comme sortie, il retourne le nombre d’éléments qui ont été écrits dans la mémoire tampon.

Valeur retournée

GetModes retourne STATUS_SUCCESS si l’appel a réussi. Sinon, la méthode retourne un code d’erreur approprié.

Remarques

Si SignalProcessingModes a la valeur NULL, GetModes écrit le nombre de modes pris en charge dans NumSignalProcessingModes et retourne STATUS_SUCCESS. Cela permet aux appelants d’interroger le nombre de modes pris en charge afin d’allouer des mémoires tampons.

Si SignalProcessingModes n’a pas la valeur NULL, GetModes vérifie que NumSignalProcessingModes est supérieur ou égal au nombre de modes pris en charge. Si c’est le cas, la méthode écrit les modes pris en charge dans la mémoire tampon SignalProcessingModes , écrit le nombre réel de modes pris en charge dans NumSignalProcessingModes et retourne STATUS_SUCCESS.

Le tableau suivant présente et explique les messages d’erreur que peuvent être retournés par GetModes.

Code d'erreur Description
STATUS_BUFFER_TOO_SMALL La mémoire tampon qui a été mise de côté pour NumSignalProcessingModes est trop petite.
STATUS_INVALID_PARAMETER La valeur du paramètre Pin indique un ID pin qui est >= le nombre de fabriques de broches sur le filtre. L’index de broche étant de base zéro, pour n fabriques de broches sur un filtre, la valeur d’index la plus élevée doit être n-1.
STATUS_NOT_SUPPORTED Un ID de code pin a été spécifié pour une broche qui ne prend pas en charge les modes de traitement du signal. Par exemple, si l’ID de code pin fait référence à une broche de bouclage audio ou à une broche de pont, GetModes retourne ce code d’erreur.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows 8.1
Serveur minimal pris en charge Windows Server 2012 R2
Plateforme cible Universal
En-tête portcls.h

Voir aussi

IMiniportAudioSignalProcessing