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

Establece el estado del efecto de audio especificado.

Sintaxis

HRESULT SetAudioEffectState(
  GUID               effectId,
  AUDIO_EFFECT_STATE state
);

Parámetros

effectId

Identificador GUID del efecto para el que se va a cambiar el estado. Los GUID de efecto de audio se definen en ksmedia.h.

state

Valor de la AUDIO_EFFECT_STATE enumeración que especifica el estado que se va a establecer.

Valor devuelto

Devuelve un VALOR HRESULT, incluido pero no limitado a lo siguiente.

Valor	Descripción
S_OK	Correcto
AUDCLNT_E_EFFECT_NOT_AVAILABLE	El efecto especificado no está disponible
AUDCLNT_E_EFFECT_STATE_READ_ONLY	El efecto especificado tiene un estado que es de solo lectura.
AUDCLNT_E_DEVICE_INVALIDATED	La secuencia de audio asociada se ha destruido.

Comentarios

Obtenga la lista actual de efectos de audio para la secuencia de audio asociada llamando a GetAudioEffects.

Ejemplos

En el ejemplo siguiente se muestra el uso de IAudioEffectsManager.SetAudioEffectState para deshabilitar el efecto de 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;
}

En el ejemplo siguiente se muestra cómo usar IAudioEffectsManager.SetAudioEffectState para habilitar el efecto de 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	Value
Cliente mínimo compatible	Windows Build 22000
Encabezado	audioclient.h