Método IXAudio2SourceVoice::Stop (xaudio2.h)

  • Artículo

Detiene el consumo de audio por la voz actual.

Sintaxis

HRESULT Stop(
  [in] UINT32 Flags,
  [in] UINT32 OperationSet
);

Parámetros

[in] Flags

Marcas que controlan cómo se detiene la voz. Puede ser 0 o lo siguiente:

Value Descripción
XAUDIO2_PLAY_TAILS Continúe emitiendo la salida del efecto después de detener la voz. 

[in] OperationSet

Identifica esta llamada como parte de un lote diferido. Consulte la información general sobre conjuntos de operaciones XAudio2 para obtener más información.

Valor devuelto

Devuelve S_OK si se ejecuta correctamente, de lo contrario, un código de error. Consulte Códigos de error XAudio2 para obtener descripciones de códigos de error específicos de XAudio2.

Observaciones

Se conservan todos los búferes de origen que se ponen en cola en la voz y la posición actual del cursor. Esto permite que la voz continúe desde donde se dejó, cuando se reinicia. El método IXAudio2SourceVoice::FlushSourceBuffers se puede usar para vaciar los búferes de origen en cola.

De forma predeterminada, las salidas pendientes de los efectos de voz (por ejemplo, colas de reverberación) no se reproducen. En su lugar, la voz se representa inmediatamente en silencio. La marca XAUDIO2_PLAY_TAILS se puede usar para seguir emitiendo la salida del efecto después de que la voz deje de ejecutarse.

Una voz detenida con la marca XAUDIO2_PLAY_TAILS deja de consumir búferes de origen, pero sigue procesando sus efectos y enviando audio a sus voces de destino. Una voz en este estado se puede detener más adelante llamando a Stop de nuevo con el argumento Flags establecido en 0. Esto permite detener una voz con XAUDIO2_PLAY_TAILS, esperando tiempo suficiente para que finalice cualquier audio producido por sus efectos y, a continuación, detener completamente la voz llamando a Stop de nuevo sin XAUDIO2_PLAY_TAILS. Esta técnica permite que las voces con efectos se detengan correctamente, a la vez que se garantiza que las voces inactivas no se seguirán procesando después de que hayan terminado de producir audio.

Stop siempre es asincrónico, incluso si se llama dentro de una devolución de llamada.

Nota XAudio2 nunca llama a ninguna devolución de llamada de voz para una voz si la voz se detiene (incluso si se ha detenido con XAUDIO2_PLAY_TAILS).
 

Requisitos de la plataforma

Windows 10 (XAudio2.9); Windows 8, Windows Phone 8 (XAudio 2.8); SDK de DirectX (XAudio 2.7)

Requisitos

   
Plataforma de destino Windows
Encabezado xaudio2.h

Consulte también

IXAudio2SourceVoice

Introducción a XAPO