irrKlang.h File Reference

Main header file of the irrKlang sound library, the only file needed to include. More...

#include "ik_irrKlangTypes.h"
#include "ik_vec3d.h"
#include "ik_IRefCounted.h"
#include "ik_IVirtualRefCounted.h"
#include "ik_ESoundOutputDrivers.h"
#include "ik_ESoundEngineOptions.h"
#include "ik_EStreamModes.h"
#include "ik_SAudioStreamFormat.h"
#include "ik_ISoundEngine.h"
#include "ik_ISoundSource.h"
#include "ik_ISound.h"
#include "ik_IAudioStream.h"
#include "ik_IAudioStreamLoader.h"
#include "ik_ISoundEffectControl.h"
#include "ik_ISoundStopEventReceiver.h"
#include "ik_IFileFactory.h"
#include "ik_IFileReader.h"
#include "ik_ISoundDeviceList.h"
#include "ik_IAudioRecorder.h"
#include "ik_ISoundMixedOutputReceiver.h"

Go to the source code of this file.

Namespaces
namespace	irrklang
	Everything in the irrKlang Sound Engine can be found in this namespace.
Defines
#define	IRR_KLANG_VERSION   "1.6.0"
	irrKlang Version
#define	IRRKLANG_API   __attribute__((visibility("default")))
#define	IRRKLANGCALLCONV
Functions
IRRKLANG_API ISoundEngine *IRRKLANGCALLCONV	irrklang::createIrrKlangDevice (E_SOUND_OUTPUT_DRIVER driver=ESOD_AUTO_DETECT, int options=ESEO_DEFAULT_OPTIONS, const char *deviceID=0, const char *sdk_version_do_not_use=IRR_KLANG_VERSION)
	Creates an irrKlang device. The irrKlang device is the root object for using the sound engine.
IRRKLANG_API ISoundDeviceList *IRRKLANGCALLCONV	irrklang::createSoundDeviceList (E_SOUND_OUTPUT_DRIVER driver=ESOD_AUTO_DETECT, const char *sdk_version_do_not_use=IRR_KLANG_VERSION)
	Creates a list of available sound devices for the driver type.
IRRKLANG_API IAudioRecorder *IRRKLANGCALLCONV	irrklang::createIrrKlangAudioRecorder (ISoundEngine *irrKlangDeviceForPlayback, E_SOUND_OUTPUT_DRIVER driver=ESOD_AUTO_DETECT, const char *deviceID=0, const char *sdk_version_do_not_use=IRR_KLANG_VERSION)
	Creates an irrKlang audio recording device. The IAudioRecorder is the root object for recording audio.
IRRKLANG_API ISoundDeviceList *IRRKLANGCALLCONV	irrklang::createAudioRecorderDeviceList (E_SOUND_OUTPUT_DRIVER driver=ESOD_AUTO_DETECT, const char *sdk_version_do_not_use=IRR_KLANG_VERSION)
	Creates a list of available recording devices for the driver type.
IRRKLANG_API bool IRRKLANGCALLCONV	irrklang::makeUTF8fromUTF16string (const wchar_t *pInputString, char *pOutputBuffer, int outputBufferSize)
	Converts a wchar_t string to an utf8 string, useful when using Windows in unicode mode.

---

Detailed Description

Main header file of the irrKlang sound library, the only file needed to include.

---

Define Documentation

#define IRR_KLANG_VERSION   "1.6.0"

irrKlang Version

#define IRRKLANG_API   __attribute__((visibility("default")))

#define IRRKLANGCALLCONV