NAP
Public Member Functions | Public Attributes | List of all members
LevelMeterComponent Class Reference

#include <audio/component/levelmetercomponent.h>

Public Member Functions

 LevelMeterComponent ()
 
- Public Member Functions inherited from Component
virtual void getDependentComponents (std::vector< rtti::TypeInfo > &components) const
 
virtual const rtti::TypeInfo getInstanceType () const =0
 
- Public Member Functions inherited from Resource
 Resource ()
 
- Public Member Functions inherited from Object
 Object ()
 
virtual ~Object ()
 
virtual bool init (utility::ErrorState &errorState)
 
virtual void onDestroy ()
 
 Object (Object &)=delete
 
Objectoperator= (const Object &)=delete
 
 Object (Object &&)=delete
 
Objectoperator= (Object &&)=delete
 

Public Attributes

nap::ComponentPtr< AudioComponentBasemInput
 property: 'Input' The component whose audio output will be measured. More...
 
TimeValue mAnalysisWindowSize = 10
 property: 'AnalysisWindowSize' Size of an analysis window in milliseconds. More...
 
LevelMeterNode::Type mMeterType = LevelMeterNode::Type::RMS
 property: 'MeterType' Type of analysis to be used: RMS for root mean square, PEAK for the peak of the analysis window. More...
 
bool mFilterInput = false
 If set to true the input signal will be filtered before being measured. More...
 
ControllerValue mCenterFrequency = 10000.f
 property: 'CenterFrequency' Center frequency of the frequency band that will be analyzed. Only has effect when mFilterInput = true. More...
 
ControllerValue mBandWidth = 10000.f
 property: 'BandWidth' Width in Hz of the frequency band that will be analyzed. Only has effect when mFilterInput = true. More...
 
ControllerValue mFilterGain = 1.0f
 property: 'FilterGain' Gain factor of the filtered input signal. Only has effect when mFilterInput = true. More...
 
int mChannel = 0
 property: 'Channel' Channel of the input that will be analyzed. More...
 
- Public Attributes inherited from Object
std::string mID
 Property: 'mID' unique name of the object. Used as an identifier by the system. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Object
static bool isIDProperty (rtti::Instance &object, const rtti::Property &property)
 

Description

Measures the amplitude level of the audio signal from a target component. A specific frequency band to be measured can be specified.

Inheritance diagram for LevelMeterComponent:
[legend]
Collaboration diagram for LevelMeterComponent:
[legend]

Constructor & Destructor Documentation

◆ LevelMeterComponent()

Member Data Documentation

◆ mAnalysisWindowSize

TimeValue mAnalysisWindowSize = 10

property: 'AnalysisWindowSize' Size of an analysis window in milliseconds.

◆ mBandWidth

ControllerValue mBandWidth = 10000.f

property: 'BandWidth' Width in Hz of the frequency band that will be analyzed. Only has effect when mFilterInput = true.

◆ mCenterFrequency

ControllerValue mCenterFrequency = 10000.f

property: 'CenterFrequency' Center frequency of the frequency band that will be analyzed. Only has effect when mFilterInput = true.

◆ mChannel

int mChannel = 0

property: 'Channel' Channel of the input that will be analyzed.

◆ mFilterGain

ControllerValue mFilterGain = 1.0f

property: 'FilterGain' Gain factor of the filtered input signal. Only has effect when mFilterInput = true.

◆ mFilterInput

bool mFilterInput = false

If set to true the input signal will be filtered before being measured.

◆ mInput

property: 'Input' The component whose audio output will be measured.

◆ mMeterType

LevelMeterNode::Type mMeterType = LevelMeterNode::Type::RMS

property: 'MeterType' Type of analysis to be used: RMS for root mean square, PEAK for the peak of the analysis window.