src/cshellsynth/synth.h File Reference

#include <jack/jack.h>
#include <cshellsynth/atomic-types.h>
#include <cshellsynth/jclient.h>

Go to the source code of this file.

Data Structures
struct	cs_synth_t
Defines
#define	cs_synth_destroy(cs_synth)   jclient_destroy((jclient_t *) (cs_synth))
Functions
int	cs_synth_init (cs_synth_t *self, const char *client_name, jack_options_t flags, char *server_name)
void	cs_synth_set_freq (cs_synth_t *self, float freq)
void	cs_synth_set_offset (cs_synth_t *self, float offset)
void	cs_synth_set_amp (cs_synth_t *self, float amp)

---

Detailed Description

Structure for generic synth functions

Ruby version: Synths::Synth

---

Define Documentation

#define cs_synth_destroy

(

cs_synth

)

jclient_destroy((jclient_t *) (cs_synth))

Destroy synth

See jclient_destroy

---

Function Documentation

int cs_synth_init	(	cs_synth_t *	self,
		const char *	client_name,
		jack_options_t	flags,
		char *	server_name
	)

Initialize synth

See jclient_init.

void cs_synth_set_amp	(	cs_synth_t *	self,
		float	amp
	)

Set amplitude of the wave

Ruby version amp=

Parameters:

amp

amplitude. Default is 1.

void cs_synth_set_freq	(	cs_synth_t *	self,
		float	freq
	)

Set static synth frequency

Ruby version freq=

Parameters:

freq

either a fraction of sampling frequency (<= 1.0) or an actual frequency (> 1.0)

void cs_synth_set_offset	(	cs_synth_t *	self,
		float	offset
	)

Set offset of the wave

Ruby version offset=

Parameters:

offset

offset. Default is 0.