SLV2 0.6.6

- Main Page
- Modules
- Files

- File List

port.h
1 /* SLV2
2 * Copyright (C) 2007-2009 Dave Robillard <http://drobilla.net>
3 *
4 * This library is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License as published by the Free
6 * Software Foundation; either version 2 of the License, or (at your option)
7 * any later version.
8 *
9 * This library is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * for more details.
13 *
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
17 */
18
19 #ifndef __SLV2_PORT_H__
20 #define __SLV2_PORT_H__
21
22 #ifdef __cplusplus
23 extern "C" {
24 #endif
25
26 #include "slv2/types.h"
27 #include "slv2/plugin.h"
28 #include "slv2/port.h"
29 #include "slv2/collections.h"
30
40 SLV2Values
41 slv2_port_get_value(SLV2Plugin plugin,
42 SLV2Port port,
43 SLV2Value predicate);
44
45
50 SLV2Values
51 slv2_port_get_value_by_qname(SLV2Plugin plugin,
52 SLV2Port port,
53 const char* property_uri);
54
55
60 SLV2Values
61 slv2_port_get_value_by_qname_i18n(SLV2Plugin plugin,
62 SLV2Port port,
63 const char* property_uri);
64
65
70 SLV2Values
71 slv2_port_get_properties(SLV2Plugin plugin,
72 SLV2Port port);
73
74
79 bool
80 slv2_port_has_property(SLV2Plugin p,
81 SLV2Port port,
82 SLV2Value property_uri);
83
84
89 bool
90 slv2_port_supports_event(SLV2Plugin p,
91 SLV2Port port,
92 SLV2Value event_uri);
93
94
102 SLV2Value
103 slv2_port_get_symbol(SLV2Plugin plugin,
104 SLV2Port port);
105
114 SLV2Value
115 slv2_port_get_name(SLV2Plugin plugin,
116 SLV2Port port);
117
118
129 SLV2Values
130 slv2_port_get_classes(SLV2Plugin plugin,
131 SLV2Port port);
132
133
145 bool
146 slv2_port_is_a(SLV2Plugin plugin,
147 SLV2Port port,
148 SLV2Value port_class);
149
150
160 void
161 slv2_port_get_range(SLV2Plugin plugin,
162 SLV2Port port,
163 SLV2Value* def,
164 SLV2Value* min,
165 SLV2Value* max);
166
167
176 SLV2ScalePoints
177 slv2_port_get_scale_points(SLV2Plugin plugin,
178 SLV2Port port);
179
180
183 #ifdef __cplusplus
184 } /* extern "C" */
185 #endif
186
187 #endif /* __SLV2_PORT_H__ */
slv2_port_get_range
void slv2_port_get_range(SLV2Plugin plugin, SLV2Port port, SLV2Value *def, SLV2Value *min, SLV2Value *max)
Get the default, minimum, and maximum values of a port.
slv2_port_has_property
bool slv2_port_has_property(SLV2Plugin p, SLV2Port port, SLV2Value property_uri)
Return whether a port has a certain property.
slv2_port_get_name
SLV2Value slv2_port_get_name(SLV2Plugin plugin, SLV2Port port)
Get the name of a port.
slv2_port_get_value_by_qname
SLV2Values slv2_port_get_value_by_qname(SLV2Plugin plugin, SLV2Port port, const char *property_uri)
Port analog of slv2_plugin_get_value_by_qname.
slv2_port_get_value_by_qname_i18n
SLV2Values slv2_port_get_value_by_qname_i18n(SLV2Plugin plugin, SLV2Port port, const char *property_uri)
Port analog of slv2_plugin_get_value_by_qname_i18n.
slv2_port_get_value
SLV2Values slv2_port_get_value(SLV2Plugin plugin, SLV2Port port, SLV2Value predicate)
Port analog of slv2_plugin_get_value.
slv2_port_get_symbol
SLV2Value slv2_port_get_symbol(SLV2Plugin plugin, SLV2Port port)
Get the symbol of a port.
slv2_port_is_a
bool slv2_port_is_a(SLV2Plugin plugin, SLV2Port port, SLV2Value port_class)
Determine if a port is of a given class (input, output, audio, etc).
slv2_port_supports_event
bool slv2_port_supports_event(SLV2Plugin p, SLV2Port port, SLV2Value event_uri)
Return whether a port is an event port and supports a certain event type.
slv2_port_get_classes
SLV2Values slv2_port_get_classes(SLV2Plugin plugin, SLV2Port port)
Get all the classes of a port.
slv2_port_get_scale_points
SLV2ScalePoints slv2_port_get_scale_points(SLV2Plugin plugin, SLV2Port port)
Get the scale points (enumeration values) of a port.
slv2_port_get_properties
SLV2Values slv2_port_get_properties(SLV2Plugin plugin, SLV2Port port)
Return the LV2 port properties of a port.