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

  • Artigo

Interrompe o consumo de áudio pela voz atual.

Sintaxe

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

Parâmetros

[in] Flags

Sinalizadores que controlam como a voz é interrompida. Pode ser 0 ou o seguinte:

Valor Descrição
XAUDIO2_PLAY_TAILS Continue emitindo saída de efeito depois que a voz for interrompida. 

[in] OperationSet

Identifica essa chamada como parte de um lote adiado. Consulte a visão geral dos Conjuntos de Operações XAudio2 para obter mais informações.

Valor retornado

Retorna S_OK se tiver êxito, caso contrário, um código de erro. Consulte Códigos de Erro XAudio2 para obter descrições de códigos de erro específicos do XAudio2.

Comentários

Todos os buffers de origem enfileirados na voz e na posição do cursor atual são preservados. Isso permite que a voz continue de onde parou quando é reiniciada. O método IXAudio2SourceVoice::FlushSourceBuffers pode ser usado para liberar buffers de origem enfileirados.

Por padrão, qualquer saída pendente de efeitos de voz, por exemplo, caudas de reverb, não é reproduzida. Em vez disso, a voz é imediatamente tornada silenciosa. O sinalizador XAUDIO2_PLAY_TAILS pode ser usado para continuar emitindo a saída de efeito depois que a voz parar de ser executada.

Uma voz parou com o sinalizador XAUDIO2_PLAY_TAILS para de consumir buffers de origem, mas continua processando seus efeitos e enviando áudio para suas vozes de destino. Uma voz nesse estado pode ser interrompida por completo chamando Parar novamente com o argumento Flags definido como 0. Isso permite interromper uma voz com XAUDIO2_PLAY_TAILS, aguardar tempo suficiente para que qualquer áudio produzido por seus efeitos seja concluído e parar totalmente a voz chamando Parar novamente sem XAUDIO2_PLAY_TAILS. Essa técnica permite que vozes com efeitos sejam interrompidas normalmente, garantindo que as vozes ociosas não continuem sendo processadas depois que terminarem de produzir áudio.

Parar é sempre assíncrono, mesmo se chamado dentro de um retorno de chamada.

Nota XAudio2 nunca chamará nenhum retorno de chamada de voz para uma voz se a voz for interrompida (mesmo que ela tenha sido interrompida com XAUDIO2_PLAY_TAILS).
 

Requisitos da plataforma

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

Requisitos

   
Plataforma de Destino Windows
Cabeçalho xaudio2.h

Confira também

IXAudio2SourceVoice

Visão geral do XAPO