Switchboard SDK
Loading...
Searching...
No Matches
switchboard::Parameter Class Reference

Parameter class. Represents an adjustable config value in an audio node. More...

#include <Parameter.hpp>

Inheritance diagram for switchboard::Parameter:
switchboard::BoolParameter switchboard::FloatParameter switchboard::IntParameter switchboard::UIntParameter switchboard::BoolCallbackParameter< T > switchboard::BoolPointerParameter switchboard::BoolStoredParameter switchboard::FloatCallbackParameter< T > switchboard::FloatPointerParameter switchboard::FloatStoredParameter switchboard::IntCallbackParameter< T > switchboard::IntPointerParameter switchboard::IntStoredParameter switchboard::UIntCallbackParameter< T > switchboard::UIntPointerParameter switchboard::UIntStoredParameter

Public Types

enum class  Type { Float , Bool , Int , UInt }
 

Public Member Functions

 Parameter (const Type type, const std::string name)
 
virtual ~Parameter ()=default
 Parameter destructor.
 
const std::string & getName () const
 Gets the name of the parameter.
 
Type getType () const
 Gets the type of the parameter.
 

Protected Attributes

Type type
 
std::string name
 

Detailed Description

Parameter class. Represents an adjustable config value in an audio node.

Member Function Documentation

◆ getName()

const std::string & switchboard::Parameter::getName ( ) const

Gets the name of the parameter.

Returns
The name of the parameter.

◆ getType()

Parameter::Type switchboard::Parameter::getType ( ) const

Gets the type of the parameter.

Returns
The type of the parameter.