Метод IAudioSystemEffects2::GetEffectsList (audioenginebaseapo.h)

Метод GetEffectsList используется для получения списка активных в данный момент эффектов обработки звука и сохраняет событие, которое будет сигнализироваться при изменении списка.

Синтаксис

HRESULT GetEffectsList(
  [out] LPGUID *ppEffectsIds,
  [out] UINT   *pcEffects,
  [in]  HANDLE Event
);

Параметры

[out] ppEffectsIds

Указатель на список идентификаторов GUID, представляющих эффекты обработки звука. Вызывающий объект отвечает за освобождение памяти путем вызова CoTaskMemFree.

[out] pcEffects

Количество эффектов обработки звука в списке.

[in] Event

Handle события, которое будет сигнализировать, если список изменится.

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

Метод GetEffectsList возвращает S_OK , если вызов метода выполнен успешно. Если в списке нет эффектов, функция по-прежнему выполняется успешно, ppEffectsIds возвращает указатель NULL, а pcEffects возвращает число 0.

Комментарии

APO сообщает указанному событию, когда список эффектов обработки звука изменяется из списка, возвращенного GetEffectsList. APO использует это событие до тех пор, пока не будет снова вызван GetEffectsList или APO не будет уничтожен. Переданный дескриптор может иметь значение NULL. В этом случае APO перестает использовать любой предыдущий дескриптор и не сообщает о событии.

APO реализует этот метод, чтобы разрешить Windows обнаруживать текущие эффекты, применяемые APO. Список эффектов может зависеть от режима обработки, инициализированного APO, и от любой конфигурации конечного пользователя. Режим обработки обозначается элементом AudioProcessingModeAPOInitSystemEffects2.

Api-интерфейсы должны определять эффекты с помощью идентификаторов GUID, определенных Windows, например AUDIO_EFFECT_TYPE_ACOUSTIC_ECHO_CANCELLATION. APO должен определять и возвращать пользовательский GUID только в редких случаях, когда тип эффекта явно отличается от тех, которые определены в Windows.

Требования

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

APOInitSystemEffects2

IAudioSystemEffects2