ISpatialAudioMetadataWriter::WriteNextItem-Methode (spatialaudiometadata.h)

  • Artikel

Startet ein neues Metadatenelement am angegebenen Offset.

Syntax

HRESULT WriteNextItem(
  [in] UINT16 frameOffset
);

Parameter

[in] frameOffset

Der Frameoffset des Elements innerhalb des Bereichs, der mit dem frameCount-Parameter zu ActivateSpatialAudioMetadataItems angegeben wird.

Rückgabewert

Wenn die Methode erfolgreich ist, wird S_OK zurückgegeben. Wenn ein Fehler auftritt, können mögliche Rückgabecodes die in der folgenden Tabelle gezeigten Werte umfassen, sind jedoch nicht darauf beschränkt.

Rückgabecode Beschreibung
SPTLAUD_MD_CLNT_E_NO_ITEMS_OPEN
 ISpatialAudioMetadataItems wurde nicht zum Schreiben mit einem Aufruf von Open geöffnet, oder das Objekt wurde zum Schreiben mit einem Aufruf von Close geschlossen.
SPTLAUD_MD_CLNT_E_FRAMEOFFSET_OUT_OF_RANGE
 Die Anzahl der in der Schreibsitzung geschriebenen Elemente ist größer als der im Feld MaxMetadataItemCount im SpatialAudioObjectRenderStreamForMetadataActivationParam bereitgestellte Wert, der an ISpatialAudioClient::ActivateSpatialAudioStream übergeben wurde.

Der frameCount-Wert ist größer als der Wert des frameCount-Parameters auf ActivateSpatialAudioMetadataItems , und der Überlaufmodus wurde auf SpatialAudioMetadataWriterOverflow_Fail festgelegt.
E_INVALIDARG
 Der Wert von frameOffset ist nicht größer als der Wert, der im vorherigen Aufruf von WriteNextItem innerhalb derselben Schreibsitzung angegeben wurde.

Hinweise

Bevor Sie WriteNextItem aufrufen, müssen Sie ISpatialAudioMetadataWriter zum Schreiben öffnen, indem Sie Open aufrufen, nachdem das Objekt erstellt wurde und nachdem Close aufgerufen wurde. Während einer Schreibsitzung, die durch Aufrufe von Open und Close abgegrenzt wird, muss der Wert des frameOffset-Parameters größer als der Wert im vorherigen Aufruf sein.

Innerhalb einer einzelnen Schreibsitzung dürfen Sie WriteNextItem nicht verwenden, um mehr Elemente als den wert zu schreiben, der im Feld MaxMetadataItemCount im SpatialAudioObjectRenderStreamForMetadataActivationParam an ISpatialAudioClient::ActivateSpatialAudioStream übergeben wird, da sonst ein SPTLAUD_MD_CLNT_E_FRAMEOFFSET_OUT_OF_RANGE Fehler auftritt.

Wenn der Überlaufmodus auf SpatialAudioMetadataWriterOverflow_Fail festgelegt ist, muss der Wert des frameOffset-Parameters kleiner als der Wert des frameCount-Parameters auf ActivateSpatialAudioMetadataItems sein, andernfalls tritt ein SPTLAUD_MD_CLNT_E_FRAMEOFFSET_OUT_OF_RANGE Fehler auf.

Rufen Sie nach dem Aufrufen von WriteNextItemWriteNextItemCommand auf, um Metadatenbefehle und Wertdaten für das Element zu schreiben.

Anforderungen

   
Zielplattform Windows
Kopfzeile spatialaudiometadata.h

Weitere Informationen

ISpatialAudioMetadataWriter