Edit

ISpatialAudioMetadataClient::ActivateSpatialAudioMetadataWriter method (spatialaudiometadata.h)

  • Article

Creates an ISpatialAudioMetadataWriter object for writing spatial audio metadata items to an ISpatialAudioMetadataItems object.

Syntax

HRESULT ActivateSpatialAudioMetadataWriter(
  [in]  SpatialAudioMetadataWriterOverflowMode overflowMode,
  [out] ISpatialAudioMetadataWriter            **metadataWriter
);

Parameters

[in] overflowMode

A value that specifies the behavior when attempting to write more metadata items to the ISpatialAudioMetadataItems than the maximum number of items specified when calling ActivateSpatialAudioMetadataItems.

[out] metadataWriter

Receives a pointer to an instance of ISpatialAudioMetadataWriter.

Return value

If the method succeeds, it returns S_OK. If it fails, possible return codes include, but are not limited to, the values shown in the following table.

Return code Description
E_INVALIDARG
 The provided pointer is not valid.

Requirements

Requirement Value
Target Platform Windows
Header spatialaudiometadata.h

See also

ISpatialAudioMetadataClient