Toni: moved Programmer Guide/Class Library/KlattSyn : CObj to Programmer Guide/Macro Library/KlattSyn

2011-04-28T08:01:12Z

moved Programmer Guide/Class Library/KlattSyn : CObj to Programmer Guide/Macro Library/KlattSyn

← Older revision	Revision as of 10:01, 28 April 2011
(No difference)

Christian: Text replace - "S_TOOLS-STx" to "{{STX}}"

2011-04-05T15:55:42Z

Text replace - "S_TOOLS-STx" to "{{STX}}"

← Older revision		Revision as of 17:55, 5 April 2011
Line 2:		Line 2:
	==KlattSyn : CObj==		==KlattSyn : CObj==

	The <code>KlattSyn</code> ~~S_TOOLS-STx~~ class provides an interface to the C++ implementation using the <code>KlattSyn</code> SPAtom.		The <code>KlattSyn</code> {{STX}} class provides an interface to the C++ implementation using the <code>KlattSyn</code> SPAtom.

	See the <code>KlattSynTB.sts</code> toolbox file for an example.		See the <code>KlattSynTB.sts</code> toolbox file for an example.

Admin: 1 revision: Initial import

2010-11-18T16:31:33Z

1 revision: Initial import

← Older revision	Revision as of 18:31, 18 November 2010
(No difference)

193.171.195.8: initial import

2010-05-17T13:05:27Z

initial import

New page

{{DISPLAYTITLE:{{SUBPAGENAME}}}}
==KlattSyn : CObj==

The <code>KlattSyn</code> S_TOOLS-STx class provides an interface to the C++ implementation using the <code>KlattSyn</code> SPAtom.

See the <code>KlattSynTB.sts</code> toolbox file for an example.

'''Constructor'''

The <code>KlattSyn</code> class constructor initialised the instance to default values.

=====Usage:=====

<code>KlattSyn</code>

=====Parameters:=====

The constructor takes no parameters.

=====Result:=====

Always returns 0.

=====Examples:=====

<code>#KLSYNinstance := cobj new KlattSyn</code>

<code>if '$#KLSYNinstance[?]' != 'instance' em '-1 ; Could not instantiate KlattSyn object'</code>

====KlattSyn Member Functions====

The <code>KlattSyn</code> class implements the following member functions. See CObj Member Functions for a list of functions implemented in the parent class.

===beginKlattSynDialog===

The <code>beginKlattSynDialog</code> method displays a stand-alone real-time synthesis dialog allowing the user to modify every parameter used in the synthesis process. It is used, for example, in the <code>KlattSynDialog</code> toolbox function to display the following dialog:

[[File:dialog_klatt_synthesiser.png]]

The display is divided into global settings, formant settings and voicing settings. When the synthesis process is started, the global settings become unavailable because they concern the whole synthesis and cannot be changed during execution. The real-time synthesis can be started using the "Start RT Synth" button which produces direct sound output. The "Save to file" box allows the user to select a target file and the duration in frames to save the synthesis output to a wave file. A description of the parameters can be found in [Parameter description part]

===beginStopDialog===

This method provides an user interface that allows the user to modify the Gain0 synthesis parameter (for amplitude adjustment) and to stop the synthesis.

===initialize===

The <code>initialise</code> method initializes the class' internal SPU. This method must be called before the method <code>startSynthesis</code>.

=====Usage:=====

<code>inst initialize tconfig ; tframe [ ; path ; srate ; nspfr ; synmode ; outmode ]</code>

=====Parameters:=====

;<var>tconfig</var>

:The global configuration table. See the KLATTSYN SPAtom documentation for details.

;<var>tframe</var>

:The frame parameter table. See the KLATTSYN SPAtom documentation for details.

;<var>path</var>

:The location of the file to which synthesis output should be written.

;<var>srate</var>

:The sampling rate.

;<var>nspfr</var>

:The number of samples per synthesis frame.

;<var>synmode</var>

:The synthesis mode. This can be either '<code>list</code>' (each entry of <var>tframe</var> contains the parameters for one frame) or '<code>loop</code>' (<var>tframe</var> contains one parameter set which is used for each parameter frame).

;<var>outmode</var>

:The output mode. See the KLATTSYN SPAtom documentation for details.

=====Result:=====

Returns an empty string on success or <code>-1</code> on failure.

===startSynthesis===

Starts the actual synthesis process.

Programmer Guide/Macro Library/KlattSyn - Revision history

Toni: moved Programmer Guide/Class Library/KlattSyn : CObj to Programmer Guide/Macro Library/KlattSyn

Christian: Text replace - "S_TOOLS-STx" to "{{STX}}"

Admin: 1 revision: Initial import

193.171.195.8: initial import