NAP
Public Member Functions | List of all members
FFTAudioNodeComponentInstance Class Reference

#include </opt/build/repo/nap/system_modules/napfft/src/fftaudionodecomponent.h>

Public Member Functions

 FFTAudioNodeComponentInstance (EntityInstance &entity, Component &resource)
 
virtual bool init (utility::ErrorState &errorState) override
 
void setInput (audio::AudioComponentBaseInstance &input)
 
virtual const FFTBuffergetFFTBuffer () const
 
virtual FFTBuffergetFFTBuffer ()
 
- Public Member Functions inherited from ComponentInstance
 ComponentInstance (EntityInstance &entity, Component &resource)
 
virtual void update (double deltaTime)
 
nap::EntityInstancegetEntityInstance () const
 
nap::ComponentgetComponent () const
 
template<typename T >
T * getComponent () const
 
virtual bool init (utility::ErrorState &errorState)
 
- Public Member Functions inherited from Object
 Object ()
 
virtual ~Object ()
 
virtual void onDestroy ()
 
 Object (Object &)=delete
 
Objectoperator= (const Object &)=delete
 
 Object (Object &&)=delete
 
Objectoperator= (Object &&)=delete
 

Additional Inherited Members

- Static Public Member Functions inherited from Object
static bool isIDProperty (rtti::Instance &object, const rtti::Property &property)
 
- Public Attributes inherited from Object
std::string mID
 Property: 'mID' unique name of the object. Used as an identifier by the system. More...
 

Description

Instance of component to measure the amplitude level of the audio signal from an @AudioComponentBase. A specific frequency band to be measured can be specified.

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

Constructor & Destructor Documentation

◆ FFTAudioNodeComponentInstance()

FFTAudioNodeComponentInstance ( EntityInstance entity,
Component resource 
)

Member Function Documentation

◆ getFFTBuffer() [1/2]

virtual FFTBuffer& getFFTBuffer ( )
virtual
Returns
the FFT buffer

◆ getFFTBuffer() [2/2]

virtual const FFTBuffer& getFFTBuffer ( ) const
virtual
Returns
the FFT buffer

◆ init()

virtual bool init ( utility::ErrorState errorState)
overridevirtual

Initializes this component based on it's resource.

Parameters
errorStatecontains the error when initialization fails.
Returns
if initialization succeeded.

Reimplemented from ComponentInstance.

◆ setInput()

void setInput ( audio::AudioComponentBaseInstance input)

Connects a different audio component as input to be analyzed.