Compartilhar via


Método IXAudio2Voice::D isableEffect (xaudio2.h)

Desabilita o efeito em uma determinada posição na cadeia de efeito da voz.

Sintaxe

\\HRESULT DisableEffect(
  [in] UINT32 EffectIndex,
  [in] UINT32 OperationSet
);

Parâmetros

[in] EffectIndex

Índice baseado em zero de um efeito na cadeia de efeitos da voz.

[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.

Retornar valor

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 válidos.

Comentários

Os efeitos na cadeia de efeitos de uma determinada voz XAudio2 devem consumir e produzir áudio na taxa de exemplo de processamento dessa voz. O único aspecto do formato de áudio que eles podem alterar é a contagem de canais. Por exemplo, um efeito reverb pode converter dados mono em 5.1. O cliente pode usar o campo OutputChannels da estrutura XAUDIO2_EFFECT_DESCRIPTOR para especificar o número de canais que deseja que cada efeito produza. Cada efeito em uma cadeia de efeitos deve produzir vários canais que o próximo efeito pode consumir. Qualquer chamada para IXAudio2Voice::EnableEffect ou IXAudio2Voice::D isableEffect que faria com que a cadeia de efeitos parasse de atender a esses requisitos falhará.

Desabilitar um efeito o remove imediatamente do grafo de processamento. Qualquer áudio pendente no efeito, como uma cauda de reverb, não é reproduzido. Tenha cuidado ao desabilitar um efeito enquanto a voz que a hospeda está em execução. Isso pode resultar em um artefato audível se o efeito alterar significativamente o tom ou o volume do áudio.

DisableEffect entra em vigor imediatamente quando chamado de um retorno de chamada XAudio2 com um OperationSet de XAUDIO2_COMMIT_NOW.

Requisitos da plataforma

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

Requisitos

Requisito Valor
Plataforma de Destino Windows
Cabeçalho xaudio2.h

Confira também

IXAudio2Voice

Visão geral do XAPO