Edit

Share via

ISpatialAudioMetadataCopier::CopyMetadataForFrames method (spatialaudiometadata.h)

  • Article

Copies metadata items from the source ISpatialAudioMetadataItems, provided to the Open method, object to the destination ISpatialAudioMetadataItems object, specified with the dstMetadataItems parameter. Each call advances the internal copy position by the number of frames in the copyFrameCount parameter.

Syntax

HRESULT CopyMetadataForFrames(
  [in]  UINT16                       copyFrameCount,
  [in]  SpatialAudioMetadataCopyMode copyMode,
  [in]  ISpatialAudioMetadataItems   *dstMetadataItems,
  [out] UINT16                       *itemsCopied
);

Parameters

[in] copyFrameCount

The number of frames from the current copy position for which metadata items are copied. After the copy, the internal copy position within the source SpatialAudioMetadataItems is advanced the value specified in this parameter. Set this value to 0 to copy the entire frame range contained in the source SpatialAudioMetadataItems.

[in] copyMode

A value that specifies the copy mode for the operation.

[in] dstMetadataItems

A pointer to the destination SpatialAudioMetadataItems for the copy operation.

[out] itemsCopied

Receives number of metadata items copied in the operation.

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
SPTLAUD_MD_CLNT_E_NO_ITEMS_OPEN
 The ISpatialAudioMetadataItems has not been opened for copying with a call to Open or the object has been closed for writing with a call to Close.
E_INVALIDARG
 One of the provided pointers is not valid.

Requirements

Requirement Value
Target Platform Windows
Header spatialaudiometadata.h

See also

ISpatialAudioMetadataCopier