Méthode IAudioSystemEffectsCustomFormats ::GetFormat (audioenginebaseapo.h)

Article
02/23/2024

La GetFormat méthode récupère une représentation IAudioMediaType d’un format personnalisé.

Syntaxe

HRESULT GetFormat(
  [in]            UINT            nFormat,
  [out, optional] IAudioMediaType **ppFormat
);

Paramètres

[in] nFormat

Spécifie l’index d’un format pris en charge. Ce paramètre peut être n’importe quelle valeur comprise entre zéro et une valeur inférieure à la valeur de retour de GetFormatCount. En d’autres termes, toute valeur comprise entre zéro et GetFormatCount( ) - 1.

[out, optional] ppFormat

Spécifie un pointeur vers une interface IAudioMediaType . Il incombe à l’appelant de libérer l’interface IAudioMediaType vers laquelle pointe le paramètre ppFormat .

Valeur retournée

La GetFormat méthode retourne S_OK lorsque l’appel réussit. Sinon, elle retourne l’un des codes d’erreur indiqués dans le tableau suivant.

Code de retour	Description
E_POINTER	Pointeur non valide passé à la fonction
E_OUTOFMEMORY	La mémoire tampon de retour ne peut pas être allouée
E_INVALIDARG	nFormat est hors limites

Remarques

Lorsque le système audio appelle la GetFormat méthode, l’objet sAPO crée un objet de type média audio et retourne une interface IAudioMediaType . L’implémentation sAPO peut utiliser la fonction utilitaire CreateAudioMediaType pour créer l’objet de type de média audio.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Disponible dans Windows Vista et les versions plus récentes de Windows.
Plateforme cible	Desktop (Expérience utilisateur)
En-tête	audioenginebaseapo.h (inclure Audioenginebaseapo.h)
IRQL	Tous les niveaux.

Voir aussi

CreateAudioMediaType

GetFormatCount

IAudioMediaType

Partager via