Edit

Share via

SpatialAudioObjectRenderStreamForMetadataActivationParams structure (spatialaudiometadata.h)

  • Article

Represents activation parameters for a spatial audio render stream for metadata. Pass this structure to ISpatialAudioClient::ActivateSpatialAudioStream when activating a stream.

Syntax

typedef struct SpatialAudioObjectRenderStreamForMetadataActivationParams {
  const WAVEFORMATEX                    *ObjectFormat;
  AudioObjectType                       StaticObjectTypeMask;
  UINT32                                MinDynamicObjectCount;
  UINT32                                MaxDynamicObjectCount;
  AUDIO_STREAM_CATEGORY                 Category;
  HANDLE                                EventHandle;
  GUID                                  MetadataFormatId;
  UINT16                                MaxMetadataItemCount;
  const PROPVARIANT                     *MetadataActivationParams;
  ISpatialAudioObjectRenderStreamNotify *NotifyObject;
} SpatialAudioObjectRenderStreamForMetadataActivationParams;

Members

ObjectFormat

Format descriptor for a single spatial audio object. All objects used by the stream must have the same format and the format must be of type WAVEFORMATEX or WAVEFORMATEXTENSIBLE.

StaticObjectTypeMask

A bitwise combination of AudioObjectType values indicating the set of static spatial audio channels that will be allowed by the activated stream.

MinDynamicObjectCount

The minimum number of concurrent dynamic objects. If this number of dynamic audio objects can't be activated simultaneously, ISpatialAudioClient::ActivateSpatialAudioStream will fail with this error SPTLAUDCLNT_E_NO_MORE_OBJECTS.

MaxDynamicObjectCount

The maximum number of concurrent dynamic objects that can be activated with ISpatialAudioObjectRenderStream.

Category

The category of the audio stream and its spatial audio objects.

EventHandle

The event that will signal the client to provide more audio data. This handle will be duplicated internally before it is used.

MetadataFormatId

The identifier of the metadata format for the currently active spatial rendering engine.

MaxMetadataItemCount

The maximum number of metadata items per frame.

MetadataActivationParams

Additional activation parameters.

NotifyObject

The object that provides notifications for spatial audio clients to respond to changes in the state of an ISpatialAudioObjectRenderStream. This object is used to notify clients that the number of dynamic spatial audio objects that can be activated concurrently is about to change.

Requirements

Requirement Value
Header spatialaudiometadata.h