Método ISpatialAudioClient::ActivateSpatialAudioStream (spatialaudioclient.h)

Artículo
03/15/2023

Activa e inicializa la secuencia de audio espacial mediante una de las estructuras de activación de secuencias de audio espaciales.

Sintaxis

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

Parámetros

[in] activationParams

Estructura que define los parámetros de activación para la secuencia de audio espacial. El campo vt debe establecerse en VT_BLOB y el campo de blob debe rellenarse con spatialAudioObjectRenderStreamActivationParams o spatialAudioObjectRenderStreamForMetadataActivationParams.

[in] riid

UUID de la interfaz de secuencia de audio espacial que se va a activar.

[out] stream

Puntero al puntero que recibe la interfaz de audio espacial activada.

Valor devuelto

Si el método se realiza correctamente, devuelve S_OK.

Comentarios

Este método admite la activación de las siguientes interfaces de secuencia de audio espacial:

ISpatialAudioObjectRenderStream

ISpatialAudioObjectRenderStreamForMetadata

Ejemplos

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);