Looking up ports

Detailed Description

Additional port related functions which allow to search for ports based on various criterias, including support of regular expressions for port names.

See Also

Creating & manipulating ports

Functions
const char **	jack_get_ports (jack_client_t *client, const char *port_name_pattern, const char *type_name_pattern, unsigned long flags) JACK_OPTIONAL_WEAK_EXPORT
jack_port_t *	jack_port_by_name (jack_client_t *client, const char *port_name) JACK_OPTIONAL_WEAK_EXPORT
jack_port_t *	jack_port_by_id (jack_client_t *client, jack_port_id_t port_id) JACK_OPTIONAL_WEAK_EXPORT

Function Documentation

const char** jack_get_ports	(	jack_client_t *	client,
		const char *	port_name_pattern,
		const char *	type_name_pattern,
		unsigned long	flags
	)

Parameters

port_name_pattern	A regular expression used to select ports by name. If NULL or of zero length, no selection based on name will be carried out. Example: "FooSynth:.*" matches all port names of client "FooSynth".
type_name_pattern	A regular expression used to select ports by type. If NULL or of zero length, no selection based on type will be carried out.
flags	A value used to select ports by their flags. If zero, no selection based on flags will be carried out.

Returns

a NULL-terminated array of ports that match the specified arguments. The caller is responsible for calling jack_free() any non-NULL returned value.

See Also

jack_port_name_size(), jack_port_type_size()

jack_port_t* jack_port_by_name	(	jack_client_t *	client,
		const char *	port_name
	)

Returns

address of the jack_port_t named port_name.

See Also

jack_port_name_size()

jack_port_t* jack_port_by_id	(	jack_client_t *	client,
		jack_port_id_t	port_id
	)

Returns

address of the jack_port_t of a port_id.