SpatialAudioClientActivationParams structure (spatialaudioclient.h)

Represents optional activation parameters for a spatial audio render stream. Pass this structure to ActivateAudioInterfaceAsync when activating an ISpatialAudioClient interface.

Syntax

typedef struct SpatialAudioClientActivationParams {
  GUID tracingContextId;
  GUID appId;
  int  majorVersion;
  int  minorVersion1;
  int  minorVersion2;
  int  minorVersion3;
} SpatialAudioClientActivationParams;

Members

tracingContextId

An app-defined context identifier, used for event logging.

appId

An identifier for the client app, used for event logging.

majorVersion

The major version number of the client app, used for event logging.

minorVersion1

The first minor version number of the client app, used for event logging.

minorVersion2

The second minor version number of the client app, used for event logging.

####### minorVersion3

The third minor version number of the client app, used for event logging.

majorVersion

minorVersion1

minorVersion2

minorVersion3

Remarks

The following example code shows how to initialize this structure.

PROPVARIANT var; 
PropVariantInit(&var);  
auto p = reinterpret_cast<SpatialAudioClientActivationParams *>(CoTaskMemAlloc(sizeof(SpatialAudioClientActivationParams)));  
if (nullptr == p) { ... } 
p->tracingContextId = /* context identifier */;  
p->appId = /* app identifier */;  
p->majorVersion = /* app version info */;  
p->majorVersionN = /* app version info */;
var.vt = VT_BLOB;
var.blob.cbSize = sizeof(*p);
var.blob.pBlobData = reinterpret_cast<BYTE *>(p); 
hr = ActivateAudioInterfaceAsync(device, __uuidof(ISpatialAudioClient), &var, ...);
// ...
ropVariantClear(&var);

To access the ActivateAudioIntefaceAsync, you will need to link to mmdevapi.lib.

Requirements

Requirement Value
Header spatialaudioclient.h