david/librubberband
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add reference to RubberBandLiveShifter

Browse Source
This commit is contained in:
Chris Cannam
2024-10-11 17:20:58 +01:00
parent 48e08a5113
commit ce06adba87
1 changed files with 13 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@@ -146,25 +146,29 @@ numerical argument from 0 to 6).
## 3. Using Rubber Band Library ## 3. Using Rubber Band Library
Rubber Band has a public API that consists of one C++ class, called Rubber Band has a public API that consists of two C++ classes living
`RubberBandStretcher` in the `RubberBand` namespace. You should in the `RubberBand` namespace, called `RubberBandStretcher` and
`#include <rubberband/RubberBandStretcher.h>` to use this class. `RubberBandLiveShifter`. The former is the main Rubber Band class for
There is extensive documentation in the class header. general time and pitch manipulation, the latter a simpler API for
block-by-block pitch-shifting. You should `#include
<rubberband/RubberBandStretcher.h>` or
`<rubberband/RubberBandLiveShifter.h>` to use these classes. There is
extensive documentation in the headers.
A header with C language bindings is also provided in A header with C language bindings is also provided in
`<rubberband/rubberband-c.h>`. This is a wrapper around the C++ `<rubberband/rubberband-c.h>`. This is a wrapper around the C++
implementation, and as the implementation is the same, it also implementation, and as the implementation is the same, it also
requires linkage against the C++ standard libraries. It is not yet requires linkage against the C++ standard libraries. It is not yet
documented separately from the C++ header. You should include only documented separately from the C++ headers. You should include either
one of the two headers, not both. C++ or C headers, not both.
A .NET interface is also included, contributed by Jonathan Gilbert; A .NET interface is also included, contributed by Jonathan Gilbert;
see the files in the `dotnet` directory for details. see the files in the `dotnet` directory for details.
The source code for the command-line utility (`main/main.cpp`) The source code for the command-line utility (`main/main.cpp`)
provides a good example of how to use Rubber Band in offline mode; the provides an example of how to use Rubber Band in offline mode; the
pitch shifter plugin (`ladspa-lv2/RubberBandPitchShifter.cpp`) may be pitch shifter plugins (in `ladspa-lv2`) may be used examples of Rubber
used as an example of Rubber Band in real-time mode. Band in real-time mode.
**IMPORTANT:** Please ensure you have read and understood the **IMPORTANT:** Please ensure you have read and understood the
licensing terms for Rubber Band before using it in your application. licensing terms for Rubber Band before using it in your application.