Metodo IAudioEffectsManager::SetAudioEffectState (audioclient.h)

Articolo
05/23/2024

Imposta lo stato dell'effetto audio specificato.

Sintassi

HRESULT SetAudioEffectState(
  GUID               effectId,
  AUDIO_EFFECT_STATE state
);

Parametri

effectId

Identificatore GUID dell'effetto per il quale viene modificato lo stato. I GUID degli effetti audio sono definiti in ksmedia.h.

state

Valore della AUDIO_EFFECT_STATE enumerata che specifica lo stato da impostare.

Valore restituito

Restituisce un valore HRESULT, incluso ma non limitato al seguente.

Valore	Descrizione
S_OK	Operazione riuscita
AUDCLNT_E_EFFECT_NOT_AVAILABLE	L'effetto specificato non è disponibile
AUDCLNT_E_EFFECT_STATE_READ_ONLY	L'effetto specificato ha uno stato di sola lettura
AUDCLNT_E_DEVICE_INVALIDATED	Il flusso audio associato è stato eliminato definitivamente.

Commenti

Ottenere l'elenco corrente di effetti audio per il flusso audio associato chiamando GetAudioEffects.

Esempio

L'esempio seguente illustra l'uso di IAudioEffectsManager.SetAudioEffectState per disabilitare l'effetto 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;
}

L'esempio seguente illustra l'uso di IAudioEffectsManager.SetAudioEffectState per abilitare l'effetto 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;
}

Requisiti

Requisito	Valore
Client minimo supportato	Windows Build 22000
Intestazione	audioclient.h

Condividi tramite