muzgen/doc/guide/quickstart.rst

28 lines
918 B
ReStructuredText
Raw Normal View History

Quick Start
===========
Hello ! So you want to make some sound design ? MuzGen allows you to
generate some sound using a language named **MuzScript**. Ok, let's
start with a simple example.
.. code-block:: bash
@out [sine 440 1]
Here, ``@out`` is a *directive* and ``sine`` is a *command*.
Let start with commands. A command is kind of a function. It has a
name followed by its parameters if any.
Here, the command ``sine`` takes two parameters: a frequency and an
amplitude. Like its name suggests, ``sine`` is a signal composed of
one sine wave with the given frequency and amplitude.
.. note::
The parameters ``440`` and ``1`` are not simple numbers. In fact,
their are signals too ! We call them constant signal.
In order to hear our sine wave, we have to specify how we want it to
be played. That is what the directive ``@out`` does. It will play the
followed signal on the default audio device.