diff options
Diffstat (limited to 'common/jack/metadata.h')
| -rw-r--r-- | common/jack/metadata.h | 87 |
1 files changed, 78 insertions, 9 deletions
diff --git a/common/jack/metadata.h b/common/jack/metadata.h index 5f9bbfe2..9fee7332 100644 --- a/common/jack/metadata.h +++ b/common/jack/metadata.h @@ -1,5 +1,5 @@ /* - Copyright (C) 2011 David Robillard + Copyright (C) 2011-2014 David Robillard Copyright (C) 2013 Paul Davis This program is free software; you can redistribute it and/or modify it @@ -204,19 +204,88 @@ int jack_set_property_change_callback (jack_client_t* client, JackPropertyChangeCallback callback, void* arg); -#ifdef __cplusplus -} /* namespace */ -#endif +/** + * ... + */ +extern const char* JACK_METADATA_CONNECTED; /** - * @} + * The supported event types of an event port. + * + * This is a kludge around Jack only supporting MIDI, particularly for OSC. + * This property is a comma-separated list of event types, currently "MIDI" or + * "OSC". If this contains "OSC", the port may carry OSC bundles (first byte + * '#') or OSC messages (first byte '/'). Note that the "status byte" of both + * OSC events is not a valid MIDI status byte, so MIDI clients that check the + * status byte will gracefully ignore OSC messages if the user makes an + * inappropriate connection. */ +extern const char* JACK_METADATA_EVENT_TYPES; -extern const char* JACK_METADATA_PRETTY_NAME; +/** + * ... + */ extern const char* JACK_METADATA_HARDWARE; -extern const char* JACK_METADATA_CONNECTED; -extern const char* JACK_METADATA_PORT_GROUP; -extern const char* JACK_METADATA_ICON_SMALL; + +/** + * ... + */ extern const char* JACK_METADATA_ICON_LARGE; +/** + * The name of the icon for the subject (typically client). + * + * This is used for looking up icons on the system, possibly with many sizes or + * themes. Icons should be searched for according to the freedesktop Icon + * + * Theme Specification: + * http://standards.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html + */ +extern const char* JACK_METADATA_ICON_NAME; + +/** + * ... + */ +extern const char* JACK_METADATA_ICON_SMALL; + +/** + * Order for a port. + * + * This is used to specify the best order to show ports in user interfaces. + * The value MUST be an integer. There are no other requirements, so there may + * be gaps in the orders for several ports. Applications should compare the + * orders of ports to determine their relative order, but must not assign any + * other relevance to order values. + */ +extern const char* JACK_METADATA_ORDER; + +/** + * ... + */ +extern const char* JACK_METADATA_PRETTY_NAME; + +/** + * ... + */ +extern const char* JACK_METADATA_PORT_GROUP; + +/** + * The type of an audio signal. + * + * This property allows audio ports to be tagged with a "meaning". The value + * is a simple string. Currently, the only type is "CV", for "control voltage" + * ports. Hosts SHOULD be take care to not treat CV ports as audibile and send + * their output directly to speakers. In particular, CV ports are not + * necessarily periodic at all and may have very high DC. + */ +extern const char* JACK_METADATA_SIGNAL_TYPE; + +/** + * @} + */ + +#ifdef __cplusplus +} /* namespace */ +#endif + #endif /* __jack_metadata_h__ */ |