Edit

ISpatialAudioObjectForMetadataCommands::WriteNextMetadataCommand method (spatialaudiometadata.h)

  • Article

Writes a metadata command to the spatial audio object, each command may only be added once per object per processing cycle. Valid commands and value lengths are defined by the metadata format specified in the SpatialAudioObjectRenderStreamForMetadataActivationParams when the ISpatialAudioObjectRenderStreamForMetadata was created.

Syntax

HRESULT WriteNextMetadataCommand(
  [in] BYTE   commandID,
  [in] void   *valueBuffer,
  [in] UINT32 valueBufferLength
);

Parameters

[in] commandID

The ID of the metadata command.

[in] valueBuffer

The buffer containing the value data for the metadata command.

[in] valueBufferLength

The length of the valueBuffer.

Return value

If the method succeeds, it returns S_OK.

Requirements

Requirement Value
Target Platform Windows
Header spatialaudiometadata.h (include Spatialaudioclient.h)

See also

ISpatialAudioObjectForMetadataCommands