Skip to content

Latest commit

 

History

History
203 lines (119 loc) · 5.95 KB

element_api.rst

File metadata and controls

203 lines (119 loc) · 5.95 KB

Element API

This page documents the API convention for accessing parameters of ADM element classes. Element classes like :cppAudioBlockFormatObjects contain many parameters, each with different types (thanks to using named types). These parameters can be accessed through a common set of templated and overloaded methods defined on elements. Compared to standard accessors methods, this makes it easy to write templates which handle parameters generically.

Note

The classes listed on this page do not actually exist, they just serve to show the API on element classes themselves.

The set of methods which may be defined for each parameter of type Parameter are shown below:

These methods are implemented in some common patterns for parameters which behave in different ways: