Share via

Método IAudioSystemEffects2::GetEffectsList (audioenginebaseapo.h)

  • Artigo

O método GetEffectsList é usado para recuperar a lista de efeitos de processamento de áudio que estão ativos no momento e armazena um evento a ser sinalizado se a lista for alterada.

Sintaxe

HRESULT GetEffectsList(
  [out] LPGUID *ppEffectsIds,
  [out] UINT   *pcEffects,
  [in]  HANDLE Event
);

Parâmetros

[out] ppEffectsIds

Ponteiro para a lista de GUIDs que representam efeitos de processamento de áudio. O chamador é responsável por liberar essa memória chamando CoTaskMemFree.

[out] pcEffects

Uma contagem dos efeitos de processamento de áudio na lista.

[in] Event

O HANDLE do evento que será sinalizado se a lista for alterada.

Retornar valor

O método GetEffectsList retorna S_OK, se a chamada de método for bem-sucedida. Se não houver efeitos na lista, a função ainda terá êxito, ppEffectsIds retornará um ponteiro NULL e pcEffects retornará uma contagem de 0.

Comentários

O APO sinaliza o evento especificado quando a lista de efeitos de processamento de áudio é alterada da lista retornada por GetEffectsList. O APO usa esse evento até que GetEffectsList seja chamado novamente ou o APO seja destruído. O identificador passado pode ser NULL, nesse caso, o APO para de usar qualquer identificador anterior e não sinaliza um evento.

Um APO implementa esse método para permitir que o Windows descubra os efeitos atuais aplicados pelo APO. A lista de efeitos pode depender do modo de processamento inicializado pelo APO e de qualquer configuração do usuário final. O modo de processamento é indicado pelo membro AudioProcessingMode de APOInitSystemEffects2.

APOs devem identificar efeitos usando GUIDs definidos pelo Windows, como AUDIO_EFFECT_TYPE_ACOUSTIC_ECHO_CANCELLATION. Um APO só deve definir e retornar um GUID personalizado em casos raros em que o tipo de efeito é claramente diferente daqueles definidos pelo Windows.

Requisitos

Requisito Valor
Plataforma de Destino Área de Trabalho
Cabeçalho audioenginebaseapo.h

Confira também

APOInitSystemEffects2

IAudioSystemEffects2