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

#include <audio/component/inputcomponent.h>

Public Member Functions

 AudioInputComponent ()
 
- Public Member Functions inherited from AudioComponentBase
 AudioComponentBase ()
 
- 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

std::vector< int > mChannels
 property: 'Channels' Defines what audio input channels to receive data from. The size of this array determines the number of channels that this component will output. More...
 
ControllerValue mGain = 1.0
 property: 'Gain' Overall gain. More...
 
bool mAllowOutOfBoundChannels = true
 property: 'AllowOutOfBoundChannels Indicates if input channels that are out of bounds will produce zero input or generate an init error.' 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

Component to receive audio input from the audio interface. Can be used as input to an OutpuComponent of LevelMeterComponent.

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

Constructor & Destructor Documentation

◆ AudioInputComponent()

Member Data Documentation

◆ mAllowOutOfBoundChannels

bool mAllowOutOfBoundChannels = true

property: 'AllowOutOfBoundChannels Indicates if input channels that are out of bounds will produce zero input or generate an init error.'

◆ mChannels

std::vector<int> mChannels

property: 'Channels' Defines what audio input channels to receive data from. The size of this array determines the number of channels that this component will output.

◆ mGain

ControllerValue mGain = 1.0

property: 'Gain' Overall gain.