Freigeben über


IApoAuxiliaryInputConfiguration::IsInputFormatSupported-Methode (audioenginebaseapo.h)

Überprüft, ob ein bestimmtes Hilfseingabeformat vom APO unterstützt wird.

Syntax

HRESULT IsInputFormatSupported(
  IAudioMediaType *pRequestedInputFormat,
  IAudioMediaType **ppSupportedInputFormat
);

Die Parameter

pRequestedInputFormat

Das Eingabeformat, das überprüft werden soll.

ppSupportedInputFormat

Das APO füllt diesen Parameter mit dem unterstützten Eingabeformat auf, das dem an die Methode übergebenen Format am nächsten kommt.

Rückgabewert

HRESULT

HRESULT Description
S_OK Erfolgreicher Abschluss. Die APO sollte einen Verweis auf pRequestedInputFormat hinzufügen und in ppSupportedInputFormat zurückgeben.
S_FALSE Das Format wird nicht unterstützt. Das APO sollte ein vorgeschlagenes unterstütztes Format in ppSupportedInputFormat zurückgeben.
APOERR_FORMAT_NOT_SUPPORTED Das Format wird nicht unterstützt. Das APO sollte ppSupportedInputFormat nicht ändern
E_POINTER Ungültiger Zeiger, der an diese Funktion übergeben wurde.
Andere Werte Eine andere Komponente verursacht einen Fehler. Diese Fehler werden vom System nachverfolgt.

Bemerkungen

Wenn das APO das angeforderte Format akzeptieren kann, sollte es einen Verweis auf das angeforderte Format hinzufügen, dies als unterstütztes Ausgabeformat zurückgeben und S_OK zurückgeben.

Wenn das APO das angeforderte Format nicht akzeptieren kann, schlägt es möglicherweise ein alternatives angefordertes Format vor. In diesem Fall sollte es das vorgeschlagene Format erstellen und zurückgeben und S_FALSE zurückgeben.

Das zurückgegebene unterstützte Format sollte dem angeforderten Format "am nächsten" sein, was bedeutet, dass das Format dieselben Werte für die folgenden Eigenschaften aufweisen sollte, die in der Prioritätsreihenfolge angegeben sind.

  • Beispielformat
  • Bittiefe
  • Anzahl der Kanäle
  • Abtastrate

Das vorgeschlagene Format unterscheidet sich möglicherweise nur vom angeforderten Format, wenn S_FALSE zurückgegeben wird. Beim Zurückgeben eines Fehlers sollte das vorgeschlagene Format unverändert bleiben.

Diese API kann jederzeit aufgerufen werden. Die zurückgegebenen Ergebnisse hängen vom internen Zustand des APO ab, der von externen Benutzeroberflächen bearbeitet werden kann. Sobald das APO für die Verarbeitung gesperrt ist, kann dieses Format jedoch nicht mehr geändert werden.

Diese Methode kann nicht aus einem Echtzeitverarbeitungsthread aufgerufen werden.

Anforderungen

Anforderung Wert
Mindestens unterstützter Client Windows 10 Build 20348
Header audioenginebaseapo.h