Método IAudioEffectsManager::SetAudioEffectState (audioclient.h)

Define o estado do efeito de áudio especificado.

Sintaxe

HRESULT SetAudioEffectState(
  GUID               effectId,
  AUDIO_EFFECT_STATE state
);

Parâmetros

effectId

O identificador GUID do efeito para o qual o estado está sendo alterado. Os GUIDs de efeito de áudio são definidos em ksmedia.h.

state

Um valor do AUDIO_EFFECT_STATE enumerando especificando o estado a ser definido.

Retornar valor

Retorna um HRESULT, incluindo, mas não se limitando ao seguinte.

Valor	Descrição
S_OK	Êxito
AUDCLNT_E_EFFECT_NOT_AVAILABLE	O efeito especificado não está disponível
AUDCLNT_E_EFFECT_STATE_READ_ONLY	O efeito especificado tem um estado somente leitura
AUDCLNT_E_DEVICE_INVALIDATED	O fluxo de áudio associado foi destruído.

Comentários

Obtenha a lista atual de efeitos de áudio para o fluxo de áudio associado chamando GetAudioEffects.

Exemplos

O exemplo a seguir demonstra o uso do IAudioEffectsManager.SetAudioEffectState para desabilitar o efeito AUDIO_EFFECT_TYPE_DEEP_NOISE_SUPPRESSION .

HRESULT TryDisablePlatformDeepNoiseSuppression(_In_ IAudioClient *client)
{
    wil::com_ptr_nothrow<IAudioEffectsManager> audioEffectsManager;
    RETURN_IF_FAILED(client->GetService(IID_PPV_ARGS(&audioEffectsManager)));
    wil::unique_cotaskmem_array_ptr<AudioEffect> effects;
    UINT32 numEffects;
    RETURN_IF_FAILED(audioEffectsManager->GetAudioEffects(&effects, &numEffects));

    for (UINT32 i = 0; i < numEffects; i++)
    {
        if (effects[i].id == AUDIO_EFFECT_TYPE_DEEP_NOISE_SUPPRESSION)
        {
            // Check if deep noise suppression can be set and if it is currently on
            if (effects[i].canSetState && effects[i].state == AUDIO_EFFECT_STATE_ON)
            {
                HRESULT hr = audioEffectsManager->SetAudioEffectState(effects[i].id, AUDIO_EFFECT_STATE_OFF);

                // If canSetState changed to false, or the effect was removed, SetAudioEffectState
                // can fail with one of the following error codes.
                if (hr != AUDCLNT_E_EFFECT_NOT_AVAILABLE && hr != AUDCLNT_E_EFFECT_STATE_READ_ONLY)
                {
                    return hr;
                }
            }

            return S_OK;
        }
    }

    return S_OK;
}

O exemplo a seguir demonstra o uso do IAudioEffectsManager.SetAudioEffectState para habilitar o efeito AUDIO_EFFECT_TYPE_DEEP_NOISE_SUPPRESSION .

HRESULT TryEnablePlatformDeepNoiseSuppression(_In_ IAudioClient *client)
{
    wil::com_ptr_nothrow<IAudioEffectsManager> audioEffectsManager;
    RETURN_IF_FAILED(client->GetService(IID_PPV_ARGS(&audioEffectsManager)));
    wil::unique_cotaskmem_array_ptr<AUDIO_EFFECT> effects;
    UINT32 numEffects;
    RETURN_IF_FAILED(audioEffectsManager->GetAudioEffects(&effects, &numEffects));

    for (UINT32 i = 0; i < numEffects; i++)
    {
        if (effects[i].id == AUDIO_EFFECT_TYPE_DEEP_NOISE_SUPPRESSION)
        {
            // Check if deep noise suppression can be set and if it is currently off
            if (effects[i].canSetState && effects[i].state == AUDIO_EFFECT_STATE_OFF)
            {
                HRESULT hr = audioEffectsManager->SetAudioEffectState(effects[i].id, AUDIO_EFFECT_STATE_ON);

                // If canSetState changed to false, or the effect was removed, SetAudioEffectState
                // can fail with one of the following error codes.
                if (hr != AUDCLNT_E_EFFECT_NOT_AVAILABLE && hr != AUDCLNT_E_EFFECT_STATE_READ_ONLY)
                {
                    return hr;
                }
            }

            return S_OK;
        }
        }

        return S_OK;
}

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows Build 22000
Cabeçalho	audioclient.h