VA.h 2.52 KB
Newer Older
1 2 3 4 5 6
/*
 *  --------------------------------------------------------------------------------------------
 *
 *    VVV        VVV A           Virtual Acoustics (VA) | http://www.virtualacoustics.org
 *     VVV      VVV AAA          Licensed under the Apache License, Version 2.0
 *      VVV    VVV   AAA
7
 *       VVV  VVV     AAA        Copyright 2015-2019
8 9 10 11 12 13 14 15 16 17
 *        VVVVVV       AAA       Institute of Technical Acoustics (ITA)
 *         VVVV         AAA      RWTH Aachen University
 *
 *  --------------------------------------------------------------------------------------------
 */

/*!

@mainpage

18
@section vabase_intro_sec Introduction
19 20

The Virtual Acoustics project is free, open source real-time auralization framework. It is distributed under the terms of the Apache License Version 2.0.
Dipl.-Ing. Jonas Stienen's avatar
Dipl.-Ing. Jonas Stienen committed
21
The official website can be found at http://www.virtualacoustics.org.
22

23 24
@section vabase_sec VABase

25
VABase provides basic classes and the interface desription #IVAInterface to control a VA core.
26 27

@section vabase_license_sec License
28

29
Copyright 2015-2019 Institute of Technical Acoustics (ITA), RWTH Aachen University
30 31

Licensed under the Apache License, Version 2.0 (the "License");
32
you may not use the VA software package except in compliance with the License.
33 34 35 36 37 38 39 40 41 42
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

43
You should also have received a copy of the License with the VA software package.
44

45
@section vabase_getting_started_sec Getting started
46

Dipl.-Ing. Jonas Stienen's avatar
Dipl.-Ing. Jonas Stienen committed
47
If you are a C++ developer and want to investigate the interface and integrate VA into your application, the first contact point should be the VABase interface represented by the #IVAInterface class.
48
If you are planning to create a binding for any other programming and/or scripting language, also have a look at VANet and the #IVANetClient class.
49
If you want to host a VA server or want to extend the core of VA by new rendering and reproduction modules, see #VACore.
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68

*/

#ifndef IW_VA
#define IW_VA

#include "VAAudioSignalSource.h"
#include "VABase.h"
#include "VAEvent.h"
#include "VAEventHandlerGlobalLock.h"
#include "VAException.h"
#include "VAInterface.h"
#include "VAObject.h"
#include "VAObjectRegistry.h"
#include "VASamples.h"
#include "VAStruct.h"
#include "VAVersion.h"

#endif // IW_VA