Метод IXAudio2Voice::D isableEffect (xaudio2.h)

  • Статья

Отключает эффект в заданной позиции в цепочке эффектов голоса.

Синтаксис

\\HRESULT DisableEffect(
  [in] UINT32 EffectIndex,
  [in] UINT32 OperationSet
);

Параметры

[in] EffectIndex

Отсчитываемый от нуля индекс эффекта в цепочке эффектов голоса.

[in] OperationSet

Определяет этот вызов как часть отложенного пакета. Дополнительные сведения см. в обзоре наборов операций XAudio2 .

Возвращаемое значение

В случае успешного выполнения возвращает S_OK; в противном случае — код ошибки. Описание допустимых кодов ошибок см. в разделе Коды ошибок XAudio2 .

Комментарии

Эффекты в цепочке эффектов конкретного голоса XAudio2 должны потреблять и производить звук при частоте обработки выборки этого голоса. Единственным аспектом аудиоформата, который они могут изменить, является количество каналов. Например, эффект реверберации может преобразовать моноданные в 5.1. Клиент может использовать поле OutputChannelsструктуры XAUDIO2_EFFECT_DESCRIPTOR, чтобы указать количество каналов, которые он хочет создать каждый эффект. Каждый эффект в цепочке эффектов должен создавать ряд каналов, которые может использовать следующий эффект. Вызовы IXAudio2Voice::EnableEffect или IXAudio2Voice::D isableEffect , которые прекратят выполнение этих требований цепочкой эффектов.

Отключение эффекта немедленно удаляет его из графа обработки. Любой ожидающий звук в эффекте, например реверберации хвоста, не воспроизводится. Будьте осторожны, отключая эффект во время работы голоса, на котором он размещен. Это может привести к звуковому артефакту, если эффект значительно изменяет шаг или громкость звука.

DisableEffect вступает в силу немедленно при вызове из обратного вызова XAudio2 с operationSetXAUDIO2_COMMIT_NOW.

Требования к платформе

Windows 10 (XAudio2.9); Windows 8, Windows Phone 8 (XAudio 2.8); Пакет SDK Для DirectX (XAudio 2.7)

Требования

Требование Значение
Целевая платформа Windows
Header xaudio2.h

См. также раздел

IXAudio2Voice

Обзор протокола XAPO