comparison README.txt @ 10:b2c6df0952eb

Add a README
author Chris Cannam
date Tue, 30 Apr 2013 11:38:14 +0100
parents
children c2369221825a
comparison
equal deleted inserted replaced
9:33a799b77949 10:b2c6df0952eb
1
2 Vamp Test Plugin
3 ================
4
5 This is a test plugin for use by developers who are working on host
6 applications for Vamp plugins.
7
8 Its primary purpose is to help you test that your host is correctly
9 handling the output sample type and sample rate, as these are quite
10 easily misinterpreted. (See http://vamp-plugins.org/ for more about
11 Vamp plugins and http://vapm-plugins.org/guide.pdf for the programming
12 guide which explains the output sample type and sample rate.)
13
14 The plugin does no real work. It simply provides a variety of outputs
15 with different output descriptors, and returns some test values. See
16 https://code.soundsoftware.ac.uk/projects/vamp-test-plugin/wiki/Wiki
17 for documentation of the outputs and features returned.
18
19 If you are developing plugins rather than hosts, and you want help in
20 testing them, look instead at the Vamp Plugin Tester
21 (https://code.soundsoftware.ac.uk/projects/vamp-plugin-tester).