src/cshellsynth/jclient.h File Reference

#include <jack/jack.h>

Go to the source code of this file.

Data Structures
struct	jclient_t
Functions
int	jclient_destroy (jclient_t *self)
int	jclient_init (jclient_t *self, const char *client_name, jack_options_t flags, char *server_name)

---

Detailed Description

Thin wrapper around jack_client_t

Ruby version: JackClient

The Ruby version includes many useful functions. I don't feel like documenting them all now, but chances are good that if you want a particular non-realtime jack function, JackClient implements that same function with a very similar name and calling sequence.

There are a number of conventions that all Ruby subclasses follow. The name of a port can be referenced in most places by either a string or a reference to the port object. Setting two ports equal connects them. When a class takes its input either from a port or from a static variable, these are named the same, and only distinguished by whether the argument is numeric or not.

---

Function Documentation

int jclient_destroy

(

jclient_t *

self

)

Destroy Jack Client

Returns:

0 on success, nonzero otherwise

int jclient_init	(	jclient_t *	self,
		const char *	client_name,
		jack_options_t	flags,
		char *	server_name
	)

Initialize Jack Client

client_name, flags, and server_name are passed directly to Jack.

Returns:

0 on success, nonzero otherwise