Share via


IApoAuxiliaryInputConfiguration::IsInputFormatSupported-Methode (audioenginebaseapo.h)

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

Syntax

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

Parameter

pRequestedInputFormat

Das zu überprüfende Eingabeformat.

ppSupportedInputFormat

Der 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 BESCHREIBUNG
S_OK Erfolgreicher Abschluss. Der APO sollte einen Verweis auf pRequestedInputFormat hinzufügen und in ppSupportedInputFormat zurückgeben.
S_FALSE Format wird nicht unterstützt. Der APO sollte ein vorgeschlagenes unterstütztes Format in ppSupportedInputFormat zurückgeben.
APOERR_FORMAT_NOT_SUPPORTED Format wird nicht unterstützt. Der APO sollte ppSupportedInputFormat nicht ändern.
E_POINTER Ungültiger Zeiger, der an diese Funktion übergeben wird.
Andere Werte Eine andere Komponente verursacht einen Fehler. Diese Fehler werden vom System nachverfolgt.

Hinweise

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

Wenn der APO das angeforderte Format nicht akzeptieren kann, kann dies ein alternatives angefordertes Format vorschlagen. In diesem Fall sollte das vorgeschlagene Format erstellt und zurückgegeben und S_FALSE zurückgegeben werden.

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

  • Beispielformat
  • Bittiefe
  • Anzahl von Kanälen
  • Abtastrate

Das vorgeschlagene Format kann nur dann vom angeforderten Format abweichen, wenn S_FALSE zurückgegeben wird. Wenn ein Fehler zurückgegeben wird, 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 der APO für die Verarbeitung gesperrt ist, kann und wird dieses Format jedoch nicht mehr geändert.

Diese Methode kann nicht aus einem Echtzeitverarbeitungsthread aufgerufen werden.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows 10 Build 20348
Kopfzeile audioenginebaseapo.h