DISTRHO Plugin Framework
 All Classes Functions Variables Modules Pages
Public Member Functions | Public Attributes | List of all members
AudioPort Struct Reference

#include <DistrhoPlugin.hpp>

Public Member Functions

 AudioPort () noexcept
 

Public Attributes

uint32_t hints
 
String name
 
String symbol
 

Detailed Description

Audio Port.

Constructor & Destructor Documentation

AudioPort::AudioPort ( )
inlinenoexcept

Default constructor for a regular audio port.

Member Data Documentation

uint32_t AudioPort::hints

Hints describing this audio port.

See also
Audio Port Hints
String AudioPort::name

The name of this audio port. An audio port name can contain any character, but hosts might have a hard time with non-ascii ones. The name doesn't have to be unique within a plugin instance, but it's recommended.

String AudioPort::symbol

The symbol of this audio port. An audio port symbol is a short restricted name used as a machine and human readable identifier. The first character must be one of _, a-z or A-Z and subsequent characters can be from _, a-z, A-Z and 0-9.

Note
: Audio port and parameter symbols MUST be unique within a plugin instance.

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