ipslgainreduction.h

//************************************************************************************************
//
// PreSonus Plug-In Extensions
// Written and placed in the PUBLIC DOMAIN by PreSonus Software Ltd.
//
// Filename    : ipslgainreduction.h
// Created by  : PreSonus Software Ltd., 03/2015
// Description : Plug-in Gain Reduction Interface
//
//************************************************************************************************
/*
	DISCLAIMER:
	PreSonus Plug-In Extensions are host-specific extensions of existing proprietary technologies,
	provided to the community on an AS IS basis. They are not part of any official 3rd party SDK and
	PreSonus is not affiliated with the owner of the underlying technology in any way.
*/
//************************************************************************************************

#ifndef _ipslgainreduction_h
#define _ipslgainreduction_h

#include "pluginterfaces/base/funknown.h"
#include "pluginterfaces/base/falignpush.h"

namespace Presonus {

//************************************************************************************************
// IGainReductionInfo
/**	Interface to report gain reduction imposed to the audio signal by the plug-in to the
	host for display in the UI. Implemented by the VST3 edit controller class. 

	@ingroup editController */
//************************************************************************************************

struct IGainReductionInfo: Steinberg::FUnknown
{
	/** Get current gain reduction for display. The returned value in dB is either 0.0 (no reduction)
		or negative. The host calls this function periodically while the plug-in is active.
		The value is used AS IS for UI display purposes, without imposing additional ballistics or
		presentation latency compensation. Be sure to return zero if processing is bypassed internally.
		For multiple reduction stages, please report the sum in dB here.
	*/
	virtual double PLUGIN_API getGainReductionValueInDb () = 0;

    static const Steinberg::FUID iid;
};

DECLARE_CLASS_IID (IGainReductionInfo, 0x8e3c292c, 0x95924f9d, 0xb2590b1e, 0x100e4198)

} // namespace Presonus

#include "pluginterfaces/base/falignpop.h"

#endif // _ipslgainreduction_h