IAudioSystemEffectsCustomFormats::GetFormat-Methode (audioenginebaseapo.h)

Die GetFormat -Methode ruft eine IAudioMediaType-Darstellung eines benutzerdefinierten Formats ab.

Syntax

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

Parameter

[in] nFormat

Gibt den Index eines unterstützten Formats an. Dieser Parameter kann ein beliebiger Wert im Bereich von 0 bis 1 sein, der kleiner als der Rückgabewert von GetFormatCount ist. Mit anderen Worten, jeder Wert im Bereich von null bis GetFormatCount( ) - 1.

[out, optional] ppFormat

Gibt einen Zeiger auf einen Zeiger auf eine IAudioMediaType-Schnittstelle an. Es liegt in der Verantwortung des Aufrufers, die IAudioMediaType-Schnittstelle freizugeben, auf die der ppFormat-Parameter verweist.

Rückgabewert

Die GetFormat -Methode gibt S_OK zurück, wenn der Aufruf erfolgreich ist. Andernfalls wird einer der in der folgenden Tabelle gezeigten Fehlercodes zurückgegeben.

Rückgabecode	Beschreibung
E_POINTER	Ungültiger Zeiger, der an die Funktion übergeben wurde
E_OUTOFMEMORY	Rückgabepuffer kann nicht zugeordnet werden
E_INVALIDARG	nFormat liegt außerhalb des Bereichs

Hinweise

Wenn das Audiosystem die GetFormat -Methode aufruft, erstellt das sAPO ein Audiomedientypobjekt und gibt eine IAudioMediaType-Schnittstelle zurück. Die sAPO-Implementierung kann die Hilfsprogrammfunktion CreateAudioMediaType verwenden, um das Audiomedientypobjekt zu erstellen.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Verfügbar in Windows Vista und späteren Windows-Versionen.
Zielplattform	Desktop
Kopfzeile	audioenginebaseapo.h (schließen Sie Audioenginebaseapo.h ein)
IRQL	Alle Ebenen.

Weitere Informationen

CreateAudioMediaType

GetFormatCount

IAudioMediaType