ISpatialAudioClient::ActivateSpatialAudioStream-Methode (spatialaudioclient.h)

Artikel
08/26/2023

Aktiviert und initialisiert den räumlichen Audiodatenstrom mithilfe einer der Räumlichen Audiostreamaktivierungsstrukturen.

Syntax

HRESULT ActivateSpatialAudioStream(
  [in]  const PROPVARIANT *activationParams,
  [in]  REFIID            riid,
  [out] void              **stream
);

Parameter

[in] activationParams

Die Struktur, die die Aktivierungsparameter für den räumlichen Audiostream definiert. Das vt-Feld sollte auf VT_BLOB festgelegt werden, und das Blobfeld sollte mit einem SpatialAudioObjectRenderStreamActivationParams oder einem SpatialAudioObjectRenderStreamForMetadataActivationParams aufgefüllt werden.

[in] riid

Die UUID der zu aktivierenden räumlichen Audiostreamschnittstelle.

[out] stream

Ein Zeiger auf den Zeiger, der die aktivierte räumliche Audioschnittstelle empfängt.

Rückgabewert

Wenn die Methode erfolgreich ist, wird S_OK zurückgegeben.

Hinweise

Diese Methode unterstützt die Aktivierung der folgenden räumlichen Audiostreamschnittstellen:

ISpatialAudioObjectRenderStream

ISpatialAudioObjectRenderStreamForMetadata

Beispiele

Microsoft::WRL::ComPtr<ISpatialAudioClient> spatialAudioClient;

// Activate ISpatialAudioClient on the desired audio-device 
hr = defaultDevice->Activate(__uuidof(ISpatialAudioClient), CLSCTX_INPROC_SERVER, nullptr, (void**)&spatialAudioClient);

hr = spatialAudioClient->IsAudioObjectFormatSupported(&format);

// Create the event that will be used to signal the client for more data
HANDLE bufferCompletionEvent = CreateEvent(nullptr, FALSE, FALSE, nullptr);

SpatialAudioObjectRenderStreamActivationParams streamParams;
streamParams.ObjectFormat = &format;
streamParams.StaticObjectTypeMask = ChannelMask_Stereo;
streamParams.MinDynamicObjectCount = 0;
streamParams.MaxDynamicObjectCount = 0;
streamParams.Category = AudioCategory_SoundEffects;
streamParams.EventHandle = bufferCompletionEvent;
streamParams.NotifyObject = nullptr;

PROPVARIANT activationParams;
PropVariantInit(&activationParams);
activationParams.vt = VT_BLOB;
activationParams.blob.cbSize = sizeof(streamParams);
activationParams.blob.pBlobData = reinterpret_cast<BYTE *>(&streamParams);

Microsoft::WRL::ComPtr<ISpatialAudioObjectRenderStream> spatialAudioStream;
hr = spatialAudioClient->ActivateSpatialAudioStream(&activationParams, __uuidof(spatialAudioStream), (void**)&spatialAudioStream);