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"

Go to the source code of this file.

Namespaces

namespace irrklang

Defines

#define IRR_KLANG_VERSION "1.1.0"

irrKlang Version

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

#define IRRKLANGCALLCONV

Functions

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 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 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.

Detailed Description

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

Definition in file irrKlang.h.

Define Documentation

#define IRR_KLANG_VERSION "1.1.0"

irrKlang Version

Definition at line 36 of file irrKlang.h.

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

Definition at line 863 of file irrKlang.h.

#define IRRKLANGCALLCONV

Definition at line 870 of file irrKlang.h.


Namespaces
namespace	irrklang
Defines
#define	IRR_KLANG_VERSION "1.1.0"
	irrKlang Version
#define	IRRKLANG_API __attribute__((visibility("default")))
#define	IRRKLANGCALLCONV
Functions
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 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 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.