irrKlang Sound Engine: irrKlang.h Source File

00001 /* irrKlang.h -- interface of the 'irrKlang' library
00002 
00003   Copyright (C) 2002-2007 Nikolaus Gebhardt
00004 
00005   This software is provided 'as-is', without any express or implied
00006   warranty.  In no event will the authors be held liable for any damages
00007   arising from the use of this software.
00008 */
00009 
00010 #ifndef __IRR_KLANG_H_INCLUDED__
00011 #define __IRR_KLANG_H_INCLUDED__
00012 
00013 #include "ik_irrKlangTypes.h"
00014 #include "ik_vec3d.h"
00015 
00016 #include "ik_IRefCounted.h"
00017 #include "ik_IVirtualRefCounted.h"
00018 
00019 #include "ik_ESoundOutputDrivers.h"
00020 #include "ik_ESoundEngineOptions.h"
00021 #include "ik_EStreamModes.h"
00022 #include "ik_SAudioStreamFormat.h"
00023 #include "ik_ISoundEngine.h"
00024 #include "ik_ISoundSource.h"
00025 #include "ik_ISound.h"
00026 #include "ik_IAudioStream.h"
00027 #include "ik_IAudioStreamLoader.h"
00028 #include "ik_ISoundEffectControl.h"
00029 #include "ik_ISoundStopEventReceiver.h"
00030 #include "ik_IFileFactory.h"
00031 #include "ik_IFileReader.h"
00032 #include "ik_ISoundDeviceList.h"
00033 #include "ik_IAudioRecorder.h"
00034 
00036 #define IRR_KLANG_VERSION "1.1.2"
00037 
00853 #if defined(IRRKLANG_STATIC)
00854     #define IRRKLANG_API
00855 #else
00856     #if (defined(WIN32) || defined(WIN64) || defined(_MSC_VER))
00857         #ifdef IRRKLANG_EXPORTS
00858         #define IRRKLANG_API __declspec(dllexport)
00859         #else
00860         #define IRRKLANG_API __declspec(dllimport)
00861         #endif // IRRKLANG_EXPORT
00862     #else
00863         #define IRRKLANG_API __attribute__((visibility("default")))
00864     #endif // defined(WIN32) || defined(WIN64)
00865 #endif // IRRKLANG_STATIC
00866 
00867 #if defined(_STDCALL_SUPPORTED)
00868 #define IRRKLANGCALLCONV __stdcall  // Declare the calling convention.
00869 #else
00870 #define IRRKLANGCALLCONV
00871 #endif // STDCALL_SUPPORTED
00872 
00874 namespace irrklang
00875 {
00877 
00893         IRRKLANG_API ISoundEngine* IRRKLANGCALLCONV createIrrKlangDevice(
00894                 E_SOUND_OUTPUT_DRIVER driver = ESOD_AUTO_DETECT,
00895                 int options = ESEO_DEFAULT_OPTIONS,
00896                 const char* deviceID = 0,
00897                 const char* sdk_version_do_not_use = IRR_KLANG_VERSION);
00898 
00899 
00901 
00912         IRRKLANG_API ISoundDeviceList* IRRKLANGCALLCONV createSoundDeviceList(
00913                 E_SOUND_OUTPUT_DRIVER driver = ESOD_AUTO_DETECT,
00914                 const char* sdk_version_do_not_use = IRR_KLANG_VERSION);
00915 
00916 
00918 
00936         IRRKLANG_API IAudioRecorder* IRRKLANGCALLCONV createIrrKlangAudioRecorder(
00937                 ISoundEngine* irrKlangDeviceForPlayback,
00938                 E_SOUND_OUTPUT_DRIVER driver = ESOD_AUTO_DETECT,
00939                 const char* deviceID = 0,
00940                 const char* sdk_version_do_not_use = IRR_KLANG_VERSION);
00941 
00943 
00953         IRRKLANG_API ISoundDeviceList* IRRKLANGCALLCONV createAudioRecorderDeviceList(
00954                 E_SOUND_OUTPUT_DRIVER driver = ESOD_AUTO_DETECT,
00955                 const char* sdk_version_do_not_use = IRR_KLANG_VERSION);
00956 
00957 
00958 } // end namespace irrklang
00959 
00960 
00965 #endif
00966