From e6dc3543b0f463a388a70bb9feb0760b312dcf8a Mon Sep 17 00:00:00 2001 From: mezmay Date: Wed, 9 Mar 2016 17:22:07 +0300 Subject: [PATCH] description added --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1092e1b..deb1866 100644 --- a/README.md +++ b/README.md @@ -1 +1,14 @@ -# Vibrato-effect \ No newline at end of file +Vibrato audio effect. +(Vibrato is a musical effect consisting of a regular, pulsating change of pitch. It is used to add expression to vocal and instrumental music) + +Using: + +#include "BerVibrato/BerVibrato.h" +//... +BerVibrato vbr; +vbr.initialize(SampleRateHz); +//... +vbr.setDepth(depth); // depth (amount) from (0; 1] +vbr.setFrequency(freq); // Vibrato rate in Hz +//... +vbr.processOneSample(sample); \ No newline at end of file