spatialaudiometadata.h header

This header is used by Core Audio APIs. For more information, see:

• Core Audio APIs

spatialaudiometadata.h contains the following programming interfaces:

Interfaces

ISpatialAudioMetadataClient Provides a class factory for creating ISpatialAudioMetadataItems, ISpatialAudioMetadataWriter, ISpatialAudioMetadataReader, and ISpatialAudioMetadataCopier objects.
ISpatialAudioMetadataCopier Provides methods for copying all or subsets of metadata items from a source SpatialAudioMetadataItems into a destination SpatialAudioMetadataItems.
ISpatialAudioMetadataItems Represents a buffer of spatial audio metadata items.
ISpatialAudioMetadataItemsBuffer Provides methods for attaching buffers to SpatialAudioMetadataItems for in-place storage of data.
ISpatialAudioMetadataReader Provides methods for extracting spatial audio metadata items and item command value pairs from an ISpatialAudioMetadataItems object.
ISpatialAudioMetadataWriter Provides methods for storing spatial audio metadata items positioned within a range of corresponding audio frames.
ISpatialAudioObjectForMetadataCommands Used to write metadata commands for spatial audio.
ISpatialAudioObjectForMetadataItems Used to write spatial audio metadata for applications that require multiple metadata items per buffer with frame-accurate placement.
ISpatialAudioObjectRenderStreamForMetadata Provides methods for controlling a spatial audio object render stream for metadata, including starting, stopping, and resetting the stream.

Structures

SpatialAudioMetadataItemsInfo Provides information about an ISpatialAudioMetadataItems object. Get a copy of this structure by calling GetInfo.
SpatialAudioObjectRenderStreamForMetadataActivationParams Represents activation parameters for a spatial audio render stream for metadata. Pass this structure to ISpatialAudioClient::ActivateSpatialAudioStream when activating a stream.
SpatialAudioObjectRenderStreamForMetadataActivationParams2 Represents activation parameters for a spatial audio render stream for metadata, extending SpatialAudioObjectRenderStreamForMetadataActivationParams with the ability to specify stream options.

Enumerations

SpatialAudioMetadataCopyMode Specifies the copy mode used when calling ISpatialAudioMetadataCopier::CopyMetadataForFrames.
SpatialAudioMetadataWriterOverflowMode Specifies the desired behavior when an ISpatialAudioMetadataWriter attempts to write more items into the metadata buffer than was specified when the client was initialized.