Metode IAudioEffectsManager::SetAudioEffectState (audioclient.h)

Artikel
05/23/2024

Menyetel status efek audio yang ditentukan.

Sintaks

HRESULT SetAudioEffectState(
  GUID               effectId,
  AUDIO_EFFECT_STATE state
);

Parameter

effectId

Pengidentifikasi GUID efek yang statusnya sedang diubah. GUID efek audio didefinisikan dalam ksmedia.h.

state

Nilai dari AUDIO_EFFECT_STATE menghitung yang menentukan status yang akan ditetapkan.

Nilai kembali

Mengembalikan HRESULT termasuk tetapi tidak terbatas pada yang berikut ini.

Nilai	Deskripsi
S_OK	Berhasil
AUDCLNT_E_EFFECT_NOT_AVAILABLE	Efek yang ditentukan tidak tersedia
AUDCLNT_E_EFFECT_STATE_READ_ONLY	Efek yang ditentukan memiliki status baca-saja
AUDCLNT_E_DEVICE_INVALIDATED	Aliran audio terkait telah dihancurkan.

Keterangan

Dapatkan daftar efek audio saat ini untuk aliran audio terkait dengan memanggil GetAudioEffects.

Contoh

Contoh berikut menunjukkan penggunaan IAudioEffectsManager.SetAudioEffectState untuk menonaktifkan efek 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;
}

Contoh berikut menunjukkan penggunaan IAudioEffectsManager.SetAudioEffectState untuk mengaktifkan efek 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;
}

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows Build 22000
Header	audioclient.h

Bagikan melalui