ardour
Public Types | Public Member Functions | Public Attributes | List of all members
ARDOUR::ParameterDescriptor Struct Reference

#include <parameter_descriptor.h>

Inheritance diagram for ARDOUR::ParameterDescriptor:
Evoral::ParameterDescriptor ARDOUR::AUParameterDescriptor

Public Types

enum  Unit { NONE, DB, MIDI_NOTE, HZ }
 

Public Member Functions

 ParameterDescriptor (const Evoral::Parameter &parameter)
 
 ParameterDescriptor ()
 
void update_steps ()
 
- Public Member Functions inherited from Evoral::ParameterDescriptor
 ParameterDescriptor ()
 

Public Attributes

std::string label
 
std::string print_fmt
 format string for pretty printing More...
 
boost::shared_ptr< ScalePointsscale_points
 
uint32_t key
 for properties More...
 
Variant::Type datatype
 for properties More...
 
AutomationType type
 
Unit unit
 
float step
 
float smallstep
 
float largestep
 
bool integer_step
 
bool logarithmic
 
bool sr_dependent
 
bool min_unbound
 
bool max_unbound
 
bool enumeration
 
- Public Attributes inherited from Evoral::ParameterDescriptor
float normal
 Default value. More...
 
float lower
 Minimum value (in Hz, for frequencies) More...
 
float upper
 Maximum value (in Hz, for frequencies) More...
 
bool toggled
 True iff parameter is boolean. More...
 

Detailed Description

Descriptor of a parameter or control.

Essentially a union of LADSPA, VST and LV2 info.

Definition at line 36 of file parameter_descriptor.h.

Member Enumeration Documentation

Enumerator
NONE 

No unit.

DB 

Decibels.

MIDI_NOTE 

MIDI note number.

HZ 

Frequency in Hertz.

Definition at line 38 of file parameter_descriptor.h.

Constructor & Destructor Documentation

ARDOUR::ParameterDescriptor::ParameterDescriptor ( const Evoral::Parameter parameter)

Definition at line 29 of file parameter_descriptor.cc.

ARDOUR::ParameterDescriptor::ParameterDescriptor ( )

Definition at line 102 of file parameter_descriptor.cc.

Member Function Documentation

void ARDOUR::ParameterDescriptor::update_steps ( )

Set step, smallstep, and largestep, based on current description.

Definition at line 119 of file parameter_descriptor.cc.

Member Data Documentation

Variant::Type ARDOUR::ParameterDescriptor::datatype

for properties

Definition at line 56 of file parameter_descriptor.h.

bool ARDOUR::ParameterDescriptor::enumeration

Definition at line 67 of file parameter_descriptor.h.

bool ARDOUR::ParameterDescriptor::integer_step

Definition at line 62 of file parameter_descriptor.h.

uint32_t ARDOUR::ParameterDescriptor::key

for properties

Definition at line 55 of file parameter_descriptor.h.

std::string ARDOUR::ParameterDescriptor::label

Definition at line 52 of file parameter_descriptor.h.

float ARDOUR::ParameterDescriptor::largestep

Definition at line 61 of file parameter_descriptor.h.

bool ARDOUR::ParameterDescriptor::logarithmic

Definition at line 63 of file parameter_descriptor.h.

bool ARDOUR::ParameterDescriptor::max_unbound

Definition at line 66 of file parameter_descriptor.h.

bool ARDOUR::ParameterDescriptor::min_unbound

Definition at line 65 of file parameter_descriptor.h.

std::string ARDOUR::ParameterDescriptor::print_fmt

format string for pretty printing

Definition at line 53 of file parameter_descriptor.h.

boost::shared_ptr<ScalePoints> ARDOUR::ParameterDescriptor::scale_points

Definition at line 54 of file parameter_descriptor.h.

float ARDOUR::ParameterDescriptor::smallstep

Definition at line 60 of file parameter_descriptor.h.

bool ARDOUR::ParameterDescriptor::sr_dependent

Definition at line 64 of file parameter_descriptor.h.

float ARDOUR::ParameterDescriptor::step

Definition at line 59 of file parameter_descriptor.h.

AutomationType ARDOUR::ParameterDescriptor::type

Definition at line 57 of file parameter_descriptor.h.

Unit ARDOUR::ParameterDescriptor::unit

Definition at line 58 of file parameter_descriptor.h.


The documentation for this struct was generated from the following files: