+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+ 
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
+
+
+
+
+Class List
Here are the classes, structs, unions and interfaces with brief descriptions:| irrklang::IAudioRecorder | Interface to an audio recorder. Create it using the createIrrKlangAudioRecorder() function |
| irrklang::IAudioStream | Reads and decodes audio data into an usable audio stream for the ISoundEngine |
| irrklang::IAudioStreamLoader | Class which is able to create an audio file stream from a file |
| irrklang::ICapturedAudioDataReceiver | Interface to be implemented by the user if access to the recorded audio data is needed |
| irrklang::IFileFactory | Interface to overwrite file access in irrKlang |
| irrklang::IFileReader | Interface providing read acess to a file |
| irrklang::IRefCounted | Base class of most objects of the irrKlang |
| irrklang::ISound | Represents a sound which is currently played |
| irrklang::ISoundDeviceList | A list of sound devices for a sound driver. Use irrklang::createSoundDeviceList() to create this list |
| irrklang::ISoundEffectControl | Interface to control the active sound effects (echo, reverb,...) of an ISound object, a playing sound |
| irrklang::ISoundEngine | Interface to the sound engine, for playing 3d and 2d sound and music |
| irrklang::ISoundMixedOutputReceiver | Interface to be implemented by the user, which recieves the mixed output when it it played by the sound engine |
| irrklang::ISoundSource | A sound source describes an input file (.ogg, .mp3, .wav or similar) and its default settings |
| irrklang::ISoundStopEventReceiver | Interface to be implemented by the user, which recieves sound stop events |
| irrklang::IVirtualRefCounted | Reference counting base class for objects in the Irrlicht Engine similar to IRefCounted |
| irrklang::SAudioStreamFormat | Structure describing an audio stream format with helper functions |
| irrklang::SInternalAudioInterface | Structure for returning pointers to the internal audio interface |
| irrklang::vec3d< T > | 3d vector template class for representing vectors and points in 3d |
+
+
+
++ + + +
 |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
+
+
+Class Index
+
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
+
+
+
+irrklang::IAudioRecorder Member List
This is the complete list of members for irrklang::IAudioRecorder, including all inherited members.| addSoundSourceFromRecordedAudio(const char *soundName)=0 | irrklang::IAudioRecorder | [pure virtual] |
| clearRecordedAudioDataBuffer()=0 | irrklang::IAudioRecorder | [pure virtual] |
| drop() | irrklang::IRefCounted | [inline] |
| getAudioFormat()=0 | irrklang::IAudioRecorder | [pure virtual] |
| getDriverName()=0 | irrklang::IAudioRecorder | [pure virtual] |
| getRecordedAudioData()=0 | irrklang::IAudioRecorder | [pure virtual] |
| grab() | irrklang::IRefCounted | [inline] |
| IRefCounted() | irrklang::IRefCounted | [inline] |
| isRecording()=0 | irrklang::IAudioRecorder | [pure virtual] |
| startRecordingBufferedAudio(ik_s32 sampleRate=22000, ESampleFormat sampleFormat=ESF_S16, ik_s32 channelCount=1)=0 | irrklang::IAudioRecorder | [pure virtual] |
| startRecordingCustomHandledAudio(ICapturedAudioDataReceiver *receiver, ik_s32 sampleRate=22000, ESampleFormat sampleFormat=ESF_S16, ik_s32 channelCount=1)=0 | irrklang::IAudioRecorder | [pure virtual] |
| stopRecordingAudio()=0 | irrklang::IAudioRecorder | [pure virtual] |
| ~IRefCounted() | irrklang::IRefCounted | [inline, virtual] |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
The documentation for this class was generated from the following file: +
+
+
+
+
+irrklang::IAudioRecorder Class Reference
+Interface to an audio recorder. Create it using the createIrrKlangAudioRecorder() function. +More...
+ +#include <ik_IAudioRecorder.h>
+Inheritance diagram for irrklang::IAudioRecorder:
+
+
+
+
+
+ 
+
+
+
+
+ Public Member Functions | |
| virtual bool | startRecordingBufferedAudio (ik_s32 sampleRate=22000, ESampleFormat sampleFormat=ESF_S16, ik_s32 channelCount=1)=0 |
| Starts recording audio. | |
| virtual bool | startRecordingCustomHandledAudio (ICapturedAudioDataReceiver *receiver, ik_s32 sampleRate=22000, ESampleFormat sampleFormat=ESF_S16, ik_s32 channelCount=1)=0 |
| Starts recording audio. | |
| virtual void | stopRecordingAudio ()=0 |
| Stops recording audio. | |
| virtual ISoundSource * | addSoundSourceFromRecordedAudio (const char *soundName)=0 |
| Creates a sound source for the recorded audio data. | |
| virtual void | clearRecordedAudioDataBuffer ()=0 |
| Clears recorded audio data buffer, freeing memory. | |
| virtual bool | isRecording ()=0 |
| Returns if the recorder is currently recording audio. | |
| virtual SAudioStreamFormat | getAudioFormat ()=0 |
| Returns the audio format of the recorded audio data. | |
| virtual void * | getRecordedAudioData ()=0 |
| Returns a pointer to the recorded audio data. | |
| virtual const char * | getDriverName ()=0 |
| returns the name of the sound driver, like 'ALSA' for the alsa device. | |
Detailed Description
+Interface to an audio recorder. Create it using the createIrrKlangAudioRecorder() function.
+It creates sound sources into an ISoundEngine which then can be played there. See Recording Audio for an example on how to use this.
+Member Function Documentation
+ +
+
+
+
+
+
+
+| virtual ISoundSource* irrklang::IAudioRecorder::addSoundSourceFromRecordedAudio | +( | +const char * | +soundName | +) | + [pure virtual] |
+
+
+
+Creates a sound source for the recorded audio data.
+The returned sound source pointer then can be used to play back the recorded audio data using ISoundEngine::play2D(). This method only will succeed if the audio was recorded using startRecordingBufferedAudio() and audio recording is currently stopped.
+- Parameters:
-
+
+
+soundName Name of the virtual sound file (e.g. "someRecordedAudio"). You can also use this name when calling play3D() or play2D().
+
+
+
+
+
+
+
+| virtual void irrklang::IAudioRecorder::clearRecordedAudioDataBuffer | +( | ++ | ) | + [pure virtual] |
+
+
+
+Clears recorded audio data buffer, freeing memory.
+This method will only succeed if audio recording is currently stopped.
+ +
+
+
+
+
+
+
+| virtual SAudioStreamFormat irrklang::IAudioRecorder::getAudioFormat | +( | ++ | ) | + [pure virtual] |
+
+
+
+Returns the audio format of the recorded audio data.
+Also contains informations about the length of the recorded audio stream.
+ +
+
+
+
+
+
+
+| virtual const char* irrklang::IAudioRecorder::getDriverName | +( | ++ | ) | + [pure virtual] |
+
+
+
+returns the name of the sound driver, like 'ALSA' for the alsa device.
+Possible returned strings are "NULL", "ALSA", "CoreAudio", "winMM", "DirectSound" and "DirectSound8".
+ +
+
+
+
+
+
+
+| virtual void* irrklang::IAudioRecorder::getRecordedAudioData | +( | ++ | ) | + [pure virtual] |
+
+
+
+Returns a pointer to the recorded audio data.
+This method will only succeed if audio recording is currently stopped and something was recorded previously using startRecordingBufferedAudio(). The lenght of the buffer can be retrieved using getAudioFormat().getSampleDataSize(). Note that the pointer is only valid as long as not clearRecordedAudioDataBuffer() is called or another sample is recorded.
+ +
+
+
+
+
+
+
+| virtual bool irrklang::IAudioRecorder::isRecording | +( | ++ | ) | + [pure virtual] |
+
+
+
+Returns if the recorder is currently recording audio.
+ +
+
+
+
+
+
+
+| virtual bool irrklang::IAudioRecorder::startRecordingBufferedAudio | +( | +ik_s32 | + sampleRate = 22000, |
+ |
| + | + | ESampleFormat | + sampleFormat = ESF_S16, |
+ |
| + | + | ik_s32 | + channelCount = 1 | + |
| + | ) | + [pure virtual] |
+
+
+
+Starts recording audio.
+Clears all possibly previously recorded buffered audio data and starts to record. When finished recording audio data, call stopRecordingAudio(). All recorded audio data gets stored into an internal audio buffer, which can then be accessed for example using addSoundSourceFromRecordedAudio() or getRecordedAudioData(). For recording audio data not into an internal audio buffer, use startRecordingCustomHandledAudio().
+- Parameters:
-
+
+
+sampleRate,: Sample rate of the recorded audio. sampleFormat,: Sample format of the recorded audio. channelCount,: Amount of audio channels.
+
- Returns:
- Returns true if successfully started recording and false if not.
+
+
+
+
+
+
+| virtual bool irrklang::IAudioRecorder::startRecordingCustomHandledAudio | +( | +ICapturedAudioDataReceiver * | +receiver, | +|
| + | + | ik_s32 | + sampleRate = 22000, |
+ |
| + | + | ESampleFormat | + sampleFormat = ESF_S16, |
+ |
| + | + | ik_s32 | + channelCount = 1 | + |
| + | ) | + [pure virtual] |
+
+
+
+Starts recording audio.
+Clears all possibly previously recorded buffered audio data and starts to record audio data, which is delivered to a custom user callback interface. When finished recording audio data, call stopRecordingAudio(). If instead of recording the data to the receiver interface recording into a managed buffer is wished, use startRecordingBufferedAudio() instead.
+- Parameters:
-
+
+
+receiver,: Interface to be implemented by the user, gets called once for each captured audio data chunk. sampleRate,: Sample rate of the recorded audio. sampleFormat,: Sample format of the recorded audio. channelCount,: Amount of audio channels.
+
- Returns:
- Returns true if successfully started recording and false if not.
+
+
+
+
+
+| virtual void irrklang::IAudioRecorder::stopRecordingAudio | +( | ++ | ) | + [pure virtual] |
+
+
+
+Stops recording audio.
+ +The documentation for this class was generated from the following file: +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
+
+
+
+irrklang::IAudioStream Member List
This is the complete list of members for irrklang::IAudioStream, including all inherited members.| drop() | irrklang::IRefCounted | [inline] |
| getFormat()=0 | irrklang::IAudioStream | [pure virtual] |
| getIsSeekingSupported() | irrklang::IAudioStream | [inline, virtual] |
| grab() | irrklang::IRefCounted | [inline] |
| IRefCounted() | irrklang::IRefCounted | [inline] |
| readFrames(void *target, ik_s32 frameCountToRead)=0 | irrklang::IAudioStream | [pure virtual] |
| setPosition(ik_s32 pos)=0 | irrklang::IAudioStream | [pure virtual] |
| ~IAudioStream() | irrklang::IAudioStream | [inline, virtual] |
| ~IRefCounted() | irrklang::IRefCounted | [inline, virtual] |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
The documentation for this class was generated from the following file: +
+
+
+
+
+irrklang::IAudioStream Class Reference
+Reads and decodes audio data into an usable audio stream for the ISoundEngine. +More...
+ +#include <ik_IAudioStream.h>
+Inheritance diagram for irrklang::IAudioStream:
+
+
+
+
+
+ 
+
+
+
+
+ Public Member Functions | |
| virtual | ~IAudioStream () |
| destructor | |
| virtual SAudioStreamFormat | getFormat ()=0 |
| returns format of the audio stream | |
| virtual bool | setPosition (ik_s32 pos)=0 |
| sets the position of the audio stream. | |
| virtual bool | getIsSeekingSupported () |
| returns true if the audio stream is seekable | |
| virtual ik_s32 | readFrames (void *target, ik_s32 frameCountToRead)=0 |
| tells the audio stream to read frameCountToRead audio frames into the specified buffer | |
Detailed Description
+Reads and decodes audio data into an usable audio stream for the ISoundEngine.
+Constructor & Destructor Documentation
+ +
+
+
+
+
+
+| virtual irrklang::IAudioStream::~IAudioStream | +( | ++ | ) | + [inline, virtual] |
+
+
+
+destructor
+ +Member Function Documentation
+ +
+
+
+
+
+
+
+| virtual SAudioStreamFormat irrklang::IAudioStream::getFormat | +( | ++ | ) | + [pure virtual] |
+
+
+
+returns format of the audio stream
+ +
+
+
+
+
+
+
+| virtual bool irrklang::IAudioStream::getIsSeekingSupported | +( | ++ | ) | + [inline, virtual] |
+
+
+
+returns true if the audio stream is seekable
+ +
+
+
+
+
+
+
+| virtual ik_s32 irrklang::IAudioStream::readFrames | +( | +void * | +target, | +|
| + | + | ik_s32 | +frameCountToRead | + |
| + | ) | + [pure virtual] |
+
+
+
+tells the audio stream to read frameCountToRead audio frames into the specified buffer
+- Parameters:
-
+
+
+target,: Target data buffer to the method will write the read frames into. The specified buffer will be at least getFormat().getFrameSize()*frameCountToRead bytes big. frameCountToRead,: amount of frames to be read.
+
- Returns:
- Returns amount of frames really read. Should be frameCountToRead in most cases.
+
+
+
+
+
+| virtual bool irrklang::IAudioStream::setPosition | +( | +ik_s32 | +pos | +) | + [pure virtual] |
+
+
+
+sets the position of the audio stream.
+For example to let the stream be read from the beginning of the file again, setPosition(0) would be called. This is usually done be the sound engine to loop a stream after if has reached the end. Return true if sucessful and 0 if not.
+- Parameters:
-
+
+
+pos,: Position in frames.
+
The documentation for this class was generated from the following file: +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
+
+
+
+irrklang::IAudioStreamLoader Member List
This is the complete list of members for irrklang::IAudioStreamLoader, including all inherited members.| createAudioStream(IFileReader *file)=0 | irrklang::IAudioStreamLoader | [pure virtual] |
| drop() | irrklang::IRefCounted | [inline] |
| grab() | irrklang::IRefCounted | [inline] |
| IRefCounted() | irrklang::IRefCounted | [inline] |
| isALoadableFileExtension(const ik_c8 *fileName)=0 | irrklang::IAudioStreamLoader | [pure virtual] |
| ~IAudioStreamLoader() | irrklang::IAudioStreamLoader | [inline, virtual] |
| ~IRefCounted() | irrklang::IRefCounted | [inline, virtual] |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
The documentation for this class was generated from the following file: +
+
+
+
+
+irrklang::IAudioStreamLoader Class Reference
+Class which is able to create an audio file stream from a file. +More...
+ +#include <ik_IAudioStreamLoader.h>
+Inheritance diagram for irrklang::IAudioStreamLoader:
+
+
+
+
+
+ 
+
+
+
+
+ Public Member Functions | |
| virtual | ~IAudioStreamLoader () |
| destructor | |
| virtual bool | isALoadableFileExtension (const ik_c8 *fileName)=0 |
| Returns true if the file maybe is able to be loaded by this class. | |
| virtual IAudioStream * | createAudioStream (IFileReader *file)=0 |
| Creates an audio file input stream from a file. | |
Detailed Description
+Class which is able to create an audio file stream from a file.
+Constructor & Destructor Documentation
+ +
+
+
+
+
+
+| virtual irrklang::IAudioStreamLoader::~IAudioStreamLoader | +( | ++ | ) | + [inline, virtual] |
+
+
+
+destructor
+ +Member Function Documentation
+ +
+
+
+
+
+
+
+| virtual IAudioStream* irrklang::IAudioStreamLoader::createAudioStream | +( | +IFileReader * | +file | +) | + [pure virtual] |
+
+
+
+Creates an audio file input stream from a file.
+- Returns:
- Pointer to the created audio stream. Returns 0 if loading failed. If you no longer need the stream, you should call IAudioFileStream::drop(). See IRefCounted::drop() for more information.
+
+
+
+
+
+| virtual bool irrklang::IAudioStreamLoader::isALoadableFileExtension | +( | +const ik_c8 * | +fileName | +) | + [pure virtual] |
+
+
+
+Returns true if the file maybe is able to be loaded by this class.
+This decision should be based only on the file extension (e.g. ".wav"). The given filename string is guaranteed to be lower case.
+ +The documentation for this class was generated from the following file: +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
+
+
+
+irrklang::ICapturedAudioDataReceiver Member List
This is the complete list of members for irrklang::ICapturedAudioDataReceiver, including all inherited members.| drop() | irrklang::IRefCounted | [inline] |
| grab() | irrklang::IRefCounted | [inline] |
| IRefCounted() | irrklang::IRefCounted | [inline] |
| OnReceiveAudioDataStreamChunk(unsigned char *audioData, unsigned long lengthInBytes)=0 | irrklang::ICapturedAudioDataReceiver | [pure virtual] |
| ~IRefCounted() | irrklang::IRefCounted | [inline, virtual] |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
The documentation for this class was generated from the following file: +
+
+
+
+
+irrklang::ICapturedAudioDataReceiver Class Reference
+Interface to be implemented by the user if access to the recorded audio data is needed. +More...
+ +#include <ik_IAudioRecorder.h>
+Inheritance diagram for irrklang::ICapturedAudioDataReceiver:
+
+
+
+
+
+ 
+
+
+
+
+ Public Member Functions | |
| virtual void | OnReceiveAudioDataStreamChunk (unsigned char *audioData, unsigned long lengthInBytes)=0 |
| Gets called once for each captured audio data chunk. | |
Detailed Description
+Interface to be implemented by the user if access to the recorded audio data is needed.
+Is used as parameter in IAudioRecorder::startRecordingCustomHandledAudio.
+Member Function Documentation
+ +
+
+
+
+
+
+| virtual void irrklang::ICapturedAudioDataReceiver::OnReceiveAudioDataStreamChunk | +( | +unsigned char * | +audioData, | +|
| + | + | unsigned long | +lengthInBytes | + |
| + | ) | + [pure virtual] |
+
+
+
+Gets called once for each captured audio data chunk.
+See IAudioRecorder::startRecordingCustomHandledAudio for details.
+- Parameters:
-
+
+
+audioData,: Pointer to a part of the recorded audio data lengthInBytes,: Amount of bytes in the audioData buffer.
+
The documentation for this class was generated from the following file: +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
+
+
+
+irrklang::IFileFactory Member List
This is the complete list of members for irrklang::IFileFactory, including all inherited members.| createFileReader(const ik_c8 *filename)=0 | irrklang::IFileFactory | [pure virtual] |
| drop() | irrklang::IRefCounted | [inline] |
| grab() | irrklang::IRefCounted | [inline] |
| IRefCounted() | irrklang::IRefCounted | [inline] |
| ~IFileFactory() | irrklang::IFileFactory | [inline, virtual] |
| ~IRefCounted() | irrklang::IRefCounted | [inline, virtual] |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
The documentation for this class was generated from the following file: +
+
+
+
+
+irrklang::IFileFactory Class Reference
+Interface to overwrite file access in irrKlang. +More...
+ +#include <ik_IFileFactory.h>
+Inheritance diagram for irrklang::IFileFactory:
+
+
+
+
+
+ 
+
+
+
+
+ Public Member Functions | |
| virtual | ~IFileFactory () |
| virtual IFileReader * | createFileReader (const ik_c8 *filename)=0 |
| Opens a file for read access. | |
Detailed Description
+Interface to overwrite file access in irrKlang.
+Derive your own class from IFileFactory, overwrite the createFileReader() method and return your own implemented IFileReader to overwrite file access of irrKlang. Use ISoundEngine::addFileFactory() to let irrKlang know about your class. Example code can be found in the tutorial 04.OverrideFileAccess.
+Constructor & Destructor Documentation
+ +
+
+
+
+
+
+| virtual irrklang::IFileFactory::~IFileFactory | +( | ++ | ) | + [inline, virtual] |
+
+
+
+Member Function Documentation
+ +
+
+
+
+
+
+| virtual IFileReader* irrklang::IFileFactory::createFileReader | +( | +const ik_c8 * | +filename | +) | + [pure virtual] |
+
+
+
+Opens a file for read access.
+Derive your own class from IFileFactory, overwrite this method and return your own implemented IFileReader to overwrite file access of irrKlang. Use ISoundEngine::addFileFactory() to let irrKlang know about your class. Example code can be found in the tutorial 04.OverrideFileAccess.
+- Parameters:
-
+
+
+filename Name of file to open.
+
- Returns:
- Returns a pointer to the created file interface. The returned pointer should be dropped when no longer needed. See IRefCounted::drop() for more information. Returns 0 if file cannot be opened.
The documentation for this class was generated from the following file: +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
+
+
+
+irrklang::IFileReader Member List
This is the complete list of members for irrklang::IFileReader, including all inherited members.| drop() | irrklang::IRefCounted | [inline] |
| getFileName()=0 | irrklang::IFileReader | [pure virtual] |
| getPos()=0 | irrklang::IFileReader | [pure virtual] |
| getSize()=0 | irrklang::IFileReader | [pure virtual] |
| grab() | irrklang::IRefCounted | [inline] |
| IRefCounted() | irrklang::IRefCounted | [inline] |
| read(void *buffer, ik_u32 sizeToRead)=0 | irrklang::IFileReader | [pure virtual] |
| seek(ik_s32 finalPos, bool relativeMovement=false)=0 | irrklang::IFileReader | [pure virtual] |
| ~IFileReader() | irrklang::IFileReader | [inline, virtual] |
| ~IRefCounted() | irrklang::IRefCounted | [inline, virtual] |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
The documentation for this class was generated from the following file: +
+
+
+
+
+irrklang::IFileReader Class Reference
+Interface providing read acess to a file. +More...
+ +#include <ik_IFileReader.h>
+Inheritance diagram for irrklang::IFileReader:
+
+
+
+
+
+ 
+
+
+
+
+ Public Member Functions | |
| virtual | ~IFileReader () |
| virtual ik_s32 | read (void *buffer, ik_u32 sizeToRead)=0 |
| virtual bool | seek (ik_s32 finalPos, bool relativeMovement=false)=0 |
| virtual ik_s32 | getSize ()=0 |
| virtual ik_s32 | getPos ()=0 |
| virtual const ik_c8 * | getFileName ()=0 |
Detailed Description
+Interface providing read acess to a file.
+Constructor & Destructor Documentation
+ +
+
+
+
+
+
+| virtual irrklang::IFileReader::~IFileReader | +( | ++ | ) | + [inline, virtual] |
+
+
+
+Member Function Documentation
+ +
+
+
+
+
+
+
+| virtual const ik_c8* irrklang::IFileReader::getFileName | +( | ++ | ) | + [pure virtual] |
+
+
+Returns name of file.
+- Returns:
- Returns the file name as zero terminated character string.
+
+
+
+
+
+
+| virtual ik_s32 irrklang::IFileReader::getPos | +( | ++ | ) | + [pure virtual] |
+
+
+Returns the current position in the file.
+- Returns:
- Returns the current position in the file in bytes.
+
+
+
+
+
+
+| virtual ik_s32 irrklang::IFileReader::getSize | +( | ++ | ) | + [pure virtual] |
+
+
+Returns size of file.
+- Returns:
- Returns the size of the file in bytes.
+
+
+
+
+
+
+| virtual ik_s32 irrklang::IFileReader::read | +( | +void * | +buffer, | +|
| + | + | ik_u32 | +sizeToRead | + |
| + | ) | + [pure virtual] |
+
+
+Reads an amount of bytes from the file.
+- Parameters:
-
+
+
+buffer,: Pointer to buffer where to read bytes will be written to. sizeToRead,: Amount of bytes to read from the file.
+
- Returns:
- Returns how much bytes were read.
+
+
+
+
+
+| virtual bool irrklang::IFileReader::seek | +( | +ik_s32 | +finalPos, | +|
| + | + | bool | + relativeMovement = false | + |
| + | ) | + [pure virtual] |
+
+
+Changes position in file, returns true if successful.
+- Parameters:
-
+
+
+finalPos,: Destination position in the file. relativeMovement,: If set to true, the position in the file is changed relative to current position. Otherwise the position is changed from beginning of file.
+
- Returns:
- Returns true if successful, otherwise false.
The documentation for this class was generated from the following file: +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
+
+
+
+irrklang::IRefCounted Member List
This is the complete list of members for irrklang::IRefCounted, including all inherited members.| drop() | irrklang::IRefCounted | [inline] |
| grab() | irrklang::IRefCounted | [inline] |
| IRefCounted() | irrklang::IRefCounted | [inline] |
| ~IRefCounted() | irrklang::IRefCounted | [inline, virtual] |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
The documentation for this class was generated from the following file: +
+
+
+
+
+irrklang::IRefCounted Class Reference
+Base class of most objects of the irrKlang. +More...
+ +#include <ik_IRefCounted.h>
+Inheritance diagram for irrklang::IRefCounted:
+
+
+
+
+
+ 
+
+
+
+
+ Public Member Functions | |
| IRefCounted () | |
| Constructor. | |
| virtual | ~IRefCounted () |
| Destructor. | |
| void | grab () |
| bool | drop () |
Detailed Description
+Base class of most objects of the irrKlang.
+This class provides reference counting through the methods grab() and drop(). It also is able to store a debug string for every instance of an object. Most objects of irrKlang are derived from IRefCounted, and so they are reference counted.
+When you receive an object in irrKlang (for example an ISound using play2D() or play3D()), and you no longer need the object, you have to call drop(). This will destroy the object, if grab() was not called in another part of you program, because this part still needs the object. Note, that you only don't need to call drop() for all objects you receive, it will be explicitely noted in the documentation.
+A simple example:
+If you want to play a sound, you may want to call the method ISoundEngine::play2D. You call ISound* mysound = engine->play2D("foobar.mp3", false, false true); If you no longer need the sound interface, call mysound->drop(). The sound may still play on after this because the engine still has a reference to that sound, but you can be sure that it's memory will be released as soon the sound is no longer used.
+If you want to add a sound source, you may want to call a method ISoundEngine::addSoundSourceFromFile. You do this like ISoundSource* mysource = engine->addSoundSourceFromFile("example.jpg"); You will not have to drop the pointer to the source, because sound sources are managed by the engine (it will live as long as the sound engine) and the documentation says so.
+Constructor & Destructor Documentation
+ +
+
+
+
+
+
+
+| irrklang::IRefCounted::IRefCounted | +( | ++ | ) | + [inline] |
+
+
+
+Constructor.
+ +
+
+
+
+
+
+| virtual irrklang::IRefCounted::~IRefCounted | +( | ++ | ) | + [inline, virtual] |
+
+
+
+Destructor.
+ +Member Function Documentation
+ +
+
+
+
+
+
+
+| bool irrklang::IRefCounted::drop | +( | ++ | ) | + [inline] |
+
+
+When you receive an object in irrKlang (for example an ISound using play2D() or play3D()), and you no longer need the object, you have to call drop(). This will destroy the object, if grab() was not called in another part of you program, because this part still needs the object. Note, that you only don't need to call drop() for all objects you receive, it will be explicitely noted in the documentation.
+A simple example:
+If you want to play a sound, you may want to call the method ISoundEngine::play2D. You call ISound* mysound = engine->play2D("foobar.mp3", false, false true); If you no longer need the sound interface, call mysound->drop(). The sound may still play on after this because the engine still has a reference to that sound, but you can be sure that it's memory will be released as soon the sound is no longer used.
+ +
+
+
+
+
+
+| void irrklang::IRefCounted::grab | +( | ++ | ) | + [inline] |
+
+
+Grabs the object. Increments the reference counter by one. Someone who calls grab() to an object, should later also call drop() to it. If an object never gets as much drop() as grab() calls, it will never be destroyed. The IRefCounted class provides a basic reference counting mechanism with its methods grab() and drop(). Most objects of irrklang are derived from IRefCounted, and so they are reference counted.
+When you receive an object in irrKlang (for example an ISound using play2D() or play3D()), and you no longer need the object, you have to call drop(). This will destroy the object, if grab() was not called in another part of you program, because this part still needs the object. Note, that you only don't need to call drop() for all objects you receive, it will be explicitely noted in the documentation.
+A simple example:
+If you want to play a sound, you may want to call the method ISoundEngine::play2D. You call ISound* mysound = engine->play2D("foobar.mp3", false, false true); If you no longer need the sound interface, call mysound->drop(). The sound may still play on after this because the engine still has a reference to that sound, but you can be sure that it's memory will be released as soon the sound is no longer used.
+ +The documentation for this class was generated from the following file: +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
+
+
+
+irrklang::ISound Member List
This is the complete list of members for irrklang::ISound, including all inherited members.| drop()=0 | irrklang::IVirtualRefCounted | [pure virtual] |
| getIsPaused()=0 | irrklang::ISound | [pure virtual] |
| getMaxDistance()=0 | irrklang::ISound | [pure virtual] |
| getMinDistance()=0 | irrklang::ISound | [pure virtual] |
| getPan()=0 | irrklang::ISound | [pure virtual] |
| getPlaybackSpeed()=0 | irrklang::ISound | [pure virtual] |
| getPlayLength()=0 | irrklang::ISound | [pure virtual] |
| getPlayPosition()=0 | irrklang::ISound | [pure virtual] |
| getPosition()=0 | irrklang::ISound | [pure virtual] |
| getSoundEffectControl()=0 | irrklang::ISound | [pure virtual] |
| getSoundSource()=0 | irrklang::ISound | [pure virtual] |
| getVelocity()=0 | irrklang::ISound | [pure virtual] |
| getVolume()=0 | irrklang::ISound | [pure virtual] |
| grab()=0 | irrklang::IVirtualRefCounted | [pure virtual] |
| isFinished()=0 | irrklang::ISound | [pure virtual] |
| isLooped()=0 | irrklang::ISound | [pure virtual] |
| setIsLooped(bool looped)=0 | irrklang::ISound | [pure virtual] |
| setIsPaused(bool paused=true)=0 | irrklang::ISound | [pure virtual] |
| setMaxDistance(ik_f32 max)=0 | irrklang::ISound | [pure virtual] |
| setMinDistance(ik_f32 min)=0 | irrklang::ISound | [pure virtual] |
| setPan(ik_f32 pan)=0 | irrklang::ISound | [pure virtual] |
| setPlaybackSpeed(ik_f32 speed=1.0f)=0 | irrklang::ISound | [pure virtual] |
| setPlayPosition(ik_u32 pos)=0 | irrklang::ISound | [pure virtual] |
| setPosition(vec3df position)=0 | irrklang::ISound | [pure virtual] |
| setSoundStopEventReceiver(ISoundStopEventReceiver *reciever, void *userData=0)=0 | irrklang::ISound | [pure virtual] |
| setVelocity(vec3df vel)=0 | irrklang::ISound | [pure virtual] |
| setVolume(ik_f32 volume)=0 | irrklang::ISound | [pure virtual] |
| stop()=0 | irrklang::ISound | [pure virtual] |
| ~IVirtualRefCounted() | irrklang::IVirtualRefCounted | [inline, virtual] |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+irrklang::ISound Class Reference
+Represents a sound which is currently played. +More...
+ +#include <ik_ISound.h>
+Inheritance diagram for irrklang::ISound:
+
+
+
+
+
+ 
+
+
+
+
+ Public Member Functions | |
| virtual ISoundSource * | getSoundSource ()=0 |
| returns source of the sound which stores the filename and other informations about that sound | |
| virtual void | setIsPaused (bool paused=true)=0 |
| returns if the sound is paused | |
| virtual bool | getIsPaused ()=0 |
| returns if the sound is paused | |
| virtual void | stop ()=0 |
| Will stop the sound and free its resources. | |
| virtual ik_f32 | getVolume ()=0 |
| returns volume of the sound, a value between 0 (mute) and 1 (full volume). | |
| virtual void | setVolume (ik_f32 volume)=0 |
| sets the volume of the sound, a value between 0 (mute) and 1 (full volume). | |
| virtual void | setPan (ik_f32 pan)=0 |
| sets the pan of the sound. Takes a value between -1 and 1, 0 is center. | |
| virtual ik_f32 | getPan ()=0 |
| returns the pan of the sound. Takes a value between -1 and 1, 0 is center. | |
| virtual bool | isLooped ()=0 |
| returns if the sound has been started to play looped | |
| virtual void | setIsLooped (bool looped)=0 |
| changes the loop mode of the sound. | |
| virtual bool | isFinished ()=0 |
| returns if the sound has finished playing. | |
| virtual void | setMinDistance (ik_f32 min)=0 |
| Sets the minimal distance if this is a 3D sound. | |
| virtual ik_f32 | getMinDistance ()=0 |
| Returns the minimal distance if this is a 3D sound. | |
| virtual void | setMaxDistance (ik_f32 max)=0 |
| Sets the maximal distance if this is a 3D sound. | |
| virtual ik_f32 | getMaxDistance ()=0 |
| Returns the maximal distance if this is a 3D sound. | |
| virtual void | setPosition (vec3df position)=0 |
| sets the position of the sound in 3d space | |
| virtual vec3df | getPosition ()=0 |
| returns the position of the sound in 3d space | |
| virtual void | setVelocity (vec3df vel)=0 |
| sets the position of the sound in 3d space, needed for Doppler effects. | |
| virtual vec3df | getVelocity ()=0 |
| returns the velocity of the sound in 3d space, needed for Doppler effects. | |
| virtual ik_u32 | getPlayPosition ()=0 |
| returns the current play position of the sound in milliseconds. | |
| virtual bool | setPlayPosition (ik_u32 pos)=0 |
| sets the current play position of the sound in milliseconds. | |
| virtual bool | setPlaybackSpeed (ik_f32 speed=1.0f)=0 |
| Sets the playback speed (frequency) of the sound. | |
| virtual ik_f32 | getPlaybackSpeed ()=0 |
| Returns the playback speed set by setPlaybackSpeed(). Default: 1.0f. | |
| virtual ik_u32 | getPlayLength ()=0 |
| returns the play length of the sound in milliseconds. | |
| virtual ISoundEffectControl * | getSoundEffectControl ()=0 |
| Returns the sound effect control interface for this sound. | |
| virtual void | setSoundStopEventReceiver (ISoundStopEventReceiver *reciever, void *userData=0)=0 |
| Sets the sound stop event receiver, an interface which gets called if a sound has finished playing. | |
Detailed Description
+Represents a sound which is currently played.
+The sound can be stopped, its volume or pan changed, effects added/removed and similar using this interface. Creating sounds is done using ISoundEngine::play2D() or ISoundEngine::play3D(). More informations about the source of a sound can be obtained from the ISoundSource interface.
+Member Function Documentation
+ +
+
+
+
+
+
+
+| virtual bool irrklang::ISound::getIsPaused | +( | ++ | ) | + [pure virtual] |
+
+
+
+returns if the sound is paused
+ +
+
+
+
+
+
+
+| virtual ik_f32 irrklang::ISound::getMaxDistance | +( | ++ | ) | + [pure virtual] |
+
+
+
+Returns the maximal distance if this is a 3D sound.
+See setMaxDistance() for details.
+ +
+
+
+
+
+
+
+| virtual ik_f32 irrklang::ISound::getMinDistance | +( | ++ | ) | + [pure virtual] |
+
+
+
+Returns the minimal distance if this is a 3D sound.
+See setMinDistance() for details.
+ +
+
+
+
+
+
+
+| virtual ik_f32 irrklang::ISound::getPan | +( | ++ | ) | + [pure virtual] |
+
+
+
+returns the pan of the sound. Takes a value between -1 and 1, 0 is center.
+ +
+
+
+
+
+
+
+| virtual ik_f32 irrklang::ISound::getPlaybackSpeed | +( | ++ | ) | + [pure virtual] |
+
+
+
+Returns the playback speed set by setPlaybackSpeed(). Default: 1.0f.
+See setPlaybackSpeed() for details
+ +
+
+
+
+
+
+
+| virtual ik_u32 irrklang::ISound::getPlayLength | +( | ++ | ) | + [pure virtual] |
+
+
+
+returns the play length of the sound in milliseconds.
+Returns -1 if not known for this sound for example because its decoder does not support length reporting or it is a file stream of unknown size. Note: You can also use ISoundSource::getPlayLength() to get the length of a sound without actually needing to play it.
+ +
+
+
+
+
+
+
+| virtual ik_u32 irrklang::ISound::getPlayPosition | +( | ++ | ) | + [pure virtual] |
+
+
+
+returns the current play position of the sound in milliseconds.
+- Returns:
- Returns -1 if not implemented or possible for this sound for example because it already has been stopped and freed internally or similar.
+
+
+
+
+
+
+| virtual vec3df irrklang::ISound::getPosition | +( | ++ | ) | + [pure virtual] |
+
+
+
+returns the position of the sound in 3d space
+ +
+
+
+
+
+
+
+| virtual ISoundEffectControl* irrklang::ISound::getSoundEffectControl | +( | ++ | ) | + [pure virtual] |
+
+
+
+Returns the sound effect control interface for this sound.
+Sound effects such as Chorus, Distorsions, Echo, Reverb and similar can be controlled using this. The interface pointer is only valid as long as the ISound pointer is valid. If the ISound pointer gets dropped (IVirtualRefCounted::drop()), the ISoundEffects may not be used any more.
+- Returns:
- Returns a pointer to the sound effects interface if available. The sound has to be started via ISoundEngine::play2D() or ISoundEngine::play3D(), with the flag enableSoundEffects=true, otherwise 0 will be returned. Note that if the output driver does not support sound effects, 0 will be returned as well.
+
+
+
+
+
+
+| virtual ISoundSource* irrklang::ISound::getSoundSource | +( | ++ | ) | + [pure virtual] |
+
+
+
+returns source of the sound which stores the filename and other informations about that sound
+- Returns:
- Returns the sound source poitner of this sound. May return 0 if the sound source has been removed.
+
+
+
+
+
+
+| virtual vec3df irrklang::ISound::getVelocity | +( | ++ | ) | + [pure virtual] |
+
+
+
+returns the velocity of the sound in 3d space, needed for Doppler effects.
+To use doppler effects use ISound::setVelocity to set a sounds velocity, ISoundEngine::setListenerPosition() to set the listeners velocity and ISoundEngine::setDopplerEffectParameters() to adjust two parameters influencing the doppler effects intensity.
+ +
+
+
+
+
+
+
+| virtual ik_f32 irrklang::ISound::getVolume | +( | ++ | ) | + [pure virtual] |
+
+
+
+returns volume of the sound, a value between 0 (mute) and 1 (full volume).
+(this volume gets multiplied with the master volume of the sound engine and other parameters like distance to listener when played as 3d sound)
+ +
+
+
+
+
+
+
+| virtual bool irrklang::ISound::isFinished | +( | ++ | ) | + [pure virtual] |
+
+
+
+returns if the sound has finished playing.
+Don't mix this up with isPaused(). isFinished() returns if the sound has been finished playing. If it has, is maybe already have been removed from the playing list of the sound engine and calls to any other of the methods of ISound will not have any result. If you call stop() to a playing sound will result that this function will return true when invoked.
+ +
+
+
+
+
+
+
+| virtual bool irrklang::ISound::isLooped | +( | ++ | ) | + [pure virtual] |
+
+
+
+returns if the sound has been started to play looped
+ +
+
+
+
+
+
+
+| virtual void irrklang::ISound::setIsLooped | +( | +bool | +looped | +) | + [pure virtual] |
+
+
+
+changes the loop mode of the sound.
+If the sound is playing looped and it is changed to not-looped, then it will stop playing after the loop has finished. If it is not looped and changed to looped, the sound will start repeating to be played when it reaches its end. Invoking this method will not have an effect when the sound already has stopped.
+ +
+
+
+
+
+
+
+| virtual void irrklang::ISound::setIsPaused | +( | +bool | + paused = true |
+ ) | + [pure virtual] |
+
+
+
+returns if the sound is paused
+ +
+
+
+
+
+
+
+| virtual void irrklang::ISound::setMaxDistance | +( | +ik_f32 | +max | +) | + [pure virtual] |
+
+
+
+Sets the maximal distance if this is a 3D sound.
+Changing this value is usually not necessary. Use setMinDistance() instead. Don't change this value if you don't know what you are doing: This value causes the sound to stop attenuating after it reaches the max distance. Most people think that this sets the volume of the sound to 0 after this distance, but this is not true. Only change the minimal distance (using for example setMinDistance()) to influence this. The maximum distance for a sound source is the distance beyond which the sound does not get any quieter. The default minimum distance is 1, the default max distance is a huge number like 1000000000.0f.
+ +
+
+
+
+
+
+
+| virtual void irrklang::ISound::setMinDistance | +( | +ik_f32 | +min | +) | + [pure virtual] |
+
+
+
+Sets the minimal distance if this is a 3D sound.
+Changes the distance at which the 3D sound stops getting louder. This works like this: As a listener approaches a 3D sound source, the sound gets louder. Past a certain point, it is not reasonable for the volume to continue to increase. Either the maximum (zero) has been reached, or the nature of the sound source imposes a logical limit. This is the minimum distance for the sound source. Similarly, the maximum distance for a sound source is the distance beyond which the sound does not get any quieter. The default minimum distance is 1, the default max distance is a huge number like 1000000000.0f.
+ +
+
+
+
+
+
+
+| virtual void irrklang::ISound::setPan | +( | +ik_f32 | +pan | +) | + [pure virtual] |
+
+
+
+sets the pan of the sound. Takes a value between -1 and 1, 0 is center.
+ +
+
+
+
+
+
+
+| virtual bool irrklang::ISound::setPlaybackSpeed | +( | +ik_f32 | + speed = 1.0f |
+ ) | + [pure virtual] |
+
+
+
+Sets the playback speed (frequency) of the sound.
+Plays the sound at a higher or lower speed, increasing or decreasing its frequency which makes it sound lower or higher. Note that this feature is not available on all sound output drivers (it is on the DirectSound drivers at least), and it does not work together with the 'enableSoundEffects' parameter of ISoundEngine::play2D and ISoundEngine::play3D when using DirectSound.
+- Parameters:
-
+
+
+speed Factor of the speed increase or decrease. 2 is twice as fast, 0.5 is only half as fast. The default is 1.0.
+
- Returns:
- Returns true if sucessful, false if not. The current sound driver might not support changing the playBack speed, or the sound was started with the 'enableSoundEffects' parameter.
+
+
+
+
+
+
+| virtual bool irrklang::ISound::setPlayPosition | +( | +ik_u32 | +pos | +) | + [pure virtual] |
+
+
+
+sets the current play position of the sound in milliseconds.
+- Parameters:
-
+
+
+pos Position in milliseconds. Must be between 0 and the value returned by getPlayPosition().
+
- Returns:
- Returns true successful. False is returned for example if the sound already finished playing and is stopped or the audio source is not seekable, for example if it is an internet stream or a a file format not supporting seeking (a .MOD file for example). A file can be tested if it can bee seeking using ISoundSource::getIsSeekingSupported().
+
+
+
+
+
+
+| virtual void irrklang::ISound::setPosition | +( | +vec3df | +position | +) | + [pure virtual] |
+
+
+
+sets the position of the sound in 3d space
+ +
+
+
+
+
+
+
+| virtual void irrklang::ISound::setSoundStopEventReceiver | +( | +ISoundStopEventReceiver * | +reciever, | +|
| + | + | void * | + userData = 0 | + |
| + | ) | + [pure virtual] |
+
+
+
+Sets the sound stop event receiver, an interface which gets called if a sound has finished playing.
+This event is guaranteed to be called when the sound or sound stream is finished, either because the sound reached its playback end, its sound source was removed, ISoundEngine::stopAllSounds() has been called or the whole engine was deleted. There is an example on how to use events in irrklang at Using Sound Events .
+- Parameters:
-
+
+
+receiver Interface to a user implementation of the sound receiver. This interface should be as long valid as the sound exists or another stop event receiver is set. Set this to null to set no sound stop event receiver. userData,: A iser data pointer, can be null.
+
+
+
+
+
+
+
+| virtual void irrklang::ISound::setVelocity | +( | +vec3df | +vel | +) | + [pure virtual] |
+
+
+
+sets the position of the sound in 3d space, needed for Doppler effects.
+To use doppler effects use ISound::setVelocity to set a sounds velocity, ISoundEngine::setListenerPosition() to set the listeners velocity and ISoundEngine::setDopplerEffectParameters() to adjust two parameters influencing the doppler effects intensity.
+ +
+
+
+
+
+
+
+| virtual void irrklang::ISound::setVolume | +( | +ik_f32 | +volume | +) | + [pure virtual] |
+
+
+
+sets the volume of the sound, a value between 0 (mute) and 1 (full volume).
+This volume gets multiplied with the master volume of the sound engine and other parameters like distance to listener when played as 3d sound.
+ +
+
+
+
+
+
+| virtual void irrklang::ISound::stop | +( | ++ | ) | + [pure virtual] |
+
+
+
+Will stop the sound and free its resources.
+If you just want to pause the sound, use setIsPaused(). After calling stop(), isFinished() will usually return true. Be sure to also call ->drop() once you are done.
+ +The documentation for this class was generated from the following file:
-
+
- ik_ISound.h +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
+
+
+
+irrklang::ISoundDeviceList Member List
This is the complete list of members for irrklang::ISoundDeviceList, including all inherited members.| drop() | irrklang::IRefCounted | [inline] |
| getDeviceCount()=0 | irrklang::ISoundDeviceList | [pure virtual] |
| getDeviceDescription(ik_s32 index)=0 | irrklang::ISoundDeviceList | [pure virtual] |
| getDeviceID(ik_s32 index)=0 | irrklang::ISoundDeviceList | [pure virtual] |
| grab() | irrklang::IRefCounted | [inline] |
| IRefCounted() | irrklang::IRefCounted | [inline] |
| ~IRefCounted() | irrklang::IRefCounted | [inline, virtual] |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
The documentation for this class was generated from the following file: +
+
+
+
+
+irrklang::ISoundDeviceList Class Reference
+A list of sound devices for a sound driver. Use irrklang::createSoundDeviceList() to create this list. +More...
+ +#include <ik_ISoundDeviceList.h>
+Inheritance diagram for irrklang::ISoundDeviceList:
+
+
+
+
+
+ 
+
+
+
+
+ Public Member Functions | |
| virtual ik_s32 | getDeviceCount ()=0 |
| Returns amount of enumerated devices in the list. | |
| virtual const char * | getDeviceID (ik_s32 index)=0 |
| Returns the ID of the device. Use this string to identify this device in createIrrKlangDevice(). | |
| virtual const char * | getDeviceDescription (ik_s32 index)=0 |
| Returns description of the device. | |
Detailed Description
+A list of sound devices for a sound driver. Use irrklang::createSoundDeviceList() to create this list.
+The function createIrrKlangDevice() has a parameter 'deviceID' which takes the value returned by ISoundDeviceList::getDeviceID() and uses that device then. The list of devices in ISoundDeviceList usually also includes the default device which is the first entry and has an empty deviceID string ("") and the description "default device". There is some example code on how to use the ISoundDeviceList in Enumerating sound devices.
+Member Function Documentation
+ +
+
+
+
+
+
+
+| virtual ik_s32 irrklang::ISoundDeviceList::getDeviceCount | +( | ++ | ) | + [pure virtual] |
+
+
+
+Returns amount of enumerated devices in the list.
+ +
+
+
+
+
+
+
+| virtual const char* irrklang::ISoundDeviceList::getDeviceDescription | +( | +ik_s32 | +index | +) | + [pure virtual] |
+
+
+
+Returns description of the device.
+- Parameters:
-
+
+
+index Index of the device, a value between 0 and ISoundDeviceList::getDeviceCount()-1.
+
+
+
+
+
+
+| virtual const char* irrklang::ISoundDeviceList::getDeviceID | +( | +ik_s32 | +index | +) | + [pure virtual] |
+
+
+
+Returns the ID of the device. Use this string to identify this device in createIrrKlangDevice().
+- Parameters:
-
+
+
+index Index of the device, a value between 0 and ISoundDeviceList::getDeviceCount()-1.
+
- Returns:
- Returns a pointer to a string identifying the device. The string will only as long valid as long as the ISoundDeviceList exists.
The documentation for this class was generated from the following file: +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
+
+
+
+irrklang::ISoundEffectControl Member List
This is the complete list of members for irrklang::ISoundEffectControl, including all inherited members.| disableAllEffects()=0 | irrklang::ISoundEffectControl | [pure virtual] |
| disableChorusSoundEffect()=0 | irrklang::ISoundEffectControl | [pure virtual] |
| disableCompressorSoundEffect()=0 | irrklang::ISoundEffectControl | [pure virtual] |
| disableDistortionSoundEffect()=0 | irrklang::ISoundEffectControl | [pure virtual] |
| disableEchoSoundEffect()=0 | irrklang::ISoundEffectControl | [pure virtual] |
| disableFlangerSoundEffect()=0 | irrklang::ISoundEffectControl | [pure virtual] |
| disableGargleSoundEffect()=0 | irrklang::ISoundEffectControl | [pure virtual] |
| disableI3DL2ReverbSoundEffect()=0 | irrklang::ISoundEffectControl | [pure virtual] |
| disableParamEqSoundEffect()=0 | irrklang::ISoundEffectControl | [pure virtual] |
| disableWavesReverbSoundEffect()=0 | irrklang::ISoundEffectControl | [pure virtual] |
| enableChorusSoundEffect(ik_f32 fWetDryMix=50, ik_f32 fDepth=10, ik_f32 fFeedback=25, ik_f32 fFrequency=1.1, bool sinusWaveForm=true, ik_f32 fDelay=16, ik_s32 lPhase=90)=0 | irrklang::ISoundEffectControl | [pure virtual] |
| enableCompressorSoundEffect(ik_f32 fGain=0, ik_f32 fAttack=10, ik_f32 fRelease=200, ik_f32 fThreshold=-20, ik_f32 fRatio=3, ik_f32 fPredelay=4)=0 | irrklang::ISoundEffectControl | [pure virtual] |
| enableDistortionSoundEffect(ik_f32 fGain=-18, ik_f32 fEdge=15, ik_f32 fPostEQCenterFrequency=2400, ik_f32 fPostEQBandwidth=2400, ik_f32 fPreLowpassCutoff=8000)=0 | irrklang::ISoundEffectControl | [pure virtual] |
| enableEchoSoundEffect(ik_f32 fWetDryMix=50, ik_f32 fFeedback=50, ik_f32 fLeftDelay=500, ik_f32 fRightDelay=500, ik_s32 lPanDelay=0)=0 | irrklang::ISoundEffectControl | [pure virtual] |
| enableFlangerSoundEffect(ik_f32 fWetDryMix=50, ik_f32 fDepth=100, ik_f32 fFeedback=-50, ik_f32 fFrequency=0.25f, bool triangleWaveForm=true, ik_f32 fDelay=2, ik_s32 lPhase=0)=0 | irrklang::ISoundEffectControl | [pure virtual] |
| enableGargleSoundEffect(ik_s32 rateHz=20, bool sinusWaveForm=true)=0 | irrklang::ISoundEffectControl | [pure virtual] |
| enableI3DL2ReverbSoundEffect(ik_s32 lRoom=-1000, ik_s32 lRoomHF=-100, ik_f32 flRoomRolloffFactor=0, ik_f32 flDecayTime=1.49f, ik_f32 flDecayHFRatio=0.83f, ik_s32 lReflections=-2602, ik_f32 flReflectionsDelay=0.007f, ik_s32 lReverb=200, ik_f32 flReverbDelay=0.011f, ik_f32 flDiffusion=100.0f, ik_f32 flDensity=100.0f, ik_f32 flHFReference=5000.0f)=0 | irrklang::ISoundEffectControl | [pure virtual] |
| enableParamEqSoundEffect(ik_f32 fCenter=8000, ik_f32 fBandwidth=12, ik_f32 fGain=0)=0 | irrklang::ISoundEffectControl | [pure virtual] |
| enableWavesReverbSoundEffect(ik_f32 fInGain=0, ik_f32 fReverbMix=0, ik_f32 fReverbTime=1000, ik_f32 fHighFreqRTRatio=0.001f)=0 | irrklang::ISoundEffectControl | [pure virtual] |
| isChorusSoundEffectEnabled()=0 | irrklang::ISoundEffectControl | [pure virtual] |
| isCompressorSoundEffectEnabled()=0 | irrklang::ISoundEffectControl | [pure virtual] |
| isDistortionSoundEffectEnabled()=0 | irrklang::ISoundEffectControl | [pure virtual] |
| isEchoSoundEffectEnabled()=0 | irrklang::ISoundEffectControl | [pure virtual] |
| isFlangerSoundEffectEnabled()=0 | irrklang::ISoundEffectControl | [pure virtual] |
| isGargleSoundEffectEnabled()=0 | irrklang::ISoundEffectControl | [pure virtual] |
| isI3DL2ReverbSoundEffectEnabled()=0 | irrklang::ISoundEffectControl | [pure virtual] |
| isParamEqSoundEffectEnabled()=0 | irrklang::ISoundEffectControl | [pure virtual] |
| isWavesReverbSoundEffectEnabled()=0 | irrklang::ISoundEffectControl | [pure virtual] |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
The documentation for this class was generated from the following file: +
+
+
+
+
+irrklang::ISoundEffectControl Class Reference
+Interface to control the active sound effects (echo, reverb,...) of an ISound object, a playing sound. +More...
+ +#include <ik_ISoundEffectControl.h>
Public Member Functions | |
| virtual void | disableAllEffects ()=0 |
| Disables all active sound effects. | |
| virtual bool | enableChorusSoundEffect (ik_f32 fWetDryMix=50, ik_f32 fDepth=10, ik_f32 fFeedback=25, ik_f32 fFrequency=1.1, bool sinusWaveForm=true, ik_f32 fDelay=16, ik_s32 lPhase=90)=0 |
| Enables the chorus sound effect or adjusts its values. | |
| virtual void | disableChorusSoundEffect ()=0 |
| removes the sound effect from the sound | |
| virtual bool | isChorusSoundEffectEnabled ()=0 |
| returns if the sound effect is active on the sound | |
| virtual bool | enableCompressorSoundEffect (ik_f32 fGain=0, ik_f32 fAttack=10, ik_f32 fRelease=200, ik_f32 fThreshold=-20, ik_f32 fRatio=3, ik_f32 fPredelay=4)=0 |
| Enables the Compressor sound effect or adjusts its values. | |
| virtual void | disableCompressorSoundEffect ()=0 |
| removes the sound effect from the sound | |
| virtual bool | isCompressorSoundEffectEnabled ()=0 |
| returns if the sound effect is active on the sound | |
| virtual bool | enableDistortionSoundEffect (ik_f32 fGain=-18, ik_f32 fEdge=15, ik_f32 fPostEQCenterFrequency=2400, ik_f32 fPostEQBandwidth=2400, ik_f32 fPreLowpassCutoff=8000)=0 |
| Enables the Distortion sound effect or adjusts its values. | |
| virtual void | disableDistortionSoundEffect ()=0 |
| removes the sound effect from the sound | |
| virtual bool | isDistortionSoundEffectEnabled ()=0 |
| returns if the sound effect is active on the sound | |
| virtual bool | enableEchoSoundEffect (ik_f32 fWetDryMix=50, ik_f32 fFeedback=50, ik_f32 fLeftDelay=500, ik_f32 fRightDelay=500, ik_s32 lPanDelay=0)=0 |
| Enables the Echo sound effect or adjusts its values. | |
| virtual void | disableEchoSoundEffect ()=0 |
| removes the sound effect from the sound | |
| virtual bool | isEchoSoundEffectEnabled ()=0 |
| returns if the sound effect is active on the sound | |
| virtual bool | enableFlangerSoundEffect (ik_f32 fWetDryMix=50, ik_f32 fDepth=100, ik_f32 fFeedback=-50, ik_f32 fFrequency=0.25f, bool triangleWaveForm=true, ik_f32 fDelay=2, ik_s32 lPhase=0)=0 |
| Enables the Flanger sound effect or adjusts its values. | |
| virtual void | disableFlangerSoundEffect ()=0 |
| removes the sound effect from the sound | |
| virtual bool | isFlangerSoundEffectEnabled ()=0 |
| returns if the sound effect is active on the sound | |
| virtual bool | enableGargleSoundEffect (ik_s32 rateHz=20, bool sinusWaveForm=true)=0 |
| Enables the Gargle sound effect or adjusts its values. | |
| virtual void | disableGargleSoundEffect ()=0 |
| removes the sound effect from the sound | |
| virtual bool | isGargleSoundEffectEnabled ()=0 |
| returns if the sound effect is active on the sound | |
| virtual bool | enableI3DL2ReverbSoundEffect (ik_s32 lRoom=-1000, ik_s32 lRoomHF=-100, ik_f32 flRoomRolloffFactor=0, ik_f32 flDecayTime=1.49f, ik_f32 flDecayHFRatio=0.83f, ik_s32 lReflections=-2602, ik_f32 flReflectionsDelay=0.007f, ik_s32 lReverb=200, ik_f32 flReverbDelay=0.011f, ik_f32 flDiffusion=100.0f, ik_f32 flDensity=100.0f, ik_f32 flHFReference=5000.0f)=0 |
| Enables the Interactive 3D Level 2 reverb sound effect or adjusts its values. | |
| virtual void | disableI3DL2ReverbSoundEffect ()=0 |
| removes the sound effect from the sound | |
| virtual bool | isI3DL2ReverbSoundEffectEnabled ()=0 |
| returns if the sound effect is active on the sound | |
| virtual bool | enableParamEqSoundEffect (ik_f32 fCenter=8000, ik_f32 fBandwidth=12, ik_f32 fGain=0)=0 |
| Enables the ParamEq sound effect or adjusts its values. | |
| virtual void | disableParamEqSoundEffect ()=0 |
| removes the sound effect from the sound | |
| virtual bool | isParamEqSoundEffectEnabled ()=0 |
| returns if the sound effect is active on the sound | |
| virtual bool | enableWavesReverbSoundEffect (ik_f32 fInGain=0, ik_f32 fReverbMix=0, ik_f32 fReverbTime=1000, ik_f32 fHighFreqRTRatio=0.001f)=0 |
| Enables the Waves Reverb sound effect or adjusts its values. | |
| virtual void | disableWavesReverbSoundEffect ()=0 |
| removes the sound effect from the sound | |
| virtual bool | isWavesReverbSoundEffectEnabled ()=0 |
| returns if the sound effect is active on the sound | |
Detailed Description
+Interface to control the active sound effects (echo, reverb,...) of an ISound object, a playing sound.
+Sound effects such as chorus, distorsions, echo, reverb and similar can be controlled using this. An instance of this interface can be obtained via ISound::getSoundEffectControl(). The sound containing this interface has to be started via ISoundEngine::play2D() or ISoundEngine::play3D() with the flag enableSoundEffects=true, otherwise no acccess to this interface will be available. For the DirectSound driver, these are effects available since DirectSound8. For most effects, sounds should have a sample rate of 44 khz and should be at least 150 milli seconds long for optimal quality when using the DirectSound driver. Note that the interface pointer is only valid as long as the ISound pointer is valid. If the ISound pointer gets dropped (IVirtualRefCounted::drop()), the ISoundEffects may not be used any more.
+Member Function Documentation
+ +
+
+
+
+
+
+
+| virtual void irrklang::ISoundEffectControl::disableAllEffects | +( | ++ | ) | + [pure virtual] |
+
+
+
+Disables all active sound effects.
+ +
+
+
+
+
+
+
+| virtual void irrklang::ISoundEffectControl::disableChorusSoundEffect | +( | ++ | ) | + [pure virtual] |
+
+
+
+removes the sound effect from the sound
+ +
+
+
+
+
+
+
+| virtual void irrklang::ISoundEffectControl::disableCompressorSoundEffect | +( | ++ | ) | + [pure virtual] |
+
+
+
+removes the sound effect from the sound
+ +
+
+
+
+
+
+
+| virtual void irrklang::ISoundEffectControl::disableDistortionSoundEffect | +( | ++ | ) | + [pure virtual] |
+
+
+
+removes the sound effect from the sound
+ +
+
+
+
+
+
+
+| virtual void irrklang::ISoundEffectControl::disableEchoSoundEffect | +( | ++ | ) | + [pure virtual] |
+
+
+
+removes the sound effect from the sound
+ +
+
+
+
+
+
+
+| virtual void irrklang::ISoundEffectControl::disableFlangerSoundEffect | +( | ++ | ) | + [pure virtual] |
+
+
+
+removes the sound effect from the sound
+ +
+
+
+
+
+
+
+| virtual void irrklang::ISoundEffectControl::disableGargleSoundEffect | +( | ++ | ) | + [pure virtual] |
+
+
+
+removes the sound effect from the sound
+ +
+
+
+
+
+
+
+| virtual void irrklang::ISoundEffectControl::disableI3DL2ReverbSoundEffect | +( | ++ | ) | + [pure virtual] |
+
+
+
+removes the sound effect from the sound
+ +
+
+
+
+
+
+
+| virtual void irrklang::ISoundEffectControl::disableParamEqSoundEffect | +( | ++ | ) | + [pure virtual] |
+
+
+
+removes the sound effect from the sound
+ +
+
+
+
+
+
+
+| virtual void irrklang::ISoundEffectControl::disableWavesReverbSoundEffect | +( | ++ | ) | + [pure virtual] |
+
+
+
+removes the sound effect from the sound
+ +
+
+
+
+
+
+
+| virtual bool irrklang::ISoundEffectControl::enableChorusSoundEffect | +( | +ik_f32 | + fWetDryMix = 50, |
+ |
| + | + | ik_f32 | + fDepth = 10, |
+ |
| + | + | ik_f32 | + fFeedback = 25, |
+ |
| + | + | ik_f32 | + fFrequency = 1.1, |
+ |
| + | + | bool | + sinusWaveForm = true, |
+ |
| + | + | ik_f32 | + fDelay = 16, |
+ |
| + | + | ik_s32 | + lPhase = 90 | + |
| + | ) | + [pure virtual] |
+
+
+
+Enables the chorus sound effect or adjusts its values.
+Chorus is a voice-doubling effect created by echoing the original sound with a slight delay and slightly modulating the delay of the echo. If this sound effect is already enabled, calling this only modifies the parameters of the active effect.
+- Parameters:
-
+
+
+fWetDryMix Ratio of wet (processed) signal to dry (unprocessed) signal. Minimal Value:0, Maximal Value:100.0f; fDepth Percentage by which the delay time is modulated by the low-frequency oscillator, in hundredths of a percentage point. Minimal Value:0, Maximal Value:100.0f; fFeedback Percentage of output signal to feed back into the effect's input. Minimal Value:-99, Maximal Value:99.0f; fFrequency Frequency of the LFO. Minimal Value:0, Maximal Value:10.0f; sinusWaveForm True for sinus wave form, false for triangle. fDelay Number of milliseconds the input is delayed before it is played back. Minimal Value:0, Maximal Value:20.0f; lPhase Phase differential between left and right LFOs. Possible values: -180, -90, 0, 90, 180
+
- Returns:
- Returns true if successful.
+
+
+
+
+
+
+| virtual bool irrklang::ISoundEffectControl::enableCompressorSoundEffect | +( | +ik_f32 | + fGain = 0, |
+ |
| + | + | ik_f32 | + fAttack = 10, |
+ |
| + | + | ik_f32 | + fRelease = 200, |
+ |
| + | + | ik_f32 | + fThreshold = -20, |
+ |
| + | + | ik_f32 | + fRatio = 3, |
+ |
| + | + | ik_f32 | + fPredelay = 4 | + |
| + | ) | + [pure virtual] |
+
+
+
+Enables the Compressor sound effect or adjusts its values.
+Compressor is a reduction in the fluctuation of a signal above a certain amplitude. If this sound effect is already enabled, calling this only modifies the parameters of the active effect.
+- Parameters:
-
+
+
+fGain Output gain of signal after Compressor. Minimal Value:-60, Maximal Value:60.0f; fAttack Time before Compressor reaches its full value. Minimal Value:0.01, Maximal Value:500.0f; fRelease Speed at which Compressor is stopped after input drops below fThreshold. Minimal Value:50, Maximal Value:3000.0f; fThreshold Point at which Compressor begins, in decibels. Minimal Value:-60, Maximal Value:0.0f; fRatio Compressor ratio. Minimal Value:1, Maximal Value:100.0f; fPredelay Time after lThreshold is reached before attack phase is started, in milliseconds. Minimal Value:0, Maximal Value:4.0f;
+
- Returns:
- Returns true if successful.
+
+
+
+
+
+
+| virtual bool irrklang::ISoundEffectControl::enableDistortionSoundEffect | +( | +ik_f32 | + fGain = -18, |
+ |
| + | + | ik_f32 | + fEdge = 15, |
+ |
| + | + | ik_f32 | + fPostEQCenterFrequency = 2400, |
+ |
| + | + | ik_f32 | + fPostEQBandwidth = 2400, |
+ |
| + | + | ik_f32 | + fPreLowpassCutoff = 8000 | + |
| + | ) | + [pure virtual] |
+
+
+
+Enables the Distortion sound effect or adjusts its values.
+Distortion is achieved by adding harmonics to the signal in such a way that, If this sound effect is already enabled, calling this only modifies the parameters of the active effect. as the level increases, the top of the waveform becomes squared off or clipped.
+- Parameters:
-
+
+
+fGain Amount of signal change after distortion. Minimal Value:-60, Maximal Value:0; fEdge Percentage of distortion intensity. Minimal Value:0, Maximal Value:100; fPostEQCenterFrequency Center frequency of harmonic content addition. Minimal Value:100, Maximal Value:8000; fPostEQBandwidth Width of frequency band that determines range of harmonic content addition. Minimal Value:100, Maximal Value:8000; fPreLowpassCutoff Filter cutoff for high-frequency harmonics attenuation. Minimal Value:100, Maximal Value:8000;
+
- Returns:
- Returns true if successful.
+
+
+
+
+
+
+| virtual bool irrklang::ISoundEffectControl::enableEchoSoundEffect | +( | +ik_f32 | + fWetDryMix = 50, |
+ |
| + | + | ik_f32 | + fFeedback = 50, |
+ |
| + | + | ik_f32 | + fLeftDelay = 500, |
+ |
| + | + | ik_f32 | + fRightDelay = 500, |
+ |
| + | + | ik_s32 | + lPanDelay = 0 | + |
| + | ) | + [pure virtual] |
+
+
+
+Enables the Echo sound effect or adjusts its values.
+An echo effect causes an entire sound to be repeated after a fixed delay. If this sound effect is already enabled, calling this only modifies the parameters of the active effect.
+- Parameters:
-
+
+
+fWetDryMix Ratio of wet (processed) signal to dry (unprocessed) signal. Minimal Value:0, Maximal Value:100.0f; fFeedback Percentage of output fed back into input. Minimal Value:0, Maximal Value:100.0f; fLeftDelay Delay for left channel, in milliseconds. Minimal Value:1, Maximal Value:2000.0f; fRightDelay Delay for right channel, in milliseconds. Minimal Value:1, Maximal Value:2000.0f; lPanDelay Value that specifies whether to swap left and right delays with each successive echo. Minimal Value:0, Maximal Value:1;
+
- Returns:
- Returns true if successful.
+
+
+
+
+
+
+| virtual bool irrklang::ISoundEffectControl::enableFlangerSoundEffect | +( | +ik_f32 | + fWetDryMix = 50, |
+ |
| + | + | ik_f32 | + fDepth = 100, |
+ |
| + | + | ik_f32 | + fFeedback = -50, |
+ |
| + | + | ik_f32 | + fFrequency = 0.25f, |
+ |
| + | + | bool | + triangleWaveForm = true, |
+ |
| + | + | ik_f32 | + fDelay = 2, |
+ |
| + | + | ik_s32 | + lPhase = 0 | + |
| + | ) | + [pure virtual] |
+
+
+
+Enables the Flanger sound effect or adjusts its values.
+Flange is an echo effect in which the delay between the original signal and its echo is very short and varies over time. The result is sometimes referred to as a sweeping sound. The term flange originated with the practice of grabbing the flanges of a tape reel to change the speed. If this sound effect is already enabled, calling this only modifies the parameters of the active effect.
+- Parameters:
-
+
+
+fWetDryMix Ratio of wet (processed) signal to dry (unprocessed) signal. Minimal Value:0, Maximal Value:100.0f; fDepth Percentage by which the delay time is modulated by the low-frequency oscillator, in hundredths of a percentage point. Minimal Value:0, Maximal Value:100.0f; fFeedback Percentage of output signal to feed back into the effect's input. Minimal Value:-99, Maximal Value:99.0f; fFrequency Frequency of the LFO. Minimal Value:0, Maximal Value:10.0f; triangleWaveForm True for triangle wave form, false for square. fDelay Number of milliseconds the input is delayed before it is played back. Minimal Value:0, Maximal Value:20.0f; lPhase Phase differential between left and right LFOs. Possible values: -180, -90, 0, 90, 180
+
- Returns:
- Returns true if successful.
+
+
+
+
+
+
+| virtual bool irrklang::ISoundEffectControl::enableGargleSoundEffect | +( | +ik_s32 | + rateHz = 20, |
+ |
| + | + | bool | + sinusWaveForm = true | + |
| + | ) | + [pure virtual] |
+
+
+
+Enables the Gargle sound effect or adjusts its values.
+The gargle effect modulates the amplitude of the signal. If this sound effect is already enabled, calling this only modifies the parameters of the active effect.
+- Parameters:
-
+
+
+rateHz Rate of modulation, in Hertz. Minimal Value:1, Maximal Value:1000 sinusWaveForm True for sinus wave form, false for triangle.
+
- Returns:
- Returns true if successful.
+
+
+
+
+
+
+| virtual bool irrklang::ISoundEffectControl::enableI3DL2ReverbSoundEffect | +( | +ik_s32 | + lRoom = -1000, |
+ |
| + | + | ik_s32 | + lRoomHF = -100, |
+ |
| + | + | ik_f32 | + flRoomRolloffFactor = 0, |
+ |
| + | + | ik_f32 | + flDecayTime = 1.49f, |
+ |
| + | + | ik_f32 | + flDecayHFRatio = 0.83f, |
+ |
| + | + | ik_s32 | + lReflections = -2602, |
+ |
| + | + | ik_f32 | + flReflectionsDelay = 0.007f, |
+ |
| + | + | ik_s32 | + lReverb = 200, |
+ |
| + | + | ik_f32 | + flReverbDelay = 0.011f, |
+ |
| + | + | ik_f32 | + flDiffusion = 100.0f, |
+ |
| + | + | ik_f32 | + flDensity = 100.0f, |
+ |
| + | + | ik_f32 | + flHFReference = 5000.0f | + |
| + | ) | + [pure virtual] |
+
+
+
+Enables the Interactive 3D Level 2 reverb sound effect or adjusts its values.
+An implementation of the listener properties in the I3DL2 specification. Source properties are not supported. If this sound effect is already enabled, calling this only modifies the parameters of the active effect.
+- Parameters:
-
+
+
+lRoom Attenuation of the room effect, in millibels (mB). Interval: [-10000, 0] Default: -1000 mB lRoomHF Attenuation of the room high-frequency effect. Interval: [-10000, 0] default: 0 mB flRoomRolloffFactor Rolloff factor for the reflected signals. Interval: [0.0, 10.0] default: 0.0 flDecayTime Decay time, in seconds. Interval: [0.1, 20.0] default: 1.49s flDecayHFRatio Ratio of the decay time at high frequencies to the decay time at low frequencies. Interval: [0.1, 2.0] default: 0.83 lReflections Attenuation of early reflections relative to lRoom. Interval: [-10000, 1000] default: -2602 mB flReflectionsDelay Delay time of the first reflection relative to the direct path in seconds. Interval: [0.0, 0.3] default: 0.007 s lReverb Attenuation of late reverberation relative to lRoom, in mB. Interval: [-10000, 2000] default: 200 mB flReverbDelay Time limit between the early reflections and the late reverberation relative to the time of the first reflection. Interval: [0.0, 0.1] default: 0.011 s flDiffusion Echo density in the late reverberation decay in percent. Interval: [0.0, 100.0] default: 100.0 % flDensity Modal density in the late reverberation decay, in percent. Interval: [0.0, 100.0] default: 100.0 % flHFReference Reference high frequency, in hertz. Interval: [20.0, 20000.0] default: 5000.0 Hz
+
- Returns:
- Returns true if successful.
+
+
+
+
+
+
+| virtual bool irrklang::ISoundEffectControl::enableParamEqSoundEffect | +( | +ik_f32 | + fCenter = 8000, |
+ |
| + | + | ik_f32 | + fBandwidth = 12, |
+ |
| + | + | ik_f32 | + fGain = 0 | + |
| + | ) | + [pure virtual] |
+
+
+
+Enables the ParamEq sound effect or adjusts its values.
+Parametric equalizer amplifies or attenuates signals of a given frequency. If this sound effect is already enabled, calling this only modifies the parameters of the active effect.
+- Parameters:
-
+
+
+fCenter Center frequency, in hertz, The default value is 8000. Minimal Value:80, Maximal Value:16000.0f fBandwidth Bandwidth, in semitones, The default value is 12. Minimal Value:1.0f, Maximal Value:36.0f fGain Gain, default value is 0. Minimal Value:-15.0f, Maximal Value:15.0f
+
- Returns:
- Returns true if successful.
+
+
+
+
+
+
+| virtual bool irrklang::ISoundEffectControl::enableWavesReverbSoundEffect | +( | +ik_f32 | + fInGain = 0, |
+ |
| + | + | ik_f32 | + fReverbMix = 0, |
+ |
| + | + | ik_f32 | + fReverbTime = 1000, |
+ |
| + | + | ik_f32 | + fHighFreqRTRatio = 0.001f | + |
| + | ) | + [pure virtual] |
+
+
+
+Enables the Waves Reverb sound effect or adjusts its values.
+- Parameters:
-
+
+
+fInGain Input gain of signal, in decibels (dB). Min/Max: [-96.0,0.0] Default: 0.0 dB. If this sound effect is already enabled, calling this only modifies the parameters of the active effect. fReverbMix Reverb mix, in dB. Min/Max: [-96.0,0.0] Default: 0.0 dB fReverbTime Reverb time, in milliseconds. Min/Max: [0.001,3000.0] Default: 1000.0 ms fHighFreqRTRatio High-frequency reverb time ratio. Min/Max: [0.001,0.999] Default: 0.001
+
- Returns:
- Returns true if successful.
+
+
+
+
+
+
+| virtual bool irrklang::ISoundEffectControl::isChorusSoundEffectEnabled | +( | ++ | ) | + [pure virtual] |
+
+
+
+returns if the sound effect is active on the sound
+ +
+
+
+
+
+
+
+| virtual bool irrklang::ISoundEffectControl::isCompressorSoundEffectEnabled | +( | ++ | ) | + [pure virtual] |
+
+
+
+returns if the sound effect is active on the sound
+ +
+
+
+
+
+
+
+| virtual bool irrklang::ISoundEffectControl::isDistortionSoundEffectEnabled | +( | ++ | ) | + [pure virtual] |
+
+
+
+returns if the sound effect is active on the sound
+ +
+
+
+
+
+
+
+| virtual bool irrklang::ISoundEffectControl::isEchoSoundEffectEnabled | +( | ++ | ) | + [pure virtual] |
+
+
+
+returns if the sound effect is active on the sound
+ +
+
+
+
+
+
+
+| virtual bool irrklang::ISoundEffectControl::isFlangerSoundEffectEnabled | +( | ++ | ) | + [pure virtual] |
+
+
+
+returns if the sound effect is active on the sound
+ +
+
+
+
+
+
+
+| virtual bool irrklang::ISoundEffectControl::isGargleSoundEffectEnabled | +( | ++ | ) | + [pure virtual] |
+
+
+
+returns if the sound effect is active on the sound
+ +
+
+
+
+
+
+
+| virtual bool irrklang::ISoundEffectControl::isI3DL2ReverbSoundEffectEnabled | +( | ++ | ) | + [pure virtual] |
+
+
+
+returns if the sound effect is active on the sound
+ +
+
+
+
+
+
+
+| virtual bool irrklang::ISoundEffectControl::isParamEqSoundEffectEnabled | +( | ++ | ) | + [pure virtual] |
+
+
+
+returns if the sound effect is active on the sound
+ +
+
+
+
+
+
+| virtual bool irrklang::ISoundEffectControl::isWavesReverbSoundEffectEnabled | +( | ++ | ) | + [pure virtual] |
+
+
+
+returns if the sound effect is active on the sound
+ +The documentation for this class was generated from the following file: +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
+
+
+
+irrklang::ISoundEngine Member List
This is the complete list of members for irrklang::ISoundEngine, including all inherited members.| addFileFactory(IFileFactory *fileFactory)=0 | irrklang::ISoundEngine | [pure virtual] |
| addSoundSourceAlias(ISoundSource *baseSource, const ik_c8 *soundName)=0 | irrklang::ISoundEngine | [pure virtual] |
| addSoundSourceFromFile(const ik_c8 *fileName, E_STREAM_MODE mode=ESM_AUTO_DETECT, bool preload=false)=0 | irrklang::ISoundEngine | [pure virtual] |
| addSoundSourceFromMemory(void *memory, ik_s32 sizeInBytes, const ik_c8 *soundName, bool copyMemory=true)=0 | irrklang::ISoundEngine | [pure virtual] |
| addSoundSourceFromPCMData(void *memory, ik_s32 sizeInBytes, const ik_c8 *soundName, SAudioStreamFormat format, bool copyMemory=true)=0 | irrklang::ISoundEngine | [pure virtual] |
| drop() | irrklang::IRefCounted | [inline] |
| getDefault3DSoundMaxDistance()=0 | irrklang::ISoundEngine | [pure virtual] |
| getDefault3DSoundMinDistance()=0 | irrklang::ISoundEngine | [pure virtual] |
| getDriverName()=0 | irrklang::ISoundEngine | [pure virtual] |
| getInternalAudioInterface()=0 | irrklang::ISoundEngine | [pure virtual] |
| getSoundSource(const ik_c8 *soundName, bool addIfNotFound=true)=0 | irrklang::ISoundEngine | [pure virtual] |
| getSoundSource(ik_s32 index)=0 | irrklang::ISoundEngine | [pure virtual] |
| getSoundSourceCount()=0 | irrklang::ISoundEngine | [pure virtual] |
| getSoundVolume()=0 | irrklang::ISoundEngine | [pure virtual] |
| grab() | irrklang::IRefCounted | [inline] |
| IRefCounted() | irrklang::IRefCounted | [inline] |
| isCurrentlyPlaying(const char *soundName)=0 | irrklang::ISoundEngine | [pure virtual] |
| isCurrentlyPlaying(ISoundSource *source)=0 | irrklang::ISoundEngine | [pure virtual] |
| isMultiThreaded() const =0 | irrklang::ISoundEngine | [pure virtual] |
| loadPlugins(const ik_c8 *path)=0 | irrklang::ISoundEngine | [pure virtual] |
| play2D(const char *soundFileName, bool playLooped=false, bool startPaused=false, bool track=false, E_STREAM_MODE streamMode=ESM_AUTO_DETECT, bool enableSoundEffects=false)=0 | irrklang::ISoundEngine | [pure virtual] |
| play2D(ISoundSource *source, bool playLooped=false, bool startPaused=false, bool track=false, bool enableSoundEffects=false)=0 | irrklang::ISoundEngine | [pure virtual] |
| play3D(const char *soundFileName, vec3df pos, bool playLooped=false, bool startPaused=false, bool track=false, E_STREAM_MODE streamMode=ESM_AUTO_DETECT, bool enableSoundEffects=false)=0 | irrklang::ISoundEngine | [pure virtual] |
| play3D(ISoundSource *source, vec3df pos, bool playLooped=false, bool startPaused=false, bool track=false, bool enableSoundEffects=false)=0 | irrklang::ISoundEngine | [pure virtual] |
| registerAudioStreamLoader(IAudioStreamLoader *loader)=0 | irrklang::ISoundEngine | [pure virtual] |
| removeAllSoundSources()=0 | irrklang::ISoundEngine | [pure virtual] |
| removeSoundSource(ISoundSource *source)=0 | irrklang::ISoundEngine | [pure virtual] |
| removeSoundSource(const ik_c8 *name)=0 | irrklang::ISoundEngine | [pure virtual] |
| setAllSoundsPaused(bool bPaused=true)=0 | irrklang::ISoundEngine | [pure virtual] |
| setDefault3DSoundMaxDistance(ik_f32 maxDistance)=0 | irrklang::ISoundEngine | [pure virtual] |
| setDefault3DSoundMinDistance(ik_f32 minDistance)=0 | irrklang::ISoundEngine | [pure virtual] |
| setDopplerEffectParameters(ik_f32 dopplerFactor=1.0f, ik_f32 distanceFactor=1.0f)=0 | irrklang::ISoundEngine | [pure virtual] |
| setListenerPosition(const vec3df &pos, const vec3df &lookdir, const vec3df &velPerSecond=vec3df(0, 0, 0), const vec3df &upVector=vec3df(0, 1, 0))=0 | irrklang::ISoundEngine | [pure virtual] |
| setMixedDataOutputReceiver(ISoundMixedOutputReceiver *receiver)=0 | irrklang::ISoundEngine | [pure virtual] |
| setRolloffFactor(ik_f32 rolloff)=0 | irrklang::ISoundEngine | [pure virtual] |
| setSoundVolume(ik_f32 volume)=0 | irrklang::ISoundEngine | [pure virtual] |
| stopAllSounds()=0 | irrklang::ISoundEngine | [pure virtual] |
| stopAllSoundsOfSoundSource(ISoundSource *source)=0 | irrklang::ISoundEngine | [pure virtual] |
| update()=0 | irrklang::ISoundEngine | [pure virtual] |
| ~IRefCounted() | irrklang::IRefCounted | [inline, virtual] |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
The documentation for this class was generated from the following file: +
+
+
+
+
+irrklang::ISoundEngine Class Reference
+Interface to the sound engine, for playing 3d and 2d sound and music. +More...
+ +#include <ik_ISoundEngine.h>
+Inheritance diagram for irrklang::ISoundEngine:
+
+
+
+
+
+ 
+
+
+
+
+ Public Member Functions | |
| virtual const char * | getDriverName ()=0 |
| returns the name of the sound driver, like 'ALSA' for the alsa device | |
| virtual ISound * | play2D (const char *soundFileName, bool playLooped=false, bool startPaused=false, bool track=false, E_STREAM_MODE streamMode=ESM_AUTO_DETECT, bool enableSoundEffects=false)=0 |
| loads a sound source (if not loaded already) from a file and plays it. | |
| virtual ISound * | play2D (ISoundSource *source, bool playLooped=false, bool startPaused=false, bool track=false, bool enableSoundEffects=false)=0 |
| Plays a sound source as 2D sound with its default settings stored in ISoundSource. | |
| virtual ISound * | play3D (const char *soundFileName, vec3df pos, bool playLooped=false, bool startPaused=false, bool track=false, E_STREAM_MODE streamMode=ESM_AUTO_DETECT, bool enableSoundEffects=false)=0 |
| Loads a sound source (if not loaded already) from a file and plays it as 3D sound. | |
| virtual ISound * | play3D (ISoundSource *source, vec3df pos, bool playLooped=false, bool startPaused=false, bool track=false, bool enableSoundEffects=false)=0 |
| Plays a sound source as 3D sound with its default settings stored in ISoundSource. | |
| virtual void | stopAllSounds ()=0 |
| Stops all currently playing sounds. | |
| virtual void | setAllSoundsPaused (bool bPaused=true)=0 |
| Pauses or unpauses all currently playing sounds. | |
| virtual ISoundSource * | getSoundSource (const ik_c8 *soundName, bool addIfNotFound=true)=0 |
| Gets a sound source by sound name. Adds the sound source as file into the sound engine if not loaded already. | |
| virtual ISoundSource * | getSoundSource (ik_s32 index)=0 |
| Returns a sound source by index. | |
| virtual ik_s32 | getSoundSourceCount ()=0 |
| Returns amount of loaded sound sources. | |
| virtual ISoundSource * | addSoundSourceFromFile (const ik_c8 *fileName, E_STREAM_MODE mode=ESM_AUTO_DETECT, bool preload=false)=0 |
| Adds sound source into the sound engine as file. | |
| virtual ISoundSource * | addSoundSourceFromMemory (void *memory, ik_s32 sizeInBytes, const ik_c8 *soundName, bool copyMemory=true)=0 |
| Adds a sound source into the sound engine as memory source. | |
| virtual ISoundSource * | addSoundSourceFromPCMData (void *memory, ik_s32 sizeInBytes, const ik_c8 *soundName, SAudioStreamFormat format, bool copyMemory=true)=0 |
| Adds a sound source into the sound engine from plain PCM data in memory. | |
| virtual ISoundSource * | addSoundSourceAlias (ISoundSource *baseSource, const ik_c8 *soundName)=0 |
| Adds a sound source as alias for an existing sound source, but with a different name or optional different default settings. | |
| virtual void | removeSoundSource (ISoundSource *source)=0 |
| Removes a sound source from the engine, freeing the memory it occupies. | |
| virtual void | removeSoundSource (const ik_c8 *name)=0 |
| Removes a sound source from the engine, freeing the memory it occupies. | |
| virtual void | removeAllSoundSources ()=0 |
| Removes all sound sources from the engine. | |
| virtual void | setSoundVolume (ik_f32 volume)=0 |
| Sets master sound volume. This value is multiplied with all sounds played. | |
| virtual ik_f32 | getSoundVolume ()=0 |
| Returns master sound volume. | |
| virtual void | setListenerPosition (const vec3df &pos, const vec3df &lookdir, const vec3df &velPerSecond=vec3df(0, 0, 0), const vec3df &upVector=vec3df(0, 1, 0))=0 |
| Sets the current listener 3d position. | |
| virtual void | update ()=0 |
| Updates the audio engine. This should be called several times per frame if irrKlang was started in single thread mode. | |
| virtual bool | isCurrentlyPlaying (const char *soundName)=0 |
| Returns if a sound with the specified name is currently playing. | |
| virtual bool | isCurrentlyPlaying (ISoundSource *source)=0 |
| Returns if a sound with the specified source is currently playing. | |
| virtual void | stopAllSoundsOfSoundSource (ISoundSource *source)=0 |
| Stops all sounds of a specific sound source. | |
| virtual void | registerAudioStreamLoader (IAudioStreamLoader *loader)=0 |
| Registers a new audio stream loader in the sound engine. | |
| virtual bool | isMultiThreaded () const =0 |
| Returns if irrKlang is running in the same thread as the application or is using multithreading. | |
| virtual void | addFileFactory (IFileFactory *fileFactory)=0 |
| Adds a file factory to the sound engine, making it possible to override file access of the sound engine. | |
| virtual void | setDefault3DSoundMinDistance (ik_f32 minDistance)=0 |
| Sets the default minimal distance for 3D sounds. | |
| virtual ik_f32 | getDefault3DSoundMinDistance ()=0 |
| Returns the default minimal distance for 3D sounds. | |
| virtual void | setDefault3DSoundMaxDistance (ik_f32 maxDistance)=0 |
| Sets the default maximal distance for 3D sounds. | |
| virtual ik_f32 | getDefault3DSoundMaxDistance ()=0 |
| Returns the default maximal distance for 3D sounds. | |
| virtual void | setRolloffFactor (ik_f32 rolloff)=0 |
| Sets a rolloff factor which influences the amount of attenuation that is applied to 3D sounds. | |
| virtual void | setDopplerEffectParameters (ik_f32 dopplerFactor=1.0f, ik_f32 distanceFactor=1.0f)=0 |
| Sets parameters affecting the doppler effect. | |
| virtual bool | loadPlugins (const ik_c8 *path)=0 |
| Loads irrKlang plugins from a custom path. | |
| virtual const +SInternalAudioInterface & | getInternalAudioInterface ()=0 |
| Returns a pointer to internal sound engine pointers, like the DirectSound interface. | |
| virtual bool | setMixedDataOutputReceiver (ISoundMixedOutputReceiver *receiver)=0 |
| Sets the OutputMixedDataReceiver, so you can receive the pure mixed output audio data while it is being played. | |
Detailed Description
+Interface to the sound engine, for playing 3d and 2d sound and music.
+This is the main interface of irrKlang. You usually would create this using the createIrrKlangDevice() function.
+Member Function Documentation
+ +
+
+
+
+
+
+
+| virtual void irrklang::ISoundEngine::addFileFactory | +( | +IFileFactory * | +fileFactory | +) | + [pure virtual] |
+
+
+
+Adds a file factory to the sound engine, making it possible to override file access of the sound engine.
+Derive your own class from IFileFactory, overwrite the createFileReader() method and return your own implemented IFileReader to overwrite file access of irrKlang.
+ +
+
+
+
+
+
+
+| virtual ISoundSource* irrklang::ISoundEngine::addSoundSourceAlias | +( | +ISoundSource * | +baseSource, | +|
| + | + | const ik_c8 * | +soundName | + |
| + | ) | + [pure virtual] |
+
+
+
+Adds a sound source as alias for an existing sound source, but with a different name or optional different default settings.
+This is useful if you want to play multiple sounds but each sound isn't necessarily one single file. Also useful if you want to or play the same sound using different names, volumes or min and max 3D distances.
+- Parameters:
-
+
+
+baseSource The sound source where this sound source should be based on. This sound source will use the baseSource as base to access the file and similar, but it will have its own name and its own default settings. soundName Name of the new sound source to be added.
+
- Returns:
- Returns the pointer to the added sound source or 0 if not sucessful because for example a sound already existed with that name. If not successful, the reason will be printed into the log.
+
+
+
+
+
+
+| virtual ISoundSource* irrklang::ISoundEngine::addSoundSourceFromFile | +( | +const ik_c8 * | +fileName, | +|
| + | + | E_STREAM_MODE | + mode = ESM_AUTO_DETECT, |
+ |
| + | + | bool | + preload = false | + |
| + | ) | + [pure virtual] |
+
+
+
+Adds sound source into the sound engine as file.
+- Parameters:
-
+
+
+fileName Name of the sound file (e.g. "sounds/something.mp3"). You can also use this name when calling play3D() or play2D(). mode Streaming mode for this sound source preload If this flag is set to false (which is default) the sound engine will not try to load the sound file when calling this method, but only when play() is called with this sound source as parameter. Otherwise the sound will be preloaded.
+
- Returns:
- Returns the pointer to the added sound source or 0 if not sucessful because for example a sound already existed with that name. If not successful, the reason will be printed into the log. Note: Don't call drop() to this pointer, it will be managed by irrKlang and exist as long as you don't delete irrKlang or call removeSoundSource(). However, you are free to call grab() if you want and drop() it then later of course.
+
+
+
+
+
+
+| virtual ISoundSource* irrklang::ISoundEngine::addSoundSourceFromMemory | +( | +void * | +memory, | +|
| + | + | ik_s32 | +sizeInBytes, | +|
| + | + | const ik_c8 * | +soundName, | +|
| + | + | bool | + copyMemory = true | + |
| + | ) | + [pure virtual] |
+
+
+
+Adds a sound source into the sound engine as memory source.
+Note: This method only accepts a file (.wav, .ogg, etc) which is totally loaded into memory. If you want to add a sound source from decoded plain PCM data in memory, use addSoundSourceFromPCMData() instead.
+- Parameters:
-
+
+
+memory Pointer to the memory to be treated as loaded sound file. sizeInBytes Size of the memory chunk, in bytes. soundName Name of the virtual sound file (e.g. "sounds/something.mp3"). You can also use this name when calling play3D() or play2D(). Hint: If you include the extension of the original file like .ogg, .mp3 or .wav at the end of the filename, irrKlang will be able to decide better what file format it is and might be able to start playback faster. copyMemory If set to true which is default, the memory block is copied and stored in the engine, after calling addSoundSourceFromMemory() the memory pointer can be deleted savely. If set to false, the memory is not copied and the user takes the responsibility that the memory block pointed to remains there as long as the sound engine or at least this sound source exists.
+
- Returns:
- Returns the pointer to the added sound source or 0 if not sucessful because for example a sound already existed with that name. If not successful, the reason will be printed into the log. Note: Don't call drop() to this pointer, it will be managed by irrKlang and exist as long as you don't delete irrKlang or call removeSoundSource(). However, you are free to call grab() if you want and drop() it then later of course.
+
+
+
+
+
+
+| virtual ISoundSource* irrklang::ISoundEngine::addSoundSourceFromPCMData | +( | +void * | +memory, | +|
| + | + | ik_s32 | +sizeInBytes, | +|
| + | + | const ik_c8 * | +soundName, | +|
| + | + | SAudioStreamFormat | +format, | +|
| + | + | bool | + copyMemory = true | + |
| + | ) | + [pure virtual] |
+
+
+
+Adds a sound source into the sound engine from plain PCM data in memory.
+- Parameters:
-
+
+
+memory Pointer to the memory to be treated as loaded sound file. sizeInBytes Size of the memory chunk, in bytes. soundName Name of the virtual sound file (e.g. "sounds/something.mp3"). You can also use this name when calling play3D() or play2D(). copyMemory If set to true which is default, the memory block is copied and stored in the engine, after calling addSoundSourceFromPCMData() the memory pointer can be deleted savely. If set to true, the memory is not copied and the user takes the responsibility that the memory block pointed to remains there as long as the sound engine or at least this sound source exists.
+
- Returns:
- Returns the pointer to the added sound source or 0 if not sucessful because for example a sound already existed with that name. If not successful, the reason will be printed into the log.
+
+
+
+
+
+
+| virtual ik_f32 irrklang::ISoundEngine::getDefault3DSoundMaxDistance | +( | ++ | ) | + [pure virtual] |
+
+
+
+Returns the default maximal distance for 3D sounds.
+This value influences how loud a sound is heard based on its distance. You can change it using setDefault3DSoundmaxDistance(), but changing this value is usually not necessary. This value causes the sound to stop attenuating after it reaches the max distance. Most people think that this sets the volume of the sound to 0 after this distance, but this is not true. Only change the minimal distance (using for example setDefault3DSoundMinDistance()) to influence this. See ISound::setMaxDistance() for details about what the max distance is. It is also possible to influence this default value for every sound file using ISoundSource::setDefaultMaxDistance().
+- Returns:
- Default maximal distance for 3d sounds. The default value is 1000000000.0f.
+
+
+
+
+
+
+| virtual ik_f32 irrklang::ISoundEngine::getDefault3DSoundMinDistance | +( | ++ | ) | + [pure virtual] |
+
+
+
+Returns the default minimal distance for 3D sounds.
+This value influences how loud a sound is heard based on its distance. You can change it using setDefault3DSoundMinDistance(). See ISound::setMinDistance() for details about what the min distance is. It is also possible to influence this default value for every sound file using ISoundSource::setDefaultMinDistance().
+- Returns:
- Default minimal distance for 3d sounds. The default value is 1.0f.
+
+
+
+
+
+
+| virtual const char* irrklang::ISoundEngine::getDriverName | +( | ++ | ) | + [pure virtual] |
+
+
+
+returns the name of the sound driver, like 'ALSA' for the alsa device
+Possible returned strings are "NULL", "ALSA", "CoreAudio", "winMM", "DirectSound" and "DirectSound8".
+ +
+
+
+
+
+
+
+| virtual const SInternalAudioInterface& irrklang::ISoundEngine::getInternalAudioInterface | +( | ++ | ) | + [pure virtual] |
+
+
+
+Returns a pointer to internal sound engine pointers, like the DirectSound interface.
+Use this with caution. This is only exposed to make it possible for other libraries such as Video playback packages to extend or use the sound driver irrklang uses.
+ +
+
+
+
+
+
+
+| virtual ISoundSource* irrklang::ISoundEngine::getSoundSource | +( | +ik_s32 | +index | +) | + [pure virtual] |
+
+
+
+Returns a sound source by index.
+- Parameters:
-
+
+
+idx,: Index of the loaded sound source, must by smaller than getSoundSourceCount().
+
- Returns:
- Returns the sound source or 0 if not available. Note: Don't call drop() to this pointer, it will be managed by irrKlang and exist as long as you don't delete irrKlang or call removeSoundSource(). However, you are free to call grab() if you want and drop() it then later of course.
+
+
+
+
+
+
+| virtual ISoundSource* irrklang::ISoundEngine::getSoundSource | +( | +const ik_c8 * | +soundName, | +|
| + | + | bool | + addIfNotFound = true | + |
| + | ) | + [pure virtual] |
+
+
+
+Gets a sound source by sound name. Adds the sound source as file into the sound engine if not loaded already.
+Please note: For performance reasons most ISoundEngine implementations will not try to load the sound when calling this method, but only when play() is called with this sound source as parameter.
+- Parameters:
-
+
+
+addIfNotFound if 'true' adds the sound source to the list and returns the interface to it if it cannot be found in the sound source list. If 'false', returns 0 if the sound source is not in the list and does not modify the list. Default value: true.
+
- Returns:
- Returns the sound source or 0 if not available. Note: Don't call drop() to this pointer, it will be managed by irrKlang and exist as long as you don't delete irrKlang or call removeSoundSource(). However, you are free to call grab() if you want and drop() it then later of course.
+
+
+
+
+
+
+| virtual ik_s32 irrklang::ISoundEngine::getSoundSourceCount | +( | ++ | ) | + [pure virtual] |
+
+
+
+Returns amount of loaded sound sources.
+ +
+
+
+
+
+
+
+| virtual ik_f32 irrklang::ISoundEngine::getSoundVolume | +( | ++ | ) | + [pure virtual] |
+
+
+
+Returns master sound volume.
+ +
+
+
+
+
+
+
+| virtual bool irrklang::ISoundEngine::isCurrentlyPlaying | +( | +ISoundSource * | +source | +) | + [pure virtual] |
+
+
+
+Returns if a sound with the specified source is currently playing.
+ +
+
+
+
+
+
+
+| virtual bool irrklang::ISoundEngine::isCurrentlyPlaying | +( | +const char * | +soundName | +) | + [pure virtual] |
+
+
+
+Returns if a sound with the specified name is currently playing.
+ +
+
+
+
+
+
+
+| virtual bool irrklang::ISoundEngine::isMultiThreaded | +( | ++ | ) | + const [pure virtual] |
+
+
+
+Returns if irrKlang is running in the same thread as the application or is using multithreading.
+This basicly returns the flag set by the user when creating the sound engine.
+ +
+
+
+
+
+
+
+| virtual bool irrklang::ISoundEngine::loadPlugins | +( | +const ik_c8 * | +path | +) | + [pure virtual] |
+
+
+
+Loads irrKlang plugins from a custom path.
+Plugins usually are .dll, .so or .dylib files named for example ikpMP3.dll (= short for irrKlangPluginMP3) which make it possible to play back mp3 files. Plugins are being loaded from the current working directory at startup of the sound engine if the parameter ESEO_LOAD_PLUGINS is set (which it is by default), but using this method, it is possible to load plugins from a custom path in addition.
+- Parameters:
-
+
+
+path Path to the plugin directory, like "C:\games\somegamegame\irrklangplugins".
+
- Returns:
- returns true if sucessful or fals if not, for example because the path could not be found.
+
+
+
+
+
+
+| virtual ISound* irrklang::ISoundEngine::play2D | +( | +ISoundSource * | +source, | +|
| + | + | bool | + playLooped = false, |
+ |
| + | + | bool | + startPaused = false, |
+ |
| + | + | bool | + track = false, |
+ |
| + | + | bool | + enableSoundEffects = false | + |
| + | ) | + [pure virtual] |
+
+
+
+Plays a sound source as 2D sound with its default settings stored in ISoundSource.
+An ISoundSource object will be created internally when playing a sound the first time, or can be added with getSoundSource().
+- Parameters:
-
+
+
+source The sound source, specifiying sound file source and default settings for this file. Use the other ISoundEngine::play2D() overloads if you want to specify a filename string instead of this. playLooped plays the sound in loop mode. If set to 'false', the sound is played once, then stopped and deleted from the internal playing list. Calls to ISound have no effect after such a non looped sound has been stopped automaticly. startPaused starts the sound paused. This implies that track=true. Use this if you want to modify some of the playing parameters before the sound actually plays. Usually you would set this parameter to true, then use the ISound interface to modify some of the sound parameters and then call ISound::setPaused(false); Note: You need to call ISound::drop() when setting this parameter to true and you don't need the ISound object anymore. See 'return' for details. track Makes it possible to track the sound. Causes the method to return an ISound interface. See 'return' for details. enableSoundEffects Makes it possible to use sound effects such as chorus, distorsions, echo, reverb and similar for this sound. Sound effects can then be controlled via ISound::getSoundEffectControl(). Only enable if necessary.
+
- Returns:
- Only returns a pointer to an ISound if the parameters 'track', 'startPaused' or 'enableSoundEffects' have been set to true. Note: if this method returns an ISound as result, you HAVE to call ISound::drop() after you don't need the ISound interface anymore. Otherwise this will cause memory waste. This method also may return 0 altough 'track', 'startPaused' or 'enableSoundEffects' have been set to true, if the sound could not be played.
+
+
+
+
+
+
+| virtual ISound* irrklang::ISoundEngine::play2D | +( | +const char * | +soundFileName, | +|
| + | + | bool | + playLooped = false, |
+ |
| + | + | bool | + startPaused = false, |
+ |
| + | + | bool | + track = false, |
+ |
| + | + | E_STREAM_MODE | + streamMode = ESM_AUTO_DETECT, |
+ |
| + | + | bool | + enableSoundEffects = false | + |
| + | ) | + [pure virtual] |
+
+
+
+loads a sound source (if not loaded already) from a file and plays it.
+- Parameters:
-
+
+
+sourceFileName Filename of sound, like "sounds/test.wav" or "foobar.ogg". playLooped plays the sound in loop mode. If set to 'false', the sound is played once, then stopped and deleted from the internal playing list. Calls to ISound have no effect after such a non looped sound has been stopped automaticly. startPaused starts the sound paused. This implies that track=true. Use this if you want to modify some of the playing parameters before the sound actually plays. Usually you would set this parameter to true, then use the ISound interface to modify some of the sound parameters and then call ISound::setPaused(false); Note: You need to call ISound::drop() when setting this parameter to true and you don't need the ISound object anymore. See 'return' for details. track Makes it possible to track the sound. Causes the method to return an ISound interface. See 'return' for details. streamMode Specifies if the file should be streamed or loaded completely into memory for playing. ESM_AUTO_DETECT sets this to autodetection. Note: if the sound has been loaded or played before into the engine, this parameter has no effect. enableSoundEffects Makes it possible to use sound effects such as chorus, distorsions, echo, reverb and similar for this sound. Sound effects can then be controlled via ISound::getSoundEffectControl(). Only enable if necessary.
+
- Returns:
- Only returns a pointer to an ISound if the parameters 'track', 'startPaused' or 'enableSoundEffects' have been set to true. Note: if this method returns an ISound as result, you HAVE to call ISound::drop() after you don't need the ISound interface anymore. Otherwise this will cause memory waste. This method also may return 0 altough 'track', 'startPaused' or 'enableSoundEffects' have been set to true, if the sound could not be played.
+
+
+
+
+
+
+| virtual ISound* irrklang::ISoundEngine::play3D | +( | +ISoundSource * | +source, | +|
| + | + | vec3df | +pos, | +|
| + | + | bool | + playLooped = false, |
+ |
| + | + | bool | + startPaused = false, |
+ |
| + | + | bool | + track = false, |
+ |
| + | + | bool | + enableSoundEffects = false | + |
| + | ) | + [pure virtual] |
+
+
+
+Plays a sound source as 3D sound with its default settings stored in ISoundSource.
+An ISoundSource object will be created internally when playing a sound the first time, or can be added with getSoundSource(). There is some example code on how to work with 3D sound 3D Sound.
+- Parameters:
-
+
+
+source The sound source, specifiying sound file source and default settings for this file. Use the other ISoundEngine::play2D() overloads if you want to specify a filename string instead of this. pos Position of the 3D sound. playLooped plays the sound in loop mode. If set to 'false', the sound is played once, then stopped and deleted from the internal playing list. Calls to ISound have no effect after such a non looped sound has been stopped automaticly. startPaused starts the sound paused. This implies that track=true. Use this if you want to modify some of the playing parameters before the sound actually plays. Usually you would set this parameter to true, then use the ISound interface to modify some of the sound parameters and then call ISound::setPaused(false); Note: You need to call ISound::drop() when setting this parameter to true and you don't need the ISound object anymore. See 'return' for details. track Makes it possible to track the sound. Causes the method to return an ISound interface. See 'return' for details. enableSoundEffects Makes it possible to use sound effects such as chorus, distorsions, echo, reverb and similar for this sound. Sound effects can then be controlled via ISound::getSoundEffectControl(). Only enable if necessary.
+
- Returns:
- Only returns a pointer to an ISound if the parameters 'track', 'startPaused' or 'enableSoundEffects' have been set to true. Note: if this method returns an ISound as result, you HAVE to call ISound::drop() after you don't need the ISound interface anymore. Otherwise this will cause memory waste. This method also may return 0 altough 'track', 'startPaused' or 'enableSoundEffects' have been set to true, if the sound could not be played.
+
+
+
+
+
+
+| virtual ISound* irrklang::ISoundEngine::play3D | +( | +const char * | +soundFileName, | +|
| + | + | vec3df | +pos, | +|
| + | + | bool | + playLooped = false, |
+ |
| + | + | bool | + startPaused = false, |
+ |
| + | + | bool | + track = false, |
+ |
| + | + | E_STREAM_MODE | + streamMode = ESM_AUTO_DETECT, |
+ |
| + | + | bool | + enableSoundEffects = false | + |
| + | ) | + [pure virtual] |
+
+
+
+Loads a sound source (if not loaded already) from a file and plays it as 3D sound.
+There is some example code on how to work with 3D sound at 3D Sound.
+- Parameters:
-
+
+
+sourceFileName Filename of sound, like "sounds/test.wav" or "foobar.ogg". pos Position of the 3D sound. playLooped plays the sound in loop mode. If set to 'false', the sound is played once, then stopped and deleted from the internal playing list. Calls to ISound have no effect after such a non looped sound has been stopped automaticly. startPaused starts the sound paused. This implies that track=true. Use this if you want to modify some of the playing parameters before the sound actually plays. Usually you would set this parameter to true, then use the ISound interface to modify some of the sound parameters and then call ISound::setPaused(false); Note: You need to call ISound::drop() when setting this parameter to true and you don't need the ISound object anymore. See 'return' for details. track Makes it possible to track the sound. Causes the method to return an ISound interface. See 'return' for details. streamMode Specifies if the file should be streamed or loaded completely into memory for playing. ESM_AUTO_DETECT sets this to autodetection. Note: if the sound has been loaded or played before into the engine, this parameter has no effect. enableSoundEffects Makes it possible to use sound effects such as chorus, distorsions, echo, reverb and similar for this sound. Sound effects can then be controlled via ISound::getSoundEffectControl(). Only enable if necessary.
+
- Returns:
- Only returns a pointer to an ISound if the parameters 'track', 'startPaused' or 'enableSoundEffects' have been set to true. Note: if this method returns an ISound as result, you HAVE to call ISound::drop() after you don't need the ISound interface anymore. Otherwise this will cause memory waste. This method also may return 0 altough 'track', 'startPaused' or 'enableSoundEffects' have been set to true, if the sound could not be played.
+
+
+
+
+
+
+| virtual void irrklang::ISoundEngine::registerAudioStreamLoader | +( | +IAudioStreamLoader * | +loader | +) | + [pure virtual] |
+
+
+
+Registers a new audio stream loader in the sound engine.
+Use this to enhance the audio engine to support other or new file formats. To do this, implement your own IAudioStreamLoader interface and register it with this method
+ +
+
+
+
+
+
+
+| virtual void irrklang::ISoundEngine::removeAllSoundSources | +( | ++ | ) | + [pure virtual] |
+
+
+
+Removes all sound sources from the engine.
+This will also cause all sounds to be stopped. Removing sound sources is only necessary if you know you won't use a lot of non-streamed sounds again. Sound sources of streamed sounds do not cost a lot of memory.
+ +
+
+
+
+
+
+
+| virtual void irrklang::ISoundEngine::removeSoundSource | +( | +const ik_c8 * | +name | +) | + [pure virtual] |
+
+
+
+Removes a sound source from the engine, freeing the memory it occupies.
+This will also cause all currently playing sounds of this source to be stopped. Also note that if the source has been removed successfully, the value returned by getSoundSourceCount() will have been decreased by one. Removing sound sources is only necessary if you know you won't use a lot of non-streamed sounds again. Sound sources of streamed sounds do not cost a lot of memory.
+ +
+
+
+
+
+
+
+| virtual void irrklang::ISoundEngine::removeSoundSource | +( | +ISoundSource * | +source | +) | + [pure virtual] |
+
+
+
+Removes a sound source from the engine, freeing the memory it occupies.
+This will also cause all currently playing sounds of this source to be stopped. Also note that if the source has been removed successfully, the value returned by getSoundSourceCount() will have been decreased by one. Removing sound sources is only necessary if you know you won't use a lot of non-streamed sounds again. Sound sources of streamed sounds do not cost a lot of memory.
+ +
+
+
+
+
+
+
+| virtual void irrklang::ISoundEngine::setAllSoundsPaused | +( | +bool | + bPaused = true |
+ ) | + [pure virtual] |
+
+
+
+Pauses or unpauses all currently playing sounds.
+ +
+
+
+
+
+
+
+| virtual void irrklang::ISoundEngine::setDefault3DSoundMaxDistance | +( | +ik_f32 | +maxDistance | +) | + [pure virtual] |
+
+
+
+Sets the default maximal distance for 3D sounds.
+Changing this value is usually not necessary. Use setDefault3DSoundMinDistance() instead. Don't change this value if you don't know what you are doing: This value causes the sound to stop attenuating after it reaches the max distance. Most people think that this sets the volume of the sound to 0 after this distance, but this is not true. Only change the minimal distance (using for example setDefault3DSoundMinDistance()) to influence this. See ISound::setMaxDistance() for details about what the max distance is. It is also possible to influence this default value for every sound file using ISoundSource::setDefaultMaxDistance(). This method only influences the initial distance value of sounds. For changing the distance after the sound has been started to play, use ISound::setMinDistance() and ISound::setMaxDistance().
+- Parameters:
-
+
+
+maxDistance Default maximal distance for 3d sounds. The default value is 1000000000.0f.
+
+
+
+
+
+
+
+| virtual void irrklang::ISoundEngine::setDefault3DSoundMinDistance | +( | +ik_f32 | +minDistance | +) | + [pure virtual] |
+
+
+
+Sets the default minimal distance for 3D sounds.
+This value influences how loud a sound is heard based on its distance. See ISound::setMinDistance() for details about what the min distance is. It is also possible to influence this default value for every sound file using ISoundSource::setDefaultMinDistance(). This method only influences the initial distance value of sounds. For changing the distance after the sound has been started to play, use ISound::setMinDistance() and ISound::setMaxDistance().
+- Parameters:
-
+
+
+minDistance Default minimal distance for 3d sounds. The default value is 1.0f.
+
+
+
+
+
+
+
+| virtual void irrklang::ISoundEngine::setDopplerEffectParameters | +( | +ik_f32 | + dopplerFactor = 1.0f, |
+ |
| + | + | ik_f32 | + distanceFactor = 1.0f | + |
| + | ) | + [pure virtual] |
+
+
+
+Sets parameters affecting the doppler effect.
+- Parameters:
-
+
+
+dopplerFactor is a value between 0 and 10 which multiplies the doppler effect. Default value is 1.0, which is the real world doppler effect, and 10.0f would be ten times the real world doppler effect. distanceFactor is the number of meters in a vector unit. The default value is 1.0. Doppler effects are calculated in meters per second, with this parameter, this can be changed, all velocities and positions are influenced by this. If the measurement should be in foot instead of meters, set this value to 0.3048f for example.
+
+
+
+
+
+
+
+| virtual void irrklang::ISoundEngine::setListenerPosition | +( | +const vec3df & | +pos, | +|
| + | + | const vec3df & | +lookdir, | +|
| + | + | const vec3df & | + velPerSecond = vec3df(0, 0, 0), |
+ |
| + | + | const vec3df & | + upVector = vec3df(0, 1, 0) | + |
| + | ) | + [pure virtual] |
+
+
+
+Sets the current listener 3d position.
+When playing sounds in 3D, updating the position of the listener every frame should be done using this function.
+- Parameters:
-
+
+
+pos Position of the camera or listener. lookdir Direction vector where the camera or listener is looking into. If you have a camera position and a target 3d point where it is looking at, this would be cam->getTarget() - cam->getAbsolutePosition(). velPerSecond The velocity per second describes the speed of the listener and is only needed for doppler effects. upvector Vector pointing 'up', so the engine can decide where is left and right. This vector is usually (0,1,0).
+
+
+
+
+
+
+
+| virtual bool irrklang::ISoundEngine::setMixedDataOutputReceiver | +( | +ISoundMixedOutputReceiver * | +receiver | +) | + [pure virtual] |
+
+
+
+Sets the OutputMixedDataReceiver, so you can receive the pure mixed output audio data while it is being played.
+This can be used to store the sound output as .wav file or for creating a Oscillograph or similar. This works only with software based audio drivers, that is ESOD_WIN_MM, ESOD_ALSA, and ESOD_CORE_AUDIO. Returns true if sucessful and fals if the current audio driver doesn't support this feature. Set this to null again once you don't need it anymore.
+ +
+
+
+
+
+
+
+| virtual void irrklang::ISoundEngine::setRolloffFactor | +( | +ik_f32 | +rolloff | +) | + [pure virtual] |
+
+
+
+Sets a rolloff factor which influences the amount of attenuation that is applied to 3D sounds.
+The rolloff factor can range from 0.0 to 10.0, where 0 is no rolloff. 1.0 is the default rolloff factor set, the value which we also experience in the real world. A value of 2 would mean twice the real-world rolloff.
+ +
+
+
+
+
+
+
+| virtual void irrklang::ISoundEngine::setSoundVolume | +( | +ik_f32 | +volume | +) | + [pure virtual] |
+
+
+
+Sets master sound volume. This value is multiplied with all sounds played.
+- Parameters:
-
+
+
+volume 0 (silent) to 1.0f (full volume)
+
+
+
+
+
+
+
+| virtual void irrklang::ISoundEngine::stopAllSounds | +( | ++ | ) | + [pure virtual] |
+
+
+
+Stops all currently playing sounds.
+ +
+
+
+
+
+
+
+| virtual void irrklang::ISoundEngine::stopAllSoundsOfSoundSource | +( | +ISoundSource * | +source | +) | + [pure virtual] |
+
+
+
+Stops all sounds of a specific sound source.
+ +
+
+
+
+
+
+| virtual void irrklang::ISoundEngine::update | +( | ++ | ) | + [pure virtual] |
+
+
+
+Updates the audio engine. This should be called several times per frame if irrKlang was started in single thread mode.
+This updates the 3d positions of the sounds as well as their volumes, effects, streams and other stuff. Call this several times per frame (the more the better) if you specified irrKlang to run single threaded. Otherwise it is not necessary to use this method. This method is being called by the scene manager automaticly if you are using one, so you might want to ignore this.
+ +The documentation for this class was generated from the following file: +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
+
+
+
+irrklang::ISoundMixedOutputReceiver Member List
This is the complete list of members for irrklang::ISoundMixedOutputReceiver, including all inherited members.| OnAudioDataReady(const void *data, int byteCount, int playbackrate)=0 | irrklang::ISoundMixedOutputReceiver | [pure virtual] |
| ~ISoundMixedOutputReceiver() | irrklang::ISoundMixedOutputReceiver | [inline, virtual] |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
The documentation for this class was generated from the following file: +
+
+
+
+
+irrklang::ISoundMixedOutputReceiver Class Reference
+Interface to be implemented by the user, which recieves the mixed output when it it played by the sound engine. +More...
+ +#include <ik_ISoundMixedOutputReceiver.h>
Public Member Functions | |
| virtual | ~ISoundMixedOutputReceiver () |
| destructor | |
| virtual void | OnAudioDataReady (const void *data, int byteCount, int playbackrate)=0 |
| Called when a chunk of sound has been mixed and is about to be played. | |
Detailed Description
+Interface to be implemented by the user, which recieves the mixed output when it it played by the sound engine.
+This can be used to store the sound output as .wav file or for creating a Oscillograph or similar. Simply implement your own class derived from ISoundMixedOutputReceiver and use ISoundEngine::setMixedDataOutputReceiver to let the audio driver know about it.
+Constructor & Destructor Documentation
+ +
+
+
+
+
+
+| virtual irrklang::ISoundMixedOutputReceiver::~ISoundMixedOutputReceiver | +( | ++ | ) | + [inline, virtual] |
+
+
+
+destructor
+ +Member Function Documentation
+ +
+
+
+
+
+
+| virtual void irrklang::ISoundMixedOutputReceiver::OnAudioDataReady | +( | +const void * | +data, | +|
| + | + | int | +byteCount, | +|
| + | + | int | +playbackrate | + |
| + | ) | + [pure virtual] |
+
+
+
+Called when a chunk of sound has been mixed and is about to be played.
+Note: This is called from the playing thread of the sound library, so you need to make everything you are doing in this method thread safe. Additionally, it would be a good idea to do nothing complicated in your implementation and return as fast as possible, otherwise sound output may be stuttering.
+- Parameters:
-
+
+
+data representing the sound frames which just have been mixed. Sound data always consists of two interleaved sound channels at 16bit per frame. byteCount Amount of bytes of the data playbackrate The playback rate at samples per second (usually something like 44000). This value will not change and always be the same for an instance of an ISoundEngine.
+
The documentation for this class was generated from the following file: +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
+
+
+
+irrklang::ISoundSource Member List
This is the complete list of members for irrklang::ISoundSource, including all inherited members.| drop()=0 | irrklang::IVirtualRefCounted | [pure virtual] |
| forceReloadAtNextUse()=0 | irrklang::ISoundSource | [pure virtual] |
| getAudioFormat()=0 | irrklang::ISoundSource | [pure virtual] |
| getDefaultMaxDistance()=0 | irrklang::ISoundSource | [pure virtual] |
| getDefaultMinDistance()=0 | irrklang::ISoundSource | [pure virtual] |
| getDefaultVolume()=0 | irrklang::ISoundSource | [pure virtual] |
| getForcedStreamingThreshold()=0 | irrklang::ISoundSource | [pure virtual] |
| getIsSeekingSupported()=0 | irrklang::ISoundSource | [pure virtual] |
| getName()=0 | irrklang::ISoundSource | [pure virtual] |
| getPlayLength()=0 | irrklang::ISoundSource | [pure virtual] |
| getSampleData()=0 | irrklang::ISoundSource | [pure virtual] |
| getStreamMode()=0 | irrklang::ISoundSource | [pure virtual] |
| grab()=0 | irrklang::IVirtualRefCounted | [pure virtual] |
| setDefaultMaxDistance(ik_f32 maxDistance)=0 | irrklang::ISoundSource | [pure virtual] |
| setDefaultMinDistance(ik_f32 minDistance)=0 | irrklang::ISoundSource | [pure virtual] |
| setDefaultVolume(ik_f32 volume=1.0f)=0 | irrklang::ISoundSource | [pure virtual] |
| setForcedStreamingThreshold(ik_s32 thresholdBytes)=0 | irrklang::ISoundSource | [pure virtual] |
| setStreamMode(E_STREAM_MODE mode)=0 | irrklang::ISoundSource | [pure virtual] |
| ~IVirtualRefCounted() | irrklang::IVirtualRefCounted | [inline, virtual] |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
The documentation for this class was generated from the following file: +
+
+
+
+
+irrklang::ISoundSource Class Reference
+A sound source describes an input file (.ogg, .mp3, .wav or similar) and its default settings. +More...
+ +#include <ik_ISoundSource.h>
+Inheritance diagram for irrklang::ISoundSource:
+
+
+
+
+
+ 
+
+
+
+
+ Public Member Functions | |
| virtual const ik_c8 * | getName ()=0 |
| Returns the name of the sound source (usually, this is the file name). | |
| virtual void | setStreamMode (E_STREAM_MODE mode)=0 |
| Sets the stream mode which should be used for a sound played from this source. | |
| virtual E_STREAM_MODE | getStreamMode ()=0 |
| Returns the detected or set type of the sound with wich the sound will be played. | |
| virtual ik_u32 | getPlayLength ()=0 |
| Returns the play length of the sound in milliseconds. | |
| virtual SAudioStreamFormat | getAudioFormat ()=0 |
| Returns informations about the sound source: channel count (mono/stereo), frame count, sample rate, etc. | |
| virtual bool | getIsSeekingSupported ()=0 |
| Returns if sounds played from this source will support seeking via ISound::setPlayPosition(). | |
| virtual void | setDefaultVolume (ik_f32 volume=1.0f)=0 |
| Sets the default volume for a sound played from this source. | |
| virtual ik_f32 | getDefaultVolume ()=0 |
| Returns the default volume for a sound played from this source. | |
| virtual void | setDefaultMinDistance (ik_f32 minDistance)=0 |
| sets the default minimal distance for 3D sounds played from this source. | |
| virtual ik_f32 | getDefaultMinDistance ()=0 |
| Returns the default minimal distance for 3D sounds played from this source. | |
| virtual void | setDefaultMaxDistance (ik_f32 maxDistance)=0 |
| Sets the default maximal distance for 3D sounds played from this source. | |
| virtual ik_f32 | getDefaultMaxDistance ()=0 |
| returns the default maxmial distance for 3D sounds played from this source. | |
| virtual void | forceReloadAtNextUse ()=0 |
| Forces the sound to be reloaded at next replay. | |
| virtual void | setForcedStreamingThreshold (ik_s32 thresholdBytes)=0 |
| Sets the threshold size where irrKlang decides to force streaming a file independent of the user specified setting. | |
| virtual ik_s32 | getForcedStreamingThreshold ()=0 |
| Returns the threshold size where irrKlang decides to force streaming a file independent of the user specified setting. | |
| virtual void * | getSampleData ()=0 |
| Returns a pointer to the loaded and decoded sample data. | |
Detailed Description
+A sound source describes an input file (.ogg, .mp3, .wav or similar) and its default settings.
+It provides some informations about the sound source like the play lenght and can have default settings for volume, distances for 3d etc. There is some example code on how to use Sound sources at Using Sound Sources.
+Member Function Documentation
+ +
+
+
+
+
+
+
+| virtual void irrklang::ISoundSource::forceReloadAtNextUse | +( | ++ | ) | + [pure virtual] |
+
+
+
+Forces the sound to be reloaded at next replay.
+Sounds which are not played as streams are buffered to make it possible to replay them without much overhead. If the sound file is altered after the sound has been played the first time, the engine won't play the changed file then. Calling this method makes the engine reload the file before the file is played the next time.
+ +
+
+
+
+
+
+
+| virtual SAudioStreamFormat irrklang::ISoundSource::getAudioFormat | +( | ++ | ) | + [pure virtual] |
+
+
+
+Returns informations about the sound source: channel count (mono/stereo), frame count, sample rate, etc.
+- Returns:
- Returns the structure filled with 0 or negative values if not known for this sound for example because because the file could not be opened or similar. Note: If the sound never has been played before, the sound engine will have to open the file and try to get the play lenght from there, so this call could take a bit depending on the type of file.
+
+
+
+
+
+
+| virtual ik_f32 irrklang::ISoundSource::getDefaultMaxDistance | +( | ++ | ) | + [pure virtual] |
+
+
+
+returns the default maxmial distance for 3D sounds played from this source.
+This value influences how loud a sound is heard based on its distance. Changing this value is usually not necessary. Use setDefaultMinDistance() instead. Don't change this value if you don't know what you are doing: This value causes the sound to stop attenuating after it reaches the max distance. Most people think that this sets the volume of the sound to 0 after this distance, but this is not true. Only change the minimal distance (using for example setDefaultMinDistance()) to influence this. See ISound::setMaxDistance() for details about what the max distance is.
+- Returns:
- Default maximal distance for 3D sounds from this source. If setDefaultMaxDistance() was set to a negative value, it will return the default value set in the engine, using ISoundEngine::setDefault3DSoundMaxDistance(). Default value is -1, causing the default max distance of the sound engine to take effect.
+
+
+
+
+
+
+| virtual ik_f32 irrklang::ISoundSource::getDefaultMinDistance | +( | ++ | ) | + [pure virtual] |
+
+
+
+Returns the default minimal distance for 3D sounds played from this source.
+This value influences how loud a sound is heard based on its distance. See ISound::setMinDistance() for details about what the minimal distance is.
+- Returns:
- Default minimal distance for 3d sounds from this source. If setDefaultMinDistance() was set to a negative value, it will return the default value set in the engine, using ISoundEngine::setDefault3DSoundMinDistance(). Default value is -1, causing the default min distance of the sound engine to take effect.
+
+
+
+
+
+
+| virtual ik_f32 irrklang::ISoundSource::getDefaultVolume | +( | ++ | ) | + [pure virtual] |
+
+
+
+Returns the default volume for a sound played from this source.
+You can influence this default volume value using setDefaultVolume(). Note that the default volume is being multiplied with the master volume of ISoundEngine, change this via ISoundEngine::setSoundVolume(). !
+- Returns:
- 0 (silent) to 1.0f (full volume). Default value is 1.0f.
+
+
+
+
+
+
+| virtual ik_s32 irrklang::ISoundSource::getForcedStreamingThreshold | +( | ++ | ) | + [pure virtual] |
+
+
+
+Returns the threshold size where irrKlang decides to force streaming a file independent of the user specified setting.
+The value is specified in uncompressed bytes and its default value is about one Megabyte. See setForcedStreamingThreshold() for details.
+ +
+
+
+
+
+
+
+| virtual bool irrklang::ISoundSource::getIsSeekingSupported | +( | ++ | ) | + [pure virtual] |
+
+
+
+Returns if sounds played from this source will support seeking via ISound::setPlayPosition().
+ +
+
+
+
+
+
+
+| virtual const ik_c8* irrklang::ISoundSource::getName | +( | ++ | ) | + [pure virtual] |
+
+
+
+Returns the name of the sound source (usually, this is the file name).
+ +
+
+
+
+
+
+
+| virtual ik_u32 irrklang::ISoundSource::getPlayLength | +( | ++ | ) | + [pure virtual] |
+
+
+
+Returns the play length of the sound in milliseconds.
+Returns -1 if not known for this sound for example because its decoder does not support lenght reporting or it is a file stream of unknown size. Note: If the sound never has been played before, the sound engine will have to open the file and try to get the play lenght from there, so this call could take a bit depending on the type of file.
+ +
+
+
+
+
+
+
+| virtual void* irrklang::ISoundSource::getSampleData | +( | ++ | ) | + [pure virtual] |
+
+
+
+Returns a pointer to the loaded and decoded sample data.
+- Returns:
- Returns a pointer to the sample data. The data is provided in decoded PCM data. The exact format can be retrieved using getAudioFormat(). Use getAudioFormat().getSampleDataSize() for getting the amount of bytes. The returned pointer will only be valid as long as the sound source exists. This function will only return a pointer to the data if the audio file is not streamed, namely ESM_NO_STREAMING. Otherwise this function will return 0. Note: If the sound never has been played before, the sound engine will have to open the file and decode audio data from there, so this call could take a bit depending on the type of the file.
+
+
+
+
+
+
+| virtual E_STREAM_MODE irrklang::ISoundSource::getStreamMode | +( | ++ | ) | + [pure virtual] |
+
+
+
+Returns the detected or set type of the sound with wich the sound will be played.
+Note: If the returned type is ESM_AUTO_DETECT, this mode will change after the sound has been played the first time.
+ +
+
+
+
+
+
+
+| virtual void irrklang::ISoundSource::setDefaultMaxDistance | +( | +ik_f32 | +maxDistance | +) | + [pure virtual] |
+
+
+
+Sets the default maximal distance for 3D sounds played from this source.
+Changing this value is usually not necessary. Use setDefaultMinDistance() instead. Don't change this value if you don't know what you are doing: This value causes the sound to stop attenuating after it reaches the max distance. Most people think that this sets the volume of the sound to 0 after this distance, but this is not true. Only change the minimal distance (using for example setDefaultMinDistance()) to influence this. See ISound::setMaxDistance() for details about what the max distance is. This method only influences the initial distance value of sounds. For changing the distance while the sound is played, use ISound::setMinDistance() and ISound::setMaxDistance().
+- Parameters:
-
+
+
+maxDistance Default maximal distance for 3D sounds from this source. Set it to a negative value to let sounds of this source use the engine level default max distance, which can be set via ISoundEngine::setDefault3DSoundMaxDistance(). Default value is -1, causing the default max distance of the sound engine to take effect.
+
+
+
+
+
+
+
+| virtual void irrklang::ISoundSource::setDefaultMinDistance | +( | +ik_f32 | +minDistance | +) | + [pure virtual] |
+
+
+
+sets the default minimal distance for 3D sounds played from this source.
+This value influences how loud a sound is heard based on its distance. See ISound::setMinDistance() for details about what the min distance is. This method only influences the initial distance value of sounds. For changing the distance while the sound is playing, use ISound::setMinDistance() and ISound::setMaxDistance().
+- Parameters:
-
+
+
+minDistance,: Default minimal distance for 3D sounds from this source. Set it to a negative value to let sounds of this source use the engine level default min distance, which can be set via ISoundEngine::setDefault3DSoundMinDistance(). Default value is -1, causing the default min distance of the sound engine to take effect.
+
+
+
+
+
+
+
+| virtual void irrklang::ISoundSource::setDefaultVolume | +( | +ik_f32 | + volume = 1.0f |
+ ) | + [pure virtual] |
+
+
+
+Sets the default volume for a sound played from this source.
+The default value of this is 1.0f. Note that the default volume is being multiplied with the master volume of ISoundEngine, change this via ISoundEngine::setSoundVolume(). !
+- Parameters:
-
+
+
+volume 0 (silent) to 1.0f (full volume). Default value is 1.0f.
+
+
+
+
+
+
+
+| virtual void irrklang::ISoundSource::setForcedStreamingThreshold | +( | +ik_s32 | +thresholdBytes | +) | + [pure virtual] |
+
+
+
+Sets the threshold size where irrKlang decides to force streaming a file independent of the user specified setting.
+When specifying ESM_NO_STREAMING for playing back a sound file, irrKlang will ignore this setting if the file is bigger than this threshold and stream the file anyway. Please note that if an audio format loader is not able to return the size of a sound source and returns -1 as length, this will be ignored as well and streaming has to be forced.
+- Parameters:
-
+
+
+threshold,: New threshold. The value is specified in uncompressed bytes and its default value is about one Megabyte. Set to 0 or a negative value to disable stream forcing.
+
+
+
+
+
+
+| virtual void irrklang::ISoundSource::setStreamMode | +( | +E_STREAM_MODE | +mode | +) | + [pure virtual] |
+
+
+
+Sets the stream mode which should be used for a sound played from this source.
+Note that if this is set to ESM_NO_STREAMING, the engine still might decide to stream the sound if it is too big. The threashold for this can be adjusted using ISoundSource::setForcedStreamingThreshold().
+ +The documentation for this class was generated from the following file: +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
+
+
+
+irrklang::ISoundStopEventReceiver Member List
This is the complete list of members for irrklang::ISoundStopEventReceiver, including all inherited members.| OnSoundStopped(ISound *sound, E_STOP_EVENT_CAUSE reason, void *userData)=0 | irrklang::ISoundStopEventReceiver | [pure virtual] |
| ~ISoundStopEventReceiver() | irrklang::ISoundStopEventReceiver | [inline, virtual] |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
The documentation for this class was generated from the following file: +
+
+
+
+
+irrklang::ISoundStopEventReceiver Class Reference
+Interface to be implemented by the user, which recieves sound stop events. +More...
+ +#include <ik_ISoundStopEventReceiver.h>
Public Member Functions | |
| virtual | ~ISoundStopEventReceiver () |
| destructor | |
| virtual void | OnSoundStopped (ISound *sound, E_STOP_EVENT_CAUSE reason, void *userData)=0 |
| Called when a sound has stopped playing. | |
Detailed Description
+Interface to be implemented by the user, which recieves sound stop events.
+The interface has only one method to be implemented by the user: OnSoundStopped(). Implement this interface and set it via ISound::setSoundStopEventReceiver(). The sound stop event is guaranteed to be called when a sound or sound stream is finished, either because the sound reached its playback end, its sound source was removed, ISoundEngine::stopAllSounds() has been called or the whole engine was deleted.
+Constructor & Destructor Documentation
+ +
+
+
+
+
+
+| virtual irrklang::ISoundStopEventReceiver::~ISoundStopEventReceiver | +( | ++ | ) | + [inline, virtual] |
+
+
+
+destructor
+ +Member Function Documentation
+ +
+
+
+
+
+
+| virtual void irrklang::ISoundStopEventReceiver::OnSoundStopped | +( | +ISound * | +sound, | +|
| + | + | E_STOP_EVENT_CAUSE | +reason, | +|
| + | + | void * | +userData | + |
| + | ) | + [pure virtual] |
+
+
+
+Called when a sound has stopped playing.
+This is the only method to be implemented by the user. The sound stop event is guaranteed to be called when a sound or sound stream is finished, either because the sound reached its playback end, its sound source was removed, ISoundEngine::stopAllSounds() has been called or the whole engine was deleted. Please note: Sound events will occur in a different thread when the engine runs in multi threaded mode (default). In single threaded mode, the event will happen while the user thread is calling ISoundEngine::update().
+- Parameters:
-
+
+
+sound,: Sound which has been stopped. reason,: The reason why the sound stop event was fired. Usually, this will be ESEC_SOUND_FINISHED_PLAYING. When the sound was aborded by calling ISound::stop() or ISoundEngine::stopAllSounds();, this would be ESEC_SOUND_STOPPED_BY_USER. If irrKlang was deleted or the sound source was removed, the value is ESEC_SOUND_STOPPED_BY_SOURCE_REMOVAL. userData,: userData pointer set by the user when registering the interface via ISound::setSoundStopEventReceiver().
+
The documentation for this class was generated from the following file: +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
+
+
+
+irrklang::IVirtualRefCounted Member List
This is the complete list of members for irrklang::IVirtualRefCounted, including all inherited members.| drop()=0 | irrklang::IVirtualRefCounted | [pure virtual] |
| grab()=0 | irrklang::IVirtualRefCounted | [pure virtual] |
| ~IVirtualRefCounted() | irrklang::IVirtualRefCounted | [inline, virtual] |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
The documentation for this class was generated from the following file: +
+
+
+
+
+irrklang::IVirtualRefCounted Class Reference
+Reference counting base class for objects in the Irrlicht Engine similar to IRefCounted. +More...
+ +#include <ik_IVirtualRefCounted.h>
+Inheritance diagram for irrklang::IVirtualRefCounted:
+
+
+
+
+
+ 
+
+
+
+
+ Public Member Functions | |
| virtual | ~IVirtualRefCounted () |
| Destructor. | |
| virtual void | grab ()=0 |
| Grabs the object. Increments the reference counter by one. | |
| virtual bool | drop ()=0 |
| Drops the object. Decrements the reference counter by one. | |
Detailed Description
+Reference counting base class for objects in the Irrlicht Engine similar to IRefCounted.
+See IRefCounted for the basics of this class. The difference to IRefCounted is that the class has to implement reference counting for itself.
+Constructor & Destructor Documentation
+ +
+
+
+
+
+
+| virtual irrklang::IVirtualRefCounted::~IVirtualRefCounted | +( | ++ | ) | + [inline, virtual] |
+
+
+
+Destructor.
+ +Member Function Documentation
+ +
+
+
+
+
+
+
+| virtual bool irrklang::IVirtualRefCounted::drop | +( | ++ | ) | + [pure virtual] |
+
+
+
+Drops the object. Decrements the reference counter by one.
+To be implemented by the derived class. If you don't want to implement this, use the class IRefCounted instead. See IRefCounted::grab() for details of this method.
+ +
+
+
+
+
+
+| virtual void irrklang::IVirtualRefCounted::grab | +( | ++ | ) | + [pure virtual] |
+
+
+
+Grabs the object. Increments the reference counter by one.
+To be implemented by the derived class. If you don't want to implement this, use the class IRefCounted instead. See IRefCounted::grab() for details of this method.
+ +The documentation for this class was generated from the following file: +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
+
+
+
+irrklang::vec3d< T > Member List
This is the complete list of members for irrklang::vec3d< T >, including all inherited members.| crossProduct(const vec3d< T > &p) const | irrklang::vec3d< T > | [inline] |
| dotProduct(const vec3d< T > &other) const | irrklang::vec3d< T > | [inline] |
| equals(const vec3d< T > &other) | irrklang::vec3d< T > | [inline] |
| getAs4Values(T *array) | irrklang::vec3d< T > | [inline] |
| getDistanceFrom(const vec3d< T > &other) const | irrklang::vec3d< T > | [inline] |
| getDistanceFromSQ(const vec3d< T > &other) const | irrklang::vec3d< T > | [inline] |
| getHorizontalAngle() | irrklang::vec3d< T > | [inline] |
| getInterpolated(const vec3d< T > &other, ik_f32 d) const | irrklang::vec3d< T > | [inline] |
| getLength() const | irrklang::vec3d< T > | [inline] |
| getLengthSQ() const | irrklang::vec3d< T > | [inline] |
| invert() | irrklang::vec3d< T > | [inline] |
| isBetweenPoints(const vec3d< T > &begin, const vec3d< T > &end) const | irrklang::vec3d< T > | [inline] |
| normalize() | irrklang::vec3d< T > | [inline] |
| operator!=(const vec3d< T > &other) const | irrklang::vec3d< T > | [inline] |
| operator*(const vec3d< T > &other) const | irrklang::vec3d< T > | [inline] |
| operator*(const T v) const | irrklang::vec3d< T > | [inline] |
| operator*=(const vec3d< T > &other) | irrklang::vec3d< T > | [inline] |
| operator*=(const T v) | irrklang::vec3d< T > | [inline] |
| operator+(const vec3d< T > &other) const | irrklang::vec3d< T > | [inline] |
| operator+=(const vec3d< T > &other) | irrklang::vec3d< T > | [inline] |
| operator-() const | irrklang::vec3d< T > | [inline] |
| operator-(const vec3d< T > &other) const | irrklang::vec3d< T > | [inline] |
| operator-=(const vec3d< T > &other) | irrklang::vec3d< T > | [inline] |
| operator/(const vec3d< T > &other) const | irrklang::vec3d< T > | [inline] |
| operator/(const T v) const | irrklang::vec3d< T > | [inline] |
| operator/=(const vec3d< T > &other) | irrklang::vec3d< T > | [inline] |
| operator/=(const T v) | irrklang::vec3d< T > | [inline] |
| operator<=(const vec3d< T > &other) const | irrklang::vec3d< T > | [inline] |
| operator=(const vec3d< T > &other) | irrklang::vec3d< T > | [inline] |
| operator==(const vec3d< T > &other) const | irrklang::vec3d< T > | [inline] |
| operator>=(const vec3d< T > &other) const | irrklang::vec3d< T > | [inline] |
| rotateXYBy(ik_f64 degrees, const vec3d< T > ¢er) | irrklang::vec3d< T > | [inline] |
| rotateXZBy(ik_f64 degrees, const vec3d< T > ¢er) | irrklang::vec3d< T > | [inline] |
| rotateYZBy(ik_f64 degrees, const vec3d< T > ¢er) | irrklang::vec3d< T > | [inline] |
| set(const T nx, const T ny, const T nz) | irrklang::vec3d< T > | [inline] |
| set(const vec3d< T > &p) | irrklang::vec3d< T > | [inline] |
| setLength(T newlength) | irrklang::vec3d< T > | [inline] |
| vec3d() | irrklang::vec3d< T > | [inline] |
| vec3d(T nx, T ny, T nz) | irrklang::vec3d< T > | [inline] |
| vec3d(const vec3d< T > &other) | irrklang::vec3d< T > | [inline] |
| X | irrklang::vec3d< T > | |
| Y | irrklang::vec3d< T > | |
| Z | irrklang::vec3d< T > |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
template<class T>
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+irrklang::vec3d< T > Class Template Reference
+a 3d vector template class for representing vectors and points in 3d +More...
+ +#include <ik_vec3d.h>
Public Member Functions | |
| vec3d () | |
| vec3d (T nx, T ny, T nz) | |
| vec3d (const vec3d< T > &other) | |
| vec3d< T > | operator- () const |
| constructor creating an irrklang vec3d from an irrlicht vector. | |
| vec3d< T > & | operator= (const vec3d< T > &other) |
| vec3d< T > | operator+ (const vec3d< T > &other) const |
| vec3d< T > & | operator+= (const vec3d< T > &other) |
| vec3d< T > | operator- (const vec3d< T > &other) const |
| vec3d< T > & | operator-= (const vec3d< T > &other) |
| vec3d< T > | operator* (const vec3d< T > &other) const |
| vec3d< T > & | operator*= (const vec3d< T > &other) |
| vec3d< T > | operator* (const T v) const |
| vec3d< T > & | operator*= (const T v) |
| vec3d< T > | operator/ (const vec3d< T > &other) const |
| vec3d< T > & | operator/= (const vec3d< T > &other) |
| vec3d< T > | operator/ (const T v) const |
| vec3d< T > & | operator/= (const T v) |
| bool | operator<= (const vec3d< T > &other) const |
| bool | operator>= (const vec3d< T > &other) const |
| bool | operator== (const vec3d< T > &other) const |
| bool | operator!= (const vec3d< T > &other) const |
| bool | equals (const vec3d< T > &other) |
| returns if this vector equalsfloat the other one, taking floating point rounding errors into account | |
| void | set (const T nx, const T ny, const T nz) |
| void | set (const vec3d< T > &p) |
| ik_f64 | getLength () const |
| Returns length of the vector. | |
| ik_f64 | getLengthSQ () const |
| Returns squared length of the vector. | |
| T | dotProduct (const vec3d< T > &other) const |
| Returns the dot product with another vector. | |
| ik_f64 | getDistanceFrom (const vec3d< T > &other) const |
| Returns distance from an other point. | |
| ik_f32 | getDistanceFromSQ (const vec3d< T > &other) const |
| Returns squared distance from an other point. | |
| vec3d< T > | crossProduct (const vec3d< T > &p) const |
| Calculates the cross product with another vector. | |
| bool | isBetweenPoints (const vec3d< T > &begin, const vec3d< T > &end) const |
| Returns if this vector interpreted as a point is on a line between two other points. | |
| vec3d< T > & | normalize () |
| Normalizes the vector. | |
| void | setLength (T newlength) |
| Sets the lenght of the vector to a new value. | |
| void | invert () |
| Inverts the vector. | |
| void | rotateXZBy (ik_f64 degrees, const vec3d< T > ¢er) |
| void | rotateXYBy (ik_f64 degrees, const vec3d< T > ¢er) |
| void | rotateYZBy (ik_f64 degrees, const vec3d< T > ¢er) |
| vec3d< T > | getInterpolated (const vec3d< T > &other, ik_f32 d) const |
| Returns interpolated vector. | |
| vec3d< T > | getHorizontalAngle () |
| Gets the Y and Z rotations of a vector. | |
| void | getAs4Values (T *array) |
| Fills an array of 4 values with the vector data (usually floats). | |
Public Attributes | |
| T | X |
| T | Y |
| T | Z |
Detailed Description
+template<class T>
+ class irrklang::vec3d< T >
+
+a 3d vector template class for representing vectors and points in 3d
+Constructor & Destructor Documentation
+ +
+
+
+
+
+
+
+
+template<class T>
+ | irrklang::vec3d< T >::vec3d | +( | ++ | ) | + [inline] |
+
+
+
+
+
+
+
+
+
+
+
+template<class T>
+ | irrklang::vec3d< T >::vec3d | +( | +T | +nx, | +|
| + | + | T | +ny, | +|
| + | + | T | +nz | + |
| + | ) | + [inline] |
+
+
+
+
+
+
+
+
+
+
+template<class T>
+ | irrklang::vec3d< T >::vec3d | +( | +const vec3d< T > & | +other | +) | + [inline] |
+
+
+
+Member Function Documentation
+ +
+
+
+
+
+
+
+
+template<class T>
+ | vec3d<T> irrklang::vec3d< T >::crossProduct | +( | +const vec3d< T > & | +p | +) | + const [inline] |
+
+
+
+Calculates the cross product with another vector.
+ +
+
+
+
+
+
+
+
+template<class T>
+ | T irrklang::vec3d< T >::dotProduct | +( | +const vec3d< T > & | +other | +) | + const [inline] |
+
+
+
+Returns the dot product with another vector.
+ +
+
+
+
+
+
+
+
+template<class T>
+ | bool irrklang::vec3d< T >::equals | +( | +const vec3d< T > & | +other | +) | + [inline] |
+
+
+
+returns if this vector equalsfloat the other one, taking floating point rounding errors into account
+ +
+
+
+
+
+
+
+
+template<class T>
+ | void irrklang::vec3d< T >::getAs4Values | +( | +T * | +array | +) | + [inline] |
+
+
+
+Fills an array of 4 values with the vector data (usually floats).
+Useful for setting in shader constants for example. The fourth value will always be 0.
+ +
+
+
+
+
+
+
+
+template<class T>
+ | ik_f64 irrklang::vec3d< T >::getDistanceFrom | +( | +const vec3d< T > & | +other | +) | + const [inline] |
+
+
+
+Returns distance from an other point.
+Here, the vector is interpreted as point in 3 dimensional space.
+ +
+
+
+
+
+
+
+
+template<class T>
+ | ik_f32 irrklang::vec3d< T >::getDistanceFromSQ | +( | +const vec3d< T > & | +other | +) | + const [inline] |
+
+
+
+Returns squared distance from an other point.
+Here, the vector is interpreted as point in 3 dimensional space.
+ +
+
+
+
+
+
+
+
+template<class T>
+ | vec3d<T> irrklang::vec3d< T >::getHorizontalAngle | +( | ++ | ) | + [inline] |
+
+
+
+Gets the Y and Z rotations of a vector.
+Thanks to Arras on the Irrlicht forums to add this method.
+- Returns:
- A vector representing the rotation in degrees of this vector. The Z component of the vector will always be 0.
+
+
+
+
+
+
+
+template<class T>
+ | vec3d<T> irrklang::vec3d< T >::getInterpolated | +( | +const vec3d< T > & | +other, | +|
| + | + | ik_f32 | +d | + |
| + | ) | + const [inline] |
+
+
+
+Returns interpolated vector.
+- Parameters:
-
+
+
+other,: other vector to interpolate between d,: value between 0.0f and 1.0f.
+
+
+
+
+
+
+
+
+template<class T>
+ | ik_f64 irrklang::vec3d< T >::getLength | +( | ++ | ) | + const [inline] |
+
+
+
+Returns length of the vector.
+ +
+
+
+
+
+
+
+
+template<class T>
+ | ik_f64 irrklang::vec3d< T >::getLengthSQ | +( | ++ | ) | + const [inline] |
+
+
+
+Returns squared length of the vector.
+This is useful because it is much faster then getLength().
+ +
+
+
+
+
+
+
+
+template<class T>
+ | void irrklang::vec3d< T >::invert | +( | ++ | ) | + [inline] |
+
+
+
+Inverts the vector.
+ +
+
+
+
+
+
+
+
+template<class T>
+ | bool irrklang::vec3d< T >::isBetweenPoints | +( | +const vec3d< T > & | +begin, | +|
| + | + | const vec3d< T > & | +end | + |
| + | ) | + const [inline] |
+
+
+
+Returns if this vector interpreted as a point is on a line between two other points.
+It is assumed that the point is on the line.
+ +
+
+
+
+
+
+
+
+template<class T>
+ | vec3d<T>& irrklang::vec3d< T >::normalize | +( | ++ | ) | + [inline] |
+
+
+
+Normalizes the vector.
+ +
+
+
+
+
+
+
+
+template<class T>
+ | bool irrklang::vec3d< T >::operator!= | +( | +const vec3d< T > & | +other | +) | + const [inline] |
+
+
+
+
+
+
+
+
+
+
+
+template<class T>
+ | vec3d<T> irrklang::vec3d< T >::operator* | +( | +const T | +v | +) | + const [inline] |
+
+
+
+
+
+
+
+
+
+
+
+template<class T>
+ | vec3d<T> irrklang::vec3d< T >::operator* | +( | +const vec3d< T > & | +other | +) | + const [inline] |
+
+
+
+
+
+
+
+
+
+
+
+template<class T>
+ | vec3d<T>& irrklang::vec3d< T >::operator*= | +( | +const T | +v | +) | + [inline] |
+
+
+
+
+
+
+
+
+
+
+
+template<class T>
+ | vec3d<T>& irrklang::vec3d< T >::operator*= | +( | +const vec3d< T > & | +other | +) | + [inline] |
+
+
+
+
+
+
+
+
+
+
+
+template<class T>
+ | vec3d<T> irrklang::vec3d< T >::operator+ | +( | +const vec3d< T > & | +other | +) | + const [inline] |
+
+
+
+
+
+
+
+
+
+
+
+template<class T>
+ | vec3d<T>& irrklang::vec3d< T >::operator+= | +( | +const vec3d< T > & | +other | +) | + [inline] |
+
+
+
+
+
+
+
+
+
+
+
+template<class T>
+ | vec3d<T> irrklang::vec3d< T >::operator- | +( | +const vec3d< T > & | +other | +) | + const [inline] |
+
+
+
+
+
+
+
+
+
+
+
+
+template<class T>
+ | vec3d<T> irrklang::vec3d< T >::operator- | +( | ++ | ) | + const [inline] |
+
+
+
+
+
+
+
+
+template<class T>
+ | vec3d<T>& irrklang::vec3d< T >::operator-= | +( | +const vec3d< T > & | +other | +) | + [inline] |
+
+
+
+
+
+
+
+
+
+
+
+template<class T>
+ | vec3d<T> irrklang::vec3d< T >::operator/ | +( | +const T | +v | +) | + const [inline] |
+
+
+
+
+
+
+
+
+
+
+
+template<class T>
+ | vec3d<T> irrklang::vec3d< T >::operator/ | +( | +const vec3d< T > & | +other | +) | + const [inline] |
+
+
+
+
+
+
+
+
+
+
+
+template<class T>
+ | vec3d<T>& irrklang::vec3d< T >::operator/= | +( | +const T | +v | +) | + [inline] |
+
+
+
+
+
+
+
+
+
+
+
+template<class T>
+ | vec3d<T>& irrklang::vec3d< T >::operator/= | +( | +const vec3d< T > & | +other | +) | + [inline] |
+
+
+
+
+
+
+
+
+
+
+
+template<class T>
+ | bool irrklang::vec3d< T >::operator<= | +( | +const vec3d< T > & | +other | +) | + const [inline] |
+
+
+
+
+
+
+
+
+
+
+
+template<class T>
+ | vec3d<T>& irrklang::vec3d< T >::operator= | +( | +const vec3d< T > & | +other | +) | + [inline] |
+
+
+
+
+
+
+
+
+
+
+
+template<class T>
+ | bool irrklang::vec3d< T >::operator== | +( | +const vec3d< T > & | +other | +) | + const [inline] |
+
+
+
+
+
+
+
+
+
+
+
+template<class T>
+ | bool irrklang::vec3d< T >::operator>= | +( | +const vec3d< T > & | +other | +) | + const [inline] |
+
+
+
+
+
+
+
+
+
+
+
+template<class T>
+ | void irrklang::vec3d< T >::rotateXYBy | +( | +ik_f64 | +degrees, | +|
| + | + | const vec3d< T > & | +center | + |
| + | ) | + [inline] |
+
+
+Rotates the vector by a specified number of degrees around the Z axis and the specified center.
+- Parameters:
-
+
+
+degrees,: Number of degrees to rotate around the Z axis. center,: The center of the rotation.
+
+
+
+
+
+
+
+
+template<class T>
+ | void irrklang::vec3d< T >::rotateXZBy | +( | +ik_f64 | +degrees, | +|
| + | + | const vec3d< T > & | +center | + |
| + | ) | + [inline] |
+
+
+Rotates the vector by a specified number of degrees around the Y axis and the specified center.
+- Parameters:
-
+
+
+degrees,: Number of degrees to rotate around the Y axis. center,: The center of the rotation.
+
+
+
+
+
+
+
+
+template<class T>
+ | void irrklang::vec3d< T >::rotateYZBy | +( | +ik_f64 | +degrees, | +|
| + | + | const vec3d< T > & | +center | + |
| + | ) | + [inline] |
+
+
+Rotates the vector by a specified number of degrees around the X axis and the specified center.
+- Parameters:
-
+
+
+degrees,: Number of degrees to rotate around the X axis. center,: The center of the rotation.
+
+
+
+
+
+
+
+
+template<class T>
+ | void irrklang::vec3d< T >::set | +( | +const vec3d< T > & | +p | +) | + [inline] |
+
+
+
+
+
+
+
+
+
+
+
+template<class T>
+ | void irrklang::vec3d< T >::set | +( | +const T | +nx, | +|
| + | + | const T | +ny, | +|
| + | + | const T | +nz | + |
| + | ) | + [inline] |
+
+
+
+
+
+
+
+
+
+
+template<class T>
+ | void irrklang::vec3d< T >::setLength | +( | +T | +newlength | +) | + [inline] |
+
+
+
+Sets the lenght of the vector to a new value.
+ +Member Data Documentation
+ +
+
+
+
+
+
+
+
+template<class T>
+ | T irrklang::vec3d< T >::X | +
+
+
+
+
+
+
+
+
+
+
+template<class T>
+ | T irrklang::vec3d< T >::Y | +
+
+
+
+
+
+
+
+
+
+template<class T>
+ | T irrklang::vec3d< T >::Z | +
+
+
+The documentation for this class was generated from the following file:
-
+
- ik_vec3d.h +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
+
+
+
+
+
+
+
+File List
Here is a list of all files with brief descriptions:| ik_ESoundEngineOptions.h [code] | |
| ik_ESoundOutputDrivers.h [code] | |
| ik_EStreamModes.h [code] | |
| ik_IAudioRecorder.h [code] | |
| ik_IAudioStream.h [code] | |
| ik_IAudioStreamLoader.h [code] | |
| ik_IFileFactory.h [code] | |
| ik_IFileReader.h [code] | |
| ik_IRefCounted.h [code] | |
| ik_irrKlangTypes.h [code] | |
| ik_ISound.h [code] | |
| ik_ISoundDeviceList.h [code] | |
| ik_ISoundEffectControl.h [code] | |
| ik_ISoundEngine.h [code] | |
| ik_ISoundMixedOutputReceiver.h [code] | |
| ik_ISoundSource.h [code] | |
| ik_ISoundStopEventReceiver.h [code] | |
| ik_IVirtualRefCounted.h [code] | |
| ik_SAudioStreamFormat.h [code] | |
| ik_vec3d.h [code] | |
| irrKlang.h [code] | Main header file of the irrKlang sound library, the only file needed to include |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+Here is a list of all class members with links to the classes they belong to:
+
+
+
+
+
+
+- a -
-
+
- addFileFactory() +: irrklang::ISoundEngine + +
- addSoundSourceAlias() +: irrklang::ISoundEngine + +
- addSoundSourceFromFile() +: irrklang::ISoundEngine + +
- addSoundSourceFromMemory() +: irrklang::ISoundEngine + +
- addSoundSourceFromPCMData() +: irrklang::ISoundEngine + +
- addSoundSourceFromRecordedAudio() +: irrklang::IAudioRecorder + +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+Here is a list of all class members with links to the classes they belong to:
+
+
+
+
+
+
+- c -
-
+
- ChannelCount +: irrklang::SAudioStreamFormat + +
- clearRecordedAudioDataBuffer() +: irrklang::IAudioRecorder + +
- createAudioStream() +: irrklang::IAudioStreamLoader + +
- createFileReader() +: irrklang::IFileFactory + +
- crossProduct() +: irrklang::vec3d< T > + +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+Here is a list of all class members with links to the classes they belong to:
+
+
+
+
+
+
+- d -
-
+
- disableAllEffects() +: irrklang::ISoundEffectControl + +
- disableChorusSoundEffect() +: irrklang::ISoundEffectControl + +
- disableCompressorSoundEffect() +: irrklang::ISoundEffectControl + +
- disableDistortionSoundEffect() +: irrklang::ISoundEffectControl + +
- disableEchoSoundEffect() +: irrklang::ISoundEffectControl + +
- disableFlangerSoundEffect() +: irrklang::ISoundEffectControl + +
- disableGargleSoundEffect() +: irrklang::ISoundEffectControl + +
- disableI3DL2ReverbSoundEffect() +: irrklang::ISoundEffectControl + +
- disableParamEqSoundEffect() +: irrklang::ISoundEffectControl + +
- disableWavesReverbSoundEffect() +: irrklang::ISoundEffectControl + +
- dotProduct() +: irrklang::vec3d< T > + +
- drop() +: irrklang::IVirtualRefCounted +, irrklang::IRefCounted + +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+Here is a list of all class members with links to the classes they belong to:
+
+
+
+
+
+
+- e -
-
+
- enableChorusSoundEffect() +: irrklang::ISoundEffectControl + +
- enableCompressorSoundEffect() +: irrklang::ISoundEffectControl + +
- enableDistortionSoundEffect() +: irrklang::ISoundEffectControl + +
- enableEchoSoundEffect() +: irrklang::ISoundEffectControl + +
- enableFlangerSoundEffect() +: irrklang::ISoundEffectControl + +
- enableGargleSoundEffect() +: irrklang::ISoundEffectControl + +
- enableI3DL2ReverbSoundEffect() +: irrklang::ISoundEffectControl + +
- enableParamEqSoundEffect() +: irrklang::ISoundEffectControl + +
- enableWavesReverbSoundEffect() +: irrklang::ISoundEffectControl + +
- equals() +: irrklang::vec3d< T > + +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+Here is a list of all class members with links to the classes they belong to:
+
+
+
+
+
+
+- f -
-
+
- forceReloadAtNextUse() +: irrklang::ISoundSource + +
- FrameCount +: irrklang::SAudioStreamFormat + +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+Here is a list of all class members with links to the classes they belong to:
+
+
+
+
+
+
+- g -
-
+
- getAs4Values() +: irrklang::vec3d< T > + +
- getAudioFormat() +: irrklang::IAudioRecorder +, irrklang::ISoundSource + +
- getBytesPerSecond() +: irrklang::SAudioStreamFormat + +
- getDefault3DSoundMaxDistance() +: irrklang::ISoundEngine + +
- getDefault3DSoundMinDistance() +: irrklang::ISoundEngine + +
- getDefaultMaxDistance() +: irrklang::ISoundSource + +
- getDefaultMinDistance() +: irrklang::ISoundSource + +
- getDefaultVolume() +: irrklang::ISoundSource + +
- getDeviceCount() +: irrklang::ISoundDeviceList + +
- getDeviceDescription() +: irrklang::ISoundDeviceList + +
- getDeviceID() +: irrklang::ISoundDeviceList + +
- getDistanceFrom() +: irrklang::vec3d< T > + +
- getDistanceFromSQ() +: irrklang::vec3d< T > + +
- getDriverName() +: irrklang::ISoundEngine +, irrklang::IAudioRecorder + +
- getFileName() +: irrklang::IFileReader + +
- getForcedStreamingThreshold() +: irrklang::ISoundSource + +
- getFormat() +: irrklang::IAudioStream + +
- getFrameSize() +: irrklang::SAudioStreamFormat + +
- getHorizontalAngle() +: irrklang::vec3d< T > + +
- getInternalAudioInterface() +: irrklang::ISoundEngine + +
- getInterpolated() +: irrklang::vec3d< T > + +
- getIsPaused() +: irrklang::ISound + +
- getIsSeekingSupported() +: irrklang::IAudioStream +, irrklang::ISoundSource + +
- getLength() +: irrklang::vec3d< T > + +
- getLengthSQ() +: irrklang::vec3d< T > + +
- getMaxDistance() +: irrklang::ISound + +
- getMinDistance() +: irrklang::ISound + +
- getName() +: irrklang::ISoundSource + +
- getPan() +: irrklang::ISound + +
- getPlaybackSpeed() +: irrklang::ISound + +
- getPlayLength() +: irrklang::ISound +, irrklang::ISoundSource + +
- getPlayPosition() +: irrklang::ISound + +
- getPos() +: irrklang::IFileReader + +
- getPosition() +: irrklang::ISound + +
- getRecordedAudioData() +: irrklang::IAudioRecorder + +
- getSampleData() +: irrklang::ISoundSource + +
- getSampleDataSize() +: irrklang::SAudioStreamFormat + +
- getSampleSize() +: irrklang::SAudioStreamFormat + +
- getSize() +: irrklang::IFileReader + +
- getSoundEffectControl() +: irrklang::ISound + +
- getSoundSource() +: irrklang::ISound +, irrklang::ISoundEngine + +
- getSoundSourceCount() +: irrklang::ISoundEngine + +
- getSoundVolume() +: irrklang::ISoundEngine + +
- getStreamMode() +: irrklang::ISoundSource + +
- getVelocity() +: irrklang::ISound + +
- getVolume() +: irrklang::ISound + +
- grab() +: irrklang::IVirtualRefCounted +, irrklang::IRefCounted + +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+Here is a list of all class members with links to the classes they belong to:
+
+
+
+
+
+
+- i -
-
+
- invert() +: irrklang::vec3d< T > + +
- IRefCounted() +: irrklang::IRefCounted + +
- isALoadableFileExtension() +: irrklang::IAudioStreamLoader + +
- isBetweenPoints() +: irrklang::vec3d< T > + +
- isChorusSoundEffectEnabled() +: irrklang::ISoundEffectControl + +
- isCompressorSoundEffectEnabled() +: irrklang::ISoundEffectControl + +
- isCurrentlyPlaying() +: irrklang::ISoundEngine + +
- isDistortionSoundEffectEnabled() +: irrklang::ISoundEffectControl + +
- isEchoSoundEffectEnabled() +: irrklang::ISoundEffectControl + +
- isFinished() +: irrklang::ISound + +
- isFlangerSoundEffectEnabled() +: irrklang::ISoundEffectControl + +
- isGargleSoundEffectEnabled() +: irrklang::ISoundEffectControl + +
- isI3DL2ReverbSoundEffectEnabled() +: irrklang::ISoundEffectControl + +
- isLooped() +: irrklang::ISound + +
- isMultiThreaded() +: irrklang::ISoundEngine + +
- isParamEqSoundEffectEnabled() +: irrklang::ISoundEffectControl + +
- isRecording() +: irrklang::IAudioRecorder + +
- isWavesReverbSoundEffectEnabled() +: irrklang::ISoundEffectControl + +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+Here is a list of all class members with links to the classes they belong to:
+
+
+
+
+
+
+- l -
-
+
- loadPlugins() +: irrklang::ISoundEngine + +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+Here is a list of all class members with links to the classes they belong to:
+
+
+
+
+
+
+- n -
-
+
- normalize() +: irrklang::vec3d< T > + +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+Here is a list of all class members with links to the classes they belong to:
+
+
+
+
+
+
+- o -
-
+
- OnAudioDataReady() +: irrklang::ISoundMixedOutputReceiver + +
- OnReceiveAudioDataStreamChunk() +: irrklang::ICapturedAudioDataReceiver + +
- OnSoundStopped() +: irrklang::ISoundStopEventReceiver + +
- operator!=() +: irrklang::vec3d< T > + +
- operator*() +: irrklang::vec3d< T > + +
- operator*=() +: irrklang::vec3d< T > + +
- operator+() +: irrklang::vec3d< T > + +
- operator+=() +: irrklang::vec3d< T > + +
- operator-() +: irrklang::vec3d< T > + +
- operator-=() +: irrklang::vec3d< T > + +
- operator/() +: irrklang::vec3d< T > + +
- operator/=() +: irrklang::vec3d< T > + +
- operator<=() +: irrklang::vec3d< T > + +
- operator=() +: irrklang::vec3d< T > + +
- operator==() +: irrklang::vec3d< T > + +
- operator>=() +: irrklang::vec3d< T > + +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+Here is a list of all class members with links to the classes they belong to:
+
+
+
+
+
+
+- p -
-
+
- pALSA_SND_PCM +: irrklang::SInternalAudioInterface + +
- pCoreAudioDeciceID +: irrklang::SInternalAudioInterface + +
- pIDirectSound +: irrklang::SInternalAudioInterface + +
- pIDirectSound8 +: irrklang::SInternalAudioInterface + +
- play2D() +: irrklang::ISoundEngine + +
- play3D() +: irrklang::ISoundEngine + +
- pWinMM_HWaveOut +: irrklang::SInternalAudioInterface + +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+Here is a list of all class members with links to the classes they belong to:
+
+
+
+
+
+
+- r -
-
+
- read() +: irrklang::IFileReader + +
- readFrames() +: irrklang::IAudioStream + +
- registerAudioStreamLoader() +: irrklang::ISoundEngine + +
- removeAllSoundSources() +: irrklang::ISoundEngine + +
- removeSoundSource() +: irrklang::ISoundEngine + +
- rotateXYBy() +: irrklang::vec3d< T > + +
- rotateXZBy() +: irrklang::vec3d< T > + +
- rotateYZBy() +: irrklang::vec3d< T > + +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+Here is a list of all class members with links to the classes they belong to:
+
+
+
+
+
+
+- s -
-
+
- SampleFormat +: irrklang::SAudioStreamFormat + +
- SampleRate +: irrklang::SAudioStreamFormat + +
- seek() +: irrklang::IFileReader + +
- set() +: irrklang::vec3d< T > + +
- setAllSoundsPaused() +: irrklang::ISoundEngine + +
- setDefault3DSoundMaxDistance() +: irrklang::ISoundEngine + +
- setDefault3DSoundMinDistance() +: irrklang::ISoundEngine + +
- setDefaultMaxDistance() +: irrklang::ISoundSource + +
- setDefaultMinDistance() +: irrklang::ISoundSource + +
- setDefaultVolume() +: irrklang::ISoundSource + +
- setDopplerEffectParameters() +: irrklang::ISoundEngine + +
- setForcedStreamingThreshold() +: irrklang::ISoundSource + +
- setIsLooped() +: irrklang::ISound + +
- setIsPaused() +: irrklang::ISound + +
- setLength() +: irrklang::vec3d< T > + +
- setListenerPosition() +: irrklang::ISoundEngine + +
- setMaxDistance() +: irrklang::ISound + +
- setMinDistance() +: irrklang::ISound + +
- setMixedDataOutputReceiver() +: irrklang::ISoundEngine + +
- setPan() +: irrklang::ISound + +
- setPlaybackSpeed() +: irrklang::ISound + +
- setPlayPosition() +: irrklang::ISound + +
- setPosition() +: irrklang::IAudioStream +, irrklang::ISound + +
- setRolloffFactor() +: irrklang::ISoundEngine + +
- setSoundStopEventReceiver() +: irrklang::ISound + +
- setSoundVolume() +: irrklang::ISoundEngine + +
- setStreamMode() +: irrklang::ISoundSource + +
- setVelocity() +: irrklang::ISound + +
- setVolume() +: irrklang::ISound + +
- startRecordingBufferedAudio() +: irrklang::IAudioRecorder + +
- startRecordingCustomHandledAudio() +: irrklang::IAudioRecorder + +
- stop() +: irrklang::ISound + +
- stopAllSounds() +: irrklang::ISoundEngine + +
- stopAllSoundsOfSoundSource() +: irrklang::ISoundEngine + +
- stopRecordingAudio() +: irrklang::IAudioRecorder + +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+Here is a list of all class members with links to the classes they belong to:
+
+
+
+
+
+
+- u -
-
+
- update() +: irrklang::ISoundEngine + +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+Here is a list of all class members with links to the classes they belong to:
+
+
+
+
+
+
+- v -
-
+
- vec3d() +: irrklang::vec3d< T > + +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+Here is a list of all class members with links to the classes they belong to:
+
+
+
+
+
+
+- x -
-
+
- X +: irrklang::vec3d< T > + +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+Here is a list of all class members with links to the classes they belong to:
+
+
+
+
+
+
+- y -
-
+
- Y +: irrklang::vec3d< T > + +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+Here is a list of all class members with links to the classes they belong to:
+
+
+
+
+
+
+- z -
-
+
- Z +: irrklang::vec3d< T > + +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+Here is a list of all class members with links to the classes they belong to:
+
+
+
+
+
+
+- ~ -
-
+
- ~IAudioStream() +: irrklang::IAudioStream + +
- ~IAudioStreamLoader() +: irrklang::IAudioStreamLoader + +
- ~IFileFactory() +: irrklang::IFileFactory + +
- ~IFileReader() +: irrklang::IFileReader + +
- ~IRefCounted() +: irrklang::IRefCounted + +
- ~ISoundMixedOutputReceiver() +: irrklang::ISoundMixedOutputReceiver + +
- ~ISoundStopEventReceiver() +: irrklang::ISoundStopEventReceiver + +
- ~IVirtualRefCounted() +: irrklang::IVirtualRefCounted + +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
+
+
+
+
+- a -
-
+
- addFileFactory() +: irrklang::ISoundEngine + +
- addSoundSourceAlias() +: irrklang::ISoundEngine + +
- addSoundSourceFromFile() +: irrklang::ISoundEngine + +
- addSoundSourceFromMemory() +: irrklang::ISoundEngine + +
- addSoundSourceFromPCMData() +: irrklang::ISoundEngine + +
- addSoundSourceFromRecordedAudio() +: irrklang::IAudioRecorder + +
- c -
-
+
- clearRecordedAudioDataBuffer() +: irrklang::IAudioRecorder + +
- createAudioStream() +: irrklang::IAudioStreamLoader + +
- createFileReader() +: irrklang::IFileFactory + +
- crossProduct() +: irrklang::vec3d< T > + +
- d -
-
+
- disableAllEffects() +: irrklang::ISoundEffectControl + +
- disableChorusSoundEffect() +: irrklang::ISoundEffectControl + +
- disableCompressorSoundEffect() +: irrklang::ISoundEffectControl + +
- disableDistortionSoundEffect() +: irrklang::ISoundEffectControl + +
- disableEchoSoundEffect() +: irrklang::ISoundEffectControl + +
- disableFlangerSoundEffect() +: irrklang::ISoundEffectControl + +
- disableGargleSoundEffect() +: irrklang::ISoundEffectControl + +
- disableI3DL2ReverbSoundEffect() +: irrklang::ISoundEffectControl + +
- disableParamEqSoundEffect() +: irrklang::ISoundEffectControl + +
- disableWavesReverbSoundEffect() +: irrklang::ISoundEffectControl + +
- dotProduct() +: irrklang::vec3d< T > + +
- drop() +: irrklang::IVirtualRefCounted +, irrklang::IRefCounted + +
- e -
-
+
- enableChorusSoundEffect() +: irrklang::ISoundEffectControl + +
- enableCompressorSoundEffect() +: irrklang::ISoundEffectControl + +
- enableDistortionSoundEffect() +: irrklang::ISoundEffectControl + +
- enableEchoSoundEffect() +: irrklang::ISoundEffectControl + +
- enableFlangerSoundEffect() +: irrklang::ISoundEffectControl + +
- enableGargleSoundEffect() +: irrklang::ISoundEffectControl + +
- enableI3DL2ReverbSoundEffect() +: irrklang::ISoundEffectControl + +
- enableParamEqSoundEffect() +: irrklang::ISoundEffectControl + +
- enableWavesReverbSoundEffect() +: irrklang::ISoundEffectControl + +
- equals() +: irrklang::vec3d< T > + +
- f -
-
+
- forceReloadAtNextUse() +: irrklang::ISoundSource + +
- g -
-
+
- getAs4Values() +: irrklang::vec3d< T > + +
- getAudioFormat() +: irrklang::IAudioRecorder +, irrklang::ISoundSource + +
- getBytesPerSecond() +: irrklang::SAudioStreamFormat + +
- getDefault3DSoundMaxDistance() +: irrklang::ISoundEngine + +
- getDefault3DSoundMinDistance() +: irrklang::ISoundEngine + +
- getDefaultMaxDistance() +: irrklang::ISoundSource + +
- getDefaultMinDistance() +: irrklang::ISoundSource + +
- getDefaultVolume() +: irrklang::ISoundSource + +
- getDeviceCount() +: irrklang::ISoundDeviceList + +
- getDeviceDescription() +: irrklang::ISoundDeviceList + +
- getDeviceID() +: irrklang::ISoundDeviceList + +
- getDistanceFrom() +: irrklang::vec3d< T > + +
- getDistanceFromSQ() +: irrklang::vec3d< T > + +
- getDriverName() +: irrklang::ISoundEngine +, irrklang::IAudioRecorder + +
- getFileName() +: irrklang::IFileReader + +
- getForcedStreamingThreshold() +: irrklang::ISoundSource + +
- getFormat() +: irrklang::IAudioStream + +
- getFrameSize() +: irrklang::SAudioStreamFormat + +
- getHorizontalAngle() +: irrklang::vec3d< T > + +
- getInternalAudioInterface() +: irrklang::ISoundEngine + +
- getInterpolated() +: irrklang::vec3d< T > + +
- getIsPaused() +: irrklang::ISound + +
- getIsSeekingSupported() +: irrklang::IAudioStream +, irrklang::ISoundSource + +
- getLength() +: irrklang::vec3d< T > + +
- getLengthSQ() +: irrklang::vec3d< T > + +
- getMaxDistance() +: irrklang::ISound + +
- getMinDistance() +: irrklang::ISound + +
- getName() +: irrklang::ISoundSource + +
- getPan() +: irrklang::ISound + +
- getPlaybackSpeed() +: irrklang::ISound + +
- getPlayLength() +: irrklang::ISound +, irrklang::ISoundSource + +
- getPlayPosition() +: irrklang::ISound + +
- getPos() +: irrklang::IFileReader + +
- getPosition() +: irrklang::ISound + +
- getRecordedAudioData() +: irrklang::IAudioRecorder + +
- getSampleData() +: irrklang::ISoundSource + +
- getSampleDataSize() +: irrklang::SAudioStreamFormat + +
- getSampleSize() +: irrklang::SAudioStreamFormat + +
- getSize() +: irrklang::IFileReader + +
- getSoundEffectControl() +: irrklang::ISound + +
- getSoundSource() +: irrklang::ISound +, irrklang::ISoundEngine + +
- getSoundSourceCount() +: irrklang::ISoundEngine + +
- getSoundVolume() +: irrklang::ISoundEngine + +
- getStreamMode() +: irrklang::ISoundSource + +
- getVelocity() +: irrklang::ISound + +
- getVolume() +: irrklang::ISound + +
- grab() +: irrklang::IVirtualRefCounted +, irrklang::IRefCounted + +
- i -
-
+
- invert() +: irrklang::vec3d< T > + +
- IRefCounted() +: irrklang::IRefCounted + +
- isALoadableFileExtension() +: irrklang::IAudioStreamLoader + +
- isBetweenPoints() +: irrklang::vec3d< T > + +
- isChorusSoundEffectEnabled() +: irrklang::ISoundEffectControl + +
- isCompressorSoundEffectEnabled() +: irrklang::ISoundEffectControl + +
- isCurrentlyPlaying() +: irrklang::ISoundEngine + +
- isDistortionSoundEffectEnabled() +: irrklang::ISoundEffectControl + +
- isEchoSoundEffectEnabled() +: irrklang::ISoundEffectControl + +
- isFinished() +: irrklang::ISound + +
- isFlangerSoundEffectEnabled() +: irrklang::ISoundEffectControl + +
- isGargleSoundEffectEnabled() +: irrklang::ISoundEffectControl + +
- isI3DL2ReverbSoundEffectEnabled() +: irrklang::ISoundEffectControl + +
- isLooped() +: irrklang::ISound + +
- isMultiThreaded() +: irrklang::ISoundEngine + +
- isParamEqSoundEffectEnabled() +: irrklang::ISoundEffectControl + +
- isRecording() +: irrklang::IAudioRecorder + +
- isWavesReverbSoundEffectEnabled() +: irrklang::ISoundEffectControl + +
- l -
-
+
- loadPlugins() +: irrklang::ISoundEngine + +
- n -
-
+
- normalize() +: irrklang::vec3d< T > + +
- o -
-
+
- OnAudioDataReady() +: irrklang::ISoundMixedOutputReceiver + +
- OnReceiveAudioDataStreamChunk() +: irrklang::ICapturedAudioDataReceiver + +
- OnSoundStopped() +: irrklang::ISoundStopEventReceiver + +
- operator!=() +: irrklang::vec3d< T > + +
- operator*() +: irrklang::vec3d< T > + +
- operator*=() +: irrklang::vec3d< T > + +
- operator+() +: irrklang::vec3d< T > + +
- operator+=() +: irrklang::vec3d< T > + +
- operator-() +: irrklang::vec3d< T > + +
- operator-=() +: irrklang::vec3d< T > + +
- operator/() +: irrklang::vec3d< T > + +
- operator/=() +: irrklang::vec3d< T > + +
- operator<=() +: irrklang::vec3d< T > + +
- operator=() +: irrklang::vec3d< T > + +
- operator==() +: irrklang::vec3d< T > + +
- operator>=() +: irrklang::vec3d< T > + +
- p -
-
+
- play2D() +: irrklang::ISoundEngine + +
- play3D() +: irrklang::ISoundEngine + +
- r -
-
+
- read() +: irrklang::IFileReader + +
- readFrames() +: irrklang::IAudioStream + +
- registerAudioStreamLoader() +: irrklang::ISoundEngine + +
- removeAllSoundSources() +: irrklang::ISoundEngine + +
- removeSoundSource() +: irrklang::ISoundEngine + +
- rotateXYBy() +: irrklang::vec3d< T > + +
- rotateXZBy() +: irrklang::vec3d< T > + +
- rotateYZBy() +: irrklang::vec3d< T > + +
- s -
-
+
- seek() +: irrklang::IFileReader + +
- set() +: irrklang::vec3d< T > + +
- setAllSoundsPaused() +: irrklang::ISoundEngine + +
- setDefault3DSoundMaxDistance() +: irrklang::ISoundEngine + +
- setDefault3DSoundMinDistance() +: irrklang::ISoundEngine + +
- setDefaultMaxDistance() +: irrklang::ISoundSource + +
- setDefaultMinDistance() +: irrklang::ISoundSource + +
- setDefaultVolume() +: irrklang::ISoundSource + +
- setDopplerEffectParameters() +: irrklang::ISoundEngine + +
- setForcedStreamingThreshold() +: irrklang::ISoundSource + +
- setIsLooped() +: irrklang::ISound + +
- setIsPaused() +: irrklang::ISound + +
- setLength() +: irrklang::vec3d< T > + +
- setListenerPosition() +: irrklang::ISoundEngine + +
- setMaxDistance() +: irrklang::ISound + +
- setMinDistance() +: irrklang::ISound + +
- setMixedDataOutputReceiver() +: irrklang::ISoundEngine + +
- setPan() +: irrklang::ISound + +
- setPlaybackSpeed() +: irrklang::ISound + +
- setPlayPosition() +: irrklang::ISound + +
- setPosition() +: irrklang::IAudioStream +, irrklang::ISound + +
- setRolloffFactor() +: irrklang::ISoundEngine + +
- setSoundStopEventReceiver() +: irrklang::ISound + +
- setSoundVolume() +: irrklang::ISoundEngine + +
- setStreamMode() +: irrklang::ISoundSource + +
- setVelocity() +: irrklang::ISound + +
- setVolume() +: irrklang::ISound + +
- startRecordingBufferedAudio() +: irrklang::IAudioRecorder + +
- startRecordingCustomHandledAudio() +: irrklang::IAudioRecorder + +
- stop() +: irrklang::ISound + +
- stopAllSounds() +: irrklang::ISoundEngine + +
- stopAllSoundsOfSoundSource() +: irrklang::ISoundEngine + +
- stopRecordingAudio() +: irrklang::IAudioRecorder + +
- u -
-
+
- update() +: irrklang::ISoundEngine + +
- v -
-
+
- vec3d() +: irrklang::vec3d< T > + +
- ~ -
-
+
- ~IAudioStream() +: irrklang::IAudioStream + +
- ~IAudioStreamLoader() +: irrklang::IAudioStreamLoader + +
- ~IFileFactory() +: irrklang::IFileFactory + +
- ~IFileReader() +: irrklang::IFileReader + +
- ~IRefCounted() +: irrklang::IRefCounted + +
- ~ISoundMixedOutputReceiver() +: irrklang::ISoundMixedOutputReceiver + +
- ~ISoundStopEventReceiver() +: irrklang::ISoundStopEventReceiver + +
- ~IVirtualRefCounted() +: irrklang::IVirtualRefCounted + +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
+
+
+-
+
- ChannelCount +: irrklang::SAudioStreamFormat + +
- FrameCount +: irrklang::SAudioStreamFormat + +
- pALSA_SND_PCM +: irrklang::SInternalAudioInterface + +
- pCoreAudioDeciceID +: irrklang::SInternalAudioInterface + +
- pIDirectSound +: irrklang::SInternalAudioInterface + +
- pIDirectSound8 +: irrklang::SInternalAudioInterface + +
- pWinMM_HWaveOut +: irrklang::SInternalAudioInterface + +
- SampleFormat +: irrklang::SAudioStreamFormat + +
- SampleRate +: irrklang::SAudioStreamFormat + +
- X +: irrklang::vec3d< T > + +
- Y +: irrklang::vec3d< T > + +
- Z +: irrklang::vec3d< T > + +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+-
+
- File List +
- File Members +
+Here is a list of all file members with links to the files they belong to:
+
+
+
+
+-
+
- IRR_KLANG_VERSION +: irrKlang.h + +
- IRRKLANG_API +: irrKlang.h + +
- IRRKLANGCALLCONV +: irrKlang.h + +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+-
+
- File List +
- File Members +
+
+
+
+
+
+-
+
- IRR_KLANG_VERSION +: irrKlang.h + +
- IRRKLANG_API +: irrKlang.h + +
- IRRKLANGCALLCONV +: irrKlang.h + +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
+
+
+Class Hierarchy
This inheritance list is sorted roughly, but not completely, alphabetically: +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
+
+
+
+
+
+
+
+ik_ESoundEngineOptions.h File Reference
+Go to the source code of this file.
+Namespaces | |
| namespace | irrklang |
Everything in the irrKlang Sound Engine can be found in this namespace. + | |
Enumerations | |
| enum | irrklang::E_SOUND_ENGINE_OPTIONS { + irrklang::ESEO_MULTI_THREADED = 0x01, +irrklang::ESEO_MUTE_IF_NOT_FOCUSED = 0x02, +irrklang::ESEO_LOAD_PLUGINS = 0x04, +irrklang::ESEO_USE_3D_BUFFERS = 0x08, + + irrklang::ESEO_PRINT_DEBUG_INFO_TO_DEBUGGER = 0x10, +irrklang::ESEO_PRINT_DEBUG_INFO_TO_STDOUT = 0x20, +irrklang::ESEO_LINEAR_ROLLOFF = 0x40, +irrklang::ESEO_DEFAULT_OPTIONS = ESEO_MULTI_THREADED | ESEO_LOAD_PLUGINS | ESEO_USE_3D_BUFFERS | ESEO_PRINT_DEBUG_INFO_TO_DEBUGGER | ESEO_PRINT_DEBUG_INFO_TO_STDOUT, + + irrklang::ESEO_FORCE_32_BIT = 0x7fffffff + + } |
An enumeration for all options for starting up the sound engine. + More... | |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
ik_ESoundEngineOptions.h
Go to the documentation of this file.00001 // Copyright (C) 2002-2018 Nikolaus Gebhardt +00002 // This file is part of the "irrKlang" library. +00003 // For conditions of distribution and use, see copyright notice in irrKlang.h +00004 +00005 #ifndef __E_IRRKLANG_SOUND_ENGINE_OPTIONS_H_INCLUDED__ +00006 #define __E_IRRKLANG_SOUND_ENGINE_OPTIONS_H_INCLUDED__ +00007 +00008 namespace irrklang +00009 { +00011 +00015 enum E_SOUND_ENGINE_OPTIONS +00016 { +00018 +00023 ESEO_MULTI_THREADED = 0x01, +00024 +00026 +00027 ESEO_MUTE_IF_NOT_FOCUSED = 0x02, +00028 +00030 +00037 ESEO_LOAD_PLUGINS = 0x04, +00038 +00040 +00043 ESEO_USE_3D_BUFFERS = 0x08, +00044 +00046 +00049 ESEO_PRINT_DEBUG_INFO_TO_DEBUGGER = 0x10, +00050 +00052 +00053 ESEO_PRINT_DEBUG_INFO_TO_STDOUT = 0x20, +00054 +00056 +00064 ESEO_LINEAR_ROLLOFF = 0x40, +00065 +00067 ESEO_DEFAULT_OPTIONS = ESEO_MULTI_THREADED | ESEO_LOAD_PLUGINS | ESEO_USE_3D_BUFFERS | ESEO_PRINT_DEBUG_INFO_TO_DEBUGGER | ESEO_PRINT_DEBUG_INFO_TO_STDOUT, +00068 +00070 +00071 ESEO_FORCE_32_BIT = 0x7fffffff +00072 }; +00073 +00074 } // end namespace irrklang +00075 +00076 +00077 #endif +00078 +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
+
+
+
+
+
+
+
+ik_ESoundOutputDrivers.h File Reference
+Go to the source code of this file.
+Namespaces | |
| namespace | irrklang |
Everything in the irrKlang Sound Engine can be found in this namespace. + | |
Enumerations | |
| enum | irrklang::E_SOUND_OUTPUT_DRIVER { + irrklang::ESOD_AUTO_DETECT = 0, +irrklang::ESOD_DIRECT_SOUND_8, +irrklang::ESOD_DIRECT_SOUND, +irrklang::ESOD_WIN_MM, + + irrklang::ESOD_ALSA, +irrklang::ESOD_CORE_AUDIO, +irrklang::ESOD_NULL, +irrklang::ESOD_COUNT, + + irrklang::ESOD_FORCE_32_BIT = 0x7fffffff + + } |
An enumeration for all types of supported sound drivers. + More... | |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
ik_ESoundOutputDrivers.h
Go to the documentation of this file.00001 // Copyright (C) 2002-2018 Nikolaus Gebhardt +00002 // This file is part of the "irrKlang" library. +00003 // For conditions of distribution and use, see copyright notice in irrKlang.h +00004 +00005 #ifndef __E_IRRKLANG_SOUND_OUTPUT_DRIVERS_H_INCLUDED__ +00006 #define __E_IRRKLANG_SOUND_OUTPUT_DRIVERS_H_INCLUDED__ +00007 +00008 namespace irrklang +00009 { +00011 +00012 enum E_SOUND_OUTPUT_DRIVER +00013 { +00015 ESOD_AUTO_DETECT = 0, +00016 +00018 +00021 ESOD_DIRECT_SOUND_8, +00022 +00024 +00028 ESOD_DIRECT_SOUND, +00029 +00031 +00032 ESOD_WIN_MM, +00033 +00035 +00039 ESOD_ALSA, +00040 +00042 +00043 ESOD_CORE_AUDIO, +00044 +00046 ESOD_NULL, +00047 +00049 ESOD_COUNT, +00050 +00053 ESOD_FORCE_32_BIT = 0x7fffffff +00054 }; +00055 +00056 } // end namespace irrklang +00057 +00058 #endif +00059 +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
+
+
+
+
+
+
+
+ik_EStreamModes.h File Reference
+Go to the source code of this file.
+Namespaces | |
| namespace | irrklang |
Everything in the irrKlang Sound Engine can be found in this namespace. + | |
Enumerations | |
| enum | irrklang::E_STREAM_MODE { irrklang::ESM_AUTO_DETECT = 0, +irrklang::ESM_STREAMING, +irrklang::ESM_NO_STREAMING, +irrklang::ESM_FORCE_32_BIT = 0x7fffffff + } |
An enumeration for all types of supported stream modes. + More... | |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
ik_EStreamModes.h
Go to the documentation of this file.00001 // Copyright (C) 2002-2018 Nikolaus Gebhardt +00002 // This file is part of the "irrKlang" library. +00003 // For conditions of distribution and use, see copyright notice in irrKlang.h +00004 +00005 #ifndef __E_IRRKLANG_STREAM_MODES_H_INCLUDED__ +00006 #define __E_IRRKLANG_STREAM_MODES_H_INCLUDED__ +00007 +00008 namespace irrklang +00009 { +00011 enum E_STREAM_MODE +00012 { +00014 ESM_AUTO_DETECT = 0, +00015 +00017 ESM_STREAMING, +00018 +00020 ESM_NO_STREAMING, +00021 +00024 ESM_FORCE_32_BIT = 0x7fffffff +00025 }; +00026 +00027 } // end namespace irrklang +00028 +00029 +00030 #endif +00031 +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
+
+
+ +
+
+
+
+
+
+
+ik_IAudioRecorder.h File Reference
#include "ik_IRefCounted.h"+
#include "ik_ISoundSource.h"+ +
Go to the source code of this file.
+Classes | |
| class | irrklang::IAudioRecorder |
| Interface to an audio recorder. Create it using the createIrrKlangAudioRecorder() function. More... | |
| class | irrklang::ICapturedAudioDataReceiver |
| Interface to be implemented by the user if access to the recorded audio data is needed. More... | |
Namespaces | |
| namespace | irrklang |
Everything in the irrKlang Sound Engine can be found in this namespace. + | |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
ik_IAudioRecorder.h
Go to the documentation of this file.00001 // Copyright (C) 2002-2018 Nikolaus Gebhardt +00002 // This file is part of the "irrKlang" library. +00003 // For conditions of distribution and use, see copyright notice in irrKlang.h +00004 +00005 #ifndef __I_IRRKLANG_AUDIO_RECORDER_H_INCLUDED__ +00006 #define __I_IRRKLANG_AUDIO_RECORDER_H_INCLUDED__ +00007 +00008 #include "ik_IRefCounted.h" +00009 #include "ik_ISoundSource.h" +00010 +00011 +00012 namespace irrklang +00013 { +00014 class ICapturedAudioDataReceiver; +00015 +00017 +00019 class IAudioRecorder : public virtual IRefCounted +00020 { +00021 public: +00022 +00024 +00034 virtual bool startRecordingBufferedAudio(ik_s32 sampleRate=22000, +00035 ESampleFormat sampleFormat=ESF_S16, +00036 ik_s32 channelCount=1) = 0; +00037 +00039 +00050 virtual bool startRecordingCustomHandledAudio(ICapturedAudioDataReceiver* receiver, +00051 ik_s32 sampleRate=22000, +00052 ESampleFormat sampleFormat=ESF_S16, +00053 ik_s32 channelCount=1) = 0; +00054 +00056 virtual void stopRecordingAudio() = 0; +00057 +00059 +00064 virtual ISoundSource* addSoundSourceFromRecordedAudio(const char* soundName) = 0; +00065 +00067 +00068 virtual void clearRecordedAudioDataBuffer() = 0; +00069 +00071 virtual bool isRecording() = 0; +00072 +00074 +00075 virtual SAudioStreamFormat getAudioFormat() = 0; +00076 +00078 +00084 virtual void* getRecordedAudioData() = 0; +00085 +00087 +00089 virtual const char* getDriverName() = 0; +00090 }; +00091 +00092 +00094 +00095 class ICapturedAudioDataReceiver : public IRefCounted +00096 { +00097 public: +00098 +00100 +00103 virtual void OnReceiveAudioDataStreamChunk(unsigned char* audioData, unsigned long lengthInBytes) = 0; +00104 }; +00105 +00106 +00107 } // end namespace irrklang +00108 +00109 +00110 #endif +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
+
+
+ +
+
+
+
+
+
+
+ik_IAudioStream.h File Reference
#include "ik_IRefCounted.h"+
#include "ik_SAudioStreamFormat.h"+ +
Go to the source code of this file.
+Classes | |
| class | irrklang::IAudioStream |
| Reads and decodes audio data into an usable audio stream for the ISoundEngine. More... | |
Namespaces | |
| namespace | irrklang |
Everything in the irrKlang Sound Engine can be found in this namespace. + | |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
ik_IAudioStream.h
Go to the documentation of this file.00001 // Copyright (C) 2002-2018 Nikolaus Gebhardt +00002 // This file is part of the "irrKlang" library. +00003 // For conditions of distribution and use, see copyright notice in irrKlang.h +00004 +00005 #ifndef __I_IRRKLANG_AUDIO_STREAM_H_INCLUDED__ +00006 #define __I_IRRKLANG_AUDIO_STREAM_H_INCLUDED__ +00007 +00008 #include "ik_IRefCounted.h" +00009 #include "ik_SAudioStreamFormat.h" +00010 +00011 namespace irrklang +00012 { +00013 +00014 +00016 class IAudioStream : public IRefCounted +00017 { +00018 public: +00019 +00021 virtual ~IAudioStream() {}; +00022 +00024 virtual SAudioStreamFormat getFormat() = 0; +00025 +00027 +00031 virtual bool setPosition(ik_s32 pos) = 0; +00032 +00034 /* Some file formats like (MODs) don't support seeking */ +00035 virtual bool getIsSeekingSupported() { return true; } +00036 +00038 +00042 virtual ik_s32 readFrames(void* target, ik_s32 frameCountToRead) = 0; +00043 }; +00044 +00045 +00046 } // end namespace irrklang +00047 +00048 #endif +00049 +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
+
+
+ +
+
+
+
+
+
+
+ik_IAudioStreamLoader.h File Reference
#include "ik_IRefCounted.h"+
#include "ik_IFileReader.h"+ +
Go to the source code of this file.
+Classes | |
| class | irrklang::IAudioStreamLoader |
| Class which is able to create an audio file stream from a file. More... | |
Namespaces | |
| namespace | irrklang |
Everything in the irrKlang Sound Engine can be found in this namespace. + | |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
ik_IAudioStreamLoader.h
Go to the documentation of this file.00001 // Copyright (C) 2002-2018 Nikolaus Gebhardt +00002 // This file is part of the "irrKlang" library. +00003 // For conditions of distribution and use, see copyright notice in irrKlang.h +00004 +00005 #ifndef __I_IRRKLANG_AUDIO_STREAM_LOADER_H_INCLUDED__ +00006 #define __I_IRRKLANG_AUDIO_STREAM_LOADER_H_INCLUDED__ +00007 +00008 #include "ik_IRefCounted.h" +00009 #include "ik_IFileReader.h" +00010 +00011 namespace irrklang +00012 { +00013 +00014 class IAudioStream; +00015 +00017 class IAudioStreamLoader : public IRefCounted +00018 { +00019 public: +00020 +00022 virtual ~IAudioStreamLoader() {}; +00023 +00025 +00027 virtual bool isALoadableFileExtension(const ik_c8* fileName) = 0; +00028 +00030 +00033 virtual IAudioStream* createAudioStream(IFileReader* file) = 0; +00034 }; +00035 +00036 +00037 } // end namespace irrklang +00038 +00039 #endif +00040 +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
+
+ +
+
+
+
+
+
+
+ik_IFileFactory.h File Reference
#include "ik_IRefCounted.h"+ +
Go to the source code of this file.
+Classes | |
| class | irrklang::IFileFactory |
| Interface to overwrite file access in irrKlang. More... | |
Namespaces | |
| namespace | irrklang |
Everything in the irrKlang Sound Engine can be found in this namespace. + | |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
ik_IFileFactory.h
Go to the documentation of this file.00001 // Copyright (C) 2002-2018 Nikolaus Gebhardt +00002 // This file is part of the "irrKlang" library. +00003 // For conditions of distribution and use, see copyright notice in irrKlang.h +00004 +00005 #ifndef __I_IRRKLANG_FILE_FACTORY_H_INCLUDED__ +00006 #define __I_IRRKLANG_FILE_FACTORY_H_INCLUDED__ +00007 +00008 #include "ik_IRefCounted.h" +00009 +00010 namespace irrklang +00011 { +00012 class IFileReader; +00013 +00015 +00020 class IFileFactory : public virtual IRefCounted +00021 { +00022 public: +00023 +00024 virtual ~IFileFactory() {}; +00025 +00027 +00035 virtual IFileReader* createFileReader(const ik_c8* filename) = 0; +00036 }; +00037 +00038 } // end namespace irrklang +00039 +00040 #endif +00041 +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
+
+ +
+
+
+
+
+
+
+ik_IFileReader.h File Reference
#include "ik_IRefCounted.h"+ +
Go to the source code of this file.
+Classes | |
| class | irrklang::IFileReader |
| Interface providing read acess to a file. More... | |
Namespaces | |
| namespace | irrklang |
Everything in the irrKlang Sound Engine can be found in this namespace. + | |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
ik_IFileReader.h
Go to the documentation of this file.00001 // Copyright (C) 2002-2018 Nikolaus Gebhardt +00002 // This file is part of the "irrKlang" library. +00003 // For conditions of distribution and use, see copyright notice in irrKlang.h +00004 +00005 #ifndef __I_IRRKLANG_READ_FILE_H_INCLUDED__ +00006 #define __I_IRRKLANG_READ_FILE_H_INCLUDED__ +00007 +00008 #include "ik_IRefCounted.h" +00009 +00010 namespace irrklang +00011 { +00012 +00014 class IFileReader : public virtual IRefCounted +00015 { +00016 public: +00017 +00018 virtual ~IFileReader() {}; +00019 +00024 virtual ik_s32 read(void* buffer, ik_u32 sizeToRead) = 0; +00025 +00032 virtual bool seek(ik_s32 finalPos, bool relativeMovement = false) = 0; +00033 +00036 virtual ik_s32 getSize() = 0; +00037 +00040 virtual ik_s32 getPos() = 0; +00041 +00044 virtual const ik_c8* getFileName() = 0; +00045 }; +00046 +00047 } // end namespace irrklang +00048 +00049 #endif +00050 +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
+
+ +
+
+
+
+
+
+
+ik_IRefCounted.h File Reference
#include "ik_irrKlangTypes.h"+ +
Go to the source code of this file.
+Classes | |
| class | irrklang::IRefCounted |
| Base class of most objects of the irrKlang. More... | |
Namespaces | |
| namespace | irrklang |
Everything in the irrKlang Sound Engine can be found in this namespace. + | |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
ik_IRefCounted.h
Go to the documentation of this file.00001 // Copyright (C) 2002-2018 Nikolaus Gebhardt +00002 // This file is part of the "irrKlang" library. +00003 // For conditions of distribution and use, see copyright notice in irrKlang.h +00004 +00005 #ifndef __I_IRRKLANG_IREFERENCE_COUNTED_H_INCLUDED__ +00006 #define __I_IRRKLANG_IREFERENCE_COUNTED_H_INCLUDED__ +00007 +00008 #include "ik_irrKlangTypes.h" +00009 +00010 namespace irrklang +00011 { +00013 +00041 class IRefCounted +00042 { +00043 public: +00044 +00046 IRefCounted() +00047 : ReferenceCounter(1) +00048 { +00049 } +00050 +00052 virtual ~IRefCounted() +00053 { +00054 } +00055 +00080 void grab() { ++ReferenceCounter; } +00081 +00098 bool drop() +00099 { +00100 --ReferenceCounter; +00101 +00102 if (!ReferenceCounter) +00103 { +00104 delete this; +00105 return true; +00106 } +00107 +00108 return false; +00109 } +00110 +00111 private: +00112 +00113 ik_s32 ReferenceCounter; +00114 }; +00115 +00116 } // end namespace irr +00117 +00118 #endif +00119 +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
+
+
+
+ +
+
+
+
+
+
+
+ik_ISound.h File Reference
#include "ik_IVirtualRefCounted.h"+
#include "ik_ISoundEffectControl.h"+
#include "ik_vec3d.h"+ +
Go to the source code of this file.
+Classes | |
| class | irrklang::ISound |
| Represents a sound which is currently played. More... | |
Namespaces | |
| namespace | irrklang |
Everything in the irrKlang Sound Engine can be found in this namespace. + | |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
ik_ISound.h
Go to the documentation of this file.00001 // Copyright (C) 2002-2018 Nikolaus Gebhardt +00002 // This file is part of the "irrKlang" library. +00003 // For conditions of distribution and use, see copyright notice in irrKlang.h +00004 +00005 #ifndef __I_IRRKLANG_SOUND_H_INCLUDED__ +00006 #define __I_IRRKLANG_SOUND_H_INCLUDED__ +00007 +00008 #include "ik_IVirtualRefCounted.h" +00009 #include "ik_ISoundEffectControl.h" +00010 #include "ik_vec3d.h" +00011 +00012 +00013 namespace irrklang +00014 { +00015 class ISoundSource; +00016 class ISoundStopEventReceiver; +00017 +00019 +00024 class ISound : public IVirtualRefCounted +00025 { +00026 public: +00027 +00029 +00031 virtual ISoundSource* getSoundSource() = 0; +00032 +00034 virtual void setIsPaused( bool paused = true) = 0; +00035 +00037 virtual bool getIsPaused() = 0; +00038 +00040 +00043 virtual void stop() = 0; +00044 +00046 +00048 virtual ik_f32 getVolume() = 0; +00049 +00051 +00053 virtual void setVolume(ik_f32 volume) = 0; +00054 +00056 virtual void setPan(ik_f32 pan) = 0; +00057 +00059 virtual ik_f32 getPan() = 0; +00060 +00062 virtual bool isLooped() = 0; +00063 +00065 +00070 virtual void setIsLooped(bool looped) = 0; +00071 +00073 +00078 virtual bool isFinished() = 0; +00079 +00081 +00089 virtual void setMinDistance(ik_f32 min) = 0; +00090 +00092 +00093 virtual ik_f32 getMinDistance() = 0; +00094 +00096 +00103 virtual void setMaxDistance(ik_f32 max) = 0; +00104 +00106 +00107 virtual ik_f32 getMaxDistance() = 0; +00108 +00110 virtual void setPosition(vec3df position) = 0; +00111 +00113 virtual vec3df getPosition() = 0; +00114 +00116 +00120 virtual void setVelocity(vec3df vel) = 0; +00121 +00123 +00127 virtual vec3df getVelocity() = 0; +00128 +00130 +00132 virtual ik_u32 getPlayPosition() = 0; +00133 +00135 +00141 virtual bool setPlayPosition(ik_u32 pos) = 0; +00142 +00144 +00155 virtual bool setPlaybackSpeed(ik_f32 speed = 1.0f) = 0; +00156 +00158 +00159 virtual ik_f32 getPlaybackSpeed() = 0; +00160 +00162 +00166 virtual ik_u32 getPlayLength() = 0; +00167 +00169 +00177 virtual ISoundEffectControl* getSoundEffectControl() = 0; +00178 +00180 +00188 virtual void setSoundStopEventReceiver(ISoundStopEventReceiver* reciever, void* userData=0) = 0; +00189 }; +00190 +00191 } // end namespace irrklang +00192 +00193 +00194 #endif +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
+
+ +
+
+
+
+
+
+
+ik_ISoundDeviceList.h File Reference
#include "ik_IRefCounted.h"+ +
Go to the source code of this file.
+Classes | |
| class | irrklang::ISoundDeviceList |
| A list of sound devices for a sound driver. Use irrklang::createSoundDeviceList() to create this list. More... | |
Namespaces | |
| namespace | irrklang |
Everything in the irrKlang Sound Engine can be found in this namespace. + | |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
ik_ISoundDeviceList.h
Go to the documentation of this file.00001 // Copyright (C) 2002-2018 Nikolaus Gebhardt +00002 // This file is part of the "irrKlang" library. +00003 // For conditions of distribution and use, see copyright notice in irrKlang.h +00004 +00005 #ifndef __I_IRRKLANG_SOUND_DEVICE_LIST_H_INCLUDED__ +00006 #define __I_IRRKLANG_SOUND_DEVICE_LIST_H_INCLUDED__ +00007 +00008 #include "ik_IRefCounted.h" +00009 +00010 namespace irrklang +00011 { +00012 +00014 +00019 class ISoundDeviceList : public IRefCounted +00020 { +00021 public: +00022 +00024 virtual ik_s32 getDeviceCount() = 0; +00025 +00027 +00030 virtual const char* getDeviceID(ik_s32 index) = 0; +00031 +00033 +00034 virtual const char* getDeviceDescription(ik_s32 index) = 0; +00035 }; +00036 +00037 +00038 } // end namespace irrklang +00039 +00040 #endif +00041 +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
+
+
+ +
+
+
+
+
+
+
+ik_ISoundEffectControl.h File Reference
#include "ik_IVirtualRefCounted.h"+
#include "ik_vec3d.h"+ +
Go to the source code of this file.
+Classes | |
| class | irrklang::ISoundEffectControl |
| Interface to control the active sound effects (echo, reverb,...) of an ISound object, a playing sound. More... | |
Namespaces | |
| namespace | irrklang |
Everything in the irrKlang Sound Engine can be found in this namespace. + | |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
ik_ISoundEffectControl.h
Go to the documentation of this file.00001 // Copyright (C) 2002-2018 Nikolaus Gebhardt +00002 // This file is part of the "irrKlang" library. +00003 // For conditions of distribution and use, see copyright notice in irrKlang.h +00004 +00005 #ifndef __I_IRRKLANG_SOUND_EFFECT_CONTROL_H_INCLUDED__ +00006 #define __I_IRRKLANG_SOUND_EFFECT_CONTROL_H_INCLUDED__ +00007 +00008 #include "ik_IVirtualRefCounted.h" +00009 #include "ik_vec3d.h" +00010 +00011 +00012 namespace irrklang +00013 { +00015 +00026 class ISoundEffectControl +00027 { +00028 public: +00029 +00031 virtual void disableAllEffects() = 0; +00032 +00034 +00046 virtual bool enableChorusSoundEffect(ik_f32 fWetDryMix = 50, +00047 ik_f32 fDepth = 10, +00048 ik_f32 fFeedback = 25, +00049 ik_f32 fFrequency = 1.1, +00050 bool sinusWaveForm = true, +00051 ik_f32 fDelay = 16, +00052 ik_s32 lPhase = 90) = 0; +00053 +00055 virtual void disableChorusSoundEffect() = 0; +00056 +00058 virtual bool isChorusSoundEffectEnabled() = 0; +00059 +00061 +00070 virtual bool enableCompressorSoundEffect( ik_f32 fGain = 0, +00071 ik_f32 fAttack = 10, +00072 ik_f32 fRelease = 200, +00073 ik_f32 fThreshold = -20, +00074 ik_f32 fRatio = 3, +00075 ik_f32 fPredelay = 4) = 0; +00076 +00078 virtual void disableCompressorSoundEffect() = 0; +00079 +00081 virtual bool isCompressorSoundEffectEnabled() = 0; +00082 +00084 +00093 virtual bool enableDistortionSoundEffect(ik_f32 fGain = -18, +00094 ik_f32 fEdge = 15, +00095 ik_f32 fPostEQCenterFrequency = 2400, +00096 ik_f32 fPostEQBandwidth = 2400, +00097 ik_f32 fPreLowpassCutoff = 8000) = 0; +00098 +00100 virtual void disableDistortionSoundEffect() = 0; +00101 +00103 virtual bool isDistortionSoundEffectEnabled() = 0; +00104 +00106 +00114 virtual bool enableEchoSoundEffect(ik_f32 fWetDryMix = 50, +00115 ik_f32 fFeedback = 50, +00116 ik_f32 fLeftDelay = 500, +00117 ik_f32 fRightDelay = 500, +00118 ik_s32 lPanDelay = 0) = 0; +00119 +00121 virtual void disableEchoSoundEffect() = 0; +00122 +00124 virtual bool isEchoSoundEffectEnabled() = 0; +00125 +00127 +00141 virtual bool enableFlangerSoundEffect(ik_f32 fWetDryMix = 50, +00142 ik_f32 fDepth = 100, +00143 ik_f32 fFeedback = -50, +00144 ik_f32 fFrequency = 0.25f, +00145 bool triangleWaveForm = true, +00146 ik_f32 fDelay = 2, +00147 ik_s32 lPhase = 0) = 0; +00148 +00150 virtual void disableFlangerSoundEffect() = 0; +00151 +00153 virtual bool isFlangerSoundEffectEnabled() = 0; +00154 +00156 +00161 virtual bool enableGargleSoundEffect(ik_s32 rateHz = 20, bool sinusWaveForm = true) = 0; +00162 +00164 virtual void disableGargleSoundEffect() = 0; +00165 +00167 virtual bool isGargleSoundEffectEnabled() = 0; +00168 +00170 +00185 virtual bool enableI3DL2ReverbSoundEffect(ik_s32 lRoom = -1000, +00186 ik_s32 lRoomHF = -100, +00187 ik_f32 flRoomRolloffFactor = 0, +00188 ik_f32 flDecayTime = 1.49f, +00189 ik_f32 flDecayHFRatio = 0.83f, +00190 ik_s32 lReflections = -2602, +00191 ik_f32 flReflectionsDelay = 0.007f, +00192 ik_s32 lReverb = 200, +00193 ik_f32 flReverbDelay = 0.011f, +00194 ik_f32 flDiffusion = 100.0f, +00195 ik_f32 flDensity = 100.0f, +00196 ik_f32 flHFReference = 5000.0f ) = 0; +00197 +00199 virtual void disableI3DL2ReverbSoundEffect() = 0; +00200 +00202 virtual bool isI3DL2ReverbSoundEffectEnabled() = 0; +00203 +00205 +00211 virtual bool enableParamEqSoundEffect(ik_f32 fCenter = 8000, +00212 ik_f32 fBandwidth = 12, +00213 ik_f32 fGain = 0) = 0; +00214 +00216 virtual void disableParamEqSoundEffect() = 0; +00217 +00219 virtual bool isParamEqSoundEffectEnabled() = 0; +00220 +00222 +00228 virtual bool enableWavesReverbSoundEffect(ik_f32 fInGain = 0, +00229 ik_f32 fReverbMix = 0, +00230 ik_f32 fReverbTime = 1000, +00231 ik_f32 fHighFreqRTRatio = 0.001f) = 0; +00232 +00234 virtual void disableWavesReverbSoundEffect() = 0; +00235 +00237 virtual bool isWavesReverbSoundEffectEnabled() = 0; +00238 }; +00239 +00240 } // end namespace irrklang +00241 +00242 +00243 #endif +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+ik_ISoundEngine.h File Reference
#include "ik_IRefCounted.h"+
#include "ik_vec3d.h"+
#include "ik_ISoundSource.h"+
#include "ik_ISound.h"+
#include "ik_EStreamModes.h"+
#include "ik_IFileFactory.h"+
#include "ik_ISoundMixedOutputReceiver.h"+ +
Go to the source code of this file.
+Classes | |
| class | irrklang::ISoundEngine |
| Interface to the sound engine, for playing 3d and 2d sound and music. More... | |
| struct | irrklang::SInternalAudioInterface |
| structure for returning pointers to the internal audio interface. More... | |
Namespaces | |
| namespace | irrklang |
Everything in the irrKlang Sound Engine can be found in this namespace. + | |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
ik_ISoundEngine.h
Go to the documentation of this file.00001 // Copyright (C) 2002-2018 Nikolaus Gebhardt +00002 // This file is part of the "irrKlang" library. +00003 // For conditions of distribution and use, see copyright notice in irrKlang.h +00004 +00005 #ifndef __I_IRRKLANG_SOUND_ENGINE_H_INCLUDED__ +00006 #define __I_IRRKLANG_SOUND_ENGINE_H_INCLUDED__ +00007 +00008 #include "ik_IRefCounted.h" +00009 #include "ik_vec3d.h" +00010 #include "ik_ISoundSource.h" +00011 #include "ik_ISound.h" +00012 #include "ik_EStreamModes.h" +00013 #include "ik_IFileFactory.h" +00014 #include "ik_ISoundMixedOutputReceiver.h" +00015 +00016 +00017 namespace irrklang +00018 { +00019 class IAudioStreamLoader; +00020 struct SInternalAudioInterface; +00021 +00023 +00026 class ISoundEngine : public virtual irrklang::IRefCounted +00027 { +00028 public: +00029 +00031 +00033 virtual const char* getDriverName() = 0; +00034 +00036 +00056 virtual ISound* play2D(const char* soundFileName, +00057 bool playLooped = false, +00058 bool startPaused = false, +00059 bool track = false, +00060 E_STREAM_MODE streamMode = ESM_AUTO_DETECT, +00061 bool enableSoundEffects = false) = 0; +00062 +00064 +00084 virtual ISound* play2D(ISoundSource* source, +00085 bool playLooped = false, +00086 bool startPaused = false, +00087 bool track = false, +00088 bool enableSoundEffects = false) = 0; +00089 +00091 +00113 virtual ISound* play3D(const char* soundFileName, vec3df pos, +00114 bool playLooped = false, +00115 bool startPaused = false, +00116 bool track = false, +00117 E_STREAM_MODE streamMode = ESM_AUTO_DETECT, +00118 bool enableSoundEffects = false) = 0; +00119 +00121 +00142 virtual ISound* play3D(ISoundSource* source, vec3df pos, +00143 bool playLooped = false, +00144 bool startPaused = false, +00145 bool track = false, +00146 bool enableSoundEffects = false) = 0; +00147 +00149 virtual void stopAllSounds() = 0; +00150 +00152 virtual void setAllSoundsPaused( bool bPaused = true ) = 0; +00153 +00155 +00165 virtual ISoundSource* getSoundSource(const ik_c8* soundName, bool addIfNotFound=true) = 0; +00166 +00168 +00173 virtual ISoundSource* getSoundSource(ik_s32 index) = 0; +00174 +00176 virtual ik_s32 getSoundSourceCount() = 0; +00177 +00179 +00190 virtual ISoundSource* addSoundSourceFromFile(const ik_c8* fileName, E_STREAM_MODE mode=ESM_AUTO_DETECT, +00191 bool preload=false) = 0; +00192 +00194 +00212 virtual ISoundSource* addSoundSourceFromMemory(void* memory, ik_s32 sizeInBytes, const ik_c8* soundName, +00213 bool copyMemory=true) = 0; +00214 +00215 +00217 +00229 virtual ISoundSource* addSoundSourceFromPCMData(void* memory, ik_s32 sizeInBytes, +00230 const ik_c8* soundName, SAudioStreamFormat format, +00231 bool copyMemory=true) = 0; +00232 +00234 +00243 virtual ISoundSource* addSoundSourceAlias(ISoundSource* baseSource, const ik_c8* soundName) = 0; +00244 +00246 +00251 virtual void removeSoundSource(ISoundSource* source) = 0; +00252 +00254 +00259 virtual void removeSoundSource(const ik_c8* name) = 0; +00260 +00262 +00265 virtual void removeAllSoundSources() = 0; +00266 +00268 +00269 virtual void setSoundVolume(ik_f32 volume) = 0; +00270 +00272 /* A value between 0.0 and 1.0. Default is 1.0. Can be changed using setSoundVolume(). */ +00273 virtual ik_f32 getSoundVolume() = 0; +00274 +00276 +00285 virtual void setListenerPosition(const vec3df& pos, +00286 const vec3df& lookdir, +00287 const vec3df& velPerSecond = vec3df(0,0,0), +00288 const vec3df& upVector = vec3df(0,1,0)) = 0; +00289 +00291 +00296 virtual void update() = 0; +00297 +00299 virtual bool isCurrentlyPlaying(const char* soundName) = 0; +00300 +00302 virtual bool isCurrentlyPlaying(ISoundSource* source) = 0; +00303 +00305 virtual void stopAllSoundsOfSoundSource(ISoundSource* source) = 0; +00306 +00308 +00311 virtual void registerAudioStreamLoader(IAudioStreamLoader* loader) = 0; +00312 +00314 +00315 virtual bool isMultiThreaded() const = 0; +00316 +00318 +00320 virtual void addFileFactory(IFileFactory* fileFactory) = 0; +00321 +00323 +00330 virtual void setDefault3DSoundMinDistance(ik_f32 minDistance) = 0; +00331 +00333 +00339 virtual ik_f32 getDefault3DSoundMinDistance() = 0; +00340 +00342 +00353 virtual void setDefault3DSoundMaxDistance(ik_f32 maxDistance) = 0; +00354 +00356 +00366 virtual ik_f32 getDefault3DSoundMaxDistance() = 0; +00367 +00369 +00372 virtual void setRolloffFactor(ik_f32 rolloff) = 0; +00373 +00375 +00383 virtual void setDopplerEffectParameters(ik_f32 dopplerFactor=1.0f, ik_f32 distanceFactor=1.0f) = 0; +00384 +00386 +00395 virtual bool loadPlugins(const ik_c8* path) = 0; +00396 +00398 +00400 virtual const SInternalAudioInterface& getInternalAudioInterface() = 0; +00401 +00403 +00407 virtual bool setMixedDataOutputReceiver(ISoundMixedOutputReceiver* receiver) = 0; +00408 }; +00409 +00410 +00412 +00413 struct SInternalAudioInterface +00414 { +00416 void* pIDirectSound; +00417 +00419 void* pIDirectSound8; +00420 +00422 void* pWinMM_HWaveOut; +00423 +00425 void* pALSA_SND_PCM; +00426 +00428 ik_u32 pCoreAudioDeciceID; +00429 }; +00430 +00431 +00432 +00433 } // end namespace irrklang +00434 +00435 +00436 #endif +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
+
+
+ +
+
+
+
+
+
+
+ik_ISoundMixedOutputReceiver.h File Reference
#include "ik_IRefCounted.h"+
#include "ik_SAudioStreamFormat.h"+ +
Go to the source code of this file.
+Classes | |
| class | irrklang::ISoundMixedOutputReceiver |
| Interface to be implemented by the user, which recieves the mixed output when it it played by the sound engine. More... | |
Namespaces | |
| namespace | irrklang |
Everything in the irrKlang Sound Engine can be found in this namespace. + | |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
ik_ISoundMixedOutputReceiver.h
Go to the documentation of this file.00001 // Copyright (C) 2002-2018 Nikolaus Gebhardt +00002 // This file is part of the "irrKlang" library. +00003 // For conditions of distribution and use, see copyright notice in irrKlang.h +00004 +00005 #ifndef __I_IRRKLANG_SOUND_MIXED_OUTPUT_RECEIVER_H_INCLUDED__ +00006 #define __I_IRRKLANG_SOUND_MIXED_OUTPUT_RECEIVER_H_INCLUDED__ +00007 +00008 #include "ik_IRefCounted.h" +00009 #include "ik_SAudioStreamFormat.h" +00010 +00011 +00012 namespace irrklang +00013 { +00014 +00015 +00017 +00020 class ISoundMixedOutputReceiver +00021 { +00022 public: +00023 +00025 virtual ~ISoundMixedOutputReceiver() {}; +00026 +00028 +00037 virtual void OnAudioDataReady(const void* data, int byteCount, int playbackrate) = 0; +00038 +00039 }; +00040 +00041 +00042 } // end namespace irrklang +00043 +00044 +00045 #endif +00046 +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
+
+
+
+
+ +
+
+
+
+
+
+
+ik_ISoundSource.h File Reference
#include "ik_IVirtualRefCounted.h"+
#include "ik_vec3d.h"+
#include "ik_EStreamModes.h"+
#include "ik_SAudioStreamFormat.h"+ +
Go to the source code of this file.
+Classes | |
| class | irrklang::ISoundSource |
| A sound source describes an input file (.ogg, .mp3, .wav or similar) and its default settings. More... | |
Namespaces | |
| namespace | irrklang |
Everything in the irrKlang Sound Engine can be found in this namespace. + | |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
ik_ISoundSource.h
Go to the documentation of this file.00001 // Copyright (C) 2002-2018 Nikolaus Gebhardt +00002 // This file is part of the "irrKlang" library. +00003 // For conditions of distribution and use, see copyright notice in irrKlang.h +00004 +00005 #ifndef __I_IRRKLANG_IRR_SOUND_SOURCE_H_INCLUDED__ +00006 #define __I_IRRKLANG_IRR_SOUND_SOURCE_H_INCLUDED__ +00007 +00008 #include "ik_IVirtualRefCounted.h" +00009 #include "ik_vec3d.h" +00010 #include "ik_EStreamModes.h" +00011 #include "ik_SAudioStreamFormat.h" +00012 +00013 +00014 namespace irrklang +00015 { +00016 +00018 +00021 class ISoundSource : public IVirtualRefCounted +00022 { +00023 public: +00024 +00026 virtual const ik_c8* getName() = 0; +00027 +00029 +00032 virtual void setStreamMode(E_STREAM_MODE mode) = 0; +00033 +00035 +00037 virtual E_STREAM_MODE getStreamMode() = 0; +00038 +00040 +00045 virtual ik_u32 getPlayLength() = 0; +00046 +00048 +00053 virtual SAudioStreamFormat getAudioFormat() = 0; +00054 +00056 /* If a sound is seekable depends on the file type and the audio format. For example MOD files +00057 cannot be seeked currently. +00058 \return Returns true of the sound source supports setPlayPosition() and false if not. +00059 Note: If the sound never has been played before, the sound engine will have to open +00060 the file and try to get the information from there, so this call could take a bit depending +00061 on the type of file. */ +00062 virtual bool getIsSeekingSupported() = 0; +00063 +00065 +00069 +00072 +00076 +00079 +00087 +00090 +00096 +00099 +00112 +00115 +00126 +00129 +00134 +00137 +00144 +00147 +00149 +00152 +00161
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
+
+
+ +
+
+
+
+
+
+
+ik_ISoundStopEventReceiver.h File Reference
#include "ik_IRefCounted.h"+
#include "ik_SAudioStreamFormat.h"+ +
Go to the source code of this file.
+Classes | |
| class | irrklang::ISoundStopEventReceiver |
| Interface to be implemented by the user, which recieves sound stop events. More... | |
Namespaces | |
| namespace | irrklang |
Everything in the irrKlang Sound Engine can be found in this namespace. + | |
Enumerations | |
| enum | irrklang::E_STOP_EVENT_CAUSE { irrklang::ESEC_SOUND_FINISHED_PLAYING = 0, +irrklang::ESEC_SOUND_STOPPED_BY_USER, +irrklang::ESEC_SOUND_STOPPED_BY_SOURCE_REMOVAL, +irrklang::ESEC_FORCE_32_BIT = 0x7fffffff + } |
An enumeration listing all reasons for a fired sound stop event. + More... | |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
ik_ISoundStopEventReceiver.h
Go to the documentation of this file.00001 // Copyright (C) 2002-2018 Nikolaus Gebhardt +00002 // This file is part of the "irrKlang" library. +00003 // For conditions of distribution and use, see copyright notice in irrKlang.h +00004 +00005 #ifndef __I_IRRKLANG_SOUND_STOP_EVENT_RECEIVER_H_INCLUDED__ +00006 #define __I_IRRKLANG_SOUND_STOP_EVENT_RECEIVER_H_INCLUDED__ +00007 +00008 #include "ik_IRefCounted.h" +00009 #include "ik_SAudioStreamFormat.h" +00010 +00011 +00012 namespace irrklang +00013 { +00014 +00015 +00017 enum E_STOP_EVENT_CAUSE +00018 { +00020 ESEC_SOUND_FINISHED_PLAYING = 0, +00021 +00023 ESEC_SOUND_STOPPED_BY_USER, +00024 +00027 ESEC_SOUND_STOPPED_BY_SOURCE_REMOVAL, +00028 +00031 ESEC_FORCE_32_BIT = 0x7fffffff +00032 }; +00033 +00034 +00036 +00041 class ISoundStopEventReceiver +00042 { +00043 public: +00044 +00046 virtual ~ISoundStopEventReceiver() {}; +00047 +00049 +00063 virtual void OnSoundStopped(ISound* sound, E_STOP_EVENT_CAUSE reason, void* userData) = 0; +00064 +00065 }; +00066 +00067 +00068 } // end namespace irrklang +00069 +00070 +00071 #endif +00072 +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
+
+ +
+
+
+
+
+
+
+ik_IVirtualRefCounted.h File Reference
#include "ik_irrKlangTypes.h"+ +
Go to the source code of this file.
+Classes | |
| class | irrklang::IVirtualRefCounted |
| Reference counting base class for objects in the Irrlicht Engine similar to IRefCounted. More... | |
Namespaces | |
| namespace | irrklang |
Everything in the irrKlang Sound Engine can be found in this namespace. + | |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
ik_IVirtualRefCounted.h
Go to the documentation of this file.00001 // Copyright (C) 2002-2018 Nikolaus Gebhardt +00002 // This file is part of the "irrKlang" library. +00003 // For conditions of distribution and use, see copyright notice in irrKlang.h +00004 +00005 #ifndef __I_IRRKLANG_VIRTUAL_UNKNOWN_H_INCLUDED__ +00006 #define __I_IRRKLANG_VIRTUAL_UNKNOWN_H_INCLUDED__ +00007 +00008 #include "ik_irrKlangTypes.h" +00009 +00010 +00011 namespace irrklang +00012 { +00013 +00015 +00019 class IVirtualRefCounted +00020 { +00021 public: +00022 +00024 virtual ~IVirtualRefCounted() +00025 { +00026 } +00027 +00029 +00032 virtual void grab() = 0; +00033 +00035 +00038 virtual bool drop() = 0; +00039 }; +00040 +00041 +00042 +00043 } // end namespace irrklang +00044 +00045 +00046 +00047 #endif +00048 +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
+
+ +
+
+
+
+
+
+
+ik_SAudioStreamFormat.h File Reference
#include "ik_IRefCounted.h"+ +
Go to the source code of this file.
+Classes | |
| struct | irrklang::SAudioStreamFormat |
| structure describing an audio stream format with helper functions More... | |
Namespaces | |
| namespace | irrklang |
Everything in the irrKlang Sound Engine can be found in this namespace. + | |
Enumerations | |
| enum | irrklang::ESampleFormat { irrklang::ESF_U8, +irrklang::ESF_S16 + } |
audio sample data format enumeration for supported formats + More... | |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
ik_SAudioStreamFormat.h
Go to the documentation of this file.00001 // Copyright (C) 2002-2018 Nikolaus Gebhardt +00002 // This file is part of the "irrKlang" library. +00003 // For conditions of distribution and use, see copyright notice in irrKlang.h +00004 +00005 #ifndef __S_IRRKLANG_AUDIO_STREAM_FORMAT_H_INCLUDED__ +00006 #define __S_IRRKLANG_AUDIO_STREAM_FORMAT_H_INCLUDED__ +00007 +00008 #include "ik_IRefCounted.h" +00009 +00010 +00011 namespace irrklang +00012 { +00013 +00015 enum ESampleFormat +00016 { +00018 ESF_U8, +00019 +00021 ESF_S16 +00022 }; +00023 +00024 +00026 struct SAudioStreamFormat +00027 { +00029 ik_s32 ChannelCount; +00030 +00032 +00033 ik_s32 FrameCount; +00034 +00036 ik_s32 SampleRate; +00037 +00039 ESampleFormat SampleFormat; +00040 +00042 inline ik_s32 getSampleSize() const +00043 { +00044 return (SampleFormat == ESF_U8) ? 1 : 2; +00045 } +00046 +00048 inline ik_s32 getFrameSize() const +00049 { +00050 return ChannelCount * getSampleSize(); +00051 } +00052 +00054 /* Returns an invalid negative value when the stream has an unknown lenght */ +00055 inline ik_s32 getSampleDataSize() const +00056 { +00057 return getFrameSize() * FrameCount; +00058 } +00059 +00061 inline ik_s32 getBytesPerSecond() const +00062 { +00063 return getFrameSize() * SampleRate; +00064 } +00065 }; +00066 +00067 +00068 } // end namespace irrklang +00069 +00070 #endif +00071 +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
+
+ +
+
+
+
+
+
+
+ik_irrKlangTypes.h File Reference
#include <wchar.h>+ +
Go to the source code of this file.
+Namespaces | |
| namespace | irrklang |
Everything in the irrKlang Sound Engine can be found in this namespace. + | |
Typedefs | |
| typedef unsigned char | irrklang::ik_u8 |
| 8 bit unsigned variable. | |
| typedef signed char | irrklang::ik_s8 |
| 8 bit signed variable. | |
| typedef char | irrklang::ik_c8 |
| 8 bit character variable. | |
| typedef unsigned short | irrklang::ik_u16 |
| 16 bit unsigned variable. | |
| typedef signed short | irrklang::ik_s16 |
| 16 bit signed variable. | |
| typedef unsigned int | irrklang::ik_u32 |
| 32 bit unsigned variable. | |
| typedef signed int | irrklang::ik_s32 |
| 32 bit signed variable. | |
| typedef float | irrklang::ik_f32 |
| 32 bit floating point variable. | |
| typedef double | irrklang::ik_f64 |
| 64 bit floating point variable. | |
Functions | |
| bool | irrklang::equalsfloat (const ik_f32 a, const ik_f32 b, const ik_f32 tolerance=IK_ROUNDING_ERROR_32) |
Variables | |
| const ik_f32 | irrklang::IK_ROUNDING_ERROR_32 = 0.000001f |
| const ik_f64 | irrklang::IK_PI64 = 3.1415926535897932384626433832795028841971693993751 |
| const ik_f32 | irrklang::IK_PI32 = 3.14159265359f |
| const ik_f32 | irrklang::IK_RADTODEG = 180.0f / IK_PI32 |
| const ik_f32 | irrklang::IK_DEGTORAD = IK_PI32 / 180.0f |
| const ik_f64 | irrklang::IK_RADTODEG64 = 180.0 / IK_PI64 |
| const ik_f64 | irrklang::IK_DEGTORAD64 = IK_PI64 / 180.0 |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
ik_irrKlangTypes.h
Go to the documentation of this file.00001 // Copyright (C) 2002-2018 Nikolaus Gebhardt +00002 // This file is part of the "irrKlang" library. +00003 // For conditions of distribution and use, see copyright notice in irrKlang.h +00004 +00005 #ifndef __IRRKLANG_TYPES_H_INCLUDED__ +00006 #define __IRRKLANG_TYPES_H_INCLUDED__ +00007 +00008 +00009 namespace irrklang +00010 { +00011 +00013 +00014 typedef unsigned char ik_u8; +00015 +00017 +00018 typedef signed char ik_s8; +00019 +00021 +00022 typedef char ik_c8; +00023 +00024 +00025 +00027 +00028 typedef unsigned short ik_u16; +00029 +00031 +00032 typedef signed short ik_s16; +00033 +00034 +00035 +00037 +00038 typedef unsigned int ik_u32; +00039 +00041 +00042 typedef signed int ik_s32; +00043 +00044 +00045 +00047 +00048 typedef float ik_f32; +00049 +00051 +00052 typedef double ik_f64; +00053 +00054 +00055 +00056 // some constants +00057 +00058 const ik_f32 IK_ROUNDING_ERROR_32 = 0.000001f; +00059 const ik_f64 IK_PI64 = 3.1415926535897932384626433832795028841971693993751; +00060 const ik_f32 IK_PI32 = 3.14159265359f; +00061 const ik_f32 IK_RADTODEG = 180.0f / IK_PI32; +00062 const ik_f32 IK_DEGTORAD = IK_PI32 / 180.0f; +00063 const ik_f64 IK_RADTODEG64 = 180.0 / IK_PI64; +00064 const ik_f64 IK_DEGTORAD64 = IK_PI64 / 180.0; +00065 +00068 inline bool equalsfloat(const ik_f32 a, const ik_f32 b, const ik_f32 tolerance = IK_ROUNDING_ERROR_32) +00069 { +00070 return (a + tolerance > b) && (a - tolerance < b); +00071 } +00072 +00073 } // end irrklang namespace +00074 +00075 // ensure wchar_t type is existing for unicode support +00076 #include <wchar.h> +00077 +00078 // define the wchar_t type if not already built in. +00079 #ifdef _MSC_VER // microsoft compiler +00080 #ifndef _WCHAR_T_DEFINED +00082 +00089 typedef unsigned short wchar_t; +00090 #define _WCHAR_T_DEFINED +00091 #endif // wchar is not defined +00092 #endif // microsoft compiler +00093 +00094 +00095 #endif // __IRR_TYPES_H_INCLUDED__ +00096 +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
+
+
+ +
+
+
+
+
+
+
+ik_vec3d.h File Reference
#include <math.h>+
#include "ik_irrKlangTypes.h"+ +
Go to the source code of this file.
+Classes | |
| class | irrklang::vec3d< T > |
| a 3d vector template class for representing vectors and points in 3d More... | |
Namespaces | |
| namespace | irrklang |
Everything in the irrKlang Sound Engine can be found in this namespace. + | |
Typedefs | |
| typedef vec3d< ik_f32 > | irrklang::vec3df |
| Typedef for a ik_f32 3d vector, a vector using floats for X, Y and Z. | |
| typedef vec3d< ik_s32 > | irrklang::vec3di |
| Typedef for an integer 3d vector, a vector using ints for X, Y and Z. | |
Functions | |
| template<class S , class T > | |
| vec3d< T > | irrklang::operator* (const S scalar, const vec3d< T > &vector) |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
ik_vec3d.h
Go to the documentation of this file.00001 // Copyright (C) 2002-2018 Nikolaus Gebhardt +00002 // This file is part of the "irrKlang" library. +00003 // For conditions of distribution and use, see copyright notice in irrKlang.h +00004 +00005 #ifndef __IRR_IRRKLANG_VEC_3D_H_INCLUDED__ +00006 #define __IRR_IRRKLANG_VEC_3D_H_INCLUDED__ +00007 +00008 #include <math.h> +00009 #include "ik_irrKlangTypes.h" +00010 +00011 +00012 namespace irrklang +00013 { +00014 +00016 template <class T> +00017 class vec3d +00018 { +00019 public: +00020 +00021 vec3d(): X(0), Y(0), Z(0) {}; +00022 vec3d(T nx, T ny, T nz) : X(nx), Y(ny), Z(nz) {}; +00023 vec3d(const vec3d<T>& other) :X(other.X), Y(other.Y), Z(other.Z) {}; +00024 +00026 #ifdef __IRR_POINT_3D_H_INCLUDED__ +00027 template<class B> +00028 vec3d(const B& other) :X(other.X), Y(other.Y), Z(other.Z) {}; +00029 #endif // __IRR_POINT_3D_H_INCLUDED__ +00030 +00031 // operators +00032 +00033 vec3d<T> operator-() const { return vec3d<T>(-X, -Y, -Z); } +00034 +00035 vec3d<T>& operator=(const vec3d<T>& other) { X = other.X; Y = other.Y; Z = other.Z; return *this; } +00036 +00037 vec3d<T> operator+(const vec3d<T>& other) const { return vec3d<T>(X + other.X, Y + other.Y, Z + other.Z); } +00038 vec3d<T>& operator+=(const vec3d<T>& other) { X+=other.X; Y+=other.Y; Z+=other.Z; return *this; } +00039 +00040 vec3d<T> operator-(const vec3d<T>& other) const { return vec3d<T>(X - other.X, Y - other.Y, Z - other.Z); } +00041 vec3d<T>& operator-=(const vec3d<T>& other) { X-=other.X; Y-=other.Y; Z-=other.Z; return *this; } +00042 +00043 vec3d<T> operator*(const vec3d<T>& other) const { return vec3d<T>(X * other.X, Y * other.Y, Z * other.Z); } +00044 vec3d<T>& operator*=(const vec3d<T>& other) { X*=other.X; Y*=other.Y; Z*=other.Z; return *this; } +00045 vec3d<T> operator*(const T v) const { return vec3d<T>(X * v, Y * v, Z * v); } +00046 vec3d<T>& operator*=(const T v) { X*=v; Y*=v; Z*=v; return *this; } +00047 +00048 vec3d<T> operator/(const vec3d<T>& other) const { return vec3d<T>(X / other.X, Y / other.Y, Z / other.Z); } +00049 vec3d<T>& operator/=(const vec3d<T>& other) { X/=other.X; Y/=other.Y; Z/=other.Z; return *this; } +00050 vec3d<T> operator/(const T v) const { T i=(T)1.0/v; return vec3d<T>(X * i, Y * i, Z * i); } +00051 vec3d<T>& operator/=(const T v) { T i=(T)1.0/v; X*=i; Y*=i; Z*=i; return *this; } +00052 +00053 bool operator<=(const vec3d<T>&other) const { return X<=other.X && Y<=other.Y && Z<=other.Z;}; +00054 bool operator>=(const vec3d<T>&other) const { return X>=other.X && Y>=other.Y && Z>=other.Z;}; +00055 +00056 bool operator==(const vec3d<T>& other) const { return other.X==X && other.Y==Y && other.Z==Z; } +00057 bool operator!=(const vec3d<T>& other) const { return other.X!=X || other.Y!=Y || other.Z!=Z; } +00058 +00059 // functions +00060 +00062 bool equals(const vec3d<T>& other) +00063 { +00064 return equalsfloat(X, other.X) && +00065 equalsfloat(Y, other.Y) && +00066 equalsfloat(Z, other.Z); +00067 } +00068 +00069 void set(const T nx, const T ny, const T nz) {X=nx; Y=ny; Z=nz; } +00070 void set(const vec3d<T>& p) { X=p.X; Y=p.Y; Z=p.Z;} +00071 +00073 ik_f64 getLength() const { return sqrt(X*X + Y*Y + Z*Z); } +00074 +00076 +00078 ik_f64 getLengthSQ() const { return X*X + Y*Y + Z*Z; } +00079 +00081 T dotProduct(const vec3d<T>& other) const +00082 { +00083 return X*other.X + Y*other.Y + Z*other.Z; +00084 } +00085 +00087 +00088 ik_f64 getDistanceFrom(const vec3d<T>& other) const +00089 { +00090 ik_f64 vx = X - other.X; ik_f64 vy = Y - other.Y; ik_f64 vz = Z - other.Z; +00091 return sqrt(vx*vx + vy*vy + vz*vz); +00092 } +00093 +00095 +00096 ik_f32 getDistanceFromSQ(const vec3d<T>& other) const +00097 { +00098 ik_f32 vx = X - other.X; ik_f32 vy = Y - other.Y; ik_f32 vz = Z - other.Z; +00099 return (vx*vx + vy*vy + vz*vz); +00100 } +00101 +00103 vec3d<T> crossProduct(const vec3d<T>& p) const +00104 { +00105 return vec3d<T>(Y * p.Z - Z * p.Y, Z * p.X - X * p.Z, X * p.Y - Y * p.X); +00106 } +00107 +00109 +00110 bool isBetweenPoints(const vec3d<T>& begin, const vec3d<T>& end) const +00111 { +00112 ik_f32 f = (ik_f32)(end - begin).getLengthSQ(); +00113 return (ik_f32)getDistanceFromSQ(begin) < f && +00114 (ik_f32)getDistanceFromSQ(end) < f; +00115 } +00116 +00118 vec3d<T>& normalize() +00119 { +00120 T l = (T)getLength(); +00121 if (l == 0) +00122 return *this; +00123 +00124 l = (T)1.0 / l; +00125 X *= l; +00126 Y *= l; +00127 Z *= l; +00128 return *this; +00129 } +00130 +00132 void setLength(T newlength) +00133 { +00134 normalize(); +00135 *this *= newlength; +00136 } +00137 +00139 void invert() +00140 { +00141 X *= -1.0f; +00142 Y *= -1.0f; +00143 Z *= -1.0f; +00144 } +00145 +00150 void rotateXZBy(ik_f64 degrees, const vec3d<T>& center) +00151 { +00152 degrees *= IK_DEGTORAD64; +00153 T cs = (T)cos(degrees); +00154 T sn = (T)sin(degrees); +00155 X -= center.X; +00156 Z -= center.Z; +00157 set(X*cs - Z*sn, Y, X*sn + Z*cs); +00158 X += center.X; +00159 Z += center.Z; +00160 } +00161 +00166 void rotateXYBy(ik_f64 degrees, const vec3d<T>& center) +00167 { +00168 degrees *= IK_DEGTORAD64; +00169 T cs = (T)cos(degrees); +00170 T sn = (T)sin(degrees); +00171 X -= center.X; +00172 Y -= center.Y; +00173 set(X*cs - Y*sn, X*sn + Y*cs, Z); +00174 X += center.X; +00175 Y += center.Y; +00176 } +00177 +00182 void rotateYZBy(ik_f64 degrees, const vec3d<T>& center) +00183 { +00184 degrees *= IK_DEGTORAD64; +00185 T cs = (T)cos(degrees); +00186 T sn = (T)sin(degrees); +00187 Z -= center.Z; +00188 Y -= center.Y; +00189 set(X, Y*cs - Z*sn, Y*sn + Z*cs); +00190 Z += center.Z; +00191 Y += center.Y; +00192 } +00193 +00195 +00197 vec3d<T> getInterpolated(const vec3d<T>& other, ik_f32 d) const +00198 { +00199 ik_f32 inv = 1.0f - d; +00200 return vec3d<T>(other.X*inv + X*d, +00201 other.Y*inv + Y*d, +00202 other.Z*inv + Z*d); +00203 } +00204 +00206 +00209 vec3d<T> getHorizontalAngle() +00210 { +00211 vec3d<T> angle; +00212 +00213 angle.Y = (T)atan2(X, Z); +00214 angle.Y *= (ik_f32)IK_RADTODEG; +00215 +00216 if (angle.Y < 0.0f) angle.Y += 360.0f; +00217 if (angle.Y >= 360.0f) angle.Y -= 360.0f; +00218 +00219 ik_f32 z1 = (T)sqrt(X*X + Z*Z); +00220 +00221 angle.X = (T)atan2(z1, Y); +00222 angle.X *= (ik_f32)IK_RADTODEG; +00223 angle.X -= 90.0f; +00224 +00225 if (angle.X < 0.0f) angle.X += 360.0f; +00226 if (angle.X >= 360) angle.X -= 360.0f; +00227 +00228 return angle; +00229 } +00230 +00232 +00234 void getAs4Values(T* array) +00235 { +00236 array[0] = X; +00237 array[1] = Y; +00238 array[2] = Z; +00239 array[3] = 0; +00240 } +00241 +00242 +00243 // member variables +00244 +00245 T X, Y, Z; +00246 }; +00247 +00248 +00250 typedef vec3d<ik_f32> vec3df; +00251 +00253 typedef vec3d<ik_s32> vec3di; +00254 +00255 template<class S, class T> vec3d<T> operator*(const S scalar, const vec3d<T>& vector) { return vector*scalar; } +00256 +00257 } // end namespace irrklang +00258 +00259 +00260 #endif +00261 +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+-
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+
+
+
+irrKlang 1.6.0 API documentation
+
+
+
++Contents
+General:
+ Introduction
+ Features of irrKlang
+ Links into the API documentation
+ Tips and Tricks
+
+ Programming irrKlang:
+ Starting up the Engine
+ Playing Sounds
+ Influencing Sounds during Playback
+ Using Sound Sources
+ 3D Sound
+ Removing Sounds
+ Using Sound Events
+ Memory Playback
+ Sound Effects
+ Overriding File Access
+ Adding Audio Decoders
+ Creating irrKlang Plugins
+ Using irrKlang as static Lib
+ Enumerating sound devices
+ Recording Audio
+ Unicode support
+
+ Short full examples:
+ Quick Start Example
+ Quick Start Example 2
+
+
+
+Introduction
+Welcome to the irrKlang API documentation. This page should give you a short overview over irrKlang, the high level audio library. In this documentation files you'll find any information you'll need to develop applications with irrKlang using C++. If you are looking for a tutorial on how to start, you'll find some on the homepage of irrKlang at http://www.ambiera.com/irrklang or inside the SDK in the directory .
+The irrKlang library is intended to be an easy-to-use 3d and 2d sound engine, so this documentation is an important part of it. If you have any questions or suggestions, please take a look into the ambiera.com forum or just send a mail.
+
+
+
+Features of irrKlang
+irrKlang is a high level 2D and 3D cross platform sound engine and audio library. It has a very simply object orientated interface and was designed to be used in games, scientific simulations, architectural visualizations and similar. irrKlang plays several file formats such as
+-
+
- +RIFF WAVE (*.wav) +
- +Ogg Vorbis (*.ogg) +
- +MPEG-1 Audio Layer 3 (*.mp3) +
- +Free Lossless Audio Codec (*.flac) +
- +Amiga Modules (*.mod) +
- +Impulse Tracker (*.it) +
- +Scream Tracker 3 (*.s3d) +
- +Fast Tracker 2 (*.xm) +
It is also able to run on different operating systems and use several output drivers:
+-
+
-
+Windows 98, ME, NT 4, 2000, XP, Vista, Windows 7, Windows 8
-
+
- +DirectSound +
- +DirectSound8 +
- +WinMM +
+ -
+Linux / *nix
-
+
- +ALSA +
+ -
+MacOSX (x86 and PPC)
-
+
- +CoreAudio +
+
+
+
+
+Links into the API documentation
+irrklang::ISoundEngine: The main class of irrKlang.
+ Class list: List of all classes with descriptions.
+ Class members: Good place to find forgotten features.
+
+
+
+
+Tips and Tricks
+This section lists a few tips you might consider when implementing the sound part of your application using irrKlang:
+-
+
- +If you can choose which audio file format is the primary one for your application, use .OGG files, instead of for example .MP3 files. irrKlang uses a lot less memory and CPU power when playing .OGGs. +
- +To keep your application simple, each time you play a sound, you can use for example play2D("filename.mp3") and let irrKlang handle the rest. There is no need to implement a preloading/caching/file management system for the audio playback. irrKlang will handle all this by itself and will never load a file twice. +
- +irrKlang is crashing in your application? This should not happen, irrKlang is pretty stable, and in most cases, this is a problem in your code: In a lot of cases the reason is simply a wrong call to irrklang::IRefCounted::drop(). Be sure you are doing it correctly. (If you are unsure, tempoarily remove all calls to irrklang::IRefCounted::drop() and see if this helps.) +
+
+
+
+
+Starting up the Engine
+irrKlang is designed so that it is very easy to achieve everything, its interface should be very simple to use. The Quick Start Example shows how to play and mp3 file, and there is another example, Quick Start Example 2, showing some few more details.
+ To start up the sound engine, you simply need to call createIrrKlangDevice(). To shut it down, call IRefCounted::drop():
#include <irrKlang.h> + + // ... + + // start up the engine + irrklang::ISoundEngine* engine = irrklang::createIrrKlangDevice(); + + // ... + + // after finished, + // close the engine again, similar as calling 'delete' + engine->drop(); +
The createIrrKlangDevice() function also accepts several parameters, so that you can specify which sound driver should be used, if plugins should be used, if irrKlang should run in multithreaded mode, and similar.
+
+
+
+
+Playing Sounds
+Once you have irrKlang running (like in Starting up the Engine), you can start playing sounds:
+engine->play2D("someSoundFile.wav"); +
This works with all supported file types. You can replace "someSoundFile.wav" with "someSoundFile.mp3", or "someSoundFile.ogg", for example.
+ To play a sound looped, set the second parameter to 'true':
engine->play2D("myMusic.mp3", true); +
To stop this looping sound again, use engine->stopAllSounds() to stop all sounds, or irrklang::ISound::stop() if you only want to stop that single sound. Influencing Sounds during Playback shows how to get to that ISound interface.
+
+
+
+
+Influencing Sounds during Playback
+To influence parameters of the sound such as pan, volume or playback speed during runtime, to get the play position or stop playback of single playing sounds, you can use the irrklang::ISound interface. irrklang::ISoundEngine::play2D (but also play3D) returns a pointer to this interface when its third ('startPaused') or fourth ('track') parameter was set to true:
+irrklang::ISound* snd = engine->play2D("myMusic.mp3", true, false, true); + + // ... + + if (snd) + snd->setVolume(someNewValue); + + // ... + + if (snd) + { + snd->drop(); // don't forget to release the pointer once it is no longer needed by you + snd = 0; + } +
The irrklang::ISound interface can also be used to test if the sound has been finished, set event receivers, pause and unpause sounds and similar.
+
+
+
+
+Using Sound Sources
+To be more flexible playing back sounds, irrKlang uses the concept of sound sources. A sound source can be simply the name of a sound file, such as "sound.wav". It is possible to add "sound.wav" as sound source to irrKlang, and play it using the sound source pointer:
+irrklang::ISoundSource* shootSound = engine->addSoundSourceFromFile("shoot.wav"); + + engine->play2D(shootSound); + + // note: you don't need to drop() the shootSound if you don't use it anymore +
The advantage of using irrklang::ISoundSource is that it is possible to set default values for this source, such as volume or distances if it should be used as 3D sound:
+irrklang::ISoundSource* shootSound = engine->addSoundSourceFromFile("shoot.wav"); + + shootSound->setDefaultVolume(0.5f); + + // shootSound will now be played with half its sound volume by default: + engine->play2D(shootSound); +
It is also possible to have multiple settings for the same sound file:
+irrklang::ISoundSource* shootSound = engine->addSoundSourceFromFile("shoot.wav"); + irrklang::ISoundSource* shootSound2 = engine->addSoundSourceAlias(shootSound, "silentShoot"); + + shootSound2->setDefaultVolume(0.1f); + + // shootSound will now be played with 100% of its sound volume by default, + // shootSound2 will now be played 10% of its sound volume by default. It is + // also possible to play it using engine->play("silentShoot"), now. +
Using addSoundSourceFromMemory(), it is also possible to play sounds back directly from memory, without files. Of course, it is not necessary to use sound sources. Using irrklang::ISound, it is possible to change the settings of all sounds, too. But using sound sources, it is not necessary to do this every time a sound is played.
+
+
+
+
+3D Sound
+There is nothing difficult in playing sounds in 3D using irrKlang: Instead of using irrklang::ISoundEngine::play2D(), just use irrklang::ISoundEngine::play3D(), which takes a 3D position as additional parameter:
+irrklang::vec3df position(23,70,90); + engine->play3D("yourSound.wav", position); +
But to make it sound realistic, you need to set a minimal sound distance: If your sound is caused by a bee, it will usually have a smaller sound radius than for example a jet engine. You can set default values using sound sources (see Using Sound Sources) or set these values after you have started the sound paused:
+irrklang::vec3df position(23,70,90); + + // start the sound paused: + irrklang::ISound* snd = engine->play3D("yourSound.wav", position, false, true); + + if (snd) + { + snd->setMinDistance(30.0f); // a loud sound + snd->setIsPaused(false); // unpause the sound + } +
There is also the possibility to change the maxDistance, but it is only necessary to change this in very rare cicumstances. If the sound moves, it is also a good idea to update its position from time to time:
+if (snd) + snd->setPosition(newPosition); +
And don't forget to drop() the sound after you don't need it anymore. If you do, it's nothing severe because irrKlang will still clean up the sounds resources after it has finished, but you still would waste some few bytes of memory:
+if (snd) + { + snd->drop(); + snd = 0; + } +
To update the position of yourself, the listener of the 3D sounds, use this from time to time:
+irrklang::vec3df position(0,0,0); // position of the listener + irrklang::vec3df lookDirection(10,0,10); // the direction the listener looks into + irrklang::vec3df velPerSecond(0,0,0); // only relevant for doppler effects + irrklang::vec3df upVector(0,1,0); // where 'up' is in your 3D scene + + engine->setListenerPosition(position, lookDirection, velPerSecond, upVector); +
+
+
+
+
+Removing Sounds
+irrKlang manages the memory usage of sounds by itself, so usually, you don't have to care about memory management. But if you know you need to reduce the amount of used memory at a certain point in your program, you can do this:
+engine->removeAllSoundSources(); +
This will remove all sounds and also cause all sounds to be stopped. To remove single sounds from the engine, use:
+engine->removeSoundSource(pointerToSomeSoundSource); + // or: + engine->removeSoundSource("nameOfASoundFile.wav"); +
Note: Only removing buffered sounds will reduce the amount of memory used by irrKlang, streamed sounds don't occupy a lot of memory when they are not played.
+
+
+
+
+Using Sound Events
+In order to wait for a sound to be finished, it is simply possible to poll irrklang::ISound::isFinished(). Another way would be to constantly use irrklang::ISoundEngine::isCurrentlyPlaying to test wether a sound with that name or source is currently playing. But of course, an event based approach is a lot nicer. That's why irrKlang supports sound events.
+ The key to sound events is the method setSoundStopEventReceiver of the irrklang::ISound interface (See Influencing Sounds during Playback on how to get the ISound interface):
irrklang::ISound* snd = engine->play2D("speech.mp3", false, false, true); + if (snd) + snd->setSoundStopEventReceiver(yourEventReceiver, 0); +
The optional second parameter of setSoundStopEventReceiver is a user pointer, set it to whatever you like. 'yourEventReceiver' must be an implementation of the irrklang::ISoundStopEventReceiver interface.
+ A whole implementation could look like this:
class MySoundEndReceiver : public irrklang::ISoundStopEventReceiver + { + public: + virtual void OnSoundStopped (irrklang::ISound* sound, irrklang::E_STOP_EVENT_CAUSE reason, void* userData) + { + // called when the sound has ended playing + printf("sound has ended"); + } + } + + // ... + + MySoundEndReceiver* myReceiver = new MySoundEndReceiver(); + irrklang::ISound* snd = engine->play2D("speech.mp3", false, false, true); + if (snd) + snd->setSoundStopEventReceiver(myReceiver); + + myReceiver->drop(); // similar to delete +
The irrklang::ISoundStopEventReceiver::OnSoundStopped() method is guaranteed to be called when a sound or sound stream has stopped, either because the sound reached its playback end, its sound source was removed, ISoundEngine::stopAllSounds() has been called or the whole engine was deleted.
+
+
+
+
+Memory Playback
+Using irrKlang, it is easily possible to play sounds directly from memory instead out of files. There is an example project showing this: In the SDK, in /examples/03.MemoryPlayback. But in short, it simply works by adding the memory as sound source (See Using Sound Sources for details about sound sources):
+engine->addSoundSourceFromMemory(pointerToMemory, memorySize, "nameforthesound.wav"); + + // play sound now + engine->play2D("nameforthesound.wav"); +
Or using a sound source pointer:
+irrklang::ISoundSource* snd = + engine->addSoundSourceFromMemory(pointerToMemory, memorySize, "nameforthesound.wav"); + + // play sound now + engine->play2D(snd); +
Note: It is also possible to overwrite the file access directly, don't use this Memory Playback feature for this. See Overriding File Access for details.
+
+
+
+
+Sound Effects
+irrKlang supports the effects Chorus, Compressor, Distortion, Echo, Flanger Gargle, 3DL2Reverb, ParamEq and WavesReverb, when using the sound driver irrklang::ESOD_DIRECT_SOUND_8, which selected by default when using Windows.
+
Using the irrklang::ISound interface, you can optain the irrklang::ISoundEffectControl interface if the sound device supports sound effects and the last parameter ('enableSoundEffects') was set to true when calling play2D():
+irrklang::ISound* snd = engine->play2D("sound.wav", true, false, true, ESM_AUTO_DETECT, true); + + if (snd) + { + irrklang::ISoundEffectControl* fx = snd->getSoundEffectControl(); + if (fx) + { + // enable the echo sound effect for this sound + fx->enableEchoSoundEffect(); + } + } + + snd->drop(); +
This enabled the echo sound effect for this sound. The method also supports a lot of parameters, and can be called multiple times to change those parameters over time if wished. There are a lot of other sound effects, see irrklang::ISoundEffectControl for details.
+
+
+
+
+Overriding File Access
+It is possible to let irrKlang use your own file access functions. This is useful if you want to read sounds from other sources than just files, for example from custom internet streams or an own encypted archive format. There is an example in the SDK in examples/04.OverrideFileAccess which shows this as well.
+
The only thing to do for this is to implement your own irrklang::IFileFactory, and set it in irrKlang using irrklang::ISoundEngine::addFileFactory():
+// a class implementing the IFileFactory interface to override irrklang file access + class CMyFileFactory : public irrklang::IFileFactory + { + public: + + // Opens a file for read access. Simply return 0 if file not found. + virtual irrklang::IFileReader* createFileReader(const ik_c8* filename) + { + // return your own irrklang::IFileReader implementation here, for example like that: + return new CMyReadFile(filename); + } + }; + + // ... + + CMyFileFactory* myFactory = new CMyFileFactory(); + engine->addFileFactory(myFactory); + myFactory->drop(); +
For a full example implementation, just take a look into the SDK in examples/04.OverrideFileAccess.
+
+
+
+
+Adding Audio Decoders
+To add support for new file formats, it is possible to add new audio decoders to irrKlang. The only thing to do for this is to implement your own irrklang::IAudioStreamLoader, and irrklang::IAudioStream, and set it in irrKlang using irrklang::ISoundEngine::registerAudioStreamLoader():
+class NewAudioStreamLoader : public irrklang::IAudioStreamLoader + { + // ... returns NewAudioDecoder and the used file name suffices. + }; + + class NewAudioDecoder : public irrklang::IAudioStream + { + public: + // ... decodes the new file format + }; + + // ... + + NewAudioDecoder* loader = new NewAudioDecoder(); + engine->registerAudioStreamLoader(loader); + loader->drop(); +
There is an example audio decoder and loader with full source in plugins/ikpMP3, which adds MP3 audio decoding capabilities to irrKlang.
+
+
+
+
+Creating irrKlang Plugins
+irrKlang plugins are ikp*.dll (Windows), ikp*.so (Unix) or ikp*.dylib (MacOS) files which are loaded by irrKlang at startup when the irrklang::ESEO_LOAD_PLUGINS was set (which is default) or irrklang::ISoundEngine::loadPlugins() was called.
+
The plugin only needs to contain the following function which will be called by irrKlang:
+#ifdef WIN32 + // Windows version + __declspec(dllexport) void __stdcall irrKlangPluginInit(ISoundEngine* engine, const char* version) + #else + // Linux and Mac OS version + void irrKlangPluginInit(ISoundEngine* engine, const char* version) + #endif + { + // your implementation here + } +
In there, it is for example possible to extend irrKlang with new audio decoders, see Adding Audio Decoders for details.
+
There is an example plugin with full source in plugins/ikpMP3, which adds MP3 audio decoding capabilities to irrKlang.
+
+
+
+
+Using irrKlang as static Lib
+If you don't want to use the irrKlang.DLL file and link irrKlang statically, you can do this by simply linking to the irrKlang.lib in the bin/win32-visualstudio_lib folder. This folder will only available in the pro versions of irrKlang, which you get when purchasing an irrKlang license.
+To use irrKlang in this way, just define IRRKLANG_STATIC before including irrklang.h, like this:
+#define IRRKLANG_STATIC + #include <irrKlang.h> +
Of course, IRRKLANG_STATIC can also simply be defined in the project/compiler settings instead of in the source file.
+
+
+
+
+Enumerating sound devices
+irrKlang uses the default sound device when playing sound when started without parameters. But if you want irrKlang to playback sound on one specific sound device, you may want to enumerate the available sound devices on your system and select one of them. Use irrklang::createSoundDeviceList() for this. This example code shows how to print a list of all available sound devices on the current system and lets the user choose one of them:
+int main(int argc, const char** argv) + { + // enumerate devices + + irrklang::ISoundDeviceList* deviceList = createSoundDeviceList(); + + // ask user for a sound device + + printf("Devices available:\n\n"); + + for (int i=0; i<deviceList->getDeviceCount(); ++i) + printf("%d: %s\n", i, deviceList->getDeviceDescription(i)); + + printf("\nselect a device using the number (or press any key to use default):\n\n"); + int deviceNumber = getch() - '0'; + + // create device with the selected driver + + const char* deviceID = deviceList->getDeviceID(deviceNumber); + + ISoundEngine* engine = createIrrKlangDevice(irrklang::ESOD_AUTO_DETECT, + irrklang::ESEO_DEFAULT_OPTIONS, + deviceID); + + deviceList->drop(); // delete device list + + // ... use engine now + } +
In this way, it is also possible to play back sound using two devices at the same time: Simply create two irrKlang devices with each a different deviceID.
+ Note: createSoundDeviceList() takes a driver type parameter (such as irrklang::ESOD_DIRECT_SOUND8), which you have to set to the same value as the first parameter you want to use with createIrrKlangDevice(), if it is other than irrklang::ESOD_AUTO_DETECT.
+
+
+
+
+Recording Audio
+irrKlang is able to record audio from sound capturing devices such as microphones (currently only supported in windows). Use the irrklang::IAudioRecorder interface to do this. The following example shows how to record some audio and play it back again using the engine:
+int main(int argc, const char** argv) + { + irrklang::ISoundEngine* engine = irrklang::createIrrKlangDevice(); + irrklang::IAudioRecorder* recorder = irrklang::createIrrKlangAudioRecorder(engine); + + if (!engine || !recorder) + { + printf("Could not create audio engine or audio recoder\n"); + return 1; + } + + printf("\nPress any key to start recording audio...\n"); + getch(); + + // record some audio + + recorder->startRecordingBufferedAudio(); + + printf("\nRECORDING. Press any key to stop...\n"); + getch(); + + recorder->stopRecordingAudio(); + + printf("\nRecording done, recorded %dms of audio.\n", + recorder->getAudioFormat().FrameCount * 1000 / recorder->getAudioFormat().SampleRate ); + printf("Press any key to play back recorded audio...\n"); + getch(); + + // play the recorded audio + recorder->addSoundSourceFromRecordedAudio("myRecordedVoice"); + engine->play2D("myRecordedVoice", true); + + // wait until user presses a key + printf("\nPress any key to quit..."); + getch(); + + recorder->drop(); + engine->drop(); // delete engine + + return 0; + } +
In order to select a specific audio capturing device for recording, it is necessary to enumerate the available devices. Simply replace the first to lines of code of the example above with code like this to list all devices and select one:
+// enumerate recording devices and ask user to select one + + irrklang::ISoundDeviceList* deviceList = irrklang::createAudioRecorderDeviceList(); + + printf("Devices available:\n\n"); + + for (int i=0; i<deviceList->getDeviceCount(); ++i) + printf("%d: %s\n", i, deviceList->getDeviceDescription(i)); + + printf("\nselect a device using the number (or press any key to use default):\n\n"); + int deviceNumber = getch() - '0'; + + // create recording device with the selected driver + + const char* deviceID = deviceList->getDeviceID(deviceNumber); + irrklang::ISoundEngine* engine = irrklang::createIrrKlangDevice(); + irrklang::IAudioRecorder* recorder = + irrklang::createIrrKlangAudioRecorder(engine, irrklang::ESOD_AUTO_DETECT, deviceID); +
+
+
+
+
+Unicode support
+irrKlang supports unicode on all operating systems. Internally, it uses UTF8, and all functions accepting strings and file names take UTF8 strings. If you are running irrKlang on Windows, and are using the UNICODE define or using wchar_t* strings directly, you can do this as well. Use the irrKlang provided function makeUTF8fromUTF16string() to convert your wchar_t* string to a char* string.
+This example shows how:
+const wchar_t* yourFilename = L"SomeUnicodeFilename.wav"; // assuming this is the file name you get from some of your functions + + const int nBufferSize = 2048; // large enough, but best would be wcslen(yourFilename)*3. + char strBuffer[nBufferSize]; + irrklang::makeUTF8fromUTF16string(yourFilename, strBuffer, nBufferSize); + + // now the converted file name is in strBuffer. We can play it for example now: + engine->play2D(strBuffer); +
Of course, you can use any other unicode converion function for this. makeUTF8fromUTF16string() is only provided for convenience.
+
+
+
+
+Quick Start Example
+To simply start the engine and play a mp3 file, use code like this:
+#include <iostream> + #include <irrKlang.h> + #pragma comment(lib, "irrKlang.lib") // link with irrKlang.dll + + int main(int argc, const char** argv) + { + irrklang::ISoundEngine* engine = irrklang::createIrrKlangDevice(); + if (!engine) return 1; // could not start engine + + engine->play2D("someMusic.mp3", true); // play some mp3 file, looped + + std::cin.get(); // wait until user presses a key + + engine->drop(); // delete engine + return 0; + } +
A mp3 file is being played until the user presses enter in this example. As you can see, irrKlang uses namespaces, all of the classes are located in the namespace irrklang. If you don't want to write this in front of every class and function you are using, simply write
+ using namespace irrklang;
+ in front of your code, as also shown in the next example.
+
+
+
+
+Quick Start Example 2
+The following is a simple interactive application, starting up the sound engine and playing some streaming .ogg music file and a .wav sound effect every time the user presses a key.
+#include <iostream> + #include <irrKlang.h> + using namespace irrklang; + + #pragma comment(lib, "irrKlang.lib") // link with irrKlang.dll + + + int main(int argc, const char** argv) + { + // start the sound engine with default parameters + ISoundEngine* engine = createIrrKlangDevice(); + + if (!engine) + return 0; // error starting up the engine + + // play some sound stream, looped + engine->play2D("../../media/helltroopers.ogg", true); + + std::cout << "\nHello World!\n"; + + char i = 0; + + while(i != 'q') + { + std::cout << "Press any key to play some sound, press 'q' to quit.\n"; + + // play a single sound + engine->play2D("../../media/bell.wav"); + + std::cin >> i; // wait for user to press some key + } + + engine->drop(); // delete engine + return 0; + } +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+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 | +
+
+
+
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- File List +
- File Members +
irrKlang.h
Go to the documentation of this file.00001 /* irrKlang.h -- interface of the 'irrKlang' library +00002 +00003 Copyright (C) 2002-2018 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 #include "ik_ISoundMixedOutputReceiver.h" +00035 +00037 #define IRR_KLANG_VERSION "1.6.0" +00038 +00912 #if defined(IRRKLANG_STATIC) +00913 #define IRRKLANG_API +00914 #else +00915 #if (defined(WIN32) || defined(WIN64) || defined(_MSC_VER)) +00916 #ifdef IRRKLANG_EXPORTS +00917 #define IRRKLANG_API __declspec(dllexport) +00918 #else +00919 #define IRRKLANG_API __declspec(dllimport) +00920 #endif // IRRKLANG_EXPORT +00921 #else +00922 #define IRRKLANG_API __attribute__((visibility("default"))) +00923 #endif // defined(WIN32) || defined(WIN64) +00924 #endif // IRRKLANG_STATIC +00925 +00926 #if defined(_STDCALL_SUPPORTED) +00927 #define IRRKLANGCALLCONV __stdcall // Declare the calling convention. +00928 #else +00929 #define IRRKLANGCALLCONV +00930 #endif // STDCALL_SUPPORTED +00931 +00933 namespace irrklang +00934 { +00936 +00952 IRRKLANG_API ISoundEngine* IRRKLANGCALLCONV createIrrKlangDevice( +00953 E_SOUND_OUTPUT_DRIVER driver = ESOD_AUTO_DETECT, +00954 int options = ESEO_DEFAULT_OPTIONS, +00955 const char* deviceID = 0, +00956 const char* sdk_version_do_not_use = IRR_KLANG_VERSION); +00957 +00958 +00960 +00971 IRRKLANG_API ISoundDeviceList* IRRKLANGCALLCONV createSoundDeviceList( +00972 E_SOUND_OUTPUT_DRIVER driver = ESOD_AUTO_DETECT, +00973 const char* sdk_version_do_not_use = IRR_KLANG_VERSION); +00974 +00975 +00977 +00995 IRRKLANG_API IAudioRecorder* IRRKLANGCALLCONV createIrrKlangAudioRecorder( +00996 ISoundEngine* irrKlangDeviceForPlayback, +00997 E_SOUND_OUTPUT_DRIVER driver = ESOD_AUTO_DETECT, +00998 const char* deviceID = 0, +00999 const char* sdk_version_do_not_use = IRR_KLANG_VERSION); +01000 +01002 +01012 IRRKLANG_API ISoundDeviceList* IRRKLANGCALLCONV createAudioRecorderDeviceList( +01013 E_SOUND_OUTPUT_DRIVER driver = ESOD_AUTO_DETECT, +01014 const char* sdk_version_do_not_use = IRR_KLANG_VERSION); +01015 +01016 +01018 +01028 IRRKLANG_API bool IRRKLANGCALLCONV makeUTF8fromUTF16string( +01029 const wchar_t* pInputString, char* pOutputBuffer, int outputBufferSize); +01030 +01031 +01032 } // end namespace irrklang +01033 +01034 +01039 #endif +01040 +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+irrklang Namespace Reference
+Everything in the irrKlang Sound Engine can be found in this namespace. +More...
+Classes | |
| class | IAudioRecorder |
| Interface to an audio recorder. Create it using the createIrrKlangAudioRecorder() function. More... | |
| class | ICapturedAudioDataReceiver |
| Interface to be implemented by the user if access to the recorded audio data is needed. More... | |
| class | IAudioStream |
| Reads and decodes audio data into an usable audio stream for the ISoundEngine. More... | |
| class | IAudioStreamLoader |
| Class which is able to create an audio file stream from a file. More... | |
| class | IFileFactory |
| Interface to overwrite file access in irrKlang. More... | |
| class | IFileReader |
| Interface providing read acess to a file. More... | |
| class | IRefCounted |
| Base class of most objects of the irrKlang. More... | |
| class | ISound |
| Represents a sound which is currently played. More... | |
| class | ISoundDeviceList |
| A list of sound devices for a sound driver. Use irrklang::createSoundDeviceList() to create this list. More... | |
| class | ISoundEffectControl |
| Interface to control the active sound effects (echo, reverb,...) of an ISound object, a playing sound. More... | |
| class | ISoundEngine |
| Interface to the sound engine, for playing 3d and 2d sound and music. More... | |
| struct | SInternalAudioInterface |
| structure for returning pointers to the internal audio interface. More... | |
| class | ISoundMixedOutputReceiver |
| Interface to be implemented by the user, which recieves the mixed output when it it played by the sound engine. More... | |
| class | ISoundSource |
| A sound source describes an input file (.ogg, .mp3, .wav or similar) and its default settings. More... | |
| class | ISoundStopEventReceiver |
| Interface to be implemented by the user, which recieves sound stop events. More... | |
| class | IVirtualRefCounted |
| Reference counting base class for objects in the Irrlicht Engine similar to IRefCounted. More... | |
| struct | SAudioStreamFormat |
| structure describing an audio stream format with helper functions More... | |
| class | vec3d |
| a 3d vector template class for representing vectors and points in 3d More... | |
Typedefs | |
| typedef unsigned char | ik_u8 |
| 8 bit unsigned variable. | |
| typedef signed char | ik_s8 |
| 8 bit signed variable. | |
| typedef char | ik_c8 |
| 8 bit character variable. | |
| typedef unsigned short | ik_u16 |
| 16 bit unsigned variable. | |
| typedef signed short | ik_s16 |
| 16 bit signed variable. | |
| typedef unsigned int | ik_u32 |
| 32 bit unsigned variable. | |
| typedef signed int | ik_s32 |
| 32 bit signed variable. | |
| typedef float | ik_f32 |
| 32 bit floating point variable. | |
| typedef double | ik_f64 |
| 64 bit floating point variable. | |
| typedef vec3d< ik_f32 > | vec3df |
| Typedef for a ik_f32 3d vector, a vector using floats for X, Y and Z. | |
| typedef vec3d< ik_s32 > | vec3di |
| Typedef for an integer 3d vector, a vector using ints for X, Y and Z. | |
Enumerations | |
| enum | E_SOUND_ENGINE_OPTIONS { + ESEO_MULTI_THREADED = 0x01, +ESEO_MUTE_IF_NOT_FOCUSED = 0x02, +ESEO_LOAD_PLUGINS = 0x04, +ESEO_USE_3D_BUFFERS = 0x08, + + ESEO_PRINT_DEBUG_INFO_TO_DEBUGGER = 0x10, +ESEO_PRINT_DEBUG_INFO_TO_STDOUT = 0x20, +ESEO_LINEAR_ROLLOFF = 0x40, +ESEO_DEFAULT_OPTIONS = ESEO_MULTI_THREADED | ESEO_LOAD_PLUGINS | ESEO_USE_3D_BUFFERS | ESEO_PRINT_DEBUG_INFO_TO_DEBUGGER | ESEO_PRINT_DEBUG_INFO_TO_STDOUT, + + ESEO_FORCE_32_BIT = 0x7fffffff + + } |
An enumeration for all options for starting up the sound engine. + More... | |
| enum | E_SOUND_OUTPUT_DRIVER { + ESOD_AUTO_DETECT = 0, +ESOD_DIRECT_SOUND_8, +ESOD_DIRECT_SOUND, +ESOD_WIN_MM, + + ESOD_ALSA, +ESOD_CORE_AUDIO, +ESOD_NULL, +ESOD_COUNT, + + ESOD_FORCE_32_BIT = 0x7fffffff + + } |
An enumeration for all types of supported sound drivers. + More... | |
| enum | E_STREAM_MODE { ESM_AUTO_DETECT = 0, +ESM_STREAMING, +ESM_NO_STREAMING, +ESM_FORCE_32_BIT = 0x7fffffff + } |
An enumeration for all types of supported stream modes. + More... | |
| enum | E_STOP_EVENT_CAUSE { ESEC_SOUND_FINISHED_PLAYING = 0, +ESEC_SOUND_STOPPED_BY_USER, +ESEC_SOUND_STOPPED_BY_SOURCE_REMOVAL, +ESEC_FORCE_32_BIT = 0x7fffffff + } |
An enumeration listing all reasons for a fired sound stop event. + More... | |
| enum | ESampleFormat { ESF_U8, +ESF_S16 + } |
audio sample data format enumeration for supported formats + More... | |
Functions | |
| bool | equalsfloat (const ik_f32 a, const ik_f32 b, const ik_f32 tolerance=IK_ROUNDING_ERROR_32) |
| template<class S , class T > | |
| vec3d< T > | operator* (const S scalar, const vec3d< T > &vector) |
| IRRKLANG_API ISoundEngine +*IRRKLANGCALLCONV | 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 | 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 | 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 | 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 | 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. | |
Variables | |
| const ik_f32 | IK_ROUNDING_ERROR_32 = 0.000001f |
| const ik_f64 | IK_PI64 = 3.1415926535897932384626433832795028841971693993751 |
| const ik_f32 | IK_PI32 = 3.14159265359f |
| const ik_f32 | IK_RADTODEG = 180.0f / IK_PI32 |
| const ik_f32 | IK_DEGTORAD = IK_PI32 / 180.0f |
| const ik_f64 | IK_RADTODEG64 = 180.0 / IK_PI64 |
| const ik_f64 | IK_DEGTORAD64 = IK_PI64 / 180.0 |
Detailed Description
+Everything in the irrKlang Sound Engine can be found in this namespace.
+Typedef Documentation
+ +
+
+
+
+
+
+
+| typedef char irrklang::ik_c8 | +
+
+
+8 bit character variable.
+This is a typedef for char, it ensures portability of the engine.
+ +
+
+
+
+
+
+
+| typedef float irrklang::ik_f32 | +
+
+
+32 bit floating point variable.
+This is a typedef for float, it ensures portability of the engine.
+ +
+
+
+
+
+
+
+| typedef double irrklang::ik_f64 | +
+
+
+64 bit floating point variable.
+This is a typedef for double, it ensures portability of the engine.
+ +
+
+
+
+
+
+
+| typedef signed short irrklang::ik_s16 | +
+
+
+16 bit signed variable.
+This is a typedef for signed short, it ensures portability of the engine.
+ +
+
+
+
+
+
+
+| typedef signed int irrklang::ik_s32 | +
+
+
+32 bit signed variable.
+This is a typedef for signed int, it ensures portability of the engine.
+ +
+
+
+
+
+
+
+| typedef signed char irrklang::ik_s8 | +
+
+
+8 bit signed variable.
+This is a typedef for signed char, it ensures portability of the engine.
+ +
+
+
+
+
+
+
+| typedef unsigned short irrklang::ik_u16 | +
+
+
+16 bit unsigned variable.
+This is a typedef for unsigned short, it ensures portability of the engine.
+ +
+
+
+
+
+
+
+| typedef unsigned int irrklang::ik_u32 | +
+
+
+32 bit unsigned variable.
+This is a typedef for unsigned int, it ensures portability of the engine.
+ +
+
+
+
+
+
+
+| typedef unsigned char irrklang::ik_u8 | +
+
+
+8 bit unsigned variable.
+This is a typedef for unsigned char, it ensures portability of the engine.
+ +
+
+
+
+
+
+
+| typedef vec3d<ik_f32> irrklang::vec3df | +
+
+
+Typedef for a ik_f32 3d vector, a vector using floats for X, Y and Z.
+ +
+
+
+
+
+
+| typedef vec3d<ik_s32> irrklang::vec3di | +
+
+
+Typedef for an integer 3d vector, a vector using ints for X, Y and Z.
+ +Enumeration Type Documentation
+ +
+
+
+
+
+
+
+| enum irrklang::E_SOUND_ENGINE_OPTIONS | +
+
+
+An enumeration for all options for starting up the sound engine.
+When using createIrrKlangDevice, use a combination of this these as 'options' parameter to start up the engine. By default, irrKlang uses ESEO_DEFAULT_OPTIONS, which is set to the combination ESEO_MULTI_THREADED | ESEO_LOAD_PLUGINS | ESEO_USE_3D_BUFFERS | ESEO_PRINT_DEBUG_INFO_TO_DEBUGGER | ESEO_PRINT_DEBUG_INFO_TO_STDOUT.
+- Enumerator:
+
+ESEO_MULTI_THREADED + If specified (default), it will make irrKlang run in a separate thread.
+Using this flag, irrKlang will update all streams, sounds, 3d positions and whatever automaticly. You also don't need to call ISoundEngine::update() if irrKlang is running multithreaded. However, if you want to run irrKlang in the same thread as your application (for easier debugging for example), don't set this. But you need to call ISoundEngine::update() as often as you can (at least about 2-3 times per second) to make irrKlang update everything correctly then.
+ESEO_MUTE_IF_NOT_FOCUSED + If the window of the application doesn't have the focus, irrKlang will be silent if this has been set.
+This will only work when irrKlang is using the DirectSound output driver.
+ESEO_LOAD_PLUGINS + Automaticly loads external plugins when starting up.
+Plugins usually are .dll, .so or .dylib files named for example ikpMP3.dll (= short for irrKlangPluginMP3) which are executed after the startup of the sound engine and modify it for example to make it possible to play back mp3 files. Plugins are being loaded from the current working directory as well as from the position where the .exe using the irrKlang library resides. It is also possible to load the plugins after the engine has started up using ISoundEngine::loadPlugins().
+ESEO_USE_3D_BUFFERS + Uses 3D sound buffers instead of emulating them when playing 3d sounds (default).
+If this flag is not specified, all buffers will by created in 2D only and 3D positioning will be emulated in software, making the engine run faster if hardware 3d audio is slow on the system.
+ESEO_PRINT_DEBUG_INFO_TO_DEBUGGER + Prints debug messages to the debugger window.
+irrKlang will print debug info and status messages to any windows debugger supporting OutputDebugString() (like VisualStudio). This is useful if your application does not capture any console output (see ESEO_PRINT_DEBUG_INFO_TO_STDOUT).
+ESEO_PRINT_DEBUG_INFO_TO_STDOUT + Prints debug messages to stdout (the ConsoleWindow).
+irrKlang will print debug info and status messages stdout, the console window in Windows.
+ESEO_LINEAR_ROLLOFF + Uses linear rolloff for 3D sound.
+If specified, instead of the default logarithmic one, irrKlang will use a linear rolloff model which influences the attenuation of the sounds over distance. The volume is interpolated linearly between the MinDistance and MaxDistance, making it possible to adjust sounds more easily although this is not physically correct. Note that this option may not work when used together with the ESEO_USE_3D_BUFFERS option when using Direct3D for example, irrKlang will then turn off ESEO_USE_3D_BUFFERS automaticly to be able to use this option and write out a warning.
+ESEO_DEFAULT_OPTIONS + Default parameters when starting up the engine.
+ESEO_FORCE_32_BIT + Never used, it only forces the compiler to compile these enumeration values to 32 bit.
+Don't use this.
+
+
+
+
+
+
+
+
+| enum irrklang::E_SOUND_OUTPUT_DRIVER | +
+
+
+An enumeration for all types of supported sound drivers.
+Values of this enumeration can be used as parameter when calling createIrrKlangDevice().
+- Enumerator:
+
+ESOD_AUTO_DETECT + Autodetects the best sound driver for the system.
+ESOD_DIRECT_SOUND_8 + DirectSound8 sound output driver, windows only.
+In contrast to ESOD_DIRECT_SOUND, this supports sophisticated sound effects but may not be available on old windows versions. It behaves very similar to ESOD_DIRECT_SOUND but also supports DX8 sound effects.
+ESOD_DIRECT_SOUND + DirectSound sound output driver, windows only.
+This uses DirectSound 3 or above, if available. If DX8 sound effects are needed, use ESOD_DIRECT_SOUND_8 instead. The ESOD_DIRECT_SOUND driver may be available on more and older windows versions than ESOD_DIRECT_SOUND_8.
+ESOD_WIN_MM + WinMM sound output driver, windows only.
+Supports the ISoundMixedOutputReceiver interface using setMixedDataOutputReceiver.
+ESOD_ALSA + ALSA sound output driver, linux only.
+When using ESOD_ALSA in createIrrKlangDevice(), it is possible to set the third parameter, 'deviceID' to the name of specific ALSA pcm device, to the irrKlang force to use this one. Set it to 'default', or 'plug:hw' or whatever you need it to be. Supports the ISoundMixedOutputReceiver interface using setMixedDataOutputReceiver.
+ESOD_CORE_AUDIO + Core Audio sound output driver, mac os only.
+Supports the ISoundMixedOutputReceiver interface using setMixedDataOutputReceiver.
+ESOD_NULL + Null driver, creating no sound output.
+ESOD_COUNT + Amount of built-in sound output drivers.
+ESOD_FORCE_32_BIT + This enumeration literal is never used, it only forces the compiler to compile these enumeration values to 32 bit.
+
+
+
+
+
+
+
+
+| enum irrklang::E_STOP_EVENT_CAUSE | +
+
+
+An enumeration listing all reasons for a fired sound stop event.
+- Enumerator:
+
+ESEC_SOUND_FINISHED_PLAYING + The sound stop event was fired because the sound finished playing.
+ESEC_SOUND_STOPPED_BY_USER + The sound stop event was fired because the sound was stopped by the user, calling ISound::stop().
+ESEC_SOUND_STOPPED_BY_SOURCE_REMOVAL + The sound stop event was fired because the source of the sound was removed, for example because irrKlang was shut down or the user called ISoundEngine::removeSoundSource().
+ESEC_FORCE_32_BIT + This enumeration literal is never used, it only forces the compiler to compile these enumeration values to 32 bit.
+
+
+
+
+
+
+
+
+| enum irrklang::E_STREAM_MODE | +
+
+
+An enumeration for all types of supported stream modes.
+- Enumerator:
+
+ESM_AUTO_DETECT + Autodetects the best stream mode for a specified audio data.
+ESM_STREAMING + Streams the audio data when needed.
+ESM_NO_STREAMING + Loads the whole audio data into the memory.
+ESM_FORCE_32_BIT + This enumeration literal is never used, it only forces the compiler to compile these enumeration values to 32 bit.
+
+
+
+
+
+
+
+
+| enum irrklang::ESampleFormat | +
Function Documentation
+ +
+
+
+
+
+
+
+| 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.
+The device IDs in this list can be used as parameter to createIrrKlangAudioRecorder() to make irrKlang use a special recording device.
+- Parameters:
-
+
+
+driver The sound output driver of which the list is generated. Set it irrklang::ESOD_AUTO_DETECT to let this function use the same device as createIrrKlangDevice() would choose. sdk_version_do_not_use Don't use or change this parameter. Always set it to IRRKLANG_SDK_VERSION, which is done by default. This is needed for sdk version checks.
+
- Returns:
- Returns a pointer to the list of enumerated recording devices for the selected sound driver. The device IDs in this list can be used as parameter to createIrrKlangAudioRecorder() to make irrKlang use a special sound device. After you don't need the list anymore, call ISoundDeviceList::drop() in order to free its memory.
+
+
+
+
+
+
+| 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.
+If you want to play back recorded audio as well, create the ISoundEngine first using createIrrKlangDevice() and then the IAudioRecorder using createIrrKlangAudioRecorder(), where you set the ISoundEngine as first parameter. See Recording Audio for an example on how to use this. Note: audio recording is a very new feature a still beta in irrKlang. It currently only works in Windows and with DirectSound (subject to change).
+- Parameters:
-
+
+
+irrKlangDeviceForPlayback A pointer to the already existing sound device used for playback of audio. Sound sources recorded with the IAudioRecorder will be added into that device so that they can be played back there. driver The sound output driver to be used for recording audio. Use irrklang::ESOD_AUTO_DETECT to let irrKlang decide which driver will be best. deviceID Some additional optional deviceID for the audio driver. If not needed, simple set this to 0. Use createAudioRecorderDeviceList() to get a list of all deviceIDs. sdk_version_do_not_use Don't use or change this parameter. Always set it to IRRKLANG_SDK_VERSION, which is done by default. This is needed for sdk version checks.
+
- Returns:
- Returns pointer to the created irrKlang device or null if the device could not be created. If you don't need the device, use ISoundEngine::drop() to delete it. See IRefCounted::drop() for details.
+
+
+
+
+
+
+| 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.
+- Parameters:
-
+
+
+driver The sound output driver to be used for sound output. Use irrklang::ESOD_AUTO_DETECT to let irrKlang decide which driver will be best. options A combination of irrklang::E_SOUND_ENGINE_OPTIONS literals. Default value is irrklang::ESEO_DEFAULT_OPTIONS. deviceID Some additional optional deviceID for the audio driver. If not needed, simple set this to 0. This can be used for example to set a specific ALSA output pcm device for output ("default" or "hw", for example). For most driver types, available deviceIDs can be enumerated using createSoundDeviceList(). See Enumerating sound devices for an example or ISoundDeviceList or details. sdk_version_do_not_use Don't use or change this parameter. Always set it to IRRKLANG_SDK_VERSION, which is done by default. This is needed for sdk version checks.
+
- Returns:
- Returns pointer to the created irrKlang device or null if the device could not be created. If you don't need the device, use ISoundEngine::drop() to delete it. See IRefCounted::drop() for details.
+
+
+
+
+
+
+| 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.
+The device IDs in this list can be used as parameter to createIrrKlangDevice() to make irrKlang use a special sound device. See Enumerating sound devices for an example on how to use this.
+- Parameters:
-
+
+
+driver The sound output driver of which the list is generated. Set it irrklang::ESOD_AUTO_DETECT to let this function use the same device as createIrrKlangDevice() would choose. sdk_version_do_not_use Don't use or change this parameter. Always set it to IRRKLANG_SDK_VERSION, which is done by default. This is needed for sdk version checks.
+
- Returns:
- Returns a pointer to the list of enumerated sound devices for the selected sound driver. The device IDs in this list can be used as parameter to createIrrKlangDevice() to make irrKlang use a special sound device. After you don't need the list anymore, call ISoundDeviceList::drop() in order to free its memory.
+
+
+
+
+
+
+| bool irrklang::equalsfloat | +( | +const ik_f32 | +a, | +|
| + | + | const ik_f32 | +b, | +|
| + | + | const ik_f32 | + tolerance = IK_ROUNDING_ERROR_32 | + |
| + | ) | + [inline] |
+
+
+returns if a float equals the other one, taking floating point rounding errors into account
+ +
+
+
+
+
+
+
+| 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.
+irrKlang works with unicode file names, and accepts char* strings as parameters for names and filenames. If you are running irrKlang in Windows, and working with wchar_t* pointers instead of char* ones, you can use this function to create a char* (UTF8) representation of your wchar_t* (UTF16) string. Works for filenames and other strings.
+- Parameters:
-
+
+
+pInputString zero terminated input string. pOutputBuffer the buffer where the converted string is written to. Be sure that this buffer has a big enough size. A good size would be three times the string length of your input buffer, like wcslen(yourInputBuffer)*3. Because each wchar_t can be represented by up to 3 chars. outputBufferSize size of your output buffer.
+
- Returns:
- Returns true if successful, and false if not. If 'false' is returned, maybe your buffer was too small.
+
+
+
+
+
+
+template<class S , class T >
+ | vec3d<T> irrklang::operator* | +( | +const S | +scalar, | +|
| + | + | const vec3d< T > & | +vector | + |
| + | ) | + [inline] |
+
+
+
+Variable Documentation
+ +
+
+
+
+
+
+
+| const ik_f32 irrklang::IK_DEGTORAD = IK_PI32 / 180.0f | +
+
+
+
+
+
+
+
+
+
+| const ik_f64 irrklang::IK_DEGTORAD64 = IK_PI64 / 180.0 | +
+
+
+
+
+
+
+
+
+
+| const ik_f32 irrklang::IK_PI32 = 3.14159265359f | +
+
+
+
+
+
+
+
+
+
+| const ik_f64 irrklang::IK_PI64 = 3.1415926535897932384626433832795028841971693993751 | +
+
+
+
+
+
+
+
+
+
+| const ik_f32 irrklang::IK_RADTODEG = 180.0f / IK_PI32 | +
+
+
+
+
+
+
+
+
+
+| const ik_f64 irrklang::IK_RADTODEG64 = 180.0 / IK_PI64 | +
+
+
+
+
+
+
+
+
+| const ik_f32 irrklang::IK_ROUNDING_ERROR_32 = 0.000001f | +
+
+
+
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+
+
+
+-
+
- All +
- Functions +
- Variables +
- Typedefs +
- Enumerations +
- Enumerator +
+Here is a list of all namespace members with links to the namespace documentation for each member:
+
+
+
+
+
+
+- c -
-
+
- createAudioRecorderDeviceList() +: irrklang + +
- createIrrKlangAudioRecorder() +: irrklang + +
- createIrrKlangDevice() +: irrklang + +
- createSoundDeviceList() +: irrklang + +
- e -
-
+
- E_SOUND_ENGINE_OPTIONS +: irrklang + +
- E_SOUND_OUTPUT_DRIVER +: irrklang + +
- E_STOP_EVENT_CAUSE +: irrklang + +
- E_STREAM_MODE +: irrklang + +
- equalsfloat() +: irrklang + +
- ESampleFormat +: irrklang + +
- ESEC_FORCE_32_BIT +: irrklang + +
- ESEC_SOUND_FINISHED_PLAYING +: irrklang + +
- ESEC_SOUND_STOPPED_BY_SOURCE_REMOVAL +: irrklang + +
- ESEC_SOUND_STOPPED_BY_USER +: irrklang + +
- ESEO_DEFAULT_OPTIONS +: irrklang + +
- ESEO_FORCE_32_BIT +: irrklang + +
- ESEO_LINEAR_ROLLOFF +: irrklang + +
- ESEO_LOAD_PLUGINS +: irrklang + +
- ESEO_MULTI_THREADED +: irrklang + +
- ESEO_MUTE_IF_NOT_FOCUSED +: irrklang + +
- ESEO_PRINT_DEBUG_INFO_TO_DEBUGGER +: irrklang + +
- ESEO_PRINT_DEBUG_INFO_TO_STDOUT +: irrklang + +
- ESEO_USE_3D_BUFFERS +: irrklang + +
- ESF_S16 +: irrklang + +
- ESF_U8 +: irrklang + +
- ESM_AUTO_DETECT +: irrklang + +
- ESM_FORCE_32_BIT +: irrklang + +
- ESM_NO_STREAMING +: irrklang + +
- ESM_STREAMING +: irrklang + +
- ESOD_ALSA +: irrklang + +
- ESOD_AUTO_DETECT +: irrklang + +
- ESOD_CORE_AUDIO +: irrklang + +
- ESOD_COUNT +: irrklang + +
- ESOD_DIRECT_SOUND +: irrklang + +
- ESOD_DIRECT_SOUND_8 +: irrklang + +
- ESOD_FORCE_32_BIT +: irrklang + +
- ESOD_NULL +: irrklang + +
- ESOD_WIN_MM +: irrklang + +
- i -
-
+
- ik_c8 +: irrklang + +
- IK_DEGTORAD +: irrklang + +
- IK_DEGTORAD64 +: irrklang + +
- ik_f32 +: irrklang + +
- ik_f64 +: irrklang + +
- IK_PI32 +: irrklang + +
- IK_PI64 +: irrklang + +
- IK_RADTODEG +: irrklang + +
- IK_RADTODEG64 +: irrklang + +
- IK_ROUNDING_ERROR_32 +: irrklang + +
- ik_s16 +: irrklang + +
- ik_s32 +: irrklang + +
- ik_s8 +: irrklang + +
- ik_u16 +: irrklang + +
- ik_u32 +: irrklang + +
- ik_u8 +: irrklang + +
- m -
-
+
- makeUTF8fromUTF16string() +: irrklang + +
- o -
-
+
- operator*() +: irrklang + +
- v -
+
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+
+
+-
+
- All +
- Functions +
- Variables +
- Typedefs +
- Enumerations +
- Enumerator +
+
+
+
+
+
+
+
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+
+
+-
+
- All +
- Functions +
- Variables +
- Typedefs +
- Enumerations +
- Enumerator +
+
+
+
+
+
+-
+
- ESEC_FORCE_32_BIT +: irrklang + +
- ESEC_SOUND_FINISHED_PLAYING +: irrklang + +
- ESEC_SOUND_STOPPED_BY_SOURCE_REMOVAL +: irrklang + +
- ESEC_SOUND_STOPPED_BY_USER +: irrklang + +
- ESEO_DEFAULT_OPTIONS +: irrklang + +
- ESEO_FORCE_32_BIT +: irrklang + +
- ESEO_LINEAR_ROLLOFF +: irrklang + +
- ESEO_LOAD_PLUGINS +: irrklang + +
- ESEO_MULTI_THREADED +: irrklang + +
- ESEO_MUTE_IF_NOT_FOCUSED +: irrklang + +
- ESEO_PRINT_DEBUG_INFO_TO_DEBUGGER +: irrklang + +
- ESEO_PRINT_DEBUG_INFO_TO_STDOUT +: irrklang + +
- ESEO_USE_3D_BUFFERS +: irrklang + +
- ESF_S16 +: irrklang + +
- ESF_U8 +: irrklang + +
- ESM_AUTO_DETECT +: irrklang + +
- ESM_FORCE_32_BIT +: irrklang + +
- ESM_NO_STREAMING +: irrklang + +
- ESM_STREAMING +: irrklang + +
- ESOD_ALSA +: irrklang + +
- ESOD_AUTO_DETECT +: irrklang + +
- ESOD_CORE_AUDIO +: irrklang + +
- ESOD_COUNT +: irrklang + +
- ESOD_DIRECT_SOUND +: irrklang + +
- ESOD_DIRECT_SOUND_8 +: irrklang + +
- ESOD_FORCE_32_BIT +: irrklang + +
- ESOD_NULL +: irrklang + +
- ESOD_WIN_MM +: irrklang + +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+
+
+-
+
- All +
- Functions +
- Variables +
- Typedefs +
- Enumerations +
- Enumerator +
+
+
+
+
+
+
+
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+
+
+-
+
- All +
- Functions +
- Variables +
- Typedefs +
- Enumerations +
- Enumerator +
+
+
+
+
+
+
+
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+
+
+-
+
- All +
- Functions +
- Variables +
- Typedefs +
- Enumerations +
- Enumerator +
+
+
+
+
+
+
+
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Namespace List
Here is a list of all namespaces with brief descriptions:| irrklang | Everything in the irrKlang Sound Engine can be found in this namespace |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/all_63.html b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/all_63.html
new file mode 100644
index 0000000..90a9efb
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/all_63.html
@@ -0,0 +1,74 @@
+
+Loading...
+
+
+
+ addFileFactory
+ irrklang::ISoundEngine
+
+
+
+
+ addSoundSourceAlias
+ irrklang::ISoundEngine
+
+
+
+
+ addSoundSourceFromFile
+ irrklang::ISoundEngine
+
+
+
+
+ addSoundSourceFromMemory
+ irrklang::ISoundEngine
+
+
+
+
+ addSoundSourceFromPCMData
+ irrklang::ISoundEngine
+
+
+
+
+ addSoundSourceFromRecordedAudio
+ irrklang::IAudioRecorder
+
+Searching...
+No Matches
+
+
+
+
+
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/all_64.html b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/all_64.html
new file mode 100644
index 0000000..89a6e7f
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/all_64.html
@@ -0,0 +1,95 @@
+
+Loading...
+
+
+
+ ChannelCount
+ irrklang::SAudioStreamFormat
+
+
+
+
+ clearRecordedAudioDataBuffer
+ irrklang::IAudioRecorder
+
+
+
+
+ createAudioRecorderDeviceList
+ irrklang
+
+
+
+
+ createAudioStream
+ irrklang::IAudioStreamLoader
+
+
+
+
+ createFileReader
+ irrklang::IFileFactory
+
+
+
+
+ createIrrKlangAudioRecorder
+ irrklang
+
+
+
+
+ createIrrKlangDevice
+ irrklang
+
+
+
+
+ createSoundDeviceList
+ irrklang
+
+
+
+
+ crossProduct
+ irrklang::vec3d
+
+Searching...
+No Matches
+
+
+
+
+
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/all_65.html b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/all_65.html
new file mode 100644
index 0000000..97747e6
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/all_65.html
@@ -0,0 +1,284 @@
+
+Loading...
+
+
+
+ disableAllEffects
+ irrklang::ISoundEffectControl
+
+
+
+
+ disableChorusSoundEffect
+ irrklang::ISoundEffectControl
+
+
+
+
+ disableCompressorSoundEffect
+ irrklang::ISoundEffectControl
+
+
+
+
+ disableDistortionSoundEffect
+ irrklang::ISoundEffectControl
+
+
+
+
+ disableEchoSoundEffect
+ irrklang::ISoundEffectControl
+
+
+
+
+ disableFlangerSoundEffect
+ irrklang::ISoundEffectControl
+
+
+
+
+ disableGargleSoundEffect
+ irrklang::ISoundEffectControl
+
+
+
+
+ disableI3DL2ReverbSoundEffect
+ irrklang::ISoundEffectControl
+
+
+
+
+ disableParamEqSoundEffect
+ irrklang::ISoundEffectControl
+
+
+
+
+ disableWavesReverbSoundEffect
+ irrklang::ISoundEffectControl
+
+
+
+
+ dotProduct
+ irrklang::vec3d
+
+
+
+
+Searching...
+No Matches
+
+
+
+
+
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/all_66.html b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/all_66.html
new file mode 100644
index 0000000..1c2066a
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/all_66.html
@@ -0,0 +1,32 @@
+
+Loading...
+
+
+
+ E_SOUND_ENGINE_OPTIONS
+ irrklang
+
+
+
+
+ E_SOUND_OUTPUT_DRIVER
+ irrklang
+
+
+
+
+ E_STOP_EVENT_CAUSE
+ irrklang
+
+
+
+
+ E_STREAM_MODE
+ irrklang
+
+
+
+
+ enableChorusSoundEffect
+ irrklang::ISoundEffectControl
+
+
+
+
+ enableCompressorSoundEffect
+ irrklang::ISoundEffectControl
+
+
+
+
+ enableDistortionSoundEffect
+ irrklang::ISoundEffectControl
+
+
+
+
+ enableEchoSoundEffect
+ irrklang::ISoundEffectControl
+
+
+
+
+ enableFlangerSoundEffect
+ irrklang::ISoundEffectControl
+
+
+
+
+ enableGargleSoundEffect
+ irrklang::ISoundEffectControl
+
+
+
+
+ enableI3DL2ReverbSoundEffect
+ irrklang::ISoundEffectControl
+
+
+
+
+ enableParamEqSoundEffect
+ irrklang::ISoundEffectControl
+
+
+
+
+ enableWavesReverbSoundEffect
+ irrklang::ISoundEffectControl
+
+
+
+
+ equals
+ irrklang::vec3d
+
+
+
+
+ equalsfloat
+ irrklang
+
+
+
+
+ ESampleFormat
+ irrklang
+
+
+
+
+ ESEC_FORCE_32_BIT
+ irrklang
+
+
+
+
+ ESEC_SOUND_FINISHED_PLAYING
+ irrklang
+
+
+
+
+ ESEC_SOUND_STOPPED_BY_SOURCE_REMOVAL
+ irrklang
+
+
+
+
+ ESEC_SOUND_STOPPED_BY_USER
+ irrklang
+
+
+
+
+ ESEO_DEFAULT_OPTIONS
+ irrklang
+
+
+
+
+ ESEO_FORCE_32_BIT
+ irrklang
+
+
+
+
+ ESEO_LINEAR_ROLLOFF
+ irrklang
+
+
+
+
+ ESEO_LOAD_PLUGINS
+ irrklang
+
+
+
+
+ ESEO_MULTI_THREADED
+ irrklang
+
+
+
+
+ ESEO_MUTE_IF_NOT_FOCUSED
+ irrklang
+
+
+
+
+ ESEO_PRINT_DEBUG_INFO_TO_DEBUGGER
+ irrklang
+
+
+
+
+ ESEO_PRINT_DEBUG_INFO_TO_STDOUT
+ irrklang
+
+
+
+
+ ESEO_USE_3D_BUFFERS
+ irrklang
+
+
+
+
+ ESF_S16
+ irrklang
+
+
+
+
+ ESF_U8
+ irrklang
+
+
+
+
+ ESM_AUTO_DETECT
+ irrklang
+
+
+
+
+ ESM_FORCE_32_BIT
+ irrklang
+
+
+
+
+ ESM_NO_STREAMING
+ irrklang
+
+
+
+
+ ESM_STREAMING
+ irrklang
+
+
+
+
+ ESOD_ALSA
+ irrklang
+
+
+
+
+ ESOD_AUTO_DETECT
+ irrklang
+
+
+
+
+ ESOD_CORE_AUDIO
+ irrklang
+
+
+
+
+ ESOD_COUNT
+ irrklang
+
+
+
+
+ ESOD_DIRECT_SOUND
+ irrklang
+
+
+
+
+ ESOD_DIRECT_SOUND_8
+ irrklang
+
+
+
+
+ ESOD_FORCE_32_BIT
+ irrklang
+
+
+
+
+ ESOD_NULL
+ irrklang
+
+
+
+
+ ESOD_WIN_MM
+ irrklang
+
+Searching...
+No Matches
+
+
+
+
+
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/all_67.html b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/all_67.html
new file mode 100644
index 0000000..7ad33cf
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/all_67.html
@@ -0,0 +1,321 @@
+
+Loading...
+
+
+
+ forceReloadAtNextUse
+ irrklang::ISoundSource
+
+
+
+
+ FrameCount
+ irrklang::SAudioStreamFormat
+
+Searching...
+No Matches
+
+
+
+
+
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/all_69.html b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/all_69.html
new file mode 100644
index 0000000..355b2a4
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/all_69.html
@@ -0,0 +1,445 @@
+
+Loading...
+
+
+
+ getAs4Values
+ irrklang::vec3d
+
+
+
+
+
+
+
+ getBytesPerSecond
+ irrklang::SAudioStreamFormat
+
+
+
+
+ getDefault3DSoundMaxDistance
+ irrklang::ISoundEngine
+
+
+
+
+ getDefault3DSoundMinDistance
+ irrklang::ISoundEngine
+
+
+
+
+ getDefaultMaxDistance
+ irrklang::ISoundSource
+
+
+
+
+ getDefaultMinDistance
+ irrklang::ISoundSource
+
+
+
+
+ getDefaultVolume
+ irrklang::ISoundSource
+
+
+
+
+ getDeviceCount
+ irrklang::ISoundDeviceList
+
+
+
+
+ getDeviceDescription
+ irrklang::ISoundDeviceList
+
+
+
+
+ getDeviceID
+ irrklang::ISoundDeviceList
+
+
+
+
+ getDistanceFrom
+ irrklang::vec3d
+
+
+
+
+ getDistanceFromSQ
+ irrklang::vec3d
+
+
+
+
+
+
+
+ getFileName
+ irrklang::IFileReader
+
+
+
+
+ getForcedStreamingThreshold
+ irrklang::ISoundSource
+
+
+
+
+ getFormat
+ irrklang::IAudioStream
+
+
+
+
+ getFrameSize
+ irrklang::SAudioStreamFormat
+
+
+
+
+ getHorizontalAngle
+ irrklang::vec3d
+
+
+
+
+ getInternalAudioInterface
+ irrklang::ISoundEngine
+
+
+
+
+ getInterpolated
+ irrklang::vec3d
+
+
+
+
+ getIsPaused
+ irrklang::ISound
+
+
+
+
+
+
+
+ getLength
+ irrklang::vec3d
+
+
+
+
+ getLengthSQ
+ irrklang::vec3d
+
+
+
+
+ getMaxDistance
+ irrklang::ISound
+
+
+
+
+ getMinDistance
+ irrklang::ISound
+
+
+
+
+ getName
+ irrklang::ISoundSource
+
+
+
+
+ getPan
+ irrklang::ISound
+
+
+
+
+ getPlaybackSpeed
+ irrklang::ISound
+
+
+
+
+
+
+
+ getPlayPosition
+ irrklang::ISound
+
+
+
+
+ getPos
+ irrklang::IFileReader
+
+
+
+
+ getPosition
+ irrklang::ISound
+
+
+
+
+ getRecordedAudioData
+ irrklang::IAudioRecorder
+
+
+
+
+ getSampleData
+ irrklang::ISoundSource
+
+
+
+
+ getSampleDataSize
+ irrklang::SAudioStreamFormat
+
+
+
+
+ getSampleSize
+ irrklang::SAudioStreamFormat
+
+
+
+
+ getSize
+ irrklang::IFileReader
+
+
+
+
+ getSoundEffectControl
+ irrklang::ISound
+
+
+
+
+
+
+
+ getSoundSourceCount
+ irrklang::ISoundEngine
+
+
+
+
+ getSoundVolume
+ irrklang::ISoundEngine
+
+
+
+
+ getStreamMode
+ irrklang::ISoundSource
+
+
+
+
+ getVelocity
+ irrklang::ISound
+
+
+
+
+ getVolume
+ irrklang::ISound
+
+
+
+
+Searching...
+No Matches
+
+
+
+
+
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/all_6c.html b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/all_6c.html
new file mode 100644
index 0000000..0f99162
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/all_6c.html
@@ -0,0 +1,26 @@
+
+Loading...
+
+
+
+ IAudioRecorder
+ irrklang
+
+
+
+
+ IAudioStream
+ irrklang
+
+
+
+
+ IAudioStreamLoader
+ irrklang
+
+
+
+
+ ICapturedAudioDataReceiver
+ irrklang
+
+
+
+
+ IFileFactory
+ irrklang
+
+
+
+
+ IFileReader
+ irrklang
+
+
+
+
+ ik_c8
+ irrklang
+
+
+
+
+ IK_DEGTORAD
+ irrklang
+
+
+
+
+ IK_DEGTORAD64
+ irrklang
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ik_f32
+ irrklang
+
+
+
+
+ ik_f64
+ irrklang
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ik_IFileReader.h
+
+
+
+
+ ik_IRefCounted.h
+
+
+
+
+
+
+
+ ik_ISound.h
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ IK_PI32
+ irrklang
+
+
+
+
+ IK_PI64
+ irrklang
+
+
+
+
+ IK_RADTODEG
+ irrklang
+
+
+
+
+ IK_RADTODEG64
+ irrklang
+
+
+
+
+ IK_ROUNDING_ERROR_32
+ irrklang
+
+
+
+
+ ik_s16
+ irrklang
+
+
+
+
+ ik_s32
+ irrklang
+
+
+
+
+ ik_s8
+ irrklang
+
+
+
+
+
+
+
+ ik_u16
+ irrklang
+
+
+
+
+ ik_u32
+ irrklang
+
+
+
+
+ ik_u8
+ irrklang
+
+
+
+
+ ik_vec3d.h
+
+
+
+
+ invert
+ irrklang::vec3d
+
+
+
+
+ IRefCounted
+ irrklang
+
+
+
+
+ IRefCounted
+ irrklang::IRefCounted
+
+
+
+
+ IRR_KLANG_VERSION
+ irrKlang.h
+
+
+
+
+ irrklang
+
+
+
+
+ irrKlang.h
+
+
+
+
+ IRRKLANG_API
+ irrKlang.h
+
+
+
+
+ IRRKLANGCALLCONV
+ irrKlang.h
+
+
+
+
+ isALoadableFileExtension
+ irrklang::IAudioStreamLoader
+
+
+
+
+ isBetweenPoints
+ irrklang::vec3d
+
+
+
+
+ isChorusSoundEffectEnabled
+ irrklang::ISoundEffectControl
+
+
+
+
+ isCompressorSoundEffectEnabled
+ irrklang::ISoundEffectControl
+
+
+
+
+
+
+
+ isDistortionSoundEffectEnabled
+ irrklang::ISoundEffectControl
+
+
+
+
+ isEchoSoundEffectEnabled
+ irrklang::ISoundEffectControl
+
+
+
+
+ isFinished
+ irrklang::ISound
+
+
+
+
+ isFlangerSoundEffectEnabled
+ irrklang::ISoundEffectControl
+
+
+
+
+ isGargleSoundEffectEnabled
+ irrklang::ISoundEffectControl
+
+
+
+
+ isI3DL2ReverbSoundEffectEnabled
+ irrklang::ISoundEffectControl
+
+
+
+
+ isLooped
+ irrklang::ISound
+
+
+
+
+ isMultiThreaded
+ irrklang::ISoundEngine
+
+
+
+
+ ISound
+ irrklang
+
+
+
+
+ ISoundDeviceList
+ irrklang
+
+
+
+
+ ISoundEffectControl
+ irrklang
+
+
+
+
+ ISoundEngine
+ irrklang
+
+
+
+
+ ISoundMixedOutputReceiver
+ irrklang
+
+
+
+
+ ISoundSource
+ irrklang
+
+
+
+
+ ISoundStopEventReceiver
+ irrklang
+
+
+
+
+ isParamEqSoundEffectEnabled
+ irrklang::ISoundEffectControl
+
+
+
+
+ isRecording
+ irrklang::IAudioRecorder
+
+
+
+
+ isWavesReverbSoundEffectEnabled
+ irrklang::ISoundEffectControl
+
+
+
+
+ IVirtualRefCounted
+ irrklang
+
+Searching...
+No Matches
+
+
+
+
+
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/all_70.html b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/all_70.html
new file mode 100644
index 0000000..cbc1adc
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/all_70.html
@@ -0,0 +1,68 @@
+
+Loading...
+
+
+
+ OnAudioDataReady
+ irrklang::ISoundMixedOutputReceiver
+
+
+
+
+ OnReceiveAudioDataStreamChunk
+ irrklang::ICapturedAudioDataReceiver
+
+
+
+
+ OnSoundStopped
+ irrklang::ISoundStopEventReceiver
+
+
+
+
+ operator!=
+ irrklang::vec3d
+
+
+
+
+
+
+
+
+
+
+ operator+
+ irrklang::vec3d
+
+
+
+
+ operator+=
+ irrklang::vec3d
+
+
+
+
+
+
+
+ operator-=
+ irrklang::vec3d
+
+
+
+
+
+
+
+
+
+
+ operator<=
+ irrklang::vec3d
+
+
+
+
+ operator=
+ irrklang::vec3d
+
+
+
+
+ operator==
+ irrklang::vec3d
+
+
+
+
+ operator>=
+ irrklang::vec3d
+
+Searching...
+No Matches
+
+
+
+
+
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/all_72.html b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/all_72.html
new file mode 100644
index 0000000..5aed2fa
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/all_72.html
@@ -0,0 +1,71 @@
+
+Loading...
+
+
+
+ pALSA_SND_PCM
+ irrklang::SInternalAudioInterface
+
+
+
+
+ pCoreAudioDeciceID
+ irrklang::SInternalAudioInterface
+
+
+
+
+ pIDirectSound
+ irrklang::SInternalAudioInterface
+
+
+
+
+ pIDirectSound8
+ irrklang::SInternalAudioInterface
+
+
+
+
+ play2D
+
+
+ irrklang::ISoundEngine::play2D(const char *soundFileName, bool playLooped=false, bool startPaused=false, bool track=false, E_STREAM_MODE streamMode=ESM_AUTO_DETECT, bool enableSoundEffects=false)=0
+ irrklang::ISoundEngine::play2D(ISoundSource *source, bool playLooped=false, bool startPaused=false, bool track=false, bool enableSoundEffects=false)=0
+
+
+
+
+ play3D
+
+
+ irrklang::ISoundEngine::play3D(const char *soundFileName, vec3df pos, bool playLooped=false, bool startPaused=false, bool track=false, E_STREAM_MODE streamMode=ESM_AUTO_DETECT, bool enableSoundEffects=false)=0
+ irrklang::ISoundEngine::play3D(ISoundSource *source, vec3df pos, bool playLooped=false, bool startPaused=false, bool track=false, bool enableSoundEffects=false)=0
+
+
+
+
+ pWinMM_HWaveOut
+ irrklang::SInternalAudioInterface
+
+Searching...
+No Matches
+
+
+
+
+
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/all_73.html b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/all_73.html
new file mode 100644
index 0000000..f18c871
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/all_73.html
@@ -0,0 +1,248 @@
+
+Loading...
+
+
+
+ read
+ irrklang::IFileReader
+
+
+
+
+ readFrames
+ irrklang::IAudioStream
+
+
+
+
+ registerAudioStreamLoader
+ irrklang::ISoundEngine
+
+
+
+
+ removeAllSoundSources
+ irrklang::ISoundEngine
+
+
+
+
+
+
+
+ rotateXYBy
+ irrklang::vec3d
+
+
+
+
+ rotateXZBy
+ irrklang::vec3d
+
+
+
+
+ rotateYZBy
+ irrklang::vec3d
+
+Searching...
+No Matches
+
+
+
+
+
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/all_75.html b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/all_75.html
new file mode 100644
index 0000000..9df3aa1
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/all_75.html
@@ -0,0 +1,26 @@
+
+Loading...
+
+
+
+ SampleFormat
+ irrklang::SAudioStreamFormat
+
+
+
+
+ SampleRate
+ irrklang::SAudioStreamFormat
+
+
+
+
+ SAudioStreamFormat
+ irrklang
+
+
+
+
+ seek
+ irrklang::IFileReader
+
+
+
+
+
+
+
+ setAllSoundsPaused
+ irrklang::ISoundEngine
+
+
+
+
+ setDefault3DSoundMaxDistance
+ irrklang::ISoundEngine
+
+
+
+
+ setDefault3DSoundMinDistance
+ irrklang::ISoundEngine
+
+
+
+
+ setDefaultMaxDistance
+ irrklang::ISoundSource
+
+
+
+
+ setDefaultMinDistance
+ irrklang::ISoundSource
+
+
+
+
+ setDefaultVolume
+ irrklang::ISoundSource
+
+
+
+
+ setDopplerEffectParameters
+ irrklang::ISoundEngine
+
+
+
+
+ setForcedStreamingThreshold
+ irrklang::ISoundSource
+
+
+
+
+ setIsLooped
+ irrklang::ISound
+
+
+
+
+ setIsPaused
+ irrklang::ISound
+
+
+
+
+ setLength
+ irrklang::vec3d
+
+
+
+
+ setListenerPosition
+ irrklang::ISoundEngine
+
+
+
+
+ setMaxDistance
+ irrklang::ISound
+
+
+
+
+ setMinDistance
+ irrklang::ISound
+
+
+
+
+ setMixedDataOutputReceiver
+ irrklang::ISoundEngine
+
+
+
+
+ setPan
+ irrklang::ISound
+
+
+
+
+ setPlaybackSpeed
+ irrklang::ISound
+
+
+
+
+
+ setPlayPosition
+ irrklang::ISound
+
+
+
+
+ setRolloffFactor
+ irrklang::ISoundEngine
+
+
+
+
+ setSoundStopEventReceiver
+ irrklang::ISound
+
+
+
+
+ setSoundVolume
+ irrklang::ISoundEngine
+
+
+
+
+ setStreamMode
+ irrklang::ISoundSource
+
+
+
+
+ setVelocity
+ irrklang::ISound
+
+
+
+
+ setVolume
+ irrklang::ISound
+
+
+
+
+ SInternalAudioInterface
+ irrklang
+
+
+
+
+ startRecordingBufferedAudio
+ irrklang::IAudioRecorder
+
+
+
+
+ startRecordingCustomHandledAudio
+ irrklang::IAudioRecorder
+
+
+
+
+ stop
+ irrklang::ISound
+
+
+
+
+ stopAllSounds
+ irrklang::ISoundEngine
+
+
+
+
+ stopAllSoundsOfSoundSource
+ irrklang::ISoundEngine
+
+
+
+
+ stopRecordingAudio
+ irrklang::IAudioRecorder
+
+Searching...
+No Matches
+
+
+
+
+
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/all_78.html b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/all_78.html
new file mode 100644
index 0000000..dc2cb05
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/all_78.html
@@ -0,0 +1,26 @@
+
+Loading...
+
+
+
+ vec3d
+ irrklang
+
+
+
+
+
+
+
+ vec3df
+ irrklang
+
+
+
+
+ vec3di
+ irrklang
+
+Searching...
+No Matches
+
+
+
+
+
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/classes_69.html b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/classes_69.html
new file mode 100644
index 0000000..2b02979
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/classes_69.html
@@ -0,0 +1,110 @@
+
+Loading...
+
+
+
+ ~IAudioStream
+ irrklang::IAudioStream
+
+
+
+
+ ~IAudioStreamLoader
+ irrklang::IAudioStreamLoader
+
+
+
+
+ ~IFileFactory
+ irrklang::IFileFactory
+
+
+
+
+ ~IFileReader
+ irrklang::IFileReader
+
+
+
+
+ ~IRefCounted
+ irrklang::IRefCounted
+
+
+
+
+ ~ISoundMixedOutputReceiver
+ irrklang::ISoundMixedOutputReceiver
+
+
+
+
+ ~ISoundStopEventReceiver
+ irrklang::ISoundStopEventReceiver
+
+
+
+
+ ~IVirtualRefCounted
+ irrklang::IVirtualRefCounted
+
+Searching...
+No Matches
+
+
+
+
+
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/classes_73.html b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/classes_73.html
new file mode 100644
index 0000000..9887d89
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/classes_73.html
@@ -0,0 +1,32 @@
+
+Loading...
+
+
+
+ IAudioRecorder
+ irrklang
+
+
+
+
+ IAudioStream
+ irrklang
+
+
+
+
+ IAudioStreamLoader
+ irrklang
+
+
+
+
+ ICapturedAudioDataReceiver
+ irrklang
+
+
+
+
+ IFileFactory
+ irrklang
+
+
+
+
+ IFileReader
+ irrklang
+
+
+
+
+ IRefCounted
+ irrklang
+
+
+
+
+ ISound
+ irrklang
+
+
+
+
+ ISoundDeviceList
+ irrklang
+
+
+
+
+ ISoundEffectControl
+ irrklang
+
+
+
+
+ ISoundEngine
+ irrklang
+
+
+
+
+ ISoundMixedOutputReceiver
+ irrklang
+
+
+
+
+ ISoundSource
+ irrklang
+
+
+
+
+ ISoundStopEventReceiver
+ irrklang
+
+
+
+
+ IVirtualRefCounted
+ irrklang
+
+Searching...
+No Matches
+
+
+
+
+
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/classes_76.html b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/classes_76.html
new file mode 100644
index 0000000..631d95e
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/classes_76.html
@@ -0,0 +1,26 @@
+
+Loading...
+
+
+
+ SAudioStreamFormat
+ irrklang
+
+
+
+
+ SInternalAudioInterface
+ irrklang
+
+Searching...
+No Matches
+
+
+
+
+
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/enums_65.html b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/enums_65.html
new file mode 100644
index 0000000..a4fe1b1
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/enums_65.html
@@ -0,0 +1,50 @@
+
+Loading...
+
+
+
+ IRR_KLANG_VERSION
+ irrKlang.h
+
+
+
+
+ IRRKLANG_API
+ irrKlang.h
+
+
+
+
+ IRRKLANGCALLCONV
+ irrKlang.h
+
+Searching...
+No Matches
+
+
+
+
+
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/enumvalues_65.html b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/enumvalues_65.html
new file mode 100644
index 0000000..b733d7d
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/enumvalues_65.html
@@ -0,0 +1,188 @@
+
+Loading...
+
+
+
+ E_SOUND_ENGINE_OPTIONS
+ irrklang
+
+
+
+
+ E_SOUND_OUTPUT_DRIVER
+ irrklang
+
+
+
+
+ E_STOP_EVENT_CAUSE
+ irrklang
+
+
+
+
+ E_STREAM_MODE
+ irrklang
+
+
+
+
+ ESampleFormat
+ irrklang
+
+Searching...
+No Matches
+
+
+
+
+
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/files_69.html b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/files_69.html
new file mode 100644
index 0000000..eb8256d
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/files_69.html
@@ -0,0 +1,125 @@
+
+Loading...
+
+
+
+ ESEC_FORCE_32_BIT
+ irrklang
+
+
+
+
+ ESEC_SOUND_FINISHED_PLAYING
+ irrklang
+
+
+
+
+ ESEC_SOUND_STOPPED_BY_SOURCE_REMOVAL
+ irrklang
+
+
+
+
+ ESEC_SOUND_STOPPED_BY_USER
+ irrklang
+
+
+
+
+ ESEO_DEFAULT_OPTIONS
+ irrklang
+
+
+
+
+ ESEO_FORCE_32_BIT
+ irrklang
+
+
+
+
+ ESEO_LINEAR_ROLLOFF
+ irrklang
+
+
+
+
+ ESEO_LOAD_PLUGINS
+ irrklang
+
+
+
+
+ ESEO_MULTI_THREADED
+ irrklang
+
+
+
+
+ ESEO_MUTE_IF_NOT_FOCUSED
+ irrklang
+
+
+
+
+ ESEO_PRINT_DEBUG_INFO_TO_DEBUGGER
+ irrklang
+
+
+
+
+ ESEO_PRINT_DEBUG_INFO_TO_STDOUT
+ irrklang
+
+
+
+
+ ESEO_USE_3D_BUFFERS
+ irrklang
+
+
+
+
+ ESF_S16
+ irrklang
+
+
+
+
+ ESF_U8
+ irrklang
+
+
+
+
+ ESM_AUTO_DETECT
+ irrklang
+
+
+
+
+ ESM_FORCE_32_BIT
+ irrklang
+
+
+
+
+ ESM_NO_STREAMING
+ irrklang
+
+
+
+
+ ESM_STREAMING
+ irrklang
+
+
+
+
+ ESOD_ALSA
+ irrklang
+
+
+
+
+ ESOD_AUTO_DETECT
+ irrklang
+
+
+
+
+ ESOD_CORE_AUDIO
+ irrklang
+
+
+
+
+ ESOD_COUNT
+ irrklang
+
+
+
+
+ ESOD_DIRECT_SOUND
+ irrklang
+
+
+
+
+ ESOD_DIRECT_SOUND_8
+ irrklang
+
+
+
+
+ ESOD_FORCE_32_BIT
+ irrklang
+
+
+
+
+ ESOD_NULL
+ irrklang
+
+
+
+
+ ESOD_WIN_MM
+ irrklang
+
+Searching...
+No Matches
+
+
+
+
+
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/functions_61.html b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/functions_61.html
new file mode 100644
index 0000000..7c29184
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/functions_61.html
@@ -0,0 +1,56 @@
+
+Loading...
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ik_IFileReader.h
+
+
+
+
+ ik_IRefCounted.h
+
+
+
+
+
+
+
+ ik_ISound.h
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ik_vec3d.h
+
+
+
+
+ irrKlang.h
+
+Searching...
+No Matches
+
+
+
+
+
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/functions_63.html b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/functions_63.html
new file mode 100644
index 0000000..dc115ae
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/functions_63.html
@@ -0,0 +1,68 @@
+
+Loading...
+
+
+
+ addFileFactory
+ irrklang::ISoundEngine
+
+
+
+
+ addSoundSourceAlias
+ irrklang::ISoundEngine
+
+
+
+
+ addSoundSourceFromFile
+ irrklang::ISoundEngine
+
+
+
+
+ addSoundSourceFromMemory
+ irrklang::ISoundEngine
+
+
+
+
+ addSoundSourceFromPCMData
+ irrklang::ISoundEngine
+
+
+
+
+ addSoundSourceFromRecordedAudio
+ irrklang::IAudioRecorder
+
+Searching...
+No Matches
+
+
+
+
+
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/functions_64.html b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/functions_64.html
new file mode 100644
index 0000000..89a6e7f
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/functions_64.html
@@ -0,0 +1,95 @@
+
+Loading...
+
+
+
+ clearRecordedAudioDataBuffer
+ irrklang::IAudioRecorder
+
+
+
+
+ createAudioRecorderDeviceList
+ irrklang
+
+
+
+
+ createAudioStream
+ irrklang::IAudioStreamLoader
+
+
+
+
+ createFileReader
+ irrklang::IFileFactory
+
+
+
+
+ createIrrKlangAudioRecorder
+ irrklang
+
+
+
+
+ createIrrKlangDevice
+ irrklang
+
+
+
+
+ createSoundDeviceList
+ irrklang
+
+
+
+
+ crossProduct
+ irrklang::vec3d
+
+Searching...
+No Matches
+
+
+
+
+
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/functions_65.html b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/functions_65.html
new file mode 100644
index 0000000..5dabec1
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/functions_65.html
@@ -0,0 +1,86 @@
+
+Loading...
+
+
+
+ disableAllEffects
+ irrklang::ISoundEffectControl
+
+
+
+
+ disableChorusSoundEffect
+ irrklang::ISoundEffectControl
+
+
+
+
+ disableCompressorSoundEffect
+ irrklang::ISoundEffectControl
+
+
+
+
+ disableDistortionSoundEffect
+ irrklang::ISoundEffectControl
+
+
+
+
+ disableEchoSoundEffect
+ irrklang::ISoundEffectControl
+
+
+
+
+ disableFlangerSoundEffect
+ irrklang::ISoundEffectControl
+
+
+
+
+ disableGargleSoundEffect
+ irrklang::ISoundEffectControl
+
+
+
+
+ disableI3DL2ReverbSoundEffect
+ irrklang::ISoundEffectControl
+
+
+
+
+ disableParamEqSoundEffect
+ irrklang::ISoundEffectControl
+
+
+
+
+ disableWavesReverbSoundEffect
+ irrklang::ISoundEffectControl
+
+
+
+
+ dotProduct
+ irrklang::vec3d
+
+
+
+
+Searching...
+No Matches
+
+
+
+
+
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/functions_66.html b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/functions_66.html
new file mode 100644
index 0000000..5d72024
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/functions_66.html
@@ -0,0 +1,26 @@
+
+Loading...
+
+
+
+ enableChorusSoundEffect
+ irrklang::ISoundEffectControl
+
+
+
+
+ enableCompressorSoundEffect
+ irrklang::ISoundEffectControl
+
+
+
+
+ enableDistortionSoundEffect
+ irrklang::ISoundEffectControl
+
+
+
+
+ enableEchoSoundEffect
+ irrklang::ISoundEffectControl
+
+
+
+
+ enableFlangerSoundEffect
+ irrklang::ISoundEffectControl
+
+
+
+
+ enableGargleSoundEffect
+ irrklang::ISoundEffectControl
+
+
+
+
+ enableI3DL2ReverbSoundEffect
+ irrklang::ISoundEffectControl
+
+
+
+
+ enableParamEqSoundEffect
+ irrklang::ISoundEffectControl
+
+
+
+
+ enableWavesReverbSoundEffect
+ irrklang::ISoundEffectControl
+
+
+
+
+ equals
+ irrklang::vec3d
+
+
+
+
+ equalsfloat
+ irrklang
+
+Searching...
+No Matches
+
+
+
+
+
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/functions_69.html b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/functions_69.html
new file mode 100644
index 0000000..2146011
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/functions_69.html
@@ -0,0 +1,131 @@
+
+Loading...
+
+
+
+ getAs4Values
+ irrklang::vec3d
+
+
+
+
+
+
+
+ getBytesPerSecond
+ irrklang::SAudioStreamFormat
+
+
+
+
+ getDefault3DSoundMaxDistance
+ irrklang::ISoundEngine
+
+
+
+
+ getDefault3DSoundMinDistance
+ irrklang::ISoundEngine
+
+
+
+
+ getDefaultMaxDistance
+ irrklang::ISoundSource
+
+
+
+
+ getDefaultMinDistance
+ irrklang::ISoundSource
+
+
+
+
+ getDefaultVolume
+ irrklang::ISoundSource
+
+
+
+
+ getDeviceCount
+ irrklang::ISoundDeviceList
+
+
+
+
+ getDeviceDescription
+ irrklang::ISoundDeviceList
+
+
+
+
+ getDeviceID
+ irrklang::ISoundDeviceList
+
+
+
+
+ getDistanceFrom
+ irrklang::vec3d
+
+
+
+
+ getDistanceFromSQ
+ irrklang::vec3d
+
+
+
+
+
+
+
+ getFileName
+ irrklang::IFileReader
+
+
+
+
+ getForcedStreamingThreshold
+ irrklang::ISoundSource
+
+
+
+
+ getFormat
+ irrklang::IAudioStream
+
+
+
+
+ getFrameSize
+ irrklang::SAudioStreamFormat
+
+
+
+
+ getHorizontalAngle
+ irrklang::vec3d
+
+
+
+
+ getInternalAudioInterface
+ irrklang::ISoundEngine
+
+
+
+
+ getInterpolated
+ irrklang::vec3d
+
+
+
+
+ getIsPaused
+ irrklang::ISound
+
+
+
+
+
+
+
+ getLength
+ irrklang::vec3d
+
+
+
+
+ getLengthSQ
+ irrklang::vec3d
+
+
+
+
+ getMaxDistance
+ irrklang::ISound
+
+
+
+
+ getMinDistance
+ irrklang::ISound
+
+
+
+
+ getName
+ irrklang::ISoundSource
+
+
+
+
+ getPan
+ irrklang::ISound
+
+
+
+
+ getPlaybackSpeed
+ irrklang::ISound
+
+
+
+
+
+
+
+ getPlayPosition
+ irrklang::ISound
+
+
+
+
+ getPos
+ irrklang::IFileReader
+
+
+
+
+ getPosition
+ irrklang::ISound
+
+
+
+
+ getRecordedAudioData
+ irrklang::IAudioRecorder
+
+
+
+
+ getSampleData
+ irrklang::ISoundSource
+
+
+
+
+ getSampleDataSize
+ irrklang::SAudioStreamFormat
+
+
+
+
+ getSampleSize
+ irrklang::SAudioStreamFormat
+
+
+
+
+ getSize
+ irrklang::IFileReader
+
+
+
+
+ getSoundEffectControl
+ irrklang::ISound
+
+
+
+
+
+
+
+ getSoundSourceCount
+ irrklang::ISoundEngine
+
+
+
+
+ getSoundVolume
+ irrklang::ISoundEngine
+
+
+
+
+ getStreamMode
+ irrklang::ISoundSource
+
+
+
+
+ getVelocity
+ irrklang::ISound
+
+
+
+
+ getVolume
+ irrklang::ISound
+
+
+
+
+Searching...
+No Matches
+
+
+
+
+
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/functions_6c.html b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/functions_6c.html
new file mode 100644
index 0000000..0f99162
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/functions_6c.html
@@ -0,0 +1,26 @@
+
+Loading...
+
+
+
+ invert
+ irrklang::vec3d
+
+
+
+
+ IRefCounted
+ irrklang::IRefCounted
+
+
+
+
+ isALoadableFileExtension
+ irrklang::IAudioStreamLoader
+
+
+
+
+ isBetweenPoints
+ irrklang::vec3d
+
+
+
+
+ isChorusSoundEffectEnabled
+ irrklang::ISoundEffectControl
+
+
+
+
+ isCompressorSoundEffectEnabled
+ irrklang::ISoundEffectControl
+
+
+
+
+
+
+
+ isDistortionSoundEffectEnabled
+ irrklang::ISoundEffectControl
+
+
+
+
+ isEchoSoundEffectEnabled
+ irrklang::ISoundEffectControl
+
+
+
+
+ isFinished
+ irrklang::ISound
+
+
+
+
+ isFlangerSoundEffectEnabled
+ irrklang::ISoundEffectControl
+
+
+
+
+ isGargleSoundEffectEnabled
+ irrklang::ISoundEffectControl
+
+
+
+
+ isI3DL2ReverbSoundEffectEnabled
+ irrklang::ISoundEffectControl
+
+
+
+
+ isLooped
+ irrklang::ISound
+
+
+
+
+ isMultiThreaded
+ irrklang::ISoundEngine
+
+
+
+
+ isParamEqSoundEffectEnabled
+ irrklang::ISoundEffectControl
+
+
+
+
+ isRecording
+ irrklang::IAudioRecorder
+
+
+
+
+ isWavesReverbSoundEffectEnabled
+ irrklang::ISoundEffectControl
+
+Searching...
+No Matches
+
+
+
+
+
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/functions_70.html b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/functions_70.html
new file mode 100644
index 0000000..99fa911
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/functions_70.html
@@ -0,0 +1,38 @@
+
+Loading...
+
+
+
+ OnAudioDataReady
+ irrklang::ISoundMixedOutputReceiver
+
+
+
+
+ OnReceiveAudioDataStreamChunk
+ irrklang::ICapturedAudioDataReceiver
+
+
+
+
+ OnSoundStopped
+ irrklang::ISoundStopEventReceiver
+
+
+
+
+ operator!=
+ irrklang::vec3d
+
+
+
+
+
+
+
+
+
+
+ operator+
+ irrklang::vec3d
+
+
+
+
+ operator+=
+ irrklang::vec3d
+
+
+
+
+
+
+
+ operator-=
+ irrklang::vec3d
+
+
+
+
+
+
+
+
+
+
+ operator<=
+ irrklang::vec3d
+
+
+
+
+ operator=
+ irrklang::vec3d
+
+
+
+
+ operator==
+ irrklang::vec3d
+
+
+
+
+ operator>=
+ irrklang::vec3d
+
+Searching...
+No Matches
+
+
+
+
+
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/functions_72.html b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/functions_72.html
new file mode 100644
index 0000000..5aed2fa
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/functions_72.html
@@ -0,0 +1,71 @@
+
+Loading...
+
+
+
+ play2D
+
+
+ irrklang::ISoundEngine::play2D(const char *soundFileName, bool playLooped=false, bool startPaused=false, bool track=false, E_STREAM_MODE streamMode=ESM_AUTO_DETECT, bool enableSoundEffects=false)=0
+ irrklang::ISoundEngine::play2D(ISoundSource *source, bool playLooped=false, bool startPaused=false, bool track=false, bool enableSoundEffects=false)=0
+
+
+
+
+ play3D
+
+
+ irrklang::ISoundEngine::play3D(const char *soundFileName, vec3df pos, bool playLooped=false, bool startPaused=false, bool track=false, E_STREAM_MODE streamMode=ESM_AUTO_DETECT, bool enableSoundEffects=false)=0
+ irrklang::ISoundEngine::play3D(ISoundSource *source, vec3df pos, bool playLooped=false, bool startPaused=false, bool track=false, bool enableSoundEffects=false)=0
+
+ Searching...
+No Matches
+
+
+
+
+
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/functions_73.html b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/functions_73.html
new file mode 100644
index 0000000..22f3e00
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/functions_73.html
@@ -0,0 +1,224 @@
+
+Loading...
+
+
+
+ read
+ irrklang::IFileReader
+
+
+
+
+ readFrames
+ irrklang::IAudioStream
+
+
+
+
+ registerAudioStreamLoader
+ irrklang::ISoundEngine
+
+
+
+
+ removeAllSoundSources
+ irrklang::ISoundEngine
+
+
+
+
+
+
+
+ rotateXYBy
+ irrklang::vec3d
+
+
+
+
+ rotateXZBy
+ irrklang::vec3d
+
+
+
+
+ rotateYZBy
+ irrklang::vec3d
+
+Searching...
+No Matches
+
+
+
+
+
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/functions_75.html b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/functions_75.html
new file mode 100644
index 0000000..9df3aa1
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/functions_75.html
@@ -0,0 +1,26 @@
+
+Loading...
+
+
+
+ seek
+ irrklang::IFileReader
+
+
+
+
+
+
+
+ setAllSoundsPaused
+ irrklang::ISoundEngine
+
+
+
+
+ setDefault3DSoundMaxDistance
+ irrklang::ISoundEngine
+
+
+
+
+ setDefault3DSoundMinDistance
+ irrklang::ISoundEngine
+
+
+
+
+ setDefaultMaxDistance
+ irrklang::ISoundSource
+
+
+
+
+ setDefaultMinDistance
+ irrklang::ISoundSource
+
+
+
+
+ setDefaultVolume
+ irrklang::ISoundSource
+
+
+
+
+ setDopplerEffectParameters
+ irrklang::ISoundEngine
+
+
+
+
+ setForcedStreamingThreshold
+ irrklang::ISoundSource
+
+
+
+
+ setIsLooped
+ irrklang::ISound
+
+
+
+
+ setIsPaused
+ irrklang::ISound
+
+
+
+
+ setLength
+ irrklang::vec3d
+
+
+
+
+ setListenerPosition
+ irrklang::ISoundEngine
+
+
+
+
+ setMaxDistance
+ irrklang::ISound
+
+
+
+
+ setMinDistance
+ irrklang::ISound
+
+
+
+
+ setMixedDataOutputReceiver
+ irrklang::ISoundEngine
+
+
+
+
+ setPan
+ irrklang::ISound
+
+
+
+
+ setPlaybackSpeed
+ irrklang::ISound
+
+
+
+
+
+ setPlayPosition
+ irrklang::ISound
+
+
+
+
+ setRolloffFactor
+ irrklang::ISoundEngine
+
+
+
+
+ setSoundStopEventReceiver
+ irrklang::ISound
+
+
+
+
+ setSoundVolume
+ irrklang::ISoundEngine
+
+
+
+
+ setStreamMode
+ irrklang::ISoundSource
+
+
+
+
+ setVelocity
+ irrklang::ISound
+
+
+
+
+ setVolume
+ irrklang::ISound
+
+
+
+
+ startRecordingBufferedAudio
+ irrklang::IAudioRecorder
+
+
+
+
+ startRecordingCustomHandledAudio
+ irrklang::IAudioRecorder
+
+
+
+
+ stop
+ irrklang::ISound
+
+
+
+
+ stopAllSounds
+ irrklang::ISoundEngine
+
+
+
+
+ stopAllSoundsOfSoundSource
+ irrklang::ISoundEngine
+
+
+
+
+ stopRecordingAudio
+ irrklang::IAudioRecorder
+
+Searching...
+No Matches
+
+
+
+
+
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/functions_7e.html b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/functions_7e.html
new file mode 100644
index 0000000..906da72
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/functions_7e.html
@@ -0,0 +1,68 @@
+
+Loading...
+
+
+
+Searching...
+No Matches
+
+
+
+
+
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/namespaces_69.html b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/namespaces_69.html
new file mode 100644
index 0000000..dfc5f13
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/namespaces_69.html
@@ -0,0 +1,25 @@
+
+Loading...
+
+
+
+ ~IAudioStream
+ irrklang::IAudioStream
+
+
+
+
+ ~IAudioStreamLoader
+ irrklang::IAudioStreamLoader
+
+
+
+
+ ~IFileFactory
+ irrklang::IFileFactory
+
+
+
+
+ ~IFileReader
+ irrklang::IFileReader
+
+
+
+
+ ~IRefCounted
+ irrklang::IRefCounted
+
+
+
+
+ ~ISoundMixedOutputReceiver
+ irrklang::ISoundMixedOutputReceiver
+
+
+
+
+ ~ISoundStopEventReceiver
+ irrklang::ISoundStopEventReceiver
+
+
+
+
+ ~IVirtualRefCounted
+ irrklang::IVirtualRefCounted
+
+Searching...
+No Matches
+
+
+
+
+
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/search.css b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/search.css
new file mode 100644
index 0000000..d263b97
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/search.css
@@ -0,0 +1,198 @@
+/*---------------- Search Box */
+
+#MSearchBox {
+ padding: 0px;
+ margin: 0px;
+ border: none;
+ border: 1px solid #84B0C7;
+ white-space: nowrap;
+ -moz-border-radius: 8px;
+ -webkit-border-top-left-radius: 8px;
+ -webkit-border-top-right-radius: 8px;
+ -webkit-border-bottom-left-radius: 8px;
+ -webkit-border-bottom-right-radius: 8px;
+}
+#MSearchField {
+ font: 9pt Arial, Verdana, sans-serif;
+ color: #999999;
+ background-color: #FFFFFF;
+ font-style: normal;
+ cursor: text;
+ padding: 1px 1px;
+ margin: 0px 6px 0px 0px;
+ border: none;
+ outline: none;
+ vertical-align: middle;
+}
+.MSearchBoxActive #MSearchField {
+ color: #000000;
+}
+#MSearchSelect {
+ float : none;
+ display : inline;
+ background : none;
+ font: 9pt Verdana, sans-serif;
+ border: none;
+ margin: 0px 0px 0px 6px;
+ vertical-align: middle;
+ padding: 0px 0px;
+}
+
+#MSearchClose {
+ float : none;
+ display : none;
+ background : none;
+ border: none;
+ margin: 0px 4px 0px 0px;
+ padding: 0px 0px;
+ outline: none;
+}
+
+#MSearchCloseImg {
+ vertical-align: middle;
+}
+
+.MSearchBoxLeft {
+ display: block;
+ text-align: left;
+ float: left;
+ margin-left: 6px;
+}
+.MSearchBoxRight {
+ display: block;
+ float: right;
+ text-align: right;
+ margin-right: 6px;
+}
+.MSearchBoxSpacer {
+ font-size: 0px;
+ clear: both;
+}
+.MSearchBoxRow {
+ font-size: 0px;
+ clear: both;
+}
+
+/*---------------- Search filter selection */
+
+#MSearchSelectWindow {
+ display: none;
+ position: absolute;
+ left: 0; top: 0;
+ border: 1px solid #A0A0A0;
+ background-color: #FAFAFA;
+ z-index: 1;
+ padding-top: 4px;
+ padding-bottom: 4px;
+ -moz-border-radius: 4px;
+ -webkit-border-top-left-radius: 4px;
+ -webkit-border-top-right-radius: 4px;
+ -webkit-border-bottom-left-radius: 4px;
+ -webkit-border-bottom-right-radius: 4px;
+ -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
+ }
+.SelectItem {
+ font: 8pt Arial, Verdana, sans-serif;
+ padding-left: 2px;
+ padding-right: 12px;
+ border: 0px;
+}
+span.SelectionMark {
+ margin-right: 4px;
+ font-family: monospace;
+ outline-style: none;
+ text-decoration: none;
+}
+a.SelectItem {
+ display: block;
+ outline-style: none;
+ color: #000000;
+ text-decoration: none;
+ padding-left: 6px;
+ padding-right: 12px;
+}
+a.SelectItem:focus,
+a.SelectItem:active {
+ color: #000000;
+ outline-style: none;
+ text-decoration: none;
+}
+a.SelectItem:hover {
+ color: #FFFFFF;
+ background-color: #2A50E4;
+ outline-style: none;
+ text-decoration: none;
+ cursor: pointer;
+ display: block;
+}
+
+/*---------------- Search results window */
+
+iframe#MSearchResults {
+ width: 60ex;
+ height: 15em;
+ }
+#MSearchResultsWindow {
+ display: none;
+ position: absolute;
+ left: 0; top: 0;
+ border: 1px solid #000000;
+ background-color: #EEF3F5;
+ }
+
+/* ----------------------------------- */
+
+
+#SRIndex {
+ clear:both;
+ padding-bottom: 15px;
+}
+
+.SREntry {
+ font-size: 10pt;
+ padding-left: 1ex;
+}
+.SRPage .SREntry {
+ font-size: 8pt;
+ padding: 1px 5px;
+}
+body.SRPage {
+ margin: 5px 2px;
+}
+
+.SRChildren {
+ padding-left: 3ex; padding-bottom: .5em
+}
+.SRPage .SRChildren {
+ display: none;
+}
+.SRSymbol {
+ font-weight: bold; color: #153788;
+ font-family: Arial, Verdana, sans-serif;
+ text-decoration: none;
+ outline: none;
+}
+
+a.SRScope {
+ display: block;
+ color: #153788;
+ font-family: Arial, Verdana, sans-serif;
+ text-decoration: none;
+ outline: none;
+}
+
+a.SRSymbol:focus, a.SRSymbol:active,
+a.SRScope:focus, a.SRScope:active {
+ text-decoration: underline;
+}
+
+.SRPage .SRStatus {
+ padding: 2px 5px;
+ font-size: 8pt;
+ font-style: italic;
+}
+
+.SRResult {
+ display: none;
+}
+
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/search.js b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/search.js
new file mode 100644
index 0000000..2ed0ceb
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/search.js
@@ -0,0 +1,744 @@
+// Search script generated by doxygen
+// Copyright (C) 2009 by Dimitri van Heesch.
+
+// The code in this file is loosly based on main.js, part of Natural Docs,
+// which is Copyright (C) 2003-2008 Greg Valure
+// Natural Docs is licensed under the GPL.
+
+var indexSectionsWithContent =
+{
+ 0: "000000000000000000000000000000000000000000000000000000000000000001011111010011111011011011100010",
+ 1: "000000000000000000000000000000000000000000000000000000000000000000000000010000000001001000000000",
+ 2: "000000000000000000000000000000000000000000000000000000000000000000000000010000000000000000000000",
+ 3: "000000000000000000000000000000000000000000000000000000000000000000000000010000000000000000000000",
+ 4: "000000000000000000000000000000000000000000000000000000000000000001011111010011111011011000000010",
+ 5: "000000000000000000000000000000000000000000000000000000000000000000010010010000001001000011100000",
+ 6: "000000000000000000000000000000000000000000000000000000000000000000000000010000000000001000000000",
+ 7: "000000000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000",
+ 8: "000000000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000",
+ 9: "000000000000000000000000000000000000000000000000000000000000000000000000010000000000000000000000"
+};
+
+var indexSectionNames =
+{
+ 0: "all",
+ 1: "classes",
+ 2: "namespaces",
+ 3: "files",
+ 4: "functions",
+ 5: "variables",
+ 6: "typedefs",
+ 7: "enums",
+ 8: "enumvalues",
+ 9: "defines"
+};
+
+function convertToId(search)
+{
+ var result = '';
+ for (i=0;iNo Matches
+
+
+
+
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/typedefs_76.html b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/typedefs_76.html
new file mode 100644
index 0000000..d9a44ff
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/typedefs_76.html
@@ -0,0 +1,32 @@
+
+Loading...
+
+
+
+ ik_c8
+ irrklang
+
+
+
+
+ ik_f32
+ irrklang
+
+
+
+
+ ik_f64
+ irrklang
+
+
+
+
+ ik_s16
+ irrklang
+
+
+
+
+ ik_s32
+ irrklang
+
+
+
+
+ ik_s8
+ irrklang
+
+
+
+
+ ik_u16
+ irrklang
+
+
+
+
+ ik_u32
+ irrklang
+
+
+
+
+ ik_u8
+ irrklang
+
+Searching...
+No Matches
+
+
+
+
+
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/variables_70.html b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/variables_70.html
new file mode 100644
index 0000000..043ae84
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/variables_70.html
@@ -0,0 +1,50 @@
+
+Loading...
+
+
+
+ IK_DEGTORAD
+ irrklang
+
+
+
+
+ IK_DEGTORAD64
+ irrklang
+
+
+
+
+ IK_PI32
+ irrklang
+
+
+
+
+ IK_PI64
+ irrklang
+
+
+
+
+ IK_RADTODEG
+ irrklang
+
+
+
+
+ IK_RADTODEG64
+ irrklang
+
+
+
+
+ IK_ROUNDING_ERROR_32
+ irrklang
+
+Searching...
+No Matches
+
+
+
+
+
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/variables_73.html b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/variables_73.html
new file mode 100644
index 0000000..b807d19
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/variables_73.html
@@ -0,0 +1,32 @@
+
+Loading...
+
+
+
+ pALSA_SND_PCM
+ irrklang::SInternalAudioInterface
+
+
+
+
+ pCoreAudioDeciceID
+ irrklang::SInternalAudioInterface
+
+
+
+
+ pIDirectSound
+ irrklang::SInternalAudioInterface
+
+
+
+
+ pIDirectSound8
+ irrklang::SInternalAudioInterface
+
+
+
+
+ pWinMM_HWaveOut
+ irrklang::SInternalAudioInterface
+
+Searching...
+No Matches
+
+
+
+
+
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/variables_78.html b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/variables_78.html
new file mode 100644
index 0000000..dc2cb05
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/cpp/search/variables_78.html
@@ -0,0 +1,26 @@
+
+Loading...
+
+
+
+ SampleFormat
+ irrklang::SAudioStreamFormat
+
+
+
+
+ SampleRate
+ irrklang::SAudioStreamFormat
+
+Searching...
+No Matches
+
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
+
+
+
+irrklang::SAudioStreamFormat Member List
This is the complete list of members for irrklang::SAudioStreamFormat, including all inherited members.| ChannelCount | irrklang::SAudioStreamFormat | |
| FrameCount | irrklang::SAudioStreamFormat | |
| getBytesPerSecond() const | irrklang::SAudioStreamFormat | [inline] |
| getFrameSize() const | irrklang::SAudioStreamFormat | [inline] |
| getSampleDataSize() const | irrklang::SAudioStreamFormat | [inline] |
| getSampleSize() const | irrklang::SAudioStreamFormat | [inline] |
| SampleFormat | irrklang::SAudioStreamFormat | |
| SampleRate | irrklang::SAudioStreamFormat |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
The documentation for this struct was generated from the following file: +
+
+
+
+
+irrklang::SAudioStreamFormat Struct Reference
+structure describing an audio stream format with helper functions +More...
+ +#include <ik_SAudioStreamFormat.h>
Public Member Functions | |
| ik_s32 | getSampleSize () const |
| returns the size of a sample of the data described by the stream data in bytes | |
| ik_s32 | getFrameSize () const |
| returns the frame size of the stream data in bytes | |
| ik_s32 | getSampleDataSize () const |
| returns the size of the sample data in bytes | |
| ik_s32 | getBytesPerSecond () const |
| returns amount of bytes per second | |
Public Attributes | |
| ik_s32 | ChannelCount |
| channels, 1 for mono, 2 for stereo | |
| ik_s32 | FrameCount |
| amount of frames in the sample data or stream. | |
| ik_s32 | SampleRate |
| samples per second | |
| ESampleFormat | SampleFormat |
| format of the sample data | |
Detailed Description
+structure describing an audio stream format with helper functions
+Member Function Documentation
+ +
+
+
+
+
+
+
+| ik_s32 irrklang::SAudioStreamFormat::getBytesPerSecond | +( | ++ | ) | + const [inline] |
+
+
+
+returns amount of bytes per second
+ +
+
+
+
+
+
+
+| ik_s32 irrklang::SAudioStreamFormat::getFrameSize | +( | ++ | ) | + const [inline] |
+
+
+
+returns the frame size of the stream data in bytes
+ +
+
+
+
+
+
+
+| ik_s32 irrklang::SAudioStreamFormat::getSampleDataSize | +( | ++ | ) | + const [inline] |
+
+
+
+returns the size of the sample data in bytes
+ +
+
+
+
+
+
+| ik_s32 irrklang::SAudioStreamFormat::getSampleSize | +( | ++ | ) | + const [inline] |
+
+
+
+returns the size of a sample of the data described by the stream data in bytes
+ +Member Data Documentation
+ +
+
+
+
+
+
+
+| ik_s32 irrklang::SAudioStreamFormat::ChannelCount | +
+
+
+channels, 1 for mono, 2 for stereo
+ +
+
+
+
+
+
+
+| ik_s32 irrklang::SAudioStreamFormat::FrameCount | +
+
+
+amount of frames in the sample data or stream.
+If the stream has an unknown lenght, this is -1
+ +
+
+
+
+
+
+
+format of the sample data
+ +
+
+
+
+
+
+| ik_s32 irrklang::SAudioStreamFormat::SampleRate | +
+
+
+samples per second
+ +The documentation for this struct was generated from the following file: +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
+
+
+
+irrklang::SInternalAudioInterface Member List
This is the complete list of members for irrklang::SInternalAudioInterface, including all inherited members.| pALSA_SND_PCM | irrklang::SInternalAudioInterface | |
| pCoreAudioDeciceID | irrklang::SInternalAudioInterface | |
| pIDirectSound | irrklang::SInternalAudioInterface | |
| pIDirectSound8 | irrklang::SInternalAudioInterface | |
| pWinMM_HWaveOut | irrklang::SInternalAudioInterface |
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+
+
+ -
+
- Main Page +
- Namespaces +
- Classes +
- Files +
-
+ ++
+
+
+
+
+
+
+-
+
- Class List +
- Class Hierarchy +
- Class Members +
+
+
+
The documentation for this struct was generated from the following file: +
+
+
+
+
+irrklang::SInternalAudioInterface Struct Reference
+structure for returning pointers to the internal audio interface. +More...
+ +#include <ik_ISoundEngine.h>
Public Attributes | |
| void * | pIDirectSound |
| IDirectSound interface, this is not null when using the ESOD_DIRECT_SOUND audio driver. | |
| void * | pIDirectSound8 |
| IDirectSound8 interface, this is not null when using the ESOD_DIRECT_SOUND8 audio driver. | |
| void * | pWinMM_HWaveOut |
| HWaveout interface, this is not null when using the ESOD_WIN_MM audio driver. | |
| void * | pALSA_SND_PCM |
| ALSA PCM Handle interface, this is not null when using the ESOD_ALSA audio driver. | |
| ik_u32 | pCoreAudioDeciceID |
| AudioDeviceID handle, this is not null when using the ESOD_CORE_AUDIO audio driver. | |
Detailed Description
+structure for returning pointers to the internal audio interface.
+Use ISoundEngine::getInternalAudioInterface() to get this.
+Member Data Documentation
+ +
+
+
+
+
+
+
+| void* irrklang::SInternalAudioInterface::pALSA_SND_PCM | +
+
+
+ALSA PCM Handle interface, this is not null when using the ESOD_ALSA audio driver.
+ +
+
+
+
+
+
+
+AudioDeviceID handle, this is not null when using the ESOD_CORE_AUDIO audio driver.
+ +
+
+
+
+
+
+
+| void* irrklang::SInternalAudioInterface::pIDirectSound | +
+
+
+IDirectSound interface, this is not null when using the ESOD_DIRECT_SOUND audio driver.
+ +
+
+
+
+
+
+
+| void* irrklang::SInternalAudioInterface::pIDirectSound8 | +
+
+
+IDirectSound8 interface, this is not null when using the ESOD_DIRECT_SOUND8 audio driver.
+ +
+
+
+
+
+
+| void* irrklang::SInternalAudioInterface::pWinMM_HWaveOut | +
+
+
+HWaveout interface, this is not null when using the ESOD_WIN_MM audio driver.
+ +The documentation for this struct was generated from the following file: +
+
+
+
++ + + +
| |
+ The irrKlang
+ Engine Documentation © 2003-2018 by Nikolaus Gebhardt. Generated
+ by Doxygen
+ (1.6.1) |
+
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.AudioFormatConstructor.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.AudioFormatConstructor.html
new file mode 100644
index 0000000..86ca83c
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.AudioFormatConstructor.html
@@ -0,0 +1,50 @@
+
+
+
+
+ +
+For a list of all members of this type, see AudioFormat Members.
+
+ System.Object
+
System.ValueType
IrrKlang.AudioFormat
+ [Visual Basic]
+
Public Structure AudioFormat
+ Public Structure AudioFormat
+ [C#]
+
+ public struct AudioFormat
+ Thread Safety
+Public static (Shared in Visual Basic) members of this type are + safe for multithreaded operations. Instance members are not guaranteed to be + thread-safe.
+Requirements
++ Namespace: + IrrKlang +
++ Assembly: irrKlang.NET (in irrKlang.NET.dll) +
+See Also
++ AudioFormat Members | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.AudioFormatFields.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.AudioFormatFields.html
new file mode 100644
index 0000000..49c3c4c
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.AudioFormatFields.html
@@ -0,0 +1,52 @@
+
+
+
+
+ Initializes a new instance of the AudioFormat class.
+
+ [Visual Basic]
+
Public Sub New()
+ Public Sub New()
+ [C#]
+
public AudioFormat();
+ public AudioFormat();
See Also
++ AudioFormat Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.AudioFormatMembers.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.AudioFormatMembers.html
new file mode 100644
index 0000000..fcffb2c
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.AudioFormatMembers.html
@@ -0,0 +1,95 @@
+
+
+
+
+ The fields of the AudioFormat structure are listed below. For a complete list of AudioFormat structure members, see the AudioFormat Members topic.
+Public Instance Fields
+
+
+
+
+  ChannelCount | |
| Format | |
| FrameCount | |
| SampleRate |
See Also
++ AudioFormat Class | IrrKlang Namespace
+ ++ +
+
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.AudioFormatProperties.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.AudioFormatProperties.html
new file mode 100644
index 0000000..f1ab46a
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.AudioFormatProperties.html
@@ -0,0 +1,52 @@
+
+
+
+
+ Public Instance Constructors
+
+
+
+
+
+ 
+ AudioFormat Constructor
+ |
+ Initializes a new instance of the AudioFormat class. | +
Public Instance Fields
+
+
+
+
+ | ChannelCount | |
| Format | |
| FrameCount | |
| SampleRate |
Public Instance Properties
+ +Public Instance Methods
+
+
+
+
+ | Equals (inherited from ValueType) | + Indicates whether this instance and a specified object are equal. + |
| GetHashCode (inherited from ValueType) | + Returns the hash code for this instance. + |
| GetType (inherited from Object) | + Gets the Type of the current instance. + |
| ToString (inherited from ValueType) | + Returns the fully qualified type name of this instance. + |
See Also
++ AudioFormat Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.EventForwarder.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.EventForwarder.html
new file mode 100644
index 0000000..a112477
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.EventForwarder.html
@@ -0,0 +1,67 @@
+
+
+
+
+ The properties of the AudioFormat structure are listed below. For a complete list of AudioFormat structure members, see the AudioFormat Members topic.
+Public Instance Properties
+ +See Also
++ AudioFormat Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.EventForwarderMembers.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.EventForwarderMembers.html
new file mode 100644
index 0000000..d834fae
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.EventForwarderMembers.html
@@ -0,0 +1,67 @@
+
+
+
+
+ Internal class, do not use.
+For a list of all members of this type, see EventForwarder Members.
+
+ System.Object
+
System.ValueType
IrrKlang.EventForwarder
+ [Visual Basic]
+
Public Structure EventForwarder
+ Public Structure EventForwarder
+ [C#]
+
+ public struct EventForwarder
+ Thread Safety
+Public static (Shared in Visual Basic) members of this type are + safe for multithreaded operations. Instance members are not guaranteed to be + thread-safe.
+Requirements
++ Namespace: + IrrKlang +
++ Assembly: irrKlang.NET (in irrKlang.NET.dll) +
+See Also
++ EventForwarder Members | IrrKlang Namespace
+ ++ +
+
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.FileFactoryForwarder.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.FileFactoryForwarder.html
new file mode 100644
index 0000000..e7b6821
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.FileFactoryForwarder.html
@@ -0,0 +1,67 @@
+
+
+
+
+ Public Instance Methods
+
+
+
+
+ | Equals (inherited from ValueType) | + Indicates whether this instance and a specified object are equal. + |
| GetHashCode (inherited from ValueType) | + Returns the hash code for this instance. + |
| GetType (inherited from Object) | + Gets the Type of the current instance. + |
| ToString (inherited from ValueType) | + Returns the fully qualified type name of this instance. + |
See Also
++ EventForwarder Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.FileFactoryForwarderMembers.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.FileFactoryForwarderMembers.html
new file mode 100644
index 0000000..2026967
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.FileFactoryForwarderMembers.html
@@ -0,0 +1,67 @@
+
+
+
+
+ Internal class, do not use.
+For a list of all members of this type, see FileFactoryForwarder Members.
+
+ System.Object
+
System.ValueType
IrrKlang.FileFactoryForwarder
+ [Visual Basic]
+
Public Structure FileFactoryForwarder
+ Public Structure FileFactoryForwarder
+ [C#]
+
+ public struct FileFactoryForwarder
+ Thread Safety
+Public static (Shared in Visual Basic) members of this type are + safe for multithreaded operations. Instance members are not guaranteed to be + thread-safe.
+Requirements
++ Namespace: + IrrKlang +
++ Assembly: irrKlang.NET (in irrKlang.NET.dll) +
+See Also
++ FileFactoryForwarder Members | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorder.AddSoundSourceFromRecordedAudio.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorder.AddSoundSourceFromRecordedAudio.html
new file mode 100644
index 0000000..220ed70
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorder.AddSoundSourceFromRecordedAudio.html
@@ -0,0 +1,54 @@
+
+
+
+
+ + FileFactoryForwarder overview +
+Public Instance Methods
+
+
+
+
+ | Equals (inherited from ValueType) | + Indicates whether this instance and a specified object are equal. + |
| GetHashCode (inherited from ValueType) | + Returns the hash code for this instance. + |
| GetType (inherited from Object) | + Gets the Type of the current instance. + |
| ToString (inherited from ValueType) | + Returns the fully qualified type name of this instance. + |
See Also
++ FileFactoryForwarder Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorder.AudioFormat.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorder.AudioFormat.html
new file mode 100644
index 0000000..08067f9
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorder.AudioFormat.html
@@ -0,0 +1,56 @@
+
+
+
+
+ Creates a sound source for the recorded audio data, so that it can be played back. Only works after calling stopRecordingAudio().
+
+ [Visual Basic]
+
Public Function AddSoundSourceFromRecordedAudio( _
ByVal soundName As String _
) As ISoundSource
+
+ Public Function AddSoundSourceFromRecordedAudio( _
ByVal soundName As String _
) As ISoundSource
See Also
++ IAudioRecorder Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorder.ClearRecordedAudioDataBuffer.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorder.ClearRecordedAudioDataBuffer.html
new file mode 100644
index 0000000..994a3c1
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorder.ClearRecordedAudioDataBuffer.html
@@ -0,0 +1,54 @@
+
+
+
+
+ Returns the audio format of the recorded audio data. Also contains informations about the length of the recorded audio stream.
+ + ++
+See Also
++ IAudioRecorder Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorder.Finalize.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorder.Finalize.html
new file mode 100644
index 0000000..fe25583
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorder.Finalize.html
@@ -0,0 +1,54 @@
+
+
+
+
+ Clears recorded audio data buffer, freeing memory. This method will only succeed if audio recording is currently stopped.
+
+ [Visual Basic]
+
Public Sub ClearRecordedAudioDataBuffer()
+
+ Public Sub ClearRecordedAudioDataBuffer()
See Also
++ IAudioRecorder Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorder.IsRecording.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorder.IsRecording.html
new file mode 100644
index 0000000..b4954c5
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorder.IsRecording.html
@@ -0,0 +1,56 @@
+
+
+
+
+ Destructor
+
+ [Visual Basic]
+
Overrides Protected Sub Finalize()
+
+ Overrides Protected Sub Finalize()
See Also
++ IAudioRecorder Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorder.RecordedAudioData.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorder.RecordedAudioData.html
new file mode 100644
index 0000000..100bf45
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorder.RecordedAudioData.html
@@ -0,0 +1,57 @@
+
+
+
+
+ Returns if the recorder is currently recording audio.
+ + ++
+See Also
++ IAudioRecorder Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorder.StartRecordingBufferedAudio_overload_2.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorder.StartRecordingBufferedAudio_overload_2.html
new file mode 100644
index 0000000..cf4c7e4
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorder.StartRecordingBufferedAudio_overload_2.html
@@ -0,0 +1,54 @@
+
+
+
+
+ +
+
+ [Visual Basic]
+
Overloads Public Function StartRecordingBufferedAudio( _
ByVal sampleRate As Integer, _
ByVal sampleFormat As SampleFormat, _
ByVal channelCount As Integer _
) As Boolean
+ Overloads Public Function StartRecordingBufferedAudio( _
ByVal sampleRate As Integer, _
ByVal sampleFormat As SampleFormat, _
ByVal channelCount As Integer _
) As Boolean
+ [C#]
+
public bool StartRecordingBufferedAudio(
int sampleRate,
SampleFormat sampleFormat,
int channelCount
);
+ public bool StartRecordingBufferedAudio(
int sampleRate,
SampleFormat sampleFormat,
int channelCount
);
See Also
++ IAudioRecorder Class | IrrKlang Namespace | IAudioRecorder.StartRecordingBufferedAudio Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorder.StartRecordingBufferedAudio_overloads.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorder.StartRecordingBufferedAudio_overloads.html
new file mode 100644
index 0000000..889bbf6
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorder.StartRecordingBufferedAudio_overloads.html
@@ -0,0 +1,49 @@
+
+
+
+
+ Starts recording audio.
+ + +See Also
++ IAudioRecorder Class | IrrKlang Namespace | IAudioRecorder.StartRecordingBufferedAudio Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorder.StopRecordingAudio.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorder.StopRecordingAudio.html
new file mode 100644
index 0000000..4d4c00c
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorder.StopRecordingAudio.html
@@ -0,0 +1,54 @@
+
+
+
+
+ Starts recording audio.
+Overload List
+Starts recording audio.
++ public bool StartRecordingBufferedAudio(); ++
+
+ public bool StartRecordingBufferedAudio(int,SampleFormat,int); ++
See Also
++ IAudioRecorder Class | IrrKlang Namespace
++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorder.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorder.html
new file mode 100644
index 0000000..abaaf10
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorder.html
@@ -0,0 +1,67 @@
+
+
+
+
+ Stops recording audio.
+
+ [Visual Basic]
+
Public Sub StopRecordingAudio()
+
+ Public Sub StopRecordingAudio()
See Also
++ IAudioRecorder Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorderConstructor.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorderConstructor.html
new file mode 100644
index 0000000..ede36ea
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorderConstructor.html
@@ -0,0 +1,58 @@
+
+
+
+
+ Interface to an audio recorder.
+For a list of all members of this type, see IAudioRecorder Members.
+
+ System.Object
+
IrrKlang.IAudioRecorder
+ [Visual Basic]
+
Public Class IAudioRecorder
+ Public Class IAudioRecorder
+ [C#]
+
+ public class IAudioRecorder
+ Thread Safety
+Public static (Shared in Visual Basic) members of this type are + safe for multithreaded operations. Instance members are not guaranteed to be + thread-safe.
+Requirements
++ Namespace: + IrrKlang +
++ Assembly: irrKlang.NET (in irrKlang.NET.dll) +
+See Also
++ IAudioRecorder Members | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorderConstructor1.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorderConstructor1.html
new file mode 100644
index 0000000..f05854d
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorderConstructor1.html
@@ -0,0 +1,47 @@
+
+
+
+
+ +
+Overload List
++
+ public IAudioRecorder(ISoundEngine); ++
+
+ public IAudioRecorder(ISoundEngine,SoundOutputDriver); ++
+
+ public IAudioRecorder(ISoundEngine,SoundOutputDriver,string); ++
See Also
++ IAudioRecorder Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorderConstructor2.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorderConstructor2.html
new file mode 100644
index 0000000..acb8f57
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorderConstructor2.html
@@ -0,0 +1,47 @@
+
+
+
+
+ +
+
+ [Visual Basic]
+
Overloads Public Sub New( _
ByVal engine As ISoundEngine, _
ByVal driver As SoundOutputDriver, _
ByVal deviceID As String _
)
+
+ Overloads Public Sub New( _
ByVal engine As ISoundEngine, _
ByVal driver As SoundOutputDriver, _
ByVal deviceID As String _
)
See Also
++ IAudioRecorder Class | IrrKlang Namespace | IAudioRecorder Constructor Overload List
++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorderConstructor3.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorderConstructor3.html
new file mode 100644
index 0000000..0283e17
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorderConstructor3.html
@@ -0,0 +1,47 @@
+
+
+
+
+ +
+
+ [Visual Basic]
+
Overloads Public Sub New( _
ByVal engine As ISoundEngine, _
ByVal driver As SoundOutputDriver _
)
+
+ Overloads Public Sub New( _
ByVal engine As ISoundEngine, _
ByVal driver As SoundOutputDriver _
)
See Also
++ IAudioRecorder Class | IrrKlang Namespace | IAudioRecorder Constructor Overload List
++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorderMembers.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorderMembers.html
new file mode 100644
index 0000000..83847af
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorderMembers.html
@@ -0,0 +1,98 @@
+
+
+
+
+ +
+ + +See Also
++ IAudioRecorder Class | IrrKlang Namespace | IAudioRecorder Constructor Overload List
++ +
+
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorderMethods.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorderMethods.html
new file mode 100644
index 0000000..55b0ed0
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorderMethods.html
@@ -0,0 +1,72 @@
+
+
+
+
+ Public Instance Constructors
+
+
+
+
+ |
+
+ IAudioRecorder
+ |
+ Overloaded. Initializes a new instance of the IAudioRecorder class. | +
Public Instance Properties
+
+
+
+
+  AudioFormat | Returns the audio format of the recorded audio data. Also contains informations about the length of the recorded audio stream. |
| IsRecording | Returns if the recorder is currently recording audio. |
| RecordedAudioData |
Public Instance Methods
+
+
+
+
+ | AddSoundSourceFromRecordedAudio | Creates a sound source for the recorded audio data, so that it can be played back. Only works after calling stopRecordingAudio(). |
| ClearRecordedAudioDataBuffer | Clears recorded audio data buffer, freeing memory. This method will only succeed if audio recording is currently stopped. |
| Equals (inherited from Object) | + Determines whether the specified Object is equal to the current Object. + |
| GetHashCode (inherited from Object) | + Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table. + |
| GetType (inherited from Object) | + Gets the Type of the current instance. + |
| StartRecordingBufferedAudio | Overloaded. |
| StopRecordingAudio | Stops recording audio. |
| ToString (inherited from Object) | + Returns a String that represents the current Object. + |
Protected Instance Methods
+
+
+
+
+  Finalize | Destructor |
| MemberwiseClone (inherited from Object) | + Creates a shallow copy of the current Object. + |
See Also
++ IAudioRecorder Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorderProperties.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorderProperties.html
new file mode 100644
index 0000000..eb04fbf
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IAudioRecorderProperties.html
@@ -0,0 +1,51 @@
+
+
+
+
+ The methods of the IAudioRecorder class are listed below. For a complete list of IAudioRecorder class members, see the IAudioRecorder Members topic.
+Public Instance Methods
+
+
+
+
+ | AddSoundSourceFromRecordedAudio | Creates a sound source for the recorded audio data, so that it can be played back. Only works after calling stopRecordingAudio(). |
| ClearRecordedAudioDataBuffer | Clears recorded audio data buffer, freeing memory. This method will only succeed if audio recording is currently stopped. |
| Equals (inherited from Object) | + Determines whether the specified Object is equal to the current Object. + |
| GetHashCode (inherited from Object) | + Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table. + |
| GetType (inherited from Object) | + Gets the Type of the current instance. + |
| StartRecordingBufferedAudio | Overloaded. |
| StopRecordingAudio | Stops recording audio. |
| ToString (inherited from Object) | + Returns a String that represents the current Object. + |
Protected Instance Methods
+
+
+
+
+ | Finalize | Destructor |
| MemberwiseClone (inherited from Object) | + Creates a shallow copy of the current Object. + |
See Also
++ IAudioRecorder Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IFileFactory.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IFileFactory.html
new file mode 100644
index 0000000..eb4b69e
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IFileFactory.html
@@ -0,0 +1,62 @@
+
+
+
+
+ The properties of the IAudioRecorder class are listed below. For a complete list of IAudioRecorder class members, see the IAudioRecorder Members topic.
+Public Instance Properties
+
+
+
+
+ | AudioFormat | Returns the audio format of the recorded audio data. Also contains informations about the length of the recorded audio stream. |
| IsRecording | Returns if the recorder is currently recording audio. |
| RecordedAudioData |
See Also
++ IAudioRecorder Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IFileFactory.openFile.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IFileFactory.openFile.html
new file mode 100644
index 0000000..7dd0621
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IFileFactory.openFile.html
@@ -0,0 +1,55 @@
+
+
+
+
+ Interface to overwrite opening files. Derive your own class from IFileFactory, overwrite the openFile() method and return your own System::IO::Stream to overwrite file access of irrKlang. Use ISoundEngine::addFileFactory() to let irrKlang know about your class. Example code can be found in the tutorial 04.OverrideFileAccess.
+For a list of all members of this type, see IFileFactory Members.
++
+
+ [Visual Basic]
+
Public Interface IFileFactory
+ Public Interface IFileFactory
+ [C#]
+
+ public interface IFileFactory
+ Requirements
++ Namespace: + IrrKlang +
++ Assembly: irrKlang.NET (in irrKlang.NET.dll) +
+See Also
++ IFileFactory Members | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IFileFactoryMembers.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IFileFactoryMembers.html
new file mode 100644
index 0000000..9de7a72
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IFileFactoryMembers.html
@@ -0,0 +1,56 @@
+
+
+
+
+ Opens a file for read access. Derive your own class from IFileFactory, overwrite this method and return your own System::IO::Stream to overwrite file access of irrKlang. Use ISoundEngine::addFileFactory() to let irrKlang know about your class. Example code can be found in the tutorial 04.OverrideFileAccess.
+ + +See Also
++ IFileFactory Interface | IrrKlang Namespace
+ ++ +
+
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IFileFactoryMethods.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IFileFactoryMethods.html
new file mode 100644
index 0000000..618acc5
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.IFileFactoryMethods.html
@@ -0,0 +1,49 @@
+
+
+
+
+ Public Instance Methods
+
+
+
+
+ | openFile | Opens a file for read access. Derive your own class from IFileFactory, overwrite this method and return your own System::IO::Stream to overwrite file access of irrKlang. Use ISoundEngine::addFileFactory() to let irrKlang know about your class. Example code can be found in the tutorial 04.OverrideFileAccess. |
See Also
++ IFileFactory Interface | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.Dispose.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.Dispose.html
new file mode 100644
index 0000000..6766dad
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.Dispose.html
@@ -0,0 +1,59 @@
+
+
+
+
+ The methods of the IFileFactory interface are listed below. For a complete list of IFileFactory interface members, see the IFileFactory Members topic.
+Public Instance Methods
+
+
+
+
+ | openFile | Opens a file for read access. Derive your own class from IFileFactory, overwrite this method and return your own System::IO::Stream to overwrite file access of irrKlang. Use ISoundEngine::addFileFactory() to let irrKlang know about your class. Example code can be found in the tutorial 04.OverrideFileAccess. |
See Also
++ IFileFactory Interface | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.Finished.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.Finished.html
new file mode 100644
index 0000000..a8eacc1
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.Finished.html
@@ -0,0 +1,56 @@
+
+
+
+
+ Destructor
+
+ [Visual Basic]
+
Overrides Protected Sub Finalize()
+
+ Overrides Protected Sub Finalize()
See Also
++ ISound Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.Looped.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.Looped.html
new file mode 100644
index 0000000..d5b8a0d
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.Looped.html
@@ -0,0 +1,56 @@
+
+
+
+
+ returns if the sound has finished playing. Don't mix this up with isPaused(). isFinished() returns if the sound has been finished playing. If it has, is maybe already have been removed from the playing list of the sound engine and calls to any other of the methods of ISound will not have any result. If you call stop() to a playing sound will result that this function will return true when invoked.
+ + ++
+See Also
++ ISound Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.MaxDistance.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.MaxDistance.html
new file mode 100644
index 0000000..883f52a
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.MaxDistance.html
@@ -0,0 +1,56 @@
+
+
+
+
+ gets or sets if the sound has been started to play looped. If the sound is playing looped and it is changed to not-looped, then it will stop playing after the loop has finished. If it is not looped and changed to looped, the sound will start repeating to be played when it reaches its end. Invoking this method will not have an effect when the sound already has stopped.
+ + ++
+See Also
++ ISound Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.MinDistance.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.MinDistance.html
new file mode 100644
index 0000000..ab2a728
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.MinDistance.html
@@ -0,0 +1,56 @@
+
+
+
+
+ Sets the maximal distance if this is a 3D sound. Specify the distances at which 3D sounds stop getting louder or quieter. This works like this: As a listener approaches a 3D sound source, the sound gets louder. Past a certain point, it is not reasonable for the volume to continue to increase. Either the maximum (zero) has been reached, or the nature of the sound source imposes a logical limit. This is the minimum distance for the sound source. Similarly, the maximum distance for a sound source is the distance beyond which the sound does not get any quieter. The default minimum distance is 1, the default max distance is a huge number nearly to infinite.
+ + ++
+See Also
++ ISound Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.Pan.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.Pan.html
new file mode 100644
index 0000000..1da8d35
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.Pan.html
@@ -0,0 +1,56 @@
+
+
+
+
+ Sets the minimal distance if this is a 3D sound. Specify the distances at which 3D sounds stop getting louder or quieter. This works like this: As a listener approaches a 3D sound source, the sound gets louder. Past a certain point, it is not reasonable for the volume to continue to increase. Either the maximum (zero) has been reached, or the nature of the sound source imposes a logical limit. This is the minimum distance for the sound source. Similarly, the maximum distance for a sound source is the distance beyond which the sound does not get any quieter. The default minimum distance is 1, the default max distance is a huge number nearly to infinite.
+ + ++
+See Also
++ ISound Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.Paused.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.Paused.html
new file mode 100644
index 0000000..d55a25e
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.Paused.html
@@ -0,0 +1,56 @@
+
+
+
+
+ sets the pan of the sound. Takes a value between -1 and 1, 0 is center.
+ + ++
+See Also
++ ISound Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.PlayPosition.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.PlayPosition.html
new file mode 100644
index 0000000..e7b3297
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.PlayPosition.html
@@ -0,0 +1,56 @@
+
+
+
+
+ Returns the play length of the sound in milliseconds. Returns -1 if not known for this sound for example because its decoder does not support length reporting or it is a file stream of unknown size. Note: You can also use ISoundSource::getPlayLength() to get the length of a sound without actually needing to play it.
+ + ++
+See Also
++ ISound Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.PlaybackSpeed.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.PlaybackSpeed.html
new file mode 100644
index 0000000..441cf8c
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.PlaybackSpeed.html
@@ -0,0 +1,59 @@
+
+
+
+
+ returns or sets the current play position of the sound in milliseconds. Returns -1 if not implemented or possible for this sound for example because it already has been stopped and freed internally or similar.
+ + ++
+See Also
++ ISound Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.Position.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.Position.html
new file mode 100644
index 0000000..0cddf56
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.Position.html
@@ -0,0 +1,56 @@
+
+
+
+
+ Sets or gets the playback speed (frequency) of the sound. Plays the sound at a higher or lower speed, increasing or decreasing its frequency which makes it sound lower or higher. Note that this feature is not available on all sound output drivers (it is on the DirectSound drivers at least), and it does not work together with the 'enableSoundEffects' parameter of ISoundEngine::play2D and ISoundEngine::play3D when using DirectSound.
+ + ++
+Parameters
+-
+
See Also
++ ISound Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.SoundEffectControl.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.SoundEffectControl.html
new file mode 100644
index 0000000..1be2907
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.SoundEffectControl.html
@@ -0,0 +1,56 @@
+
+
+
+
+ sets the position of the sound in 3d space
+ + ++
+See Also
++ ISound Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.Stop.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.Stop.html
new file mode 100644
index 0000000..8f33317
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.Stop.html
@@ -0,0 +1,55 @@
+
+
+
+
+ Returns the sound effect control interface for this sound. Sound effects such as Chorus, Distorsions, Echo, Reverb and similar can be controlled using this. This can be null if the sound has not been started with the flag 'enableSoundEffects' or the driver doesn't support effects.
+ + ++
+See Also
++ ISound Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.Velocity.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.Velocity.html
new file mode 100644
index 0000000..bce63b9
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.Velocity.html
@@ -0,0 +1,56 @@
+
+
+
+
+ +
+
+ [Visual Basic]
+
Public Sub Stop()
+
+ Public Sub Stop()
See Also
++ ISound Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.Volume.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.Volume.html
new file mode 100644
index 0000000..05ca45b
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.Volume.html
@@ -0,0 +1,56 @@
+
+
+
+
+ sets or returns the velocity of the sound in 3d space, needed for Doppler effects. To use doppler effects use ISound::setVelocity to set a sounds velocity, ISoundEngine::setListenerPosition() to set the listeners velocity and ISoundEngine::setDopplerEffectParameters() to adjust two parameters influencing the doppler effects intensity.
+ + ++
+See Also
++ ISound Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.html
new file mode 100644
index 0000000..2522db0
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.html
@@ -0,0 +1,67 @@
+
+
+
+
+ returns volume of the sound, a value between 0 (mute) and 1 (full volume). (this volume gets multiplied with the master volume of the sound engine and other parameters like distance to listener when played as 3d sound)
+ + ++
+See Also
++ ISound Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.setSoundStopEventReceiver_overload_1.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.setSoundStopEventReceiver_overload_1.html
new file mode 100644
index 0000000..ffc6608
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.setSoundStopEventReceiver_overload_1.html
@@ -0,0 +1,62 @@
+
+
+
+
+ Represents a sound which is currently played. You can stop the sound or change the volume or whatever using this interface. Don't create sounds using new ISound, this won't work anyway. You can get an instance of an ISonud class by calling ISoundEngine::Play2D or Play3D.
+For a list of all members of this type, see ISound Members.
+
+ System.Object
+
IrrKlang.ISound
+ [C#]
+
+ public class ISound : IDisposable
+ Thread Safety
+Public static (Shared in Visual Basic) members of this type are + safe for multithreaded operations. Instance members are not guaranteed to be + thread-safe.
+Requirements
++ Namespace: + IrrKlang +
++ Assembly: irrKlang.NET (in irrKlang.NET.dll) +
+See Also
++ ISound Members | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.setSoundStopEventReceiver_overload_2.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.setSoundStopEventReceiver_overload_2.html
new file mode 100644
index 0000000..dbdceeb
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.setSoundStopEventReceiver_overload_2.html
@@ -0,0 +1,66 @@
+
+
+
+
+ Sets the sound stop event receiver, an interface which gets called if a sound has finished playing.
+
+ [Visual Basic]
+
Overloads Public Sub setSoundStopEventReceiver( _
ByVal reciever As ISoundStopEventReceiver _
)
+
+ Overloads Public Sub setSoundStopEventReceiver( _
ByVal reciever As ISoundStopEventReceiver _
)
Parameters
+-
+
- + reciever + +
- + +
See Also
++ ISound Class | IrrKlang Namespace | ISound.setSoundStopEventReceiver Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.setSoundStopEventReceiver_overloads.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.setSoundStopEventReceiver_overloads.html
new file mode 100644
index 0000000..3d08360
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISound.setSoundStopEventReceiver_overloads.html
@@ -0,0 +1,49 @@
+
+
+
+
+ Sets the sound stop event receiver, an interface which gets called if a sound has finished playing.
+
+ [Visual Basic]
+
Overloads Public Sub setSoundStopEventReceiver( _
ByVal reciever As ISoundStopEventReceiver, _
ByVal userData As Object _
)
+
+ Overloads Public Sub setSoundStopEventReceiver( _
ByVal reciever As ISoundStopEventReceiver, _
ByVal userData As Object _
)
Parameters
+-
+
- + reciever + +
- + +
- + userData + +
- A user data object, can be null +
See Also
++ ISound Class | IrrKlang Namespace | ISound.setSoundStopEventReceiver Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundConstructor.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundConstructor.html
new file mode 100644
index 0000000..d70389a
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundConstructor.html
@@ -0,0 +1,51 @@
+
+
+
+
+ Sets the sound stop event receiver, an interface which gets called if a sound has finished playing.
+Overload List
+Sets the sound stop event receiver, an interface which gets called if a sound has finished playing.
++ public void setSoundStopEventReceiver(ISoundStopEventReceiver); ++
Sets the sound stop event receiver, an interface which gets called if a sound has finished playing.
++ public void setSoundStopEventReceiver(ISoundStopEventReceiver,object); ++
See Also
++ ISound Class | IrrKlang Namespace
++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundDeviceList.DeviceCount.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundDeviceList.DeviceCount.html
new file mode 100644
index 0000000..d8dc05c
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundDeviceList.DeviceCount.html
@@ -0,0 +1,56 @@
+
+
+
+
+ +
+
+ [Visual Basic]
+
Public Sub New( _
ByVal nativeSound As ISound*, _
ByVal nativeEngine As ISoundEngine* _
)
+
+ Public Sub New( _
ByVal nativeSound As ISound*, _
ByVal nativeEngine As ISoundEngine* _
)
See Also
++ ISound Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundDeviceList.Finalize.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundDeviceList.Finalize.html
new file mode 100644
index 0000000..3b4840d
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundDeviceList.Finalize.html
@@ -0,0 +1,54 @@
+
+
+
+
+ returns amount of enumerated devices in the list
+ + ++
+See Also
++ ISoundDeviceList Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundDeviceList.getDeviceDescription.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundDeviceList.getDeviceDescription.html
new file mode 100644
index 0000000..0933ba0
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundDeviceList.getDeviceDescription.html
@@ -0,0 +1,54 @@
+
+
+
+
+ Destructor
+
+ [Visual Basic]
+
Overrides Protected Sub Finalize()
+
+ Overrides Protected Sub Finalize()
See Also
++ ISoundDeviceList Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundDeviceList.getDeviceID.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundDeviceList.getDeviceID.html
new file mode 100644
index 0000000..e649625
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundDeviceList.getDeviceID.html
@@ -0,0 +1,55 @@
+
+
+
+
+ returns description of the device. Index of the device, a value between 0 and ISoundDeviceList::getDeviceCount()-1.
+ + +See Also
++ ISoundDeviceList Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundDeviceListConstructor.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundDeviceListConstructor.html
new file mode 100644
index 0000000..b4152cd
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundDeviceListConstructor.html
@@ -0,0 +1,54 @@
+
+
+
+
+ A list of sound devices for a sound driver. Use irrklang::createSoundDeviceList() to create this list. The function createIrrKlangDevice() has a parameter 'deviceID' which takes the value returned by ISoundDeviceList::getDeviceID() and uses that device then. The list of devices in ISoundDeviceList usually also includes the default device which is the first entry and has an empty deviceID string ("") and the description "default device".*/
+For a list of all members of this type, see ISoundDeviceList Members.
+
+ System.Object
+
IrrKlang.ISoundDeviceList
+ [Visual Basic]
+
Public Class ISoundDeviceList
+ Public Class ISoundDeviceList
+ [C#]
+
+ public class ISoundDeviceList
+ Thread Safety
+Public static (Shared in Visual Basic) members of this type are + safe for multithreaded operations. Instance members are not guaranteed to be + thread-safe.
+Requirements
++ Namespace: + IrrKlang +
++ Assembly: irrKlang.NET (in irrKlang.NET.dll) +
+See Also
++ ISoundDeviceList Members | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundDeviceListConstructor1.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundDeviceListConstructor1.html
new file mode 100644
index 0000000..c722a33
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundDeviceListConstructor1.html
@@ -0,0 +1,47 @@
+
+
+
+
+ +
+Overload List
++
+ public ISoundDeviceList(SoundDeviceListType); ++
+
+ public ISoundDeviceList(SoundDeviceListType,SoundOutputDriver); ++
See Also
++ ISoundDeviceList Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundDeviceListConstructor2.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundDeviceListConstructor2.html
new file mode 100644
index 0000000..e2053f7
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundDeviceListConstructor2.html
@@ -0,0 +1,47 @@
+
+
+
+
+ +
+
+ [Visual Basic]
+
Overloads Public Sub New( _
ByVal type As SoundDeviceListType, _
ByVal driver As SoundOutputDriver _
)
+
+ Overloads Public Sub New( _
ByVal type As SoundDeviceListType, _
ByVal driver As SoundOutputDriver _
)
See Also
++ ISoundDeviceList Class | IrrKlang Namespace | ISoundDeviceList Constructor Overload List
++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundDeviceListMembers.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundDeviceListMembers.html
new file mode 100644
index 0000000..ad8e2cd
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundDeviceListMembers.html
@@ -0,0 +1,94 @@
+
+
+
+
+ +
+ + +See Also
++ ISoundDeviceList Class | IrrKlang Namespace | ISoundDeviceList Constructor Overload List
++ +
+
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundDeviceListMethods.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundDeviceListMethods.html
new file mode 100644
index 0000000..267e41c
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundDeviceListMethods.html
@@ -0,0 +1,70 @@
+
+
+
+
+ Public Instance Constructors
+
+
+
+
+ |
+
+ ISoundDeviceList
+ |
+ Overloaded. Initializes a new instance of the ISoundDeviceList class. | +
Public Instance Properties
+
+
+
+
+ | DeviceCount | returns amount of enumerated devices in the list |
Public Instance Methods
+
+
+
+
+ | Equals (inherited from Object) | + Determines whether the specified Object is equal to the current Object. + |
| getDeviceDescription | returns description of the device. Index of the device, a value between 0 and ISoundDeviceList::getDeviceCount()-1. |
| getDeviceID | |
| GetHashCode (inherited from Object) | + Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table. + |
| GetType (inherited from Object) | + Gets the Type of the current instance. + |
| ToString (inherited from Object) | + Returns a String that represents the current Object. + |
Protected Instance Methods
+
+
+
+
+ | Finalize | Destructor |
| MemberwiseClone (inherited from Object) | + Creates a shallow copy of the current Object. + |
See Also
++ ISoundDeviceList Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundDeviceListProperties.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundDeviceListProperties.html
new file mode 100644
index 0000000..3915763
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundDeviceListProperties.html
@@ -0,0 +1,49 @@
+
+
+
+
+ The methods of the ISoundDeviceList class are listed below. For a complete list of ISoundDeviceList class members, see the ISoundDeviceList Members topic.
+Public Instance Methods
+
+
+
+
+ | Equals (inherited from Object) | + Determines whether the specified Object is equal to the current Object. + |
| getDeviceDescription | returns description of the device. Index of the device, a value between 0 and ISoundDeviceList::getDeviceCount()-1. |
| getDeviceID | |
| GetHashCode (inherited from Object) | + Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table. + |
| GetType (inherited from Object) | + Gets the Type of the current instance. + |
| ToString (inherited from Object) | + Returns a String that represents the current Object. + |
Protected Instance Methods
+
+
+
+
+ | Finalize | Destructor |
| MemberwiseClone (inherited from Object) | + Creates a shallow copy of the current Object. + |
See Also
++ ISoundDeviceList Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.DisableAllEffects.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.DisableAllEffects.html
new file mode 100644
index 0000000..8e1a2dc
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.DisableAllEffects.html
@@ -0,0 +1,54 @@
+
+
+
+
+ The properties of the ISoundDeviceList class are listed below. For a complete list of ISoundDeviceList class members, see the ISoundDeviceList Members topic.
+Public Instance Properties
+
+
+
+
+ | DeviceCount | returns amount of enumerated devices in the list |
See Also
++ ISoundDeviceList Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.DisableChorusSoundEffect.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.DisableChorusSoundEffect.html
new file mode 100644
index 0000000..e24c899
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.DisableChorusSoundEffect.html
@@ -0,0 +1,54 @@
+
+
+
+
+ Disables all active sound effects.
+
+ [Visual Basic]
+
Public Sub DisableAllEffects()
+
+ Public Sub DisableAllEffects()
See Also
++ ISoundEffectControl Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.DisableCompressorSoundEffect.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.DisableCompressorSoundEffect.html
new file mode 100644
index 0000000..45de1a6
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.DisableCompressorSoundEffect.html
@@ -0,0 +1,54 @@
+
+
+
+
+ Disables the Chorus sound effect.
+
+ [Visual Basic]
+
Public Sub DisableChorusSoundEffect()
+
+ Public Sub DisableChorusSoundEffect()
See Also
++ ISoundEffectControl Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.DisableDistortionSoundEffect.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.DisableDistortionSoundEffect.html
new file mode 100644
index 0000000..724d770
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.DisableDistortionSoundEffect.html
@@ -0,0 +1,54 @@
+
+
+
+
+ Disables the Compressor sound effect.
+
+ [Visual Basic]
+
Public Sub DisableCompressorSoundEffect()
+
+ Public Sub DisableCompressorSoundEffect()
See Also
++ ISoundEffectControl Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.DisableEchoSoundEffect.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.DisableEchoSoundEffect.html
new file mode 100644
index 0000000..46ec536
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.DisableEchoSoundEffect.html
@@ -0,0 +1,54 @@
+
+
+
+
+ Disables the Distortion sound effect.
+
+ [Visual Basic]
+
Public Sub DisableDistortionSoundEffect()
+
+ Public Sub DisableDistortionSoundEffect()
See Also
++ ISoundEffectControl Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.DisableFlangerSoundEffect.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.DisableFlangerSoundEffect.html
new file mode 100644
index 0000000..42b72d7
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.DisableFlangerSoundEffect.html
@@ -0,0 +1,54 @@
+
+
+
+
+ Disables the Echo sound effect.
+
+ [Visual Basic]
+
Public Sub DisableEchoSoundEffect()
+
+ Public Sub DisableEchoSoundEffect()
See Also
++ ISoundEffectControl Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.DisableGargleSoundEffect.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.DisableGargleSoundEffect.html
new file mode 100644
index 0000000..e7a21f7
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.DisableGargleSoundEffect.html
@@ -0,0 +1,54 @@
+
+
+
+
+ Disables the Flanger sound effect.
+
+ [Visual Basic]
+
Public Sub DisableFlangerSoundEffect()
+
+ Public Sub DisableFlangerSoundEffect()
See Also
++ ISoundEffectControl Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.DisableI3DL2ReverbSoundEffect.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.DisableI3DL2ReverbSoundEffect.html
new file mode 100644
index 0000000..b403fdc
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.DisableI3DL2ReverbSoundEffect.html
@@ -0,0 +1,54 @@
+
+
+
+
+ Disables the Gargle sound effect.
+
+ [Visual Basic]
+
Public Sub DisableGargleSoundEffect()
+
+ Public Sub DisableGargleSoundEffect()
See Also
++ ISoundEffectControl Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.DisableParamEqSoundEffect.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.DisableParamEqSoundEffect.html
new file mode 100644
index 0000000..fc6fe7d
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.DisableParamEqSoundEffect.html
@@ -0,0 +1,54 @@
+
+
+
+
+ Disables the I3DL2 sound effect.
+
+ [Visual Basic]
+
Public Sub DisableI3DL2ReverbSoundEffect()
+
+ Public Sub DisableI3DL2ReverbSoundEffect()
See Also
++ ISoundEffectControl Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.DisableWavesReverbSoundEffect.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.DisableWavesReverbSoundEffect.html
new file mode 100644
index 0000000..6917872
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.DisableWavesReverbSoundEffect.html
@@ -0,0 +1,54 @@
+
+
+
+
+ Disables the ParamEq sound effect.
+
+ [Visual Basic]
+
Public Sub DisableParamEqSoundEffect()
+
+ Public Sub DisableParamEqSoundEffect()
See Also
++ ISoundEffectControl Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableChorusSoundEffect_overload_1.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableChorusSoundEffect_overload_1.html
new file mode 100644
index 0000000..cc3d167
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableChorusSoundEffect_overload_1.html
@@ -0,0 +1,56 @@
+
+
+
+
+ Disable the WavesReverb sound effect.
+
+ [Visual Basic]
+
Public Sub DisableWavesReverbSoundEffect()
+
+ Public Sub DisableWavesReverbSoundEffect()
See Also
++ ISoundEffectControl Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableChorusSoundEffect_overload_2.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableChorusSoundEffect_overload_2.html
new file mode 100644
index 0000000..9a83619
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableChorusSoundEffect_overload_2.html
@@ -0,0 +1,56 @@
+
+
+
+
+ Enables the chorus sound effect with default values. Chorus is a voice-doubling effect created by echoing the original sound with a slight delay and slightly modulating the delay of the echo. If this sound effect is already enabled, calling this only modifies the parameters of the active effect.
+
+ [Visual Basic]
+
Overloads Public Function EnableChorusSoundEffect( _
ByVal fWetDryMix As Single, _
ByVal fDepth As Single, _
ByVal fFeedback As Single, _
ByVal fFrequency As Single, _
ByVal sinusWaveForm As Boolean, _
ByVal fDelay As Single, _
ByVal lPhase As Integer _
) As Boolean
+ Overloads Public Function EnableChorusSoundEffect( _
ByVal fWetDryMix As Single, _
ByVal fDepth As Single, _
ByVal fFeedback As Single, _
ByVal fFrequency As Single, _
ByVal sinusWaveForm As Boolean, _
ByVal fDelay As Single, _
ByVal lPhase As Integer _
) As Boolean
+ [C#]
+
public bool EnableChorusSoundEffect(
float fWetDryMix,
float fDepth,
float fFeedback,
float fFrequency,
bool sinusWaveForm,
float fDelay,
int lPhase
);
+ public bool EnableChorusSoundEffect(
float fWetDryMix,
float fDepth,
float fFeedback,
float fFrequency,
bool sinusWaveForm,
float fDelay,
int lPhase
);
Return Value
+Returns true if successful.
+See Also
++ ISoundEffectControl Class | IrrKlang Namespace | ISoundEffectControl.EnableChorusSoundEffect Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableChorusSoundEffect_overloads.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableChorusSoundEffect_overloads.html
new file mode 100644
index 0000000..65020da
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableChorusSoundEffect_overloads.html
@@ -0,0 +1,49 @@
+
+
+
+
+ Enables the chorus sound effect with default values. Chorus is a voice-doubling effect created by echoing the original sound with a slight delay and slightly modulating the delay of the echo. If this sound effect is already enabled, calling this only modifies the parameters of the active effect.
+ + +Return Value
+Returns true if successful.
+See Also
++ ISoundEffectControl Class | IrrKlang Namespace | ISoundEffectControl.EnableChorusSoundEffect Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableCompressorSoundEffect_overload_1.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableCompressorSoundEffect_overload_1.html
new file mode 100644
index 0000000..b9596a4
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableCompressorSoundEffect_overload_1.html
@@ -0,0 +1,56 @@
+
+
+
+
+ Enables the chorus sound effect with default values. Chorus is a voice-doubling effect created by echoing the original sound with a slight delay and slightly modulating the delay of the echo. If this sound effect is already enabled, calling this only modifies the parameters of the active effect.
+Overload List
+Enables the chorus sound effect with default values. Chorus is a voice-doubling effect created by echoing the original sound with a slight delay and slightly modulating the delay of the echo. If this sound effect is already enabled, calling this only modifies the parameters of the active effect.
++ public bool EnableChorusSoundEffect(); ++
Enables the chorus sound effect with default values. Chorus is a voice-doubling effect created by echoing the original sound with a slight delay and slightly modulating the delay of the echo. If this sound effect is already enabled, calling this only modifies the parameters of the active effect.
++ public bool EnableChorusSoundEffect(float,float,float,float,bool,float,int); ++
See Also
++ ISoundEffectControl Class | IrrKlang Namespace
++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableCompressorSoundEffect_overload_2.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableCompressorSoundEffect_overload_2.html
new file mode 100644
index 0000000..91d1c40
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableCompressorSoundEffect_overload_2.html
@@ -0,0 +1,56 @@
+
+
+
+
+ Enables the Compressor sound effect with default values. Compressor is a reduction in the fluctuation of a signal above a certain amplitude.
+
+ [Visual Basic]
+
Overloads Public Function EnableCompressorSoundEffect( _
ByVal fGain As Single, _
ByVal fAttack As Single, _
ByVal fRelease As Single, _
ByVal fThreshold As Single, _
ByVal fRatio As Single, _
ByVal fPredelay As Single _
) As Boolean
+ Overloads Public Function EnableCompressorSoundEffect( _
ByVal fGain As Single, _
ByVal fAttack As Single, _
ByVal fRelease As Single, _
ByVal fThreshold As Single, _
ByVal fRatio As Single, _
ByVal fPredelay As Single _
) As Boolean
+ [C#]
+
public bool EnableCompressorSoundEffect(
float fGain,
float fAttack,
float fRelease,
float fThreshold,
float fRatio,
float fPredelay
);
+ public bool EnableCompressorSoundEffect(
float fGain,
float fAttack,
float fRelease,
float fThreshold,
float fRatio,
float fPredelay
);
Return Value
+Returns true if successful.
+See Also
++ ISoundEffectControl Class | IrrKlang Namespace | ISoundEffectControl.EnableCompressorSoundEffect Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableCompressorSoundEffect_overloads.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableCompressorSoundEffect_overloads.html
new file mode 100644
index 0000000..8d649a6
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableCompressorSoundEffect_overloads.html
@@ -0,0 +1,49 @@
+
+
+
+
+ Enables the Compressor sound effect with default values. Compressor is a reduction in the fluctuation of a signal above a certain amplitude.
+ + +Return Value
+Returns true if successful.
+See Also
++ ISoundEffectControl Class | IrrKlang Namespace | ISoundEffectControl.EnableCompressorSoundEffect Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableDistortionSoundEffect_overload_1.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableDistortionSoundEffect_overload_1.html
new file mode 100644
index 0000000..9d881d1
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableDistortionSoundEffect_overload_1.html
@@ -0,0 +1,56 @@
+
+
+
+
+ Enables the Compressor sound effect with default values. Compressor is a reduction in the fluctuation of a signal above a certain amplitude.
+Overload List
+Enables the Compressor sound effect with default values. Compressor is a reduction in the fluctuation of a signal above a certain amplitude.
++ public bool EnableCompressorSoundEffect(); ++
Enables the Compressor sound effect with default values. Compressor is a reduction in the fluctuation of a signal above a certain amplitude.
++ public bool EnableCompressorSoundEffect(float,float,float,float,float,float); ++
See Also
++ ISoundEffectControl Class | IrrKlang Namespace
++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableDistortionSoundEffect_overload_2.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableDistortionSoundEffect_overload_2.html
new file mode 100644
index 0000000..981b662
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableDistortionSoundEffect_overload_2.html
@@ -0,0 +1,56 @@
+
+
+
+
+ Enables the Distortion sound effect with default values. Distortion is achieved by adding harmonics to the signal in such a way that, as the level increases, the top of the waveform becomes squared off or clipped. If this sound effect is already enabled, calling this only modifies the parameters of the active effect.
+
+ [Visual Basic]
+
Overloads Public Function EnableDistortionSoundEffect( _
ByVal fGain As Single, _
ByVal fEdge As Single, _
ByVal fPostEQCenterFrequency As Single, _
ByVal fPostEQBandwidth As Single, _
ByVal fPreLowpassCutoff As Single _
) As Boolean
+ Overloads Public Function EnableDistortionSoundEffect( _
ByVal fGain As Single, _
ByVal fEdge As Single, _
ByVal fPostEQCenterFrequency As Single, _
ByVal fPostEQBandwidth As Single, _
ByVal fPreLowpassCutoff As Single _
) As Boolean
+ [C#]
+
public bool EnableDistortionSoundEffect(
float fGain,
float fEdge,
float fPostEQCenterFrequency,
float fPostEQBandwidth,
float fPreLowpassCutoff
);
+ public bool EnableDistortionSoundEffect(
float fGain,
float fEdge,
float fPostEQCenterFrequency,
float fPostEQBandwidth,
float fPreLowpassCutoff
);
Return Value
+Returns true if successful.
+See Also
++ ISoundEffectControl Class | IrrKlang Namespace | ISoundEffectControl.EnableDistortionSoundEffect Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableDistortionSoundEffect_overloads.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableDistortionSoundEffect_overloads.html
new file mode 100644
index 0000000..ca5cf59
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableDistortionSoundEffect_overloads.html
@@ -0,0 +1,49 @@
+
+
+
+
+ Enables the Distortion sound effect with default values. Distortion is achieved by adding harmonics to the signal in such a way that, as the level increases, the top of the waveform becomes squared off or clipped. If this sound effect is already enabled, calling this only modifies the parameters of the active effect.
+ + +Return Value
+Returns true if successful.
+See Also
++ ISoundEffectControl Class | IrrKlang Namespace | ISoundEffectControl.EnableDistortionSoundEffect Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableEchoSoundEffect_overload_1.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableEchoSoundEffect_overload_1.html
new file mode 100644
index 0000000..1428817
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableEchoSoundEffect_overload_1.html
@@ -0,0 +1,56 @@
+
+
+
+
+ Enables the Distortion sound effect with default values. Distortion is achieved by adding harmonics to the signal in such a way that, as the level increases, the top of the waveform becomes squared off or clipped. If this sound effect is already enabled, calling this only modifies the parameters of the active effect.
+Overload List
+Enables the Distortion sound effect with default values. Distortion is achieved by adding harmonics to the signal in such a way that, as the level increases, the top of the waveform becomes squared off or clipped. If this sound effect is already enabled, calling this only modifies the parameters of the active effect.
++ public bool EnableDistortionSoundEffect(); ++
Enables the Distortion sound effect with default values. Distortion is achieved by adding harmonics to the signal in such a way that, as the level increases, the top of the waveform becomes squared off or clipped. If this sound effect is already enabled, calling this only modifies the parameters of the active effect.
++ public bool EnableDistortionSoundEffect(float,float,float,float,float); ++
See Also
++ ISoundEffectControl Class | IrrKlang Namespace
++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableEchoSoundEffect_overload_2.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableEchoSoundEffect_overload_2.html
new file mode 100644
index 0000000..37470ef
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableEchoSoundEffect_overload_2.html
@@ -0,0 +1,56 @@
+
+
+
+
+ Enables the Echo sound effect with default values. An echo effect causes an entire sound to be repeated after a fixed delay. If this sound effect is already enabled, calling this only modifies the parameters of the active effect.
+
+ [Visual Basic]
+
Overloads Public Function EnableEchoSoundEffect( _
ByVal fWetDryMix As Single, _
ByVal fFeedback As Single, _
ByVal fLeftDelay As Single, _
ByVal fRightDelay As Single, _
ByVal lPanDelay As Integer _
) As Boolean
+ Overloads Public Function EnableEchoSoundEffect( _
ByVal fWetDryMix As Single, _
ByVal fFeedback As Single, _
ByVal fLeftDelay As Single, _
ByVal fRightDelay As Single, _
ByVal lPanDelay As Integer _
) As Boolean
+ [C#]
+
public bool EnableEchoSoundEffect(
float fWetDryMix,
float fFeedback,
float fLeftDelay,
float fRightDelay,
int lPanDelay
);
+ public bool EnableEchoSoundEffect(
float fWetDryMix,
float fFeedback,
float fLeftDelay,
float fRightDelay,
int lPanDelay
);
Return Value
+Returns true if successful.
+See Also
++ ISoundEffectControl Class | IrrKlang Namespace | ISoundEffectControl.EnableEchoSoundEffect Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableEchoSoundEffect_overloads.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableEchoSoundEffect_overloads.html
new file mode 100644
index 0000000..3ea9f80
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableEchoSoundEffect_overloads.html
@@ -0,0 +1,49 @@
+
+
+
+
+ Enables the Echo sound effect with default values. An echo effect causes an entire sound to be repeated after a fixed delay. If this sound effect is already enabled, calling this only modifies the parameters of the active effect.
+ + +Return Value
+Returns true if successful.
+See Also
++ ISoundEffectControl Class | IrrKlang Namespace | ISoundEffectControl.EnableEchoSoundEffect Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableFlangerSoundEffect_overload_1.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableFlangerSoundEffect_overload_1.html
new file mode 100644
index 0000000..7b68935
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableFlangerSoundEffect_overload_1.html
@@ -0,0 +1,56 @@
+
+
+
+
+ Enables the Echo sound effect with default values. An echo effect causes an entire sound to be repeated after a fixed delay. If this sound effect is already enabled, calling this only modifies the parameters of the active effect.
+Overload List
+Enables the Echo sound effect with default values. An echo effect causes an entire sound to be repeated after a fixed delay. If this sound effect is already enabled, calling this only modifies the parameters of the active effect.
++ public bool EnableEchoSoundEffect(); ++
Enables the Echo sound effect with default values. An echo effect causes an entire sound to be repeated after a fixed delay. If this sound effect is already enabled, calling this only modifies the parameters of the active effect.
++ public bool EnableEchoSoundEffect(float,float,float,float,int); ++
See Also
++ ISoundEffectControl Class | IrrKlang Namespace
++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableFlangerSoundEffect_overload_2.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableFlangerSoundEffect_overload_2.html
new file mode 100644
index 0000000..3e7c9a9
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableFlangerSoundEffect_overload_2.html
@@ -0,0 +1,56 @@
+
+
+
+
+ Enables the Flanger sound effect with default values. Flange is an echo effect in which the delay between the original signal and its echo is very short and varies over time. The result is sometimes referred to as a sweeping sound. The term flange originated with the practice of grabbing the flanges of a tape reel to change the speed.
+
+ [Visual Basic]
+
Overloads Public Function EnableFlangerSoundEffect( _
ByVal fWetDryMix As Single, _
ByVal fDepth As Single, _
ByVal fFeedback As Single, _
ByVal fFrequency As Single, _
ByVal triangleWaveForm As Boolean, _
ByVal fDelay As Single, _
ByVal lPhase As Integer _
) As Boolean
+ Overloads Public Function EnableFlangerSoundEffect( _
ByVal fWetDryMix As Single, _
ByVal fDepth As Single, _
ByVal fFeedback As Single, _
ByVal fFrequency As Single, _
ByVal triangleWaveForm As Boolean, _
ByVal fDelay As Single, _
ByVal lPhase As Integer _
) As Boolean
+ [C#]
+
public bool EnableFlangerSoundEffect(
float fWetDryMix,
float fDepth,
float fFeedback,
float fFrequency,
bool triangleWaveForm,
float fDelay,
int lPhase
);
+ public bool EnableFlangerSoundEffect(
float fWetDryMix,
float fDepth,
float fFeedback,
float fFrequency,
bool triangleWaveForm,
float fDelay,
int lPhase
);
Return Value
+Returns true if successful.
+See Also
++ ISoundEffectControl Class | IrrKlang Namespace | ISoundEffectControl.EnableFlangerSoundEffect Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableFlangerSoundEffect_overloads.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableFlangerSoundEffect_overloads.html
new file mode 100644
index 0000000..d321405
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableFlangerSoundEffect_overloads.html
@@ -0,0 +1,49 @@
+
+
+
+
+ Enables the Flanger sound effect with default values. Flange is an echo effect in which the delay between the original signal and its echo is very short and varies over time. The result is sometimes referred to as a sweeping sound. The term flange originated with the practice of grabbing the flanges of a tape reel to change the speed.
+ + +Return Value
+Returns true if successful.
+See Also
++ ISoundEffectControl Class | IrrKlang Namespace | ISoundEffectControl.EnableFlangerSoundEffect Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableGargleSoundEffect_overload_1.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableGargleSoundEffect_overload_1.html
new file mode 100644
index 0000000..56b95b2
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableGargleSoundEffect_overload_1.html
@@ -0,0 +1,56 @@
+
+
+
+
+ Enables the Flanger sound effect with default values. Flange is an echo effect in which the delay between the original signal and its echo is very short and varies over time. The result is sometimes referred to as a sweeping sound. The term flange originated with the practice of grabbing the flanges of a tape reel to change the speed.
+Overload List
+Enables the Flanger sound effect with default values. Flange is an echo effect in which the delay between the original signal and its echo is very short and varies over time. The result is sometimes referred to as a sweeping sound. The term flange originated with the practice of grabbing the flanges of a tape reel to change the speed.
++ public bool EnableFlangerSoundEffect(); ++
Enables the Flanger sound effect with default values. Flange is an echo effect in which the delay between the original signal and its echo is very short and varies over time. The result is sometimes referred to as a sweeping sound. The term flange originated with the practice of grabbing the flanges of a tape reel to change the speed.
++ public bool EnableFlangerSoundEffect(float,float,float,float,bool,float,int); ++
See Also
++ ISoundEffectControl Class | IrrKlang Namespace
++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableGargleSoundEffect_overload_2.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableGargleSoundEffect_overload_2.html
new file mode 100644
index 0000000..a317d9e
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableGargleSoundEffect_overload_2.html
@@ -0,0 +1,56 @@
+
+
+
+
+ Enables the Gargle sound effect with default values. The gargle effect modulates the amplitude of the signal.
+
+ [Visual Basic]
+
Overloads Public Function EnableGargleSoundEffect( _
ByVal rateHz As Integer, _
ByVal sinusWaveForm As Boolean _
) As Boolean
+
+ Overloads Public Function EnableGargleSoundEffect( _
ByVal rateHz As Integer, _
ByVal sinusWaveForm As Boolean _
) As Boolean
Return Value
+Returns true if successful.
+See Also
++ ISoundEffectControl Class | IrrKlang Namespace | ISoundEffectControl.EnableGargleSoundEffect Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableGargleSoundEffect_overloads.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableGargleSoundEffect_overloads.html
new file mode 100644
index 0000000..563d395
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableGargleSoundEffect_overloads.html
@@ -0,0 +1,49 @@
+
+
+
+
+ Enables the Gargle sound effect with default values. The gargle effect modulates the amplitude of the signal.
+ + +Return Value
+Returns true if successful.
+See Also
++ ISoundEffectControl Class | IrrKlang Namespace | ISoundEffectControl.EnableGargleSoundEffect Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableI3DL2ReverbSoundEffect_overload_1.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableI3DL2ReverbSoundEffect_overload_1.html
new file mode 100644
index 0000000..f84495c
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableI3DL2ReverbSoundEffect_overload_1.html
@@ -0,0 +1,56 @@
+
+
+
+
+ Enables the Gargle sound effect with default values. The gargle effect modulates the amplitude of the signal.
+Overload List
+Enables the Gargle sound effect with default values. The gargle effect modulates the amplitude of the signal.
++ public bool EnableGargleSoundEffect(); ++
Enables the Gargle sound effect with default values. The gargle effect modulates the amplitude of the signal.
++ public bool EnableGargleSoundEffect(int,bool); ++
See Also
++ ISoundEffectControl Class | IrrKlang Namespace
++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableI3DL2ReverbSoundEffect_overload_2.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableI3DL2ReverbSoundEffect_overload_2.html
new file mode 100644
index 0000000..7da673b
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableI3DL2ReverbSoundEffect_overload_2.html
@@ -0,0 +1,56 @@
+
+
+
+
+ Enables the I3DL2Reverb sound effect with default values. An implementation of the listener properties in the I3DL2 specification. Source properties are not supported. If this sound effect is already enabled, calling this only modifies the parameters of the active effect.
+
+ [Visual Basic]
+
Overloads Public Function EnableI3DL2ReverbSoundEffect( _
ByVal lRoom As Integer, _
ByVal lRoomHF As Integer, _
ByVal flRoomRolloffFactor As Single, _
ByVal flDecayTime As Single, _
ByVal flDecayHFRatio As Single, _
ByVal lReflections As Integer, _
ByVal flReflectionsDelay As Single, _
ByVal lReverb As Integer, _
ByVal flReverbDelay As Single, _
ByVal flDiffusion As Single, _
ByVal flDensity As Single, _
ByVal flHFReference As Single _
) As Boolean
+ Overloads Public Function EnableI3DL2ReverbSoundEffect( _
ByVal lRoom As Integer, _
ByVal lRoomHF As Integer, _
ByVal flRoomRolloffFactor As Single, _
ByVal flDecayTime As Single, _
ByVal flDecayHFRatio As Single, _
ByVal lReflections As Integer, _
ByVal flReflectionsDelay As Single, _
ByVal lReverb As Integer, _
ByVal flReverbDelay As Single, _
ByVal flDiffusion As Single, _
ByVal flDensity As Single, _
ByVal flHFReference As Single _
) As Boolean
+ [C#]
+
public bool EnableI3DL2ReverbSoundEffect(
int lRoom,
int lRoomHF,
float flRoomRolloffFactor,
float flDecayTime,
float flDecayHFRatio,
int lReflections,
float flReflectionsDelay,
int lReverb,
float flReverbDelay,
float flDiffusion,
float flDensity,
float flHFReference
);
+ public bool EnableI3DL2ReverbSoundEffect(
int lRoom,
int lRoomHF,
float flRoomRolloffFactor,
float flDecayTime,
float flDecayHFRatio,
int lReflections,
float flReflectionsDelay,
int lReverb,
float flReverbDelay,
float flDiffusion,
float flDensity,
float flHFReference
);
Return Value
+Returns true if successful.
+See Also
++ ISoundEffectControl Class | IrrKlang Namespace | ISoundEffectControl.EnableI3DL2ReverbSoundEffect Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableI3DL2ReverbSoundEffect_overloads.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableI3DL2ReverbSoundEffect_overloads.html
new file mode 100644
index 0000000..3a80a54
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableI3DL2ReverbSoundEffect_overloads.html
@@ -0,0 +1,49 @@
+
+
+
+
+ Enables the I3DL2Reverb sound effect with default values. An implementation of the listener properties in the I3DL2 specification. Source properties are not supported. If this sound effect is already enabled, calling this only modifies the parameters of the active effect.
+ + +Return Value
+Returns true if successful.
+See Also
++ ISoundEffectControl Class | IrrKlang Namespace | ISoundEffectControl.EnableI3DL2ReverbSoundEffect Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableParamEqSoundEffect_overload_1.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableParamEqSoundEffect_overload_1.html
new file mode 100644
index 0000000..53e90e5
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableParamEqSoundEffect_overload_1.html
@@ -0,0 +1,56 @@
+
+
+
+
+ Enables the I3DL2Reverb sound effect with default values. An implementation of the listener properties in the I3DL2 specification. Source properties are not supported. If this sound effect is already enabled, calling this only modifies the parameters of the active effect.
+Overload List
+Enables the I3DL2Reverb sound effect with default values. An implementation of the listener properties in the I3DL2 specification. Source properties are not supported. If this sound effect is already enabled, calling this only modifies the parameters of the active effect.
++ public bool EnableI3DL2ReverbSoundEffect(); ++
Enables the I3DL2Reverb sound effect with default values. An implementation of the listener properties in the I3DL2 specification. Source properties are not supported. If this sound effect is already enabled, calling this only modifies the parameters of the active effect.
++ public bool EnableI3DL2ReverbSoundEffect(int,int,float,float,float,int,float,int,float,float,float,float); ++
See Also
++ ISoundEffectControl Class | IrrKlang Namespace
++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableParamEqSoundEffect_overload_2.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableParamEqSoundEffect_overload_2.html
new file mode 100644
index 0000000..9deb255
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableParamEqSoundEffect_overload_2.html
@@ -0,0 +1,56 @@
+
+
+
+
+ Enables the ParamEq sound effect with default values. Parametric equalizer amplifies or attenuates signals of a given frequency. If this sound effect is already enabled, calling this only modifies the parameters of the active effect.
+
+ [Visual Basic]
+
Overloads Public Function EnableParamEqSoundEffect( _
ByVal fCenter As Single, _
ByVal fBandwidth As Single, _
ByVal fGain As Single _
) As Boolean
+
+ Overloads Public Function EnableParamEqSoundEffect( _
ByVal fCenter As Single, _
ByVal fBandwidth As Single, _
ByVal fGain As Single _
) As Boolean
Return Value
+Returns true if successful.
+See Also
++ ISoundEffectControl Class | IrrKlang Namespace | ISoundEffectControl.EnableParamEqSoundEffect Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableParamEqSoundEffect_overloads.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableParamEqSoundEffect_overloads.html
new file mode 100644
index 0000000..f770b74
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableParamEqSoundEffect_overloads.html
@@ -0,0 +1,49 @@
+
+
+
+
+ Enables the ParamEq sound effect with default values. Parametric equalizer amplifies or attenuates signals of a given frequency. If this sound effect is already enabled, calling this only modifies the parameters of the active effect.
+ + +Return Value
+Returns true if successful.
+See Also
++ ISoundEffectControl Class | IrrKlang Namespace | ISoundEffectControl.EnableParamEqSoundEffect Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableWavesReverbSoundEffect_overload_1.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableWavesReverbSoundEffect_overload_1.html
new file mode 100644
index 0000000..e58c2a4
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableWavesReverbSoundEffect_overload_1.html
@@ -0,0 +1,56 @@
+
+
+
+
+ Enables the ParamEq sound effect with default values. Parametric equalizer amplifies or attenuates signals of a given frequency. If this sound effect is already enabled, calling this only modifies the parameters of the active effect.
+Overload List
+Enables the ParamEq sound effect with default values. Parametric equalizer amplifies or attenuates signals of a given frequency. If this sound effect is already enabled, calling this only modifies the parameters of the active effect.
++ public bool EnableParamEqSoundEffect(); ++
Enables the ParamEq sound effect with default values. Parametric equalizer amplifies or attenuates signals of a given frequency. If this sound effect is already enabled, calling this only modifies the parameters of the active effect.
++ public bool EnableParamEqSoundEffect(float,float,float); ++
See Also
++ ISoundEffectControl Class | IrrKlang Namespace
++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableWavesReverbSoundEffect_overload_2.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableWavesReverbSoundEffect_overload_2.html
new file mode 100644
index 0000000..73b99e0
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableWavesReverbSoundEffect_overload_2.html
@@ -0,0 +1,56 @@
+
+
+
+
+ Enables the WavesReverb sound effect with default values. Parametric equalizer amplifies or attenuates signals of a given frequency. If this sound effect is already enabled, calling this only modifies the parameters of the active effect.
+
+ [Visual Basic]
+
Overloads Public Function EnableWavesReverbSoundEffect( _
ByVal fInGain As Single, _
ByVal fReverbMix As Single, _
ByVal fReverbTime As Single, _
ByVal fHighFreqRTRatio As Single _
) As Boolean
+ Overloads Public Function EnableWavesReverbSoundEffect( _
ByVal fInGain As Single, _
ByVal fReverbMix As Single, _
ByVal fReverbTime As Single, _
ByVal fHighFreqRTRatio As Single _
) As Boolean
+ [C#]
+
public bool EnableWavesReverbSoundEffect(
float fInGain,
float fReverbMix,
float fReverbTime,
float fHighFreqRTRatio
);
+ public bool EnableWavesReverbSoundEffect(
float fInGain,
float fReverbMix,
float fReverbTime,
float fHighFreqRTRatio
);
Return Value
+Returns true if successful.
+See Also
++ ISoundEffectControl Class | IrrKlang Namespace | ISoundEffectControl.EnableWavesReverbSoundEffect Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableWavesReverbSoundEffect_overloads.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableWavesReverbSoundEffect_overloads.html
new file mode 100644
index 0000000..648d356
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.EnableWavesReverbSoundEffect_overloads.html
@@ -0,0 +1,49 @@
+
+
+
+
+ Enables the WavesReverb sound effect with default values. Parametric equalizer amplifies or attenuates signals of a given frequency. If this sound effect is already enabled, calling this only modifies the parameters of the active effect.
+ + +Return Value
+Returns true if successful.
+See Also
++ ISoundEffectControl Class | IrrKlang Namespace | ISoundEffectControl.EnableWavesReverbSoundEffect Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.Finalize.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.Finalize.html
new file mode 100644
index 0000000..2f6a334
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.Finalize.html
@@ -0,0 +1,54 @@
+
+
+
+
+ Enables the WavesReverb sound effect with default values. Parametric equalizer amplifies or attenuates signals of a given frequency. If this sound effect is already enabled, calling this only modifies the parameters of the active effect.
+Overload List
+Enables the WavesReverb sound effect with default values. Parametric equalizer amplifies or attenuates signals of a given frequency. If this sound effect is already enabled, calling this only modifies the parameters of the active effect.
++ public bool EnableWavesReverbSoundEffect(); ++
Enables the WavesReverb sound effect with default values. Parametric equalizer amplifies or attenuates signals of a given frequency. If this sound effect is already enabled, calling this only modifies the parameters of the active effect.
++ public bool EnableWavesReverbSoundEffect(float,float,float,float); ++
See Also
++ ISoundEffectControl Class | IrrKlang Namespace
++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.IsChorusSoundEffectEnabled.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.IsChorusSoundEffectEnabled.html
new file mode 100644
index 0000000..376fc39
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.IsChorusSoundEffectEnabled.html
@@ -0,0 +1,56 @@
+
+
+
+
+ Destructor
+
+ [Visual Basic]
+
Overrides Protected Sub Finalize()
+
+ Overrides Protected Sub Finalize()
See Also
++ ISoundEffectControl Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.IsCompressorSoundEffectEnabled.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.IsCompressorSoundEffectEnabled.html
new file mode 100644
index 0000000..53c075a
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.IsCompressorSoundEffectEnabled.html
@@ -0,0 +1,56 @@
+
+
+
+
+ returns if the sound effect is enabled
+ + ++
+See Also
++ ISoundEffectControl Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.IsDistortionSoundEffectEnabled.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.IsDistortionSoundEffectEnabled.html
new file mode 100644
index 0000000..74ae278
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.IsDistortionSoundEffectEnabled.html
@@ -0,0 +1,56 @@
+
+
+
+
+ returns if the sound effect is enabled
+ + ++
+See Also
++ ISoundEffectControl Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.IsEchoSoundEffectEnabled.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.IsEchoSoundEffectEnabled.html
new file mode 100644
index 0000000..0afd627
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.IsEchoSoundEffectEnabled.html
@@ -0,0 +1,56 @@
+
+
+
+
+ returns if the sound effect is enabled
+ + ++
+See Also
++ ISoundEffectControl Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.IsFlangerSoundEffectEnabled.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.IsFlangerSoundEffectEnabled.html
new file mode 100644
index 0000000..d7355bf
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.IsFlangerSoundEffectEnabled.html
@@ -0,0 +1,56 @@
+
+
+
+
+ returns if the sound effect is enabled
+ + ++
+See Also
++ ISoundEffectControl Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.IsGargleSoundEffectEnabled.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.IsGargleSoundEffectEnabled.html
new file mode 100644
index 0000000..fecd63a
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.IsGargleSoundEffectEnabled.html
@@ -0,0 +1,56 @@
+
+
+
+
+ returns if the sound effect is enabled
+ + ++
+See Also
++ ISoundEffectControl Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.IsI3DL2ReverbSoundEffectEnabled.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.IsI3DL2ReverbSoundEffectEnabled.html
new file mode 100644
index 0000000..3c6e6d3
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.IsI3DL2ReverbSoundEffectEnabled.html
@@ -0,0 +1,56 @@
+
+
+
+
+ returns if the sound effect is enabled
+ + ++
+See Also
++ ISoundEffectControl Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.IsParamEqSoundEffectEnabled.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.IsParamEqSoundEffectEnabled.html
new file mode 100644
index 0000000..d956adf
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.IsParamEqSoundEffectEnabled.html
@@ -0,0 +1,56 @@
+
+
+
+
+ returns if the sound effect is enabled
+ + ++
+See Also
++ ISoundEffectControl Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.IsWavesReverbSoundEffectEnabled.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.IsWavesReverbSoundEffectEnabled.html
new file mode 100644
index 0000000..0346abd
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.IsWavesReverbSoundEffectEnabled.html
@@ -0,0 +1,56 @@
+
+
+
+
+ returns if the sound effect is enabled
+ + ++
+See Also
++ ISoundEffectControl Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.html
new file mode 100644
index 0000000..05ea97f
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControl.html
@@ -0,0 +1,67 @@
+
+
+
+
+ returns if the sound effect is enabled
+ + ++
+See Also
++ ISoundEffectControl Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControlConstructor.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControlConstructor.html
new file mode 100644
index 0000000..aceb154
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControlConstructor.html
@@ -0,0 +1,51 @@
+
+
+
+
+ Interface to control the active sound effects (echo, reverb,...) of an ISound object, a playing sound. Sound effects such as chorus, distorsions, echo, reverb and similar can be controlled using this. An instance of this interface can be obtained via ISound::getSoundEffectControl(). The sound containing this interface has to be started via ISoundEngine::play2D() or ISoundEngine::play3D() with the flag enableSoundEffects=true, otherwise no acccess to this interface will be available. For the DirectSound driver, these are effects available since DirectSound8. For most effects, sounds should have a sample rate of 44 khz and should be at least 150 milli seconds long for optimal quality when using the DirectSound driver.
+For a list of all members of this type, see ISoundEffectControl Members.
+
+ System.Object
+
IrrKlang.ISoundEffectControl
+ [Visual Basic]
+
Public Class ISoundEffectControl
+ Public Class ISoundEffectControl
+ [C#]
+
+ public class ISoundEffectControl
+ Thread Safety
+Public static (Shared in Visual Basic) members of this type are + safe for multithreaded operations. Instance members are not guaranteed to be + thread-safe.
+Requirements
++ Namespace: + IrrKlang +
++ Assembly: irrKlang.NET (in irrKlang.NET.dll) +
+See Also
++ ISoundEffectControl Members | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControlMembers.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControlMembers.html
new file mode 100644
index 0000000..326367f
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControlMembers.html
@@ -0,0 +1,120 @@
+
+
+
+
+ +
+
+ [Visual Basic]
+
Public Sub New( _
ByVal nativeSound As ISound*, _
ByVal nativeEngine As ISoundEngine* _
)
+
+ Public Sub New( _
ByVal nativeSound As ISound*, _
ByVal nativeEngine As ISoundEngine* _
)
See Also
++ ISoundEffectControl Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControlMethods.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControlMethods.html
new file mode 100644
index 0000000..9585254
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControlMethods.html
@@ -0,0 +1,87 @@
+
+
+
+
+ + ISoundEffectControl overview +
+Public Instance Constructors
+
+
+
+
+ |
+
+ ISoundEffectControl Constructor
+ |
+ + | +
Public Instance Properties
+
+
+
+
+ | IsChorusSoundEffectEnabled | returns if the sound effect is enabled |
| IsCompressorSoundEffectEnabled | returns if the sound effect is enabled |
| IsDistortionSoundEffectEnabled | returns if the sound effect is enabled |
| IsEchoSoundEffectEnabled | returns if the sound effect is enabled |
| IsFlangerSoundEffectEnabled | returns if the sound effect is enabled |
| IsGargleSoundEffectEnabled | returns if the sound effect is enabled |
| IsI3DL2ReverbSoundEffectEnabled | returns if the sound effect is enabled |
| IsParamEqSoundEffectEnabled | returns if the sound effect is enabled |
| IsWavesReverbSoundEffectEnabled | returns if the sound effect is enabled |
Public Instance Methods
+
+
+
+
+ | DisableAllEffects | Disables all active sound effects. |
| DisableChorusSoundEffect | Disables the Chorus sound effect. |
| DisableCompressorSoundEffect | Disables the Compressor sound effect. |
| DisableDistortionSoundEffect | Disables the Distortion sound effect. |
| DisableEchoSoundEffect | Disables the Echo sound effect. |
| DisableFlangerSoundEffect | Disables the Flanger sound effect. |
| DisableGargleSoundEffect | Disables the Gargle sound effect. |
| DisableI3DL2ReverbSoundEffect | Disables the I3DL2 sound effect. |
| DisableParamEqSoundEffect | Disables the ParamEq sound effect. |
| DisableWavesReverbSoundEffect | Disable the WavesReverb sound effect. |
| EnableChorusSoundEffect | Overloaded. Enables the chorus sound effect with default values. Chorus is a voice-doubling effect created by echoing the original sound with a slight delay and slightly modulating the delay of the echo. If this sound effect is already enabled, calling this only modifies the parameters of the active effect. |
| EnableCompressorSoundEffect | Overloaded. Enables the Compressor sound effect with default values. Compressor is a reduction in the fluctuation of a signal above a certain amplitude. |
| EnableDistortionSoundEffect | Overloaded. Enables the Distortion sound effect with default values. Distortion is achieved by adding harmonics to the signal in such a way that, as the level increases, the top of the waveform becomes squared off or clipped. If this sound effect is already enabled, calling this only modifies the parameters of the active effect. |
| EnableEchoSoundEffect | Overloaded. Enables the Echo sound effect with default values. An echo effect causes an entire sound to be repeated after a fixed delay. If this sound effect is already enabled, calling this only modifies the parameters of the active effect. |
| EnableFlangerSoundEffect | Overloaded. Enables the Flanger sound effect with default values. Flange is an echo effect in which the delay between the original signal and its echo is very short and varies over time. The result is sometimes referred to as a sweeping sound. The term flange originated with the practice of grabbing the flanges of a tape reel to change the speed. |
| EnableGargleSoundEffect | Overloaded. Enables the Gargle sound effect with default values. The gargle effect modulates the amplitude of the signal. |
| EnableI3DL2ReverbSoundEffect | Overloaded. Enables the I3DL2Reverb sound effect with default values. An implementation of the listener properties in the I3DL2 specification. Source properties are not supported. If this sound effect is already enabled, calling this only modifies the parameters of the active effect. |
| EnableParamEqSoundEffect | Overloaded. Enables the ParamEq sound effect with default values. Parametric equalizer amplifies or attenuates signals of a given frequency. If this sound effect is already enabled, calling this only modifies the parameters of the active effect. |
| EnableWavesReverbSoundEffect | Overloaded. Enables the WavesReverb sound effect with default values. Parametric equalizer amplifies or attenuates signals of a given frequency. If this sound effect is already enabled, calling this only modifies the parameters of the active effect. |
| Equals (inherited from Object) | + Determines whether the specified Object is equal to the current Object. + |
| GetHashCode (inherited from Object) | + Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table. + |
| GetType (inherited from Object) | + Gets the Type of the current instance. + |
| ToString (inherited from Object) | + Returns a String that represents the current Object. + |
Protected Instance Methods
+
+
+
+
+ | Finalize | Destructor |
| MemberwiseClone (inherited from Object) | + Creates a shallow copy of the current Object. + |
See Also
++ ISoundEffectControl Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControlProperties.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControlProperties.html
new file mode 100644
index 0000000..f151905
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEffectControlProperties.html
@@ -0,0 +1,57 @@
+
+
+
+
+ The methods of the ISoundEffectControl class are listed below. For a complete list of ISoundEffectControl class members, see the ISoundEffectControl Members topic.
+Public Instance Methods
+
+
+
+
+ | DisableAllEffects | Disables all active sound effects. |
| DisableChorusSoundEffect | Disables the Chorus sound effect. |
| DisableCompressorSoundEffect | Disables the Compressor sound effect. |
| DisableDistortionSoundEffect | Disables the Distortion sound effect. |
| DisableEchoSoundEffect | Disables the Echo sound effect. |
| DisableFlangerSoundEffect | Disables the Flanger sound effect. |
| DisableGargleSoundEffect | Disables the Gargle sound effect. |
| DisableI3DL2ReverbSoundEffect | Disables the I3DL2 sound effect. |
| DisableParamEqSoundEffect | Disables the ParamEq sound effect. |
| DisableWavesReverbSoundEffect | Disable the WavesReverb sound effect. |
| EnableChorusSoundEffect | Overloaded. Enables the chorus sound effect with default values. Chorus is a voice-doubling effect created by echoing the original sound with a slight delay and slightly modulating the delay of the echo. If this sound effect is already enabled, calling this only modifies the parameters of the active effect. |
| EnableCompressorSoundEffect | Overloaded. Enables the Compressor sound effect with default values. Compressor is a reduction in the fluctuation of a signal above a certain amplitude. |
| EnableDistortionSoundEffect | Overloaded. Enables the Distortion sound effect with default values. Distortion is achieved by adding harmonics to the signal in such a way that, as the level increases, the top of the waveform becomes squared off or clipped. If this sound effect is already enabled, calling this only modifies the parameters of the active effect. |
| EnableEchoSoundEffect | Overloaded. Enables the Echo sound effect with default values. An echo effect causes an entire sound to be repeated after a fixed delay. If this sound effect is already enabled, calling this only modifies the parameters of the active effect. |
| EnableFlangerSoundEffect | Overloaded. Enables the Flanger sound effect with default values. Flange is an echo effect in which the delay between the original signal and its echo is very short and varies over time. The result is sometimes referred to as a sweeping sound. The term flange originated with the practice of grabbing the flanges of a tape reel to change the speed. |
| EnableGargleSoundEffect | Overloaded. Enables the Gargle sound effect with default values. The gargle effect modulates the amplitude of the signal. |
| EnableI3DL2ReverbSoundEffect | Overloaded. Enables the I3DL2Reverb sound effect with default values. An implementation of the listener properties in the I3DL2 specification. Source properties are not supported. If this sound effect is already enabled, calling this only modifies the parameters of the active effect. |
| EnableParamEqSoundEffect | Overloaded. Enables the ParamEq sound effect with default values. Parametric equalizer amplifies or attenuates signals of a given frequency. If this sound effect is already enabled, calling this only modifies the parameters of the active effect. |
| EnableWavesReverbSoundEffect | Overloaded. Enables the WavesReverb sound effect with default values. Parametric equalizer amplifies or attenuates signals of a given frequency. If this sound effect is already enabled, calling this only modifies the parameters of the active effect. |
| Equals (inherited from Object) | + Determines whether the specified Object is equal to the current Object. + |
| GetHashCode (inherited from Object) | + Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table. + |
| GetType (inherited from Object) | + Gets the Type of the current instance. + |
| ToString (inherited from Object) | + Returns a String that represents the current Object. + |
Protected Instance Methods
+
+
+
+
+ | Finalize | Destructor |
| MemberwiseClone (inherited from Object) | + Creates a shallow copy of the current Object. + |
See Also
++ ISoundEffectControl Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.AddFileFactory.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.AddFileFactory.html
new file mode 100644
index 0000000..496ec9e
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.AddFileFactory.html
@@ -0,0 +1,54 @@
+
+
+
+
+ The properties of the ISoundEffectControl class are listed below. For a complete list of ISoundEffectControl class members, see the ISoundEffectControl Members topic.
+Public Instance Properties
+
+
+
+
+ | IsChorusSoundEffectEnabled | returns if the sound effect is enabled |
| IsCompressorSoundEffectEnabled | returns if the sound effect is enabled |
| IsDistortionSoundEffectEnabled | returns if the sound effect is enabled |
| IsEchoSoundEffectEnabled | returns if the sound effect is enabled |
| IsFlangerSoundEffectEnabled | returns if the sound effect is enabled |
| IsGargleSoundEffectEnabled | returns if the sound effect is enabled |
| IsI3DL2ReverbSoundEffectEnabled | returns if the sound effect is enabled |
| IsParamEqSoundEffectEnabled | returns if the sound effect is enabled |
| IsWavesReverbSoundEffectEnabled | returns if the sound effect is enabled |
See Also
++ ISoundEffectControl Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.AddSoundSourceAlias.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.AddSoundSourceAlias.html
new file mode 100644
index 0000000..e197707
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.AddSoundSourceAlias.html
@@ -0,0 +1,67 @@
+
+
+
+
+ Adds a file factory to the sound engine, making it possible to override file access of the sound engine. Derive your own class from IFileFactory, overwrite the openFile() method and return your own implemented System::IO::Stream to overwrite file access of irrKlang.
+ + +See Also
++ ISoundEngine Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.AddSoundSourceFromFile_overload_1.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.AddSoundSourceFromFile_overload_1.html
new file mode 100644
index 0000000..d8325d4
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.AddSoundSourceFromFile_overload_1.html
@@ -0,0 +1,63 @@
+
+
+
+
+ Adds a sound source as alias for an existing sound source, but with a different name or optional different default settings. This is useful if you want to play multiple sounds but each sound isn't necessarily one single file. Also useful if you want to or play the same sound using different names, volumes or min and max 3D distances.
+
+ [Visual Basic]
+
Public Function AddSoundSourceAlias( _
ByVal baseSource As ISoundSource, _
ByVal soundName As String _
) As ISoundSource
+
+ Public Function AddSoundSourceAlias( _
ByVal baseSource As ISoundSource, _
ByVal soundName As String _
) As ISoundSource
Parameters
+-
+
- + baseSource + +
- The sound source where this sound source should be based on. This sound source will use the baseSource as base to access the file and similar, but it will have its own name and its own default settings. +
- + soundName + +
- Name of the new sound source to be added. +
Return Value
+Returns the pointer to the added sound source or 0 if not sucessful because for example a sound already existed with that name. If not successful, the reason will be printed into the log.
+See Also
++ ISoundEngine Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.AddSoundSourceFromFile_overload_2.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.AddSoundSourceFromFile_overload_2.html
new file mode 100644
index 0000000..64f0032
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.AddSoundSourceFromFile_overload_2.html
@@ -0,0 +1,67 @@
+
+
+
+
+ Adds sound source into the sound engine as file.
+
+ [Visual Basic]
+
Overloads Public Function AddSoundSourceFromFile( _
ByVal soundName As String _
) As ISoundSource
+
+ Overloads Public Function AddSoundSourceFromFile( _
ByVal soundName As String _
) As ISoundSource
Parameters
+-
+
- + soundName + +
- Name of the sound file (e.g. "sounds/something.mp3"). You can also use this name when calling play3D() or play2D(). +
Return Value
+Returns the added sound source or null if not sucessful because for example a sound already existed with that name. If not successful, the reason will be printed into the log.
+See Also
++ ISoundEngine Class | IrrKlang Namespace | ISoundEngine.AddSoundSourceFromFile Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.AddSoundSourceFromFile_overload_3.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.AddSoundSourceFromFile_overload_3.html
new file mode 100644
index 0000000..a097dad
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.AddSoundSourceFromFile_overload_3.html
@@ -0,0 +1,72 @@
+
+
+
+
+ Adds sound source into the sound engine as file.
+
+ [Visual Basic]
+
Overloads Public Function AddSoundSourceFromFile( _
ByVal soundName As String, _
ByVal streamMode As StreamMode _
) As ISoundSource
+
+ Overloads Public Function AddSoundSourceFromFile( _
ByVal soundName As String, _
ByVal streamMode As StreamMode _
) As ISoundSource
Parameters
+-
+
- + soundName + +
- Name of the sound file (e.g. "sounds/something.mp3"). You can also use this name when calling play3D() or play2D(). +
- + streamMode + +
- Streaming mode for this sound source +
Return Value
+Returns the added sound source or null if not sucessful because for example a sound already existed with that name. If not successful, the reason will be printed into the log.
+See Also
++ ISoundEngine Class | IrrKlang Namespace | ISoundEngine.AddSoundSourceFromFile Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.AddSoundSourceFromFile_overloads.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.AddSoundSourceFromFile_overloads.html
new file mode 100644
index 0000000..69de301
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.AddSoundSourceFromFile_overloads.html
@@ -0,0 +1,53 @@
+
+
+
+
+ Adds sound source into the sound engine as file.
+
+ [Visual Basic]
+
Overloads Public Function AddSoundSourceFromFile( _
ByVal soundName As String, _
ByVal streamMode As StreamMode, _
ByVal preLoad As Boolean _
) As ISoundSource
+ Overloads Public Function AddSoundSourceFromFile( _
ByVal soundName As String, _
ByVal streamMode As StreamMode, _
ByVal preLoad As Boolean _
) As ISoundSource
+ [C#]
+
public ISoundSource AddSoundSourceFromFile(
string soundName,
StreamMode streamMode,
bool preLoad
);
+ public ISoundSource AddSoundSourceFromFile(
string soundName,
StreamMode streamMode,
bool preLoad
);
Parameters
+-
+
- + soundName + +
- Name of the sound file (e.g. "sounds/something.mp3"). You can also use this name when calling play3D() or play2D(). +
- + streamMode + +
- Streaming mode for this sound source +
- + preLoad + +
- + +
Return Value
+Returns the added sound source or null if not sucessful because for example a sound already existed with that name. If not successful, the reason will be printed into the log.
+See Also
++ ISoundEngine Class | IrrKlang Namespace | ISoundEngine.AddSoundSourceFromFile Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.AddSoundSourceFromIOStream.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.AddSoundSourceFromIOStream.html
new file mode 100644
index 0000000..eefacca
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.AddSoundSourceFromIOStream.html
@@ -0,0 +1,56 @@
+
+
+
+
+ Adds sound source into the sound engine as file.
+Overload List
+Adds sound source into the sound engine as file.
++ public ISoundSource AddSoundSourceFromFile(string); ++
Adds sound source into the sound engine as file.
++ public ISoundSource AddSoundSourceFromFile(string,StreamMode); ++
Adds sound source into the sound engine as file.
++ public ISoundSource AddSoundSourceFromFile(string,StreamMode,bool); ++
See Also
++ ISoundEngine Class | IrrKlang Namespace
++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.AddSoundSourceFromMemory.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.AddSoundSourceFromMemory.html
new file mode 100644
index 0000000..d71e6d3
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.AddSoundSourceFromMemory.html
@@ -0,0 +1,55 @@
+
+
+
+
+ Adds a sound source into the sound engine from a IOStream. Note that the stream is totally read into memory when adding the sound source. If you want irrKlang to dynamically open and close custom file streams without loading everything into memory, use the addFileFactory with your own IFileFactory implementation.
+
+ [Visual Basic]
+
Public Function AddSoundSourceFromIOStream( _
ByVal stream As Stream, _
ByVal soundName As String _
) As ISoundSource
+
+ Public Function AddSoundSourceFromIOStream( _
ByVal stream As Stream, _
ByVal soundName As String _
) As ISoundSource
Return Value
+Returns the pointer to the added sound source or 0 if not sucessful because for example a sound already existed with that name. If not successful, the reason will be printed into the log.
+See Also
++ ISoundEngine Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.AddSoundSourceFromPCMData.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.AddSoundSourceFromPCMData.html
new file mode 100644
index 0000000..0033476
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.AddSoundSourceFromPCMData.html
@@ -0,0 +1,55 @@
+
+
+
+
+ +
+
+ [Visual Basic]
+
Public Function AddSoundSourceFromMemory( _
ByVal soundDataInMemory As Byte(), _
ByVal soundName As String _
) As ISoundSource
+
+ Public Function AddSoundSourceFromMemory( _
ByVal soundDataInMemory As Byte(), _
ByVal soundName As String _
) As ISoundSource
See Also
++ ISoundEngine Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Default3DSoundMaxDistance.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Default3DSoundMaxDistance.html
new file mode 100644
index 0000000..e8f6642
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Default3DSoundMaxDistance.html
@@ -0,0 +1,56 @@
+
+
+
+
+ +
+
+ [Visual Basic]
+
Public Function AddSoundSourceFromPCMData( _
ByVal soundDataInMemory As Byte(), _
ByVal soundName As String, _
ByVal format As AudioFormat _
) As ISoundSource
+ Public Function AddSoundSourceFromPCMData( _
ByVal soundDataInMemory As Byte(), _
ByVal soundName As String, _
ByVal format As AudioFormat _
) As ISoundSource
+ [C#]
+
public ISoundSource AddSoundSourceFromPCMData(
byte[] soundDataInMemory,
string soundName,
AudioFormat format
);
+ public ISoundSource AddSoundSourceFromPCMData(
byte[] soundDataInMemory,
string soundName,
AudioFormat format
);
See Also
++ ISoundEngine Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Default3DSoundMinDistance.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Default3DSoundMinDistance.html
new file mode 100644
index 0000000..9163d89
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Default3DSoundMinDistance.html
@@ -0,0 +1,56 @@
+
+
+
+
+ Sets or gets the default maximal distance for 3D sounds. This value influences how loud a sound is heard based on its distance. See ISound::setMaxDistance() for details about what the max distance is. It is also possible to influence this default value for every sound file using ISoundSource::setDefaultMaxDistance(). This method only influences the initial distance value of sounds. For changing the distance after the sound has been started to play, use ISound::setMaxDistance() and ISound::setMaxDistance().
+ + ++
+See Also
++ ISoundEngine Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Finalize.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Finalize.html
new file mode 100644
index 0000000..d350499
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Finalize.html
@@ -0,0 +1,54 @@
+
+
+
+
+ Sets or gets the default minimal distance for 3D sounds. This value influences how loud a sound is heard based on its distance. See ISound::setMinDistance() for details about what the min distance is. It is also possible to influence this default value for every sound file using ISoundSource::setDefaultMinDistance(). This method only influences the initial distance value of sounds. For changing the distance after the sound has been started to play, use ISound::setMinDistance() and ISound::setMaxDistance().
+ + ++
+See Also
++ ISoundEngine Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.GetSoundSource_overload_1.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.GetSoundSource_overload_1.html
new file mode 100644
index 0000000..c8e131c
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.GetSoundSource_overload_1.html
@@ -0,0 +1,55 @@
+
+
+
+
+ Destructor
+
+ [Visual Basic]
+
Overrides Protected Sub Finalize()
+
+ Overrides Protected Sub Finalize()
See Also
++ ISoundEngine Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.GetSoundSource_overload_2.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.GetSoundSource_overload_2.html
new file mode 100644
index 0000000..ba8571b
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.GetSoundSource_overload_2.html
@@ -0,0 +1,55 @@
+
+
+
+
+ +
+
+ [Visual Basic]
+
Overloads Public Function GetSoundSource( _
ByVal soundName As String, _
ByVal addIfNotFound As Boolean _
) As ISoundSource
+
+ Overloads Public Function GetSoundSource( _
ByVal soundName As String, _
ByVal addIfNotFound As Boolean _
) As ISoundSource
See Also
++ ISoundEngine Class | IrrKlang Namespace | ISoundEngine.GetSoundSource Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.GetSoundSource_overloads.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.GetSoundSource_overloads.html
new file mode 100644
index 0000000..97b939d
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.GetSoundSource_overloads.html
@@ -0,0 +1,50 @@
+
+
+
+
+ +
+
+ [Visual Basic]
+
Overloads Public Function GetSoundSource( _
ByVal soundName As String _
) As ISoundSource
+
+ Overloads Public Function GetSoundSource( _
ByVal soundName As String _
) As ISoundSource
See Also
++ ISoundEngine Class | IrrKlang Namespace | ISoundEngine.GetSoundSource Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.IsCurrentlyPlaying.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.IsCurrentlyPlaying.html
new file mode 100644
index 0000000..a403ab1
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.IsCurrentlyPlaying.html
@@ -0,0 +1,54 @@
+
+
+
+
+ +
+Overload List
++
+ public ISoundSource GetSoundSource(string); ++
+
+ public ISoundSource GetSoundSource(string,bool); ++
See Also
++ ISoundEngine Class | IrrKlang Namespace
++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.IsMultiThreaded.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.IsMultiThreaded.html
new file mode 100644
index 0000000..31c1dd8
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.IsMultiThreaded.html
@@ -0,0 +1,56 @@
+
+
+
+
+ Returns if a sound with the specified name is currently playing
+ + +See Also
++ ISoundEngine Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.LoadPlugins.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.LoadPlugins.html
new file mode 100644
index 0000000..8451131
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.LoadPlugins.html
@@ -0,0 +1,55 @@
+
+
+
+
+ Returns if irrKlang is running in the same thread as the application or is using multithreading. This basicly returns the flag set by the user when creating the sound engine.
+ + ++
+See Also
++ ISoundEngine Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play2D_overload_1.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play2D_overload_1.html
new file mode 100644
index 0000000..2df861f
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play2D_overload_1.html
@@ -0,0 +1,54 @@
+
+
+
+
+ Returns the name of the audio driver.
+ + ++
+See Also
++ ISoundEngine Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play2D_overload_2.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play2D_overload_2.html
new file mode 100644
index 0000000..49d7e0b
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play2D_overload_2.html
@@ -0,0 +1,54 @@
+
+
+
+
+ loads a sound source (if not loaded already) from a file and plays it.
+
+ [Visual Basic]
+
Overloads Public Function Play2D( _
ByVal source As ISoundSource, _
ByVal playLooped As Boolean, _
ByVal startPaused As Boolean, _
ByVal enableSoundEffects As Boolean _
) As ISound
+ Overloads Public Function Play2D( _
ByVal source As ISoundSource, _
ByVal playLooped As Boolean, _
ByVal startPaused As Boolean, _
ByVal enableSoundEffects As Boolean _
) As ISound
+ [C#]
+
public ISound Play2D(
ISoundSource source,
bool playLooped,
bool startPaused,
bool enableSoundEffects
);
+ public ISound Play2D(
ISoundSource source,
bool playLooped,
bool startPaused,
bool enableSoundEffects
);
See Also
++ ISoundEngine Class | IrrKlang Namespace | ISoundEngine.Play2D Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play2D_overload_3.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play2D_overload_3.html
new file mode 100644
index 0000000..530960e
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play2D_overload_3.html
@@ -0,0 +1,54 @@
+
+
+
+
+ loads a sound source (if not loaded already) from a file and plays it.
+
+ [Visual Basic]
+
Overloads Public Function Play2D( _
ByVal soundFilename As String, _
ByVal playLooped As Boolean, _
ByVal startPaused As Boolean _
) As ISound
+
+ Overloads Public Function Play2D( _
ByVal soundFilename As String, _
ByVal playLooped As Boolean, _
ByVal startPaused As Boolean _
) As ISound
See Also
++ ISoundEngine Class | IrrKlang Namespace | ISoundEngine.Play2D Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play2D_overload_4.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play2D_overload_4.html
new file mode 100644
index 0000000..5a57379
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play2D_overload_4.html
@@ -0,0 +1,54 @@
+
+
+
+
+ loads a sound source (if not loaded already) from a file and plays it.
+
+ [Visual Basic]
+
Overloads Public Function Play2D( _
ByVal soundFilename As String, _
ByVal playLooped As Boolean _
) As ISound
+
+ Overloads Public Function Play2D( _
ByVal soundFilename As String, _
ByVal playLooped As Boolean _
) As ISound
See Also
++ ISoundEngine Class | IrrKlang Namespace | ISoundEngine.Play2D Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play2D_overload_5.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play2D_overload_5.html
new file mode 100644
index 0000000..14989c9
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play2D_overload_5.html
@@ -0,0 +1,54 @@
+
+
+
+
+ loads a sound source (if not loaded already) from a file and plays it.
+ + +See Also
++ ISoundEngine Class | IrrKlang Namespace | ISoundEngine.Play2D Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play2D_overload_6.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play2D_overload_6.html
new file mode 100644
index 0000000..419cf7e
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play2D_overload_6.html
@@ -0,0 +1,54 @@
+
+
+
+
+ loads a sound source (if not loaded already) from a file and plays it.
+
+ [Visual Basic]
+
Overloads Public Function Play2D( _
ByVal soundFilename As String, _
ByVal playLooped As Boolean, _
ByVal startPaused As Boolean, _
ByVal streamMode As StreamMode _
) As ISound
+ Overloads Public Function Play2D( _
ByVal soundFilename As String, _
ByVal playLooped As Boolean, _
ByVal startPaused As Boolean, _
ByVal streamMode As StreamMode _
) As ISound
+ [C#]
+
public ISound Play2D(
string soundFilename,
bool playLooped,
bool startPaused,
StreamMode streamMode
);
+ public ISound Play2D(
string soundFilename,
bool playLooped,
bool startPaused,
StreamMode streamMode
);
See Also
++ ISoundEngine Class | IrrKlang Namespace | ISoundEngine.Play2D Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play2D_overloads.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play2D_overloads.html
new file mode 100644
index 0000000..300a453
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play2D_overloads.html
@@ -0,0 +1,65 @@
+
+
+
+
+ loads a sound source (if not loaded already) from a file and plays it.
+
+ [Visual Basic]
+
Overloads Public Function Play2D( _
ByVal soundFilename As String, _
ByVal playLooped As Boolean, _
ByVal startPaused As Boolean, _
ByVal streamMode As StreamMode, _
ByVal enableSoundEffects As Boolean _
) As ISound
+ Overloads Public Function Play2D( _
ByVal soundFilename As String, _
ByVal playLooped As Boolean, _
ByVal startPaused As Boolean, _
ByVal streamMode As StreamMode, _
ByVal enableSoundEffects As Boolean _
) As ISound
+ [C#]
+
public ISound Play2D(
string soundFilename,
bool playLooped,
bool startPaused,
StreamMode streamMode,
bool enableSoundEffects
);
+ public ISound Play2D(
string soundFilename,
bool playLooped,
bool startPaused,
StreamMode streamMode,
bool enableSoundEffects
);
See Also
++ ISoundEngine Class | IrrKlang Namespace | ISoundEngine.Play2D Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play3D_overload_1.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play3D_overload_1.html
new file mode 100644
index 0000000..aa01e1d
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play3D_overload_1.html
@@ -0,0 +1,54 @@
+
+
+
+
+ loads a sound source (if not loaded already) from a file and plays it.
+Overload List
+loads a sound source (if not loaded already) from a file and plays it.
++ public ISound Play2D(ISoundSource,bool,bool,bool); ++
loads a sound source (if not loaded already) from a file and plays it.
++ public ISound Play2D(string); ++
loads a sound source (if not loaded already) from a file and plays it.
++ public ISound Play2D(string,bool); ++
loads a sound source (if not loaded already) from a file and plays it.
++ public ISound Play2D(string,bool,bool); ++
loads a sound source (if not loaded already) from a file and plays it.
++ public ISound Play2D(string,bool,bool,StreamMode); ++
loads a sound source (if not loaded already) from a file and plays it.
++ public ISound Play2D(string,bool,bool,StreamMode,bool); ++
See Also
++ ISoundEngine Class | IrrKlang Namespace
++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play3D_overload_2.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play3D_overload_2.html
new file mode 100644
index 0000000..0e067ab
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play3D_overload_2.html
@@ -0,0 +1,54 @@
+
+
+
+
+ loads a sound source (if not loaded already) from a file and plays it as 3d sound.
+
+ [Visual Basic]
+
Overloads Public Function Play3D( _
ByVal source As ISoundSource, _
ByVal posX As Single, _
ByVal posY As Single, _
ByVal posZ As Single, _
ByVal playLooped As Boolean, _
ByVal startPaused As Boolean, _
ByVal enableSoundEffects As Boolean _
) As ISound
+ Overloads Public Function Play3D( _
ByVal source As ISoundSource, _
ByVal posX As Single, _
ByVal posY As Single, _
ByVal posZ As Single, _
ByVal playLooped As Boolean, _
ByVal startPaused As Boolean, _
ByVal enableSoundEffects As Boolean _
) As ISound
+ [C#]
+
public ISound Play3D(
ISoundSource source,
float posX,
float posY,
float posZ,
bool playLooped,
bool startPaused,
bool enableSoundEffects
);
+ public ISound Play3D(
ISoundSource source,
float posX,
float posY,
float posZ,
bool playLooped,
bool startPaused,
bool enableSoundEffects
);
See Also
++ ISoundEngine Class | IrrKlang Namespace | ISoundEngine.Play3D Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play3D_overload_3.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play3D_overload_3.html
new file mode 100644
index 0000000..79a2441
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play3D_overload_3.html
@@ -0,0 +1,54 @@
+
+
+
+
+ loads a sound source (if not loaded already) from a file and plays it as 3d sound.
+
+ [Visual Basic]
+
Overloads Public Function Play3D( _
ByVal soundFilename As String, _
ByVal posX As Single, _
ByVal posY As Single, _
ByVal posZ As Single _
) As ISound
+
+ Overloads Public Function Play3D( _
ByVal soundFilename As String, _
ByVal posX As Single, _
ByVal posY As Single, _
ByVal posZ As Single _
) As ISound
See Also
++ ISoundEngine Class | IrrKlang Namespace | ISoundEngine.Play3D Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play3D_overload_4.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play3D_overload_4.html
new file mode 100644
index 0000000..2b32665
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play3D_overload_4.html
@@ -0,0 +1,54 @@
+
+
+
+
+ loads a sound source (if not loaded already) from a file and plays it as 3d sound.
+
+ [Visual Basic]
+
Overloads Public Function Play3D( _
ByVal soundFilename As String, _
ByVal posX As Single, _
ByVal posY As Single, _
ByVal posZ As Single, _
ByVal playLooped As Boolean _
) As ISound
+ Overloads Public Function Play3D( _
ByVal soundFilename As String, _
ByVal posX As Single, _
ByVal posY As Single, _
ByVal posZ As Single, _
ByVal playLooped As Boolean _
) As ISound
+ [C#]
+
public ISound Play3D(
string soundFilename,
float posX,
float posY,
float posZ,
bool playLooped
);
+ public ISound Play3D(
string soundFilename,
float posX,
float posY,
float posZ,
bool playLooped
);
See Also
++ ISoundEngine Class | IrrKlang Namespace | ISoundEngine.Play3D Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play3D_overload_5.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play3D_overload_5.html
new file mode 100644
index 0000000..0552002
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play3D_overload_5.html
@@ -0,0 +1,54 @@
+
+
+
+
+ loads a sound source (if not loaded already) from a file and plays it as 3d sound.
+
+ [Visual Basic]
+
Overloads Public Function Play3D( _
ByVal soundFilename As String, _
ByVal posX As Single, _
ByVal posY As Single, _
ByVal posZ As Single, _
ByVal playLooped As Boolean, _
ByVal startPaused As Boolean _
) As ISound
+ Overloads Public Function Play3D( _
ByVal soundFilename As String, _
ByVal posX As Single, _
ByVal posY As Single, _
ByVal posZ As Single, _
ByVal playLooped As Boolean, _
ByVal startPaused As Boolean _
) As ISound
+ [C#]
+
public ISound Play3D(
string soundFilename,
float posX,
float posY,
float posZ,
bool playLooped,
bool startPaused
);
+ public ISound Play3D(
string soundFilename,
float posX,
float posY,
float posZ,
bool playLooped,
bool startPaused
);
See Also
++ ISoundEngine Class | IrrKlang Namespace | ISoundEngine.Play3D Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play3D_overload_6.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play3D_overload_6.html
new file mode 100644
index 0000000..920e7bd
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play3D_overload_6.html
@@ -0,0 +1,54 @@
+
+
+
+
+ loads a sound source (if not loaded already) from a file and plays it as 3d sound.
+
+ [Visual Basic]
+
Overloads Public Function Play3D( _
ByVal soundFilename As String, _
ByVal posX As Single, _
ByVal posY As Single, _
ByVal posZ As Single, _
ByVal playLooped As Boolean, _
ByVal startPaused As Boolean, _
ByVal streamMode As StreamMode _
) As ISound
+ Overloads Public Function Play3D( _
ByVal soundFilename As String, _
ByVal posX As Single, _
ByVal posY As Single, _
ByVal posZ As Single, _
ByVal playLooped As Boolean, _
ByVal startPaused As Boolean, _
ByVal streamMode As StreamMode _
) As ISound
+ [C#]
+
public ISound Play3D(
string soundFilename,
float posX,
float posY,
float posZ,
bool playLooped,
bool startPaused,
StreamMode streamMode
);
+ public ISound Play3D(
string soundFilename,
float posX,
float posY,
float posZ,
bool playLooped,
bool startPaused,
StreamMode streamMode
);
See Also
++ ISoundEngine Class | IrrKlang Namespace | ISoundEngine.Play3D Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play3D_overload_7.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play3D_overload_7.html
new file mode 100644
index 0000000..48b0b6c
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play3D_overload_7.html
@@ -0,0 +1,54 @@
+
+
+
+
+ loads a sound source (if not loaded already) from a file and plays it as 3d sound.
+
+ [Visual Basic]
+
Overloads Public Function Play3D( _
ByVal soundFilename As String, _
ByVal posX As Single, _
ByVal posY As Single, _
ByVal posZ As Single, _
ByVal playLooped As Boolean, _
ByVal startPaused As Boolean, _
ByVal streamMode As StreamMode, _
ByVal enableSoundEffects As Boolean _
) As ISound
+ Overloads Public Function Play3D( _
ByVal soundFilename As String, _
ByVal posX As Single, _
ByVal posY As Single, _
ByVal posZ As Single, _
ByVal playLooped As Boolean, _
ByVal startPaused As Boolean, _
ByVal streamMode As StreamMode, _
ByVal enableSoundEffects As Boolean _
) As ISound
+ [C#]
+
public ISound Play3D(
string soundFilename,
float posX,
float posY,
float posZ,
bool playLooped,
bool startPaused,
StreamMode streamMode,
bool enableSoundEffects
);
+ public ISound Play3D(
string soundFilename,
float posX,
float posY,
float posZ,
bool playLooped,
bool startPaused,
StreamMode streamMode,
bool enableSoundEffects
);
See Also
++ ISoundEngine Class | IrrKlang Namespace | ISoundEngine.Play3D Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play3D_overload_8.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play3D_overload_8.html
new file mode 100644
index 0000000..50fac12
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play3D_overload_8.html
@@ -0,0 +1,54 @@
+
+
+
+
+ loads a sound source (if not loaded already) from a file and plays it as 3d sound.
+
+ [Visual Basic]
+
Overloads Public Function Play3D( _
ByVal soundFilename As String, _
ByVal position As Vector3D, _
ByVal playLooped As Boolean, _
ByVal startPaused As Boolean, _
ByVal streamMode As StreamMode, _
ByVal enableSoundEffects As Boolean _
) As ISound
+ Overloads Public Function Play3D( _
ByVal soundFilename As String, _
ByVal position As Vector3D, _
ByVal playLooped As Boolean, _
ByVal startPaused As Boolean, _
ByVal streamMode As StreamMode, _
ByVal enableSoundEffects As Boolean _
) As ISound
+ [C#]
+
public ISound Play3D(
string soundFilename,
Vector3D position,
bool playLooped,
bool startPaused,
StreamMode streamMode,
bool enableSoundEffects
);
+ public ISound Play3D(
string soundFilename,
Vector3D position,
bool playLooped,
bool startPaused,
StreamMode streamMode,
bool enableSoundEffects
);
See Also
++ ISoundEngine Class | IrrKlang Namespace | ISoundEngine.Play3D Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play3D_overloads.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play3D_overloads.html
new file mode 100644
index 0000000..8e980c0
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Play3D_overloads.html
@@ -0,0 +1,73 @@
+
+
+
+
+ loads a sound source (if not loaded already) from a file and plays it as 3d sound.
+
+ [Visual Basic]
+
Overloads Public Function Play3D( _
ByVal soundFilename As String, _
ByVal position As Vector3D, _
ByVal playLooped As Boolean, _
ByVal startPaused As Boolean, _
ByVal streamMode As StreamMode _
) As ISound
+ Overloads Public Function Play3D( _
ByVal soundFilename As String, _
ByVal position As Vector3D, _
ByVal playLooped As Boolean, _
ByVal startPaused As Boolean, _
ByVal streamMode As StreamMode _
) As ISound
+ [C#]
+
public ISound Play3D(
string soundFilename,
Vector3D position,
bool playLooped,
bool startPaused,
StreamMode streamMode
);
+ public ISound Play3D(
string soundFilename,
Vector3D position,
bool playLooped,
bool startPaused,
StreamMode streamMode
);
See Also
++ ISoundEngine Class | IrrKlang Namespace | ISoundEngine.Play3D Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.RemoveAllSoundSources.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.RemoveAllSoundSources.html
new file mode 100644
index 0000000..df1bec1
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.RemoveAllSoundSources.html
@@ -0,0 +1,54 @@
+
+
+
+
+ loads a sound source (if not loaded already) from a file and plays it as 3d sound.
+Overload List
+loads a sound source (if not loaded already) from a file and plays it as 3d sound.
++ public ISound Play3D(ISoundSource,float,float,float,bool,bool,bool); ++
loads a sound source (if not loaded already) from a file and plays it as 3d sound.
++ public ISound Play3D(string,Vector3D,bool,bool,StreamMode); ++
loads a sound source (if not loaded already) from a file and plays it as 3d sound.
++ public ISound Play3D(string,Vector3D,bool,bool,StreamMode,bool); ++
loads a sound source (if not loaded already) from a file and plays it as 3d sound.
++ public ISound Play3D(string,float,float,float); ++
loads a sound source (if not loaded already) from a file and plays it as 3d sound.
++ public ISound Play3D(string,float,float,float,bool); ++
loads a sound source (if not loaded already) from a file and plays it as 3d sound.
++ public ISound Play3D(string,float,float,float,bool,bool); ++
loads a sound source (if not loaded already) from a file and plays it as 3d sound.
++ public ISound Play3D(string,float,float,float,bool,bool,StreamMode); ++
loads a sound source (if not loaded already) from a file and plays it as 3d sound.
++ public ISound Play3D(string,float,float,float,bool,bool,StreamMode,bool); ++
See Also
++ ISoundEngine Class | IrrKlang Namespace
++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.RemoveSoundSource.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.RemoveSoundSource.html
new file mode 100644
index 0000000..a9ba245
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.RemoveSoundSource.html
@@ -0,0 +1,54 @@
+
+
+
+
+ Removes all sound sources from the engine. This will also cause all sounds to be stopped. Removing sound sources is only necessary if you know you won't use a lot of non-streamed sounds again. Sound sources of streamed sounds do not cost a lot of memory.
+
+ [Visual Basic]
+
Public Sub RemoveAllSoundSources()
+
+ Public Sub RemoveAllSoundSources()
See Also
++ ISoundEngine Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.SetAllSoundsPaused.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.SetAllSoundsPaused.html
new file mode 100644
index 0000000..affcc39
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.SetAllSoundsPaused.html
@@ -0,0 +1,54 @@
+
+
+
+
+ Removes a sound source from the engine, freeing the memory it occupies. This will also cause all currently playing sounds of this source to be stopped. Also note that if the source has been removed successfully, the value returned by getSoundSourceCount() will have been decreased by one. Removing sound sources is only necessary if you know you won't use a lot of non-streamed sounds again. Sound sources of streamed sounds do not cost a lot of memory.
+ + +See Also
++ ISoundEngine Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.SetDopplerEffectParameters.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.SetDopplerEffectParameters.html
new file mode 100644
index 0000000..c7dd158
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.SetDopplerEffectParameters.html
@@ -0,0 +1,54 @@
+
+
+
+
+ pauses or unpauses all currently playing sounds
+ + +See Also
++ ISoundEngine Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.SetListenerPosition_overload_1.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.SetListenerPosition_overload_1.html
new file mode 100644
index 0000000..13364dc
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.SetListenerPosition_overload_1.html
@@ -0,0 +1,54 @@
+
+
+
+
+ Sets parameters affecting the doppler effect.
+
+ [Visual Basic]
+
Public Sub SetDopplerEffectParameters( _
ByVal dopplerFactor As Single, _
ByVal distanceFactor As Single _
)
+
+ Public Sub SetDopplerEffectParameters( _
ByVal dopplerFactor As Single, _
ByVal distanceFactor As Single _
)
See Also
++ ISoundEngine Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.SetListenerPosition_overload_2.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.SetListenerPosition_overload_2.html
new file mode 100644
index 0000000..11c9cef
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.SetListenerPosition_overload_2.html
@@ -0,0 +1,54 @@
+
+
+
+
+ Sets the current listener 3d position. This method is being called by the scene manager automaticly if you are using one, so you might want to ignore this.
+
+ [Visual Basic]
+
Overloads Public Sub SetListenerPosition( _
ByVal posX As Single, _
ByVal posY As Single, _
ByVal posZ As Single, _
ByVal lookDirX As Single, _
ByVal lookDirY As Single, _
ByVal lookDirZ As Single _
)
+ Overloads Public Sub SetListenerPosition( _
ByVal posX As Single, _
ByVal posY As Single, _
ByVal posZ As Single, _
ByVal lookDirX As Single, _
ByVal lookDirY As Single, _
ByVal lookDirZ As Single _
)
+ [C#]
+
public void SetListenerPosition(
float posX,
float posY,
float posZ,
float lookDirX,
float lookDirY,
float lookDirZ
);
+ public void SetListenerPosition(
float posX,
float posY,
float posZ,
float lookDirX,
float lookDirY,
float lookDirZ
);
See Also
++ ISoundEngine Class | IrrKlang Namespace | ISoundEngine.SetListenerPosition Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.SetListenerPosition_overload_3.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.SetListenerPosition_overload_3.html
new file mode 100644
index 0000000..0b1ded5
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.SetListenerPosition_overload_3.html
@@ -0,0 +1,54 @@
+
+
+
+
+ Sets the current listener 3d position. This method is being called by the scene manager automaticly if you are using one, so you might want to ignore this.
+
+ [Visual Basic]
+
Overloads Public Sub SetListenerPosition( _
ByVal posX As Single, _
ByVal posY As Single, _
ByVal posZ As Single, _
ByVal lookDirX As Single, _
ByVal lookDirY As Single, _
ByVal lookDirZ As Single, _
ByVal velPerSecondX As Single, _
ByVal velPerSecondY As Single, _
ByVal velPerSecondZ As Single, _
ByVal upVectorX As Single, _
ByVal upVectorY As Single, _
ByVal upVectorZ As Single _
)
+ Overloads Public Sub SetListenerPosition( _
ByVal posX As Single, _
ByVal posY As Single, _
ByVal posZ As Single, _
ByVal lookDirX As Single, _
ByVal lookDirY As Single, _
ByVal lookDirZ As Single, _
ByVal velPerSecondX As Single, _
ByVal velPerSecondY As Single, _
ByVal velPerSecondZ As Single, _
ByVal upVectorX As Single, _
ByVal upVectorY As Single, _
ByVal upVectorZ As Single _
)
+ [C#]
+
public void SetListenerPosition(
float posX,
float posY,
float posZ,
float lookDirX,
float lookDirY,
float lookDirZ,
float velPerSecondX,
float velPerSecondY,
float velPerSecondZ,
float upVectorX,
float upVectorY,
float upVectorZ
);
+ public void SetListenerPosition(
float posX,
float posY,
float posZ,
float lookDirX,
float lookDirY,
float lookDirZ,
float velPerSecondX,
float velPerSecondY,
float velPerSecondZ,
float upVectorX,
float upVectorY,
float upVectorZ
);
See Also
++ ISoundEngine Class | IrrKlang Namespace | ISoundEngine.SetListenerPosition Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.SetListenerPosition_overload_4.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.SetListenerPosition_overload_4.html
new file mode 100644
index 0000000..de962f7
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.SetListenerPosition_overload_4.html
@@ -0,0 +1,54 @@
+
+
+
+
+ Sets the current listener 3d position. This method is being called by the scene manager automaticly if you are using one, so you might want to ignore this.
+
+ [Visual Basic]
+
Overloads Public Sub SetListenerPosition( _
ByVal pos As Vector3D, _
ByVal lookdir As Vector3D _
)
+
+ Overloads Public Sub SetListenerPosition( _
ByVal pos As Vector3D, _
ByVal lookdir As Vector3D _
)
See Also
++ ISoundEngine Class | IrrKlang Namespace | ISoundEngine.SetListenerPosition Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.SetListenerPosition_overloads.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.SetListenerPosition_overloads.html
new file mode 100644
index 0000000..989fffb
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.SetListenerPosition_overloads.html
@@ -0,0 +1,57 @@
+
+
+
+
+ Sets the current listener 3d position. This method is being called by the scene manager automaticly if you are using one, so you might want to ignore this.
+
+ [Visual Basic]
+
Overloads Public Sub SetListenerPosition( _
ByVal pos As Vector3D, _
ByVal lookdir As Vector3D, _
ByVal velPerSecond As Vector3D, _
ByVal upVector As Vector3D _
)
+ Overloads Public Sub SetListenerPosition( _
ByVal pos As Vector3D, _
ByVal lookdir As Vector3D, _
ByVal velPerSecond As Vector3D, _
ByVal upVector As Vector3D _
)
+ [C#]
+
public void SetListenerPosition(
Vector3D pos,
Vector3D lookdir,
Vector3D velPerSecond,
Vector3D upVector
);
+ public void SetListenerPosition(
Vector3D pos,
Vector3D lookdir,
Vector3D velPerSecond,
Vector3D upVector
);
See Also
++ ISoundEngine Class | IrrKlang Namespace | ISoundEngine.SetListenerPosition Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.SetRolloffFactor.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.SetRolloffFactor.html
new file mode 100644
index 0000000..a65faa8
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.SetRolloffFactor.html
@@ -0,0 +1,61 @@
+
+
+
+
+ Sets the current listener 3d position. This method is being called by the scene manager automaticly if you are using one, so you might want to ignore this.
+Overload List
+Sets the current listener 3d position. This method is being called by the scene manager automaticly if you are using one, so you might want to ignore this.
++ public void SetListenerPosition(Vector3D,Vector3D); ++
Sets the current listener 3d position. This method is being called by the scene manager automaticly if you are using one, so you might want to ignore this.
++ public void SetListenerPosition(Vector3D,Vector3D,Vector3D,Vector3D); ++
Sets the current listener 3d position. This method is being called by the scene manager automaticly if you are using one, so you might want to ignore this.
++ public void SetListenerPosition(float,float,float,float,float,float); ++
Sets the current listener 3d position. This method is being called by the scene manager automaticly if you are using one, so you might want to ignore this.
++ public void SetListenerPosition(float,float,float,float,float,float,float,float,float,float,float,float); ++
See Also
++ ISoundEngine Class | IrrKlang Namespace
++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.SoundVolume.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.SoundVolume.html
new file mode 100644
index 0000000..dc9823f
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.SoundVolume.html
@@ -0,0 +1,56 @@
+
+
+
+
+ Sets the roll off factor for 3d sounds.
+ + +Parameters
+-
+
- + rolloffFactor + +
- The rolloff factor can range from 0.0 to 10.0, where 0 is no rolloff. 1.0 is the default rolloff factor set, the value which we also experience in the real world. A value of 2 would mean twice the real-world rolloff. +
See Also
++ ISoundEngine Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.StopAllSounds.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.StopAllSounds.html
new file mode 100644
index 0000000..48fa736
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.StopAllSounds.html
@@ -0,0 +1,54 @@
+
+
+
+
+ sets sound volume. This value is multiplied with all sounds played. Volume set to 0 is silent and 1.0f is full volume.
+ + ++
+See Also
++ ISoundEngine Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Update.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Update.html
new file mode 100644
index 0000000..4734a58
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.Update.html
@@ -0,0 +1,54 @@
+
+
+
+
+ stops all currently playing sounds
+
+ [Visual Basic]
+
Public Sub StopAllSounds()
+
+ Public Sub StopAllSounds()
See Also
++ ISoundEngine Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.html
new file mode 100644
index 0000000..4bcd663
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.html
@@ -0,0 +1,68 @@
+
+
+
+
+ Updates the audio engine. This should be called several times per frame if irrKlang was started in single thread mode. This updates the 3d positions of the sounds as well as their volumes, effects streams and other stuff. Call this several times per frame (the more the better) if you specified irrKlang to run single threaded. Otherwise it is not necessary to use this method. This method is being called by the scene manager automaticly if you are using one, so you might want to ignore this.
+
+ [Visual Basic]
+
Public Sub Update()
+
+ Public Sub Update()
See Also
++ ISoundEngine Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.internalGetNativeEngine.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.internalGetNativeEngine.html
new file mode 100644
index 0000000..150696d
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngine.internalGetNativeEngine.html
@@ -0,0 +1,55 @@
+
+
+
+
+ +
+For a list of all members of this type, see ISoundEngine Members.
+
+ System.Object
+
IrrKlang.ISoundEngine
+ [Visual Basic]
+
Public Class ISoundEngine
+ Public Class ISoundEngine
+ [C#]
+
+ public class ISoundEngine
+ Thread Safety
+Public static (Shared in Visual Basic) members of this type are + safe for multithreaded operations. Instance members are not guaranteed to be + thread-safe.
+Requirements
++ Namespace: + IrrKlang +
++ Assembly: irrKlang.NET (in irrKlang.NET.dll) +
+See Also
++ ISoundEngine Members | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngineConstructor1.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngineConstructor1.html
new file mode 100644
index 0000000..99e94b7
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngineConstructor1.html
@@ -0,0 +1,47 @@
+
+
+
+
+ +
+Overload List
+Initializes a new instance of the ISoundEngine class.
++ public ISoundEngine(); ++
+
+ public ISoundEngine(SoundOutputDriver); ++
+
+ public ISoundEngine(SoundOutputDriver,SoundEngineOptionFlag); ++
+
+ public ISoundEngine(SoundOutputDriver,SoundEngineOptionFlag,string); ++
See Also
++ ISoundEngine Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngineConstructor2.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngineConstructor2.html
new file mode 100644
index 0000000..376ec49
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngineConstructor2.html
@@ -0,0 +1,47 @@
+
+
+
+
+ +
+
+ [Visual Basic]
+
Overloads Public Sub New( _
ByVal driver As SoundOutputDriver, _
ByVal options As SoundEngineOptionFlag, _
ByVal deviceID As String _
)
+ Overloads Public Sub New( _
ByVal driver As SoundOutputDriver, _
ByVal options As SoundEngineOptionFlag, _
ByVal deviceID As String _
)
+ [C#]
+
public ISoundEngine(
SoundOutputDriver driver,
SoundEngineOptionFlag options,
string deviceID
);
+ public ISoundEngine(
SoundOutputDriver driver,
SoundEngineOptionFlag options,
string deviceID
);
See Also
++ ISoundEngine Class | IrrKlang Namespace | ISoundEngine Constructor Overload List
++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngineConstructor3.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngineConstructor3.html
new file mode 100644
index 0000000..d01c522
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngineConstructor3.html
@@ -0,0 +1,47 @@
+
+
+
+
+ +
+
+ [Visual Basic]
+
Overloads Public Sub New( _
ByVal driver As SoundOutputDriver, _
ByVal options As SoundEngineOptionFlag _
)
+
+ Overloads Public Sub New( _
ByVal driver As SoundOutputDriver, _
ByVal options As SoundEngineOptionFlag _
)
See Also
++ ISoundEngine Class | IrrKlang Namespace | ISoundEngine Constructor Overload List
++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngineConstructor4.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngineConstructor4.html
new file mode 100644
index 0000000..4bb2257
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngineConstructor4.html
@@ -0,0 +1,46 @@
+
+
+
+
+ +
+ + +See Also
++ ISoundEngine Class | IrrKlang Namespace | ISoundEngine Constructor Overload List
++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngineMembers.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngineMembers.html
new file mode 100644
index 0000000..ca401d9
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngineMembers.html
@@ -0,0 +1,116 @@
+
+
+
+
+ Initializes a new instance of the ISoundEngine class.
+
+ [Visual Basic]
+
Overloads Public Sub New()
+ Overloads Public Sub New()
+ [C#]
+
public ISoundEngine();
+ public ISoundEngine();
See Also
++ ISoundEngine Class | IrrKlang Namespace | ISoundEngine Constructor Overload List
++ +
+
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngineMethods.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngineMethods.html
new file mode 100644
index 0000000..40007b4
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngineMethods.html
@@ -0,0 +1,88 @@
+
+
+
+
+ Public Instance Constructors
+
+
+
+
+ |
+
+ ISoundEngine
+ |
+ Overloaded. Initializes a new instance of the ISoundEngine class. | +
Public Instance Properties
+
+
+
+
+ | Default3DSoundMaxDistance | Sets or gets the default maximal distance for 3D sounds. This value influences how loud a sound is heard based on its distance. See ISound::setMaxDistance() for details about what the max distance is. It is also possible to influence this default value for every sound file using ISoundSource::setDefaultMaxDistance(). This method only influences the initial distance value of sounds. For changing the distance after the sound has been started to play, use ISound::setMaxDistance() and ISound::setMaxDistance(). |
| Default3DSoundMinDistance | Sets or gets the default minimal distance for 3D sounds. This value influences how loud a sound is heard based on its distance. See ISound::setMinDistance() for details about what the min distance is. It is also possible to influence this default value for every sound file using ISoundSource::setDefaultMinDistance(). This method only influences the initial distance value of sounds. For changing the distance after the sound has been started to play, use ISound::setMinDistance() and ISound::setMaxDistance(). |
| IsMultiThreaded | Returns if irrKlang is running in the same thread as the application or is using multithreading. This basicly returns the flag set by the user when creating the sound engine. |
| Name | Returns the name of the audio driver. |
| SoundVolume | sets sound volume. This value is multiplied with all sounds played. Volume set to 0 is silent and 1.0f is full volume. |
Public Instance Methods
+
+
+
+
+ | AddFileFactory | Adds a file factory to the sound engine, making it possible to override file access of the sound engine. Derive your own class from IFileFactory, overwrite the openFile() method and return your own implemented System::IO::Stream to overwrite file access of irrKlang. |
| AddSoundSourceAlias | Adds a sound source as alias for an existing sound source, but with a different name or optional different default settings. This is useful if you want to play multiple sounds but each sound isn't necessarily one single file. Also useful if you want to or play the same sound using different names, volumes or min and max 3D distances. |
| AddSoundSourceFromFile | Overloaded. Adds sound source into the sound engine as file. |
| AddSoundSourceFromIOStream | Adds a sound source into the sound engine from a IOStream. Note that the stream is totally read into memory when adding the sound source. If you want irrKlang to dynamically open and close custom file streams without loading everything into memory, use the addFileFactory with your own IFileFactory implementation. |
| AddSoundSourceFromMemory | |
| AddSoundSourceFromPCMData | |
| Equals (inherited from Object) | + Determines whether the specified Object is equal to the current Object. + |
| GetHashCode (inherited from Object) | + Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table. + |
| GetSoundSource | Overloaded. |
| GetType (inherited from Object) | + Gets the Type of the current instance. + |
| internalGetNativeEngine | |
| IsCurrentlyPlaying | Returns if a sound with the specified name is currently playing |
| LoadPlugins | |
| Play2D | Overloaded. loads a sound source (if not loaded already) from a file and plays it. |
| Play3D | Overloaded. loads a sound source (if not loaded already) from a file and plays it as 3d sound. |
| RemoveAllSoundSources | Removes all sound sources from the engine. This will also cause all sounds to be stopped. Removing sound sources is only necessary if you know you won't use a lot of non-streamed sounds again. Sound sources of streamed sounds do not cost a lot of memory. |
| RemoveSoundSource | Removes a sound source from the engine, freeing the memory it occupies. This will also cause all currently playing sounds of this source to be stopped. Also note that if the source has been removed successfully, the value returned by getSoundSourceCount() will have been decreased by one. Removing sound sources is only necessary if you know you won't use a lot of non-streamed sounds again. Sound sources of streamed sounds do not cost a lot of memory. |
| SetAllSoundsPaused | pauses or unpauses all currently playing sounds |
| SetDopplerEffectParameters | Sets parameters affecting the doppler effect. |
| SetListenerPosition | Overloaded. Sets the current listener 3d position. This method is being called by the scene manager automaticly if you are using one, so you might want to ignore this. |
| SetRolloffFactor | Sets the roll off factor for 3d sounds. |
| StopAllSounds | stops all currently playing sounds |
| ToString (inherited from Object) | + Returns a String that represents the current Object. + |
| Update | Updates the audio engine. This should be called several times per frame if irrKlang was started in single thread mode. This updates the 3d positions of the sounds as well as their volumes, effects streams and other stuff. Call this several times per frame (the more the better) if you specified irrKlang to run single threaded. Otherwise it is not necessary to use this method. This method is being called by the scene manager automaticly if you are using one, so you might want to ignore this. |
Protected Instance Methods
+
+
+
+
+ | Finalize | Destructor |
| MemberwiseClone (inherited from Object) | + Creates a shallow copy of the current Object. + |
See Also
++ ISoundEngine Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngineProperties.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngineProperties.html
new file mode 100644
index 0000000..1b8e35b
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundEngineProperties.html
@@ -0,0 +1,53 @@
+
+
+
+
+ The methods of the ISoundEngine class are listed below. For a complete list of ISoundEngine class members, see the ISoundEngine Members topic.
+Public Instance Methods
+
+
+
+
+ | AddFileFactory | Adds a file factory to the sound engine, making it possible to override file access of the sound engine. Derive your own class from IFileFactory, overwrite the openFile() method and return your own implemented System::IO::Stream to overwrite file access of irrKlang. |
| AddSoundSourceAlias | Adds a sound source as alias for an existing sound source, but with a different name or optional different default settings. This is useful if you want to play multiple sounds but each sound isn't necessarily one single file. Also useful if you want to or play the same sound using different names, volumes or min and max 3D distances. |
| AddSoundSourceFromFile | Overloaded. Adds sound source into the sound engine as file. |
| AddSoundSourceFromIOStream | Adds a sound source into the sound engine from a IOStream. Note that the stream is totally read into memory when adding the sound source. If you want irrKlang to dynamically open and close custom file streams without loading everything into memory, use the addFileFactory with your own IFileFactory implementation. |
| AddSoundSourceFromMemory | |
| AddSoundSourceFromPCMData | |
| Equals (inherited from Object) | + Determines whether the specified Object is equal to the current Object. + |
| GetHashCode (inherited from Object) | + Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table. + |
| GetSoundSource | Overloaded. |
| GetType (inherited from Object) | + Gets the Type of the current instance. + |
| internalGetNativeEngine | |
| IsCurrentlyPlaying | Returns if a sound with the specified name is currently playing |
| LoadPlugins | |
| Play2D | Overloaded. loads a sound source (if not loaded already) from a file and plays it. |
| Play3D | Overloaded. loads a sound source (if not loaded already) from a file and plays it as 3d sound. |
| RemoveAllSoundSources | Removes all sound sources from the engine. This will also cause all sounds to be stopped. Removing sound sources is only necessary if you know you won't use a lot of non-streamed sounds again. Sound sources of streamed sounds do not cost a lot of memory. |
| RemoveSoundSource | Removes a sound source from the engine, freeing the memory it occupies. This will also cause all currently playing sounds of this source to be stopped. Also note that if the source has been removed successfully, the value returned by getSoundSourceCount() will have been decreased by one. Removing sound sources is only necessary if you know you won't use a lot of non-streamed sounds again. Sound sources of streamed sounds do not cost a lot of memory. |
| SetAllSoundsPaused | pauses or unpauses all currently playing sounds |
| SetDopplerEffectParameters | Sets parameters affecting the doppler effect. |
| SetListenerPosition | Overloaded. Sets the current listener 3d position. This method is being called by the scene manager automaticly if you are using one, so you might want to ignore this. |
| SetRolloffFactor | Sets the roll off factor for 3d sounds. |
| StopAllSounds | stops all currently playing sounds |
| ToString (inherited from Object) | + Returns a String that represents the current Object. + |
| Update | Updates the audio engine. This should be called several times per frame if irrKlang was started in single thread mode. This updates the 3d positions of the sounds as well as their volumes, effects streams and other stuff. Call this several times per frame (the more the better) if you specified irrKlang to run single threaded. Otherwise it is not necessary to use this method. This method is being called by the scene manager automaticly if you are using one, so you might want to ignore this. |
Protected Instance Methods
+
+
+
+
+ | Finalize | Destructor |
| MemberwiseClone (inherited from Object) | + Creates a shallow copy of the current Object. + |
See Also
++ ISoundEngine Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundMembers.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundMembers.html
new file mode 100644
index 0000000..34bb8ba
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundMembers.html
@@ -0,0 +1,108 @@
+
+
+
+
+ The properties of the ISoundEngine class are listed below. For a complete list of ISoundEngine class members, see the ISoundEngine Members topic.
+Public Instance Properties
+
+
+
+
+ | Default3DSoundMaxDistance | Sets or gets the default maximal distance for 3D sounds. This value influences how loud a sound is heard based on its distance. See ISound::setMaxDistance() for details about what the max distance is. It is also possible to influence this default value for every sound file using ISoundSource::setDefaultMaxDistance(). This method only influences the initial distance value of sounds. For changing the distance after the sound has been started to play, use ISound::setMaxDistance() and ISound::setMaxDistance(). |
| Default3DSoundMinDistance | Sets or gets the default minimal distance for 3D sounds. This value influences how loud a sound is heard based on its distance. See ISound::setMinDistance() for details about what the min distance is. It is also possible to influence this default value for every sound file using ISoundSource::setDefaultMinDistance(). This method only influences the initial distance value of sounds. For changing the distance after the sound has been started to play, use ISound::setMinDistance() and ISound::setMaxDistance(). |
| IsMultiThreaded | Returns if irrKlang is running in the same thread as the application or is using multithreading. This basicly returns the flag set by the user when creating the sound engine. |
| Name | Returns the name of the audio driver. |
| SoundVolume | sets sound volume. This value is multiplied with all sounds played. Volume set to 0 is silent and 1.0f is full volume. |
See Also
++ ISoundEngine Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundMethods.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundMethods.html
new file mode 100644
index 0000000..8501b5d
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundMethods.html
@@ -0,0 +1,71 @@
+
+
+
+
+ + ISound overview +
+Public Instance Constructors
+
+
+
+
+ |
+
+ ISound Constructor
+ |
+ + | +
Public Instance Properties
+
+
+
+
+ | Finished | returns if the sound has finished playing. Don't mix this up with isPaused(). isFinished() returns if the sound has been finished playing. If it has, is maybe already have been removed from the playing list of the sound engine and calls to any other of the methods of ISound will not have any result. If you call stop() to a playing sound will result that this function will return true when invoked. |
| Looped | gets or sets if the sound has been started to play looped. If the sound is playing looped and it is changed to not-looped, then it will stop playing after the loop has finished. If it is not looped and changed to looped, the sound will start repeating to be played when it reaches its end. Invoking this method will not have an effect when the sound already has stopped. |
| MaxDistance | Sets the maximal distance if this is a 3D sound. Specify the distances at which 3D sounds stop getting louder or quieter. This works like this: As a listener approaches a 3D sound source, the sound gets louder. Past a certain point, it is not reasonable for the volume to continue to increase. Either the maximum (zero) has been reached, or the nature of the sound source imposes a logical limit. This is the minimum distance for the sound source. Similarly, the maximum distance for a sound source is the distance beyond which the sound does not get any quieter. The default minimum distance is 1, the default max distance is a huge number nearly to infinite. |
| MinDistance | Sets the minimal distance if this is a 3D sound. Specify the distances at which 3D sounds stop getting louder or quieter. This works like this: As a listener approaches a 3D sound source, the sound gets louder. Past a certain point, it is not reasonable for the volume to continue to increase. Either the maximum (zero) has been reached, or the nature of the sound source imposes a logical limit. This is the minimum distance for the sound source. Similarly, the maximum distance for a sound source is the distance beyond which the sound does not get any quieter. The default minimum distance is 1, the default max distance is a huge number nearly to infinite. |
| Pan | sets the pan of the sound. Takes a value between -1 and 1, 0 is center. |
| Paused | returns if the sound is paused |
| PlaybackSpeed | Sets or gets the playback speed (frequency) of the sound. Plays the sound at a higher or lower speed, increasing or decreasing its frequency which makes it sound lower or higher. Note that this feature is not available on all sound output drivers (it is on the DirectSound drivers at least), and it does not work together with the 'enableSoundEffects' parameter of ISoundEngine::play2D and ISoundEngine::play3D when using DirectSound. |
| PlayLength | Returns the play length of the sound in milliseconds. Returns -1 if not known for this sound for example because its decoder does not support length reporting or it is a file stream of unknown size. Note: You can also use ISoundSource::getPlayLength() to get the length of a sound without actually needing to play it. |
| PlayPosition | returns or sets the current play position of the sound in milliseconds. Returns -1 if not implemented or possible for this sound for example because it already has been stopped and freed internally or similar. |
| Position | sets the position of the sound in 3d space |
| SoundEffectControl | Returns the sound effect control interface for this sound. Sound effects such as Chorus, Distorsions, Echo, Reverb and similar can be controlled using this. This can be null if the sound has not been started with the flag 'enableSoundEffects' or the driver doesn't support effects. |
| Velocity | sets or returns the velocity of the sound in 3d space, needed for Doppler effects. To use doppler effects use ISound::setVelocity to set a sounds velocity, ISoundEngine::setListenerPosition() to set the listeners velocity and ISoundEngine::setDopplerEffectParameters() to adjust two parameters influencing the doppler effects intensity. |
| Volume | returns volume of the sound, a value between 0 (mute) and 1 (full volume). (this volume gets multiplied with the master volume of the sound engine and other parameters like distance to listener when played as 3d sound) |
Public Instance Methods
+
+
+
+
+ | Dispose | |
| Equals (inherited from Object) | + Determines whether the specified Object is equal to the current Object. + |
| GetHashCode (inherited from Object) | + Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table. + |
| GetType (inherited from Object) | + Gets the Type of the current instance. + |
| setSoundStopEventReceiver | Overloaded. Sets the sound stop event receiver, an interface which gets called if a sound has finished playing. |
| Stop | |
| ToString (inherited from Object) | + Returns a String that represents the current Object. + |
Protected Instance Methods
+
+
+
+
+ | Finalize | Destructor |
| MemberwiseClone (inherited from Object) | + Creates a shallow copy of the current Object. + |
See Also
++ ISound Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundProperties.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundProperties.html
new file mode 100644
index 0000000..643c308
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundProperties.html
@@ -0,0 +1,61 @@
+
+
+
+
+ The methods of the ISound class are listed below. For a complete list of ISound class members, see the ISound Members topic.
+Public Instance Methods
+
+
+
+
+ | Dispose | |
| Equals (inherited from Object) | + Determines whether the specified Object is equal to the current Object. + |
| GetHashCode (inherited from Object) | + Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table. + |
| GetType (inherited from Object) | + Gets the Type of the current instance. + |
| setSoundStopEventReceiver | Overloaded. Sets the sound stop event receiver, an interface which gets called if a sound has finished playing. |
| Stop | |
| ToString (inherited from Object) | + Returns a String that represents the current Object. + |
Protected Instance Methods
+
+
+
+
+ | Finalize | Destructor |
| MemberwiseClone (inherited from Object) | + Creates a shallow copy of the current Object. + |
See Also
++ ISound Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSource.AudioFormat.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSource.AudioFormat.html
new file mode 100644
index 0000000..f7a9fef
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSource.AudioFormat.html
@@ -0,0 +1,56 @@
+
+
+
+
+ The properties of the ISound class are listed below. For a complete list of ISound class members, see the ISound Members topic.
+Public Instance Properties
+
+
+
+
+ | Finished | returns if the sound has finished playing. Don't mix this up with isPaused(). isFinished() returns if the sound has been finished playing. If it has, is maybe already have been removed from the playing list of the sound engine and calls to any other of the methods of ISound will not have any result. If you call stop() to a playing sound will result that this function will return true when invoked. |
| Looped | gets or sets if the sound has been started to play looped. If the sound is playing looped and it is changed to not-looped, then it will stop playing after the loop has finished. If it is not looped and changed to looped, the sound will start repeating to be played when it reaches its end. Invoking this method will not have an effect when the sound already has stopped. |
| MaxDistance | Sets the maximal distance if this is a 3D sound. Specify the distances at which 3D sounds stop getting louder or quieter. This works like this: As a listener approaches a 3D sound source, the sound gets louder. Past a certain point, it is not reasonable for the volume to continue to increase. Either the maximum (zero) has been reached, or the nature of the sound source imposes a logical limit. This is the minimum distance for the sound source. Similarly, the maximum distance for a sound source is the distance beyond which the sound does not get any quieter. The default minimum distance is 1, the default max distance is a huge number nearly to infinite. |
| MinDistance | Sets the minimal distance if this is a 3D sound. Specify the distances at which 3D sounds stop getting louder or quieter. This works like this: As a listener approaches a 3D sound source, the sound gets louder. Past a certain point, it is not reasonable for the volume to continue to increase. Either the maximum (zero) has been reached, or the nature of the sound source imposes a logical limit. This is the minimum distance for the sound source. Similarly, the maximum distance for a sound source is the distance beyond which the sound does not get any quieter. The default minimum distance is 1, the default max distance is a huge number nearly to infinite. |
| Pan | sets the pan of the sound. Takes a value between -1 and 1, 0 is center. |
| Paused | returns if the sound is paused |
| PlaybackSpeed | Sets or gets the playback speed (frequency) of the sound. Plays the sound at a higher or lower speed, increasing or decreasing its frequency which makes it sound lower or higher. Note that this feature is not available on all sound output drivers (it is on the DirectSound drivers at least), and it does not work together with the 'enableSoundEffects' parameter of ISoundEngine::play2D and ISoundEngine::play3D when using DirectSound. |
| PlayLength | Returns the play length of the sound in milliseconds. Returns -1 if not known for this sound for example because its decoder does not support length reporting or it is a file stream of unknown size. Note: You can also use ISoundSource::getPlayLength() to get the length of a sound without actually needing to play it. |
| PlayPosition | returns or sets the current play position of the sound in milliseconds. Returns -1 if not implemented or possible for this sound for example because it already has been stopped and freed internally or similar. |
| Position | sets the position of the sound in 3d space |
| SoundEffectControl | Returns the sound effect control interface for this sound. Sound effects such as Chorus, Distorsions, Echo, Reverb and similar can be controlled using this. This can be null if the sound has not been started with the flag 'enableSoundEffects' or the driver doesn't support effects. |
| Velocity | sets or returns the velocity of the sound in 3d space, needed for Doppler effects. To use doppler effects use ISound::setVelocity to set a sounds velocity, ISoundEngine::setListenerPosition() to set the listeners velocity and ISoundEngine::setDopplerEffectParameters() to adjust two parameters influencing the doppler effects intensity. |
| Volume | returns volume of the sound, a value between 0 (mute) and 1 (full volume). (this volume gets multiplied with the master volume of the sound engine and other parameters like distance to listener when played as 3d sound) |
See Also
++ ISound Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSource.DefaultMaxDistance.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSource.DefaultMaxDistance.html
new file mode 100644
index 0000000..9146c9e
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSource.DefaultMaxDistance.html
@@ -0,0 +1,56 @@
+
+
+
+
+ Returns informations about the sound source: channel count (mono/stereo), frame count, sample rate, etc. Returns the structure filled with 0 or negative values if not known for this sound for example because because the file could not be opened or similar. Note: If the sound never has been played before, the sound engine will have to open the file and try to get the play lenght from there, so this call could take a bit depending on the type of file.
+ + ++
+See Also
++ ISoundSource Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSource.DefaultMinDistance.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSource.DefaultMinDistance.html
new file mode 100644
index 0000000..bc3926d
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSource.DefaultMinDistance.html
@@ -0,0 +1,56 @@
+
+
+
+
+ Sets or gets the default maximal distance for 3D sounds played from this source. This value influences how loud a sound is heard based on its distance. See ISound::setMaxDistance() for details about what the max distance is. This method only influences the initial distance value of sounds. For changing the distance after the sound has been started to play, use ISound::setMaxDistance() and ISound::setMaxDistance().
+ + ++
+See Also
++ ISoundSource Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSource.DefaultVolume.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSource.DefaultVolume.html
new file mode 100644
index 0000000..4684787
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSource.DefaultVolume.html
@@ -0,0 +1,56 @@
+
+
+
+
+ Sets or gets the default minimal distance for 3D sounds played from this source. This value influences how loud a sound is heard based on its distance. See ISound::setMinDistance() for details about what the min distance is. This method only influences the initial distance value of sounds. For changing the distance after the sound has been started to play, use ISound::setMinDistance() and ISound::setMaxDistance().
+ + ++
+See Also
++ ISoundSource Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSource.Dispose.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSource.Dispose.html
new file mode 100644
index 0000000..08331ac
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSource.Dispose.html
@@ -0,0 +1,59 @@
+
+
+
+
+ Sets or gets the default volume for a sound played from this source. The default value of this is 1.0f. Note that the default volume is being multiplied with the master volume of ISoundEngine, change this via ISoundEngine::setSoundVolume(). The volume is a value between 0 (silent) and 1.0f (full volume).
+ + ++
+See Also
++ ISoundSource Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSource.ForceReloadAtNextUse.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSource.ForceReloadAtNextUse.html
new file mode 100644
index 0000000..c02ebaf
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSource.ForceReloadAtNextUse.html
@@ -0,0 +1,54 @@
+
+
+
+
+ Destructor
+
+ [Visual Basic]
+
Overrides Protected Sub Finalize()
+
+ Overrides Protected Sub Finalize()
See Also
++ ISoundSource Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSource.ForcedStreamingThreshold.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSource.ForcedStreamingThreshold.html
new file mode 100644
index 0000000..691cc22
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSource.ForcedStreamingThreshold.html
@@ -0,0 +1,57 @@
+
+
+
+
+ Forces the sound to be reloaded at next replay. Sounds which are not played as streams are buffered to make it possible to replay them without much overhead. If the sound file is altered after the sound has been played the first time, the engine won't play the changed file then. Calling this method makes the engine reload the file before the file is played the next time.
+
+ [Visual Basic]
+
Public Sub ForceReloadAtNextUse()
+
+ Public Sub ForceReloadAtNextUse()
See Also
++ ISoundSource Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSource.Name.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSource.Name.html
new file mode 100644
index 0000000..7dd04e7
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSource.Name.html
@@ -0,0 +1,56 @@
+
+
+
+
+ Returns if sounds played from this source will support seeking via ISound::setPlayPosition(). If a sound is seekable depends on the file type and the audio format. For example MOD files cannot be seeked currently. Returns true of the sound source supports setPlayPosition() and false if not. Note: If the sound never has been played before, the sound engine will have to open the file and try to get the information from there, so this call could take a bit depending on the type of file.
+ + ++
+See Also
++ ISoundSource Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSource.PlayLength.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSource.PlayLength.html
new file mode 100644
index 0000000..38e7cf8
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSource.PlayLength.html
@@ -0,0 +1,56 @@
+
+
+
+
+ Returns the name of the sound source (usually, this is the file name)
+ + ++
+See Also
++ ISoundSource Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSource.SampleData.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSource.SampleData.html
new file mode 100644
index 0000000..f38db9f
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSource.SampleData.html
@@ -0,0 +1,57 @@
+
+
+
+
+ Returns the play length of the sound in milliseconds. Returns -1 if not known for this sound for example because its decoder does not support lenght reporting or it is a file stream of unknown size. Note: If the sound never has been played before, the sound engine will have to open the file and try to get the play lenght from there, so this call could take a bit depending on the type of file.
+ + ++
+See Also
++ ISoundSource Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSource.getNativeSoundSource.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSource.getNativeSoundSource.html
new file mode 100644
index 0000000..ec62f6b
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSource.getNativeSoundSource.html
@@ -0,0 +1,54 @@
+
+
+
+
+ Sets or returns the stream mode which is used for a sound played from this source. Note that if this is set to ESM_NO_STREAMING, the engine still might decide to stream the sound if it is too big. The threashold for this can be adjusted using ISoundSource::setForcedStreamingThreshold(). Note: If the returned type is ESM_AUTO_DETECT, this mode will change after the sound has been played the first time.
+ + ++
+See Also
++ ISoundSource Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSourceConstructor.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSourceConstructor.html
new file mode 100644
index 0000000..cb8cde5
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSourceConstructor.html
@@ -0,0 +1,51 @@
+
+
+
+
+ A sound source describes an input file (.ogg, .mp3 or .wav) and its default settings. It provides some informations about the sound source like the play lenght and can have default settings for volume, distances for 3d etc.
+For a list of all members of this type, see ISoundSource Members.
+
+ System.Object
+
IrrKlang.ISoundSource
+ [C#]
+
+ public class ISoundSource : IDisposable
+ Thread Safety
+Public static (Shared in Visual Basic) members of this type are + safe for multithreaded operations. Instance members are not guaranteed to be + thread-safe.
+Requirements
++ Namespace: + IrrKlang +
++ Assembly: irrKlang.NET (in irrKlang.NET.dll) +
+See Also
++ ISoundSource Members | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSourceMembers.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSourceMembers.html
new file mode 100644
index 0000000..a486221
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSourceMembers.html
@@ -0,0 +1,105 @@
+
+
+
+
+ +
+
+ [Visual Basic]
+
Public Sub New( _
ByVal nativeSound As ISoundSource*, _
ByVal nativeEngine As ISoundEngine* _
)
+
+ Public Sub New( _
ByVal nativeSound As ISoundSource*, _
ByVal nativeEngine As ISoundEngine* _
)
See Also
++ ISoundSource Class | IrrKlang Namespace
+ ++ +
+
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSourceMethods.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSourceMethods.html
new file mode 100644
index 0000000..05b3d86
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSourceMethods.html
@@ -0,0 +1,71 @@
+
+
+
+
+ Public Instance Constructors
+
+
+
+
+ |
+
+ ISoundSource Constructor
+ |
+ + | +
Public Instance Properties
+
+
+
+
+ | AudioFormat | Returns informations about the sound source: channel count (mono/stereo), frame count, sample rate, etc. Returns the structure filled with 0 or negative values if not known for this sound for example because because the file could not be opened or similar. Note: If the sound never has been played before, the sound engine will have to open the file and try to get the play lenght from there, so this call could take a bit depending on the type of file. |
| DefaultMaxDistance | Sets or gets the default maximal distance for 3D sounds played from this source. This value influences how loud a sound is heard based on its distance. See ISound::setMaxDistance() for details about what the max distance is. This method only influences the initial distance value of sounds. For changing the distance after the sound has been started to play, use ISound::setMaxDistance() and ISound::setMaxDistance(). |
| DefaultMinDistance | Sets or gets the default minimal distance for 3D sounds played from this source. This value influences how loud a sound is heard based on its distance. See ISound::setMinDistance() for details about what the min distance is. This method only influences the initial distance value of sounds. For changing the distance after the sound has been started to play, use ISound::setMinDistance() and ISound::setMaxDistance(). |
| DefaultVolume | Sets or gets the default volume for a sound played from this source. The default value of this is 1.0f. Note that the default volume is being multiplied with the master volume of ISoundEngine, change this via ISoundEngine::setSoundVolume(). The volume is a value between 0 (silent) and 1.0f (full volume). |
| ForcedStreamingThreshold | |
| IsSeekingSupported | Returns if sounds played from this source will support seeking via ISound::setPlayPosition(). If a sound is seekable depends on the file type and the audio format. For example MOD files cannot be seeked currently. Returns true of the sound source supports setPlayPosition() and false if not. Note: If the sound never has been played before, the sound engine will have to open the file and try to get the information from there, so this call could take a bit depending on the type of file. |
| Name | Returns the name of the sound source (usually, this is the file name) |
| PlayLength | Returns the play length of the sound in milliseconds. Returns -1 if not known for this sound for example because its decoder does not support lenght reporting or it is a file stream of unknown size. Note: If the sound never has been played before, the sound engine will have to open the file and try to get the play lenght from there, so this call could take a bit depending on the type of file. |
| SampleData | |
| StreamMode | Sets or returns the stream mode which is used for a sound played from this source. Note that if this is set to ESM_NO_STREAMING, the engine still might decide to stream the sound if it is too big. The threashold for this can be adjusted using ISoundSource::setForcedStreamingThreshold(). Note: If the returned type is ESM_AUTO_DETECT, this mode will change after the sound has been played the first time. |
Public Instance Methods
+
+
+
+
+ | Dispose | |
| Equals (inherited from Object) | + Determines whether the specified Object is equal to the current Object. + |
| ForceReloadAtNextUse | Forces the sound to be reloaded at next replay. Sounds which are not played as streams are buffered to make it possible to replay them without much overhead. If the sound file is altered after the sound has been played the first time, the engine won't play the changed file then. Calling this method makes the engine reload the file before the file is played the next time. |
| GetHashCode (inherited from Object) | + Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table. + |
| getNativeSoundSource | for internal use only |
| GetType (inherited from Object) | + Gets the Type of the current instance. + |
| ToString (inherited from Object) | + Returns a String that represents the current Object. + |
Protected Instance Methods
+
+
+
+
+ | Finalize | Destructor |
| MemberwiseClone (inherited from Object) | + Creates a shallow copy of the current Object. + |
See Also
++ ISoundSource Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSourceProperties.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSourceProperties.html
new file mode 100644
index 0000000..4da8179
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundSourceProperties.html
@@ -0,0 +1,58 @@
+
+
+
+
+ The methods of the ISoundSource class are listed below. For a complete list of ISoundSource class members, see the ISoundSource Members topic.
+Public Instance Methods
+
+
+
+
+ | Dispose | |
| Equals (inherited from Object) | + Determines whether the specified Object is equal to the current Object. + |
| ForceReloadAtNextUse | Forces the sound to be reloaded at next replay. Sounds which are not played as streams are buffered to make it possible to replay them without much overhead. If the sound file is altered after the sound has been played the first time, the engine won't play the changed file then. Calling this method makes the engine reload the file before the file is played the next time. |
| GetHashCode (inherited from Object) | + Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table. + |
| getNativeSoundSource | for internal use only |
| GetType (inherited from Object) | + Gets the Type of the current instance. + |
| ToString (inherited from Object) | + Returns a String that represents the current Object. + |
Protected Instance Methods
+
+
+
+
+ | Finalize | Destructor |
| MemberwiseClone (inherited from Object) | + Creates a shallow copy of the current Object. + |
See Also
++ ISoundSource Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundStopEventReceiver.OnSoundStopped.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundStopEventReceiver.OnSoundStopped.html
new file mode 100644
index 0000000..bc5eb7b
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundStopEventReceiver.OnSoundStopped.html
@@ -0,0 +1,56 @@
+
+
+
+
+ The properties of the ISoundSource class are listed below. For a complete list of ISoundSource class members, see the ISoundSource Members topic.
+Public Instance Properties
+
+
+
+
+ | AudioFormat | Returns informations about the sound source: channel count (mono/stereo), frame count, sample rate, etc. Returns the structure filled with 0 or negative values if not known for this sound for example because because the file could not be opened or similar. Note: If the sound never has been played before, the sound engine will have to open the file and try to get the play lenght from there, so this call could take a bit depending on the type of file. |
| DefaultMaxDistance | Sets or gets the default maximal distance for 3D sounds played from this source. This value influences how loud a sound is heard based on its distance. See ISound::setMaxDistance() for details about what the max distance is. This method only influences the initial distance value of sounds. For changing the distance after the sound has been started to play, use ISound::setMaxDistance() and ISound::setMaxDistance(). |
| DefaultMinDistance | Sets or gets the default minimal distance for 3D sounds played from this source. This value influences how loud a sound is heard based on its distance. See ISound::setMinDistance() for details about what the min distance is. This method only influences the initial distance value of sounds. For changing the distance after the sound has been started to play, use ISound::setMinDistance() and ISound::setMaxDistance(). |
| DefaultVolume | Sets or gets the default volume for a sound played from this source. The default value of this is 1.0f. Note that the default volume is being multiplied with the master volume of ISoundEngine, change this via ISoundEngine::setSoundVolume(). The volume is a value between 0 (silent) and 1.0f (full volume). |
| ForcedStreamingThreshold | |
| IsSeekingSupported | Returns if sounds played from this source will support seeking via ISound::setPlayPosition(). If a sound is seekable depends on the file type and the audio format. For example MOD files cannot be seeked currently. Returns true of the sound source supports setPlayPosition() and false if not. Note: If the sound never has been played before, the sound engine will have to open the file and try to get the information from there, so this call could take a bit depending on the type of file. |
| Name | Returns the name of the sound source (usually, this is the file name) |
| PlayLength | Returns the play length of the sound in milliseconds. Returns -1 if not known for this sound for example because its decoder does not support lenght reporting or it is a file stream of unknown size. Note: If the sound never has been played before, the sound engine will have to open the file and try to get the play lenght from there, so this call could take a bit depending on the type of file. |
| SampleData | |
| StreamMode | Sets or returns the stream mode which is used for a sound played from this source. Note that if this is set to ESM_NO_STREAMING, the engine still might decide to stream the sound if it is too big. The threashold for this can be adjusted using ISoundSource::setForcedStreamingThreshold(). Note: If the returned type is ESM_AUTO_DETECT, this mode will change after the sound has been played the first time. |
See Also
++ ISoundSource Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundStopEventReceiver.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundStopEventReceiver.html
new file mode 100644
index 0000000..31efe00
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundStopEventReceiver.html
@@ -0,0 +1,62 @@
+
+
+
+
+ +
+
+ [Visual Basic]
+
Sub OnSoundStopped( _
ByVal sound As ISound, _
ByVal reason As StopEventCause, _
ByVal userData As Object _
)
+
+ Sub OnSoundStopped( _
ByVal sound As ISound, _
ByVal reason As StopEventCause, _
ByVal userData As Object _
)
See Also
++ ISoundStopEventReceiver Interface | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundStopEventReceiverMembers.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundStopEventReceiverMembers.html
new file mode 100644
index 0000000..95c8230
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundStopEventReceiverMembers.html
@@ -0,0 +1,56 @@
+
+
+
+
+ Interface to be implemented by the user, which recieves sound stop events. The interface has only one method to be implemented by the user: OnSoundStopped(). Implement this interface and set it via ISound::setSoundStopEventReceiver(). The sound stop event is guaranteed to be called when a sound or sound stream is finished, either because the sound reached its playback end, its sound source was removed, ISoundEngine::stopAllSounds() has been called or the whole engine was deleted.
+For a list of all members of this type, see ISoundStopEventReceiver Members.
++
+
+ [Visual Basic]
+
Public Interface ISoundStopEventReceiver
+ Public Interface ISoundStopEventReceiver
+ [C#]
+
+ public interface ISoundStopEventReceiver
+ Requirements
++ Namespace: + IrrKlang +
++ Assembly: irrKlang.NET (in irrKlang.NET.dll) +
+See Also
++ ISoundStopEventReceiver Members | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundStopEventReceiverMethods.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundStopEventReceiverMethods.html
new file mode 100644
index 0000000..a1eeac7
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.ISoundStopEventReceiverMethods.html
@@ -0,0 +1,49 @@
+
+
+
+
+ + ISoundStopEventReceiver overview +
+Public Instance Methods
+
+
+
+
+ | OnSoundStopped |
See Also
++ ISoundStopEventReceiver Interface | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.SampleFormat.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.SampleFormat.html
new file mode 100644
index 0000000..f52b1cf
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.SampleFormat.html
@@ -0,0 +1,81 @@
+
+
+
+
+ The methods of the ISoundStopEventReceiver interface are listed below. For a complete list of ISoundStopEventReceiver interface members, see the ISoundStopEventReceiver Members topic.
+Public Instance Methods
+
+
+
+
+ | OnSoundStopped |
See Also
++ ISoundStopEventReceiver Interface | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.SoundDeviceListType.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.SoundDeviceListType.html
new file mode 100644
index 0000000..8eee1d9
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.SoundDeviceListType.html
@@ -0,0 +1,80 @@
+
+
+
+
+ +
+
+ [Visual Basic]
+
Public Enum SampleFormat
+ Public Enum SampleFormat
+ [C#]
+
+ public enum SampleFormat
+ Members
+
+
+
+
+ | Member Name | +Description | +
|---|---|
| Signed16Bit | |
| Unsigned8Bit |
Requirements
++ Namespace: + IrrKlang +
++ Assembly: irrKlang.NET (in irrKlang.NET.dll) +
+See Also
+ + ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.SoundEngineOptionFlag.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.SoundEngineOptionFlag.html
new file mode 100644
index 0000000..b5fe857
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.SoundEngineOptionFlag.html
@@ -0,0 +1,110 @@
+
+
+
+
+ type of a sound device list
+
+ [Visual Basic]
+
Public Enum SoundDeviceListType
+ Public Enum SoundDeviceListType
+ [C#]
+
+ public enum SoundDeviceListType
+ Members
+
+
+
+
+ | Member Name | +Description | +
|---|---|
| RecordingDevice | type of a sound device list |
| PlaybackDevice | type of a sound device list |
Requirements
++ Namespace: + IrrKlang +
++ Assembly: irrKlang.NET (in irrKlang.NET.dll) +
+See Also
+ + ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.SoundOutputDriver.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.SoundOutputDriver.html
new file mode 100644
index 0000000..11fbf70
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.SoundOutputDriver.html
@@ -0,0 +1,105 @@
+
+
+
+
+ An enumeration for all options for starting up the sound engine When using createSoundEngine, use a combination of this these options parameter to start up the engine.
+
+ [Visual Basic]
+
Public Enum SoundEngineOptionFlag
+ Public Enum SoundEngineOptionFlag
+ [C#]
+
+ public enum SoundEngineOptionFlag
+ Members
+
+
+
+
+ | Member Name | +Description | +
|---|---|
| DefaultOptions | Default parameters when starting up the engine. A combination of MultiThreaded | LoadPlugins | Use3DBuffers | PrintDebugInfoIntoDebugger |
| LinearRolloff | If specified, instead of the default logarithmic one, irrKlang will use a linear rolloff model which influences the attenuation of the sounds over distance. The volume is interpolated linearly between the MinDistance and MaxDistance, making it possible to adjust sounds more easily although this is not physically correct. Note that this option may not work when used together with the Use3DBuffers option when using Direct3D for example, irrKlang will then turn off Use3DBuffers automaticly to be able to use this option and write out a warning. |
| PrintDebugInfoToStdOut | |
| PrintDebugInfoIntoDebugger | In addition to printing debug info to stdout, irrKlang will print debug info to any windows debugger supporting OutputDebugString() (like VisualStudio). This is pretty useful if your application does not capture any console output. |
| Use3DBuffers | Uses 3D sound buffers instead of emulating them when playing 3d sounds (default). If this flag is not specified, all buffers will by created in 2D only and 3D positioning will be emulated in software, making the engine run faster if hardware 3d audio is slow on the system. |
| LoadPlugins | Automaticly loads external plugins when starting up. Plugins usually are .dll files named for example ikpMP3.dll (= short for irrKlangPluginMP3) which are executed after the startup of the sound engine and modify it for example to make it possible to play back mp3 files. Plugins are being loaded from the current working directory as well as from the position where the .exe using the irrKlang library resides. |
| MuteIfNotFocused | If the window of the application doesn't have the focus, irrKlang will be silent if this has been set. This will only work when irrKlang is using the DirectSound output driver. |
| MultiThreaded | If specified (default), it will make irrKlang run in a separate thread, updating all streams, sounds, 3d positions and whatever automaticly. You also don't need to call ISoundEngine::update() if irrKlang is running multithreaded. However, if you want to run irrKlang in the same thread as your application (for easier debugging for example), don't set this. But you need to call ISoundEngine::update() as often as you can (at least about 2-3 times per second) to make irrKlang update everything correctly then. |
Requirements
++ Namespace: + IrrKlang +
++ Assembly: irrKlang.NET (in irrKlang.NET.dll) +
+See Also
+ + ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.StopEventCause.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.StopEventCause.html
new file mode 100644
index 0000000..7f8f3d1
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.StopEventCause.html
@@ -0,0 +1,85 @@
+
+
+
+
+ An enum for all types of output drivers irrKlang supports.
+
+ [Visual Basic]
+
Public Enum SoundOutputDriver
+ Public Enum SoundOutputDriver
+ [C#]
+
+ public enum SoundOutputDriver
+ Members
+
+
+
+
+ | Member Name | +Description | +
|---|---|
| NullDriver | Null driver, creating no sound output |
| CoreAudio | Core Audio sound output driver, mac os only |
| ALSA | ALSA sound output driver, linux only |
| WinMM | WinMM sound output driver, windows only |
| DirectSound | DirectSound sound output driver, windows only |
| DirectSound8 | DirectSound8 sound output driver, windows only |
| AutoDetect | An enum for all types of output drivers irrKlang supports. |
Requirements
++ Namespace: + IrrKlang +
++ Assembly: irrKlang.NET (in irrKlang.NET.dll) +
+See Also
+ + ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.StreamForwarder.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.StreamForwarder.html
new file mode 100644
index 0000000..2919264
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.StreamForwarder.html
@@ -0,0 +1,67 @@
+
+
+
+
+ An enumeration listing all reasons for a fired sound stop event
+
+ [Visual Basic]
+
Public Enum StopEventCause
+ Public Enum StopEventCause
+ [C#]
+
+ public enum StopEventCause
+ Members
+
+
+
+
+ | Member Name | +Description | +
|---|---|
| SoundStoppedBySourceRemoval | The sound was stopped because its sound source was removed or the engine was shut down |
| SoundStoppedByUser | The sound was stopped because the user called ISound::stop(). |
| SoundFinishedPlaying | The sound finished playing. |
Requirements
++ Namespace: + IrrKlang +
++ Assembly: irrKlang.NET (in irrKlang.NET.dll) +
+See Also
+ + ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.StreamForwarderMembers.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.StreamForwarderMembers.html
new file mode 100644
index 0000000..764df8c
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.StreamForwarderMembers.html
@@ -0,0 +1,67 @@
+
+
+
+
+ Internal class, do not use.
+For a list of all members of this type, see StreamForwarder Members.
+
+ System.Object
+
System.ValueType
IrrKlang.StreamForwarder
+ [Visual Basic]
+
Public Structure StreamForwarder
+ Public Structure StreamForwarder
+ [C#]
+
+ public struct StreamForwarder
+ Thread Safety
+Public static (Shared in Visual Basic) members of this type are + safe for multithreaded operations. Instance members are not guaranteed to be + thread-safe.
+Requirements
++ Namespace: + IrrKlang +
++ Assembly: irrKlang.NET (in irrKlang.NET.dll) +
+See Also
++ StreamForwarder Members | IrrKlang Namespace
+ ++ +
+
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.StreamMode.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.StreamMode.html
new file mode 100644
index 0000000..0695eb3
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.StreamMode.html
@@ -0,0 +1,85 @@
+
+
+
+
+ Public Instance Methods
+
+
+
+
+ | Equals (inherited from ValueType) | + Indicates whether this instance and a specified object are equal. + |
| GetHashCode (inherited from ValueType) | + Returns the hash code for this instance. + |
| GetType (inherited from Object) | + Gets the Type of the current instance. + |
| ToString (inherited from ValueType) | + Returns the fully qualified type name of this instance. + |
See Also
++ StreamForwarder Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.CrossProduct.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.CrossProduct.html
new file mode 100644
index 0000000..6e639fe
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.CrossProduct.html
@@ -0,0 +1,63 @@
+
+
+
+
+ An enum for all types of output stream modes
+
+ [Visual Basic]
+
Public Enum StreamMode
+ Public Enum StreamMode
+ [C#]
+
+ public enum StreamMode
+ Members
+
+
+
+
+ | Member Name | +Description | +
|---|---|
| NoStreaming | An enum for all types of output stream modes |
| Streaming | An enum for all types of output stream modes |
| AutoDetect | Autodetects the best sound driver for the system |
Requirements
++ Namespace: + IrrKlang +
++ Assembly: irrKlang.NET (in irrKlang.NET.dll) +
+See Also
+ + ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.DotProduct.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.DotProduct.html
new file mode 100644
index 0000000..82befbc
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.DotProduct.html
@@ -0,0 +1,54 @@
+
+
+
+
+ Returns cross product with an other vector
+ + +Parameters
+-
+
- + p + +
- other vector +
Return Value
+cross product
+See Also
++ Vector3D Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.Equals.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.Equals.html
new file mode 100644
index 0000000..6ce3a24
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.Equals.html
@@ -0,0 +1,54 @@
+
+
+
+
+ Returns the dot product with another vector.
+ + +See Also
++ Vector3D Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.GetDistanceFrom.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.GetDistanceFrom.html
new file mode 100644
index 0000000..6bfb6af
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.GetDistanceFrom.html
@@ -0,0 +1,54 @@
+
+
+
+
+ Compares the vector to another vector.
+ + +See Also
++ Vector3D Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.GetDistanceFromSQ.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.GetDistanceFromSQ.html
new file mode 100644
index 0000000..ce004c5
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.GetDistanceFromSQ.html
@@ -0,0 +1,54 @@
+
+
+
+
+ Returns distance from an other point. Here, the vector is interpreted as point in 3 dimensional space.
+ + +See Also
++ Vector3D Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.GetInterpolated.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.GetInterpolated.html
new file mode 100644
index 0000000..0f1fd49
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.GetInterpolated.html
@@ -0,0 +1,65 @@
+
+
+
+
+ Returns squared distance from an other point. Here, the vector is interpreted as point in 3 dimensional space.
+ + +See Also
++ Vector3D Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.GetLength.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.GetLength.html
new file mode 100644
index 0000000..4d8851d
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.GetLength.html
@@ -0,0 +1,54 @@
+
+
+
+
+ returns interpolated vector
+
+ [Visual Basic]
+
Public Function GetInterpolated( _
ByVal other As Vector3D, _
ByVal d As Single _
) As Vector3D
+
+ Public Function GetInterpolated( _
ByVal other As Vector3D, _
ByVal d As Single _
) As Vector3D
Parameters
+-
+
- + other + +
- other vector to interpolate between +
- + d + +
- value between 0.0f and 1.0f. +
See Also
++ Vector3D Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.Invert.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.Invert.html
new file mode 100644
index 0000000..2d61ab1
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.Invert.html
@@ -0,0 +1,54 @@
+
+
+
+
+ Returns squared length of the vector. This is useful because it is much faster then GetLength().
+ + +See Also
++ Vector3D Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.IsBetweenPoints.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.IsBetweenPoints.html
new file mode 100644
index 0000000..7d7b1d3
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.IsBetweenPoints.html
@@ -0,0 +1,67 @@
+
+
+
+
+ Inverts the vector.
+
+ [Visual Basic]
+
Public Sub Invert()
+
+ Public Sub Invert()
See Also
++ Vector3D Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.Length.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.Length.html
new file mode 100644
index 0000000..ff28736
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.Length.html
@@ -0,0 +1,57 @@
+
+
+
+
+ Returns if the point represented by this vector is between to points
+
+ [Visual Basic]
+
Public Function IsBetweenPoints( _
ByVal begin As Vector3D, _
ByVal end As Vector3D _
) As Boolean
+
+ Public Function IsBetweenPoints( _
ByVal begin As Vector3D, _
ByVal end As Vector3D _
) As Boolean
Parameters
+-
+
- + begin + +
- Start point of line +
- + end + +
- End point of line +
Return Value
+True if between points, false if not.
+See Also
++ Vector3D Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.Set_overload_1.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.Set_overload_1.html
new file mode 100644
index 0000000..d674a6a
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.Set_overload_1.html
@@ -0,0 +1,55 @@
+
+
+
+
+ Sets the lenght of the vector to a new value
+ + +See Also
++ Vector3D Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.Set_overloads.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.Set_overloads.html
new file mode 100644
index 0000000..9b0ba01
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.Set_overloads.html
@@ -0,0 +1,50 @@
+
+
+
+
+ +
+
+ [Visual Basic]
+
Overloads Public Sub Set( _
ByVal nx As Single, _
ByVal ny As Single, _
ByVal nz As Single _
)
+
+ Overloads Public Sub Set( _
ByVal nx As Single, _
ByVal ny As Single, _
ByVal nz As Single _
)
See Also
++ Vector3D Class | IrrKlang Namespace | Vector3D.Set Overload List
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.ToString.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.ToString.html
new file mode 100644
index 0000000..839a6ef
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.ToString.html
@@ -0,0 +1,55 @@
+
+
+
+
+ +
+Overload List
++
+ public void Set(Vector3D); ++
+
+ public void Set(float,float,float); ++
See Also
++ Vector3D Class | IrrKlang Namespace
++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.op_Addition.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.op_Addition.html
new file mode 100644
index 0000000..0253b4a
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.op_Addition.html
@@ -0,0 +1,48 @@
+
+
+
+
+ 3d vector class with lots of operators and methods. This class has been ported directly from the native C++ Irrlicht Engine, so it may not be 100% complete yet and the design may not be 100% .NET like.
+For a list of all members of this type, see Vector3D Members.
+
+ System.Object
+
System.ValueType
IrrKlang.Vector3D
+ [Visual Basic]
+
Public Structure Vector3D
+ Public Structure Vector3D
+ [C#]
+
+ public struct Vector3D
+ Thread Safety
+Public static (Shared in Visual Basic) members of this type are + safe for multithreaded operations. Instance members are not guaranteed to be + thread-safe.
+Requirements
++ Namespace: + IrrKlang +
++ Assembly: irrKlang.NET (in irrKlang.NET.dll) +
+See Also
++ Vector3D Members | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.op_Division.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.op_Division.html
new file mode 100644
index 0000000..3730821
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.op_Division.html
@@ -0,0 +1,48 @@
+
+
+
+
+ +
+
+ [Visual Basic]
+
+ Vector3D.op_Addition(o1, o2)
+
+ + Vector3D.op_Addition(o1, o2)
See Also
++ Vector3D Class | IrrKlang Namespace
++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.op_Equality.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.op_Equality.html
new file mode 100644
index 0000000..829fb2d
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.op_Equality.html
@@ -0,0 +1,48 @@
+
+
+
+
+ +
+
+ [Visual Basic]
+
+ Vector3D.op_Division(o, scal)
+
+ + Vector3D.op_Division(o, scal)
See Also
++ Vector3D Class | IrrKlang Namespace
++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.op_Multiply_overload_1.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.op_Multiply_overload_1.html
new file mode 100644
index 0000000..dfdc913
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.op_Multiply_overload_1.html
@@ -0,0 +1,48 @@
+
+
+
+
+ +
+
+ [Visual Basic]
+
+ Vector3D.op_Equality(o1, o2)
+
+ + Vector3D.op_Equality(o1, o2)
See Also
++ Vector3D Class | IrrKlang Namespace
++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.op_Multiply_overload_2.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.op_Multiply_overload_2.html
new file mode 100644
index 0000000..eb69be9
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.op_Multiply_overload_2.html
@@ -0,0 +1,48 @@
+
+
+
+
+ +
+
+ [Visual Basic]
+
+ Vector3D.op_Multiply(scal, o)
+
+ + Vector3D.op_Multiply(scal, o)
See Also
++ Vector3D Class | IrrKlang Namespace | Vector3DMultiplication Operator Overload List
++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.op_Multiply_overloads.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.op_Multiply_overloads.html
new file mode 100644
index 0000000..967e333
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.op_Multiply_overloads.html
@@ -0,0 +1,50 @@
+
+
+
+
+ +
+
+ [Visual Basic]
+
+ Vector3D.op_Multiply(o, scal)
+
+ + Vector3D.op_Multiply(o, scal)
See Also
++ Vector3D Class | IrrKlang Namespace | Vector3DMultiplication Operator Overload List
++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.op_Subtraction.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.op_Subtraction.html
new file mode 100644
index 0000000..3f2076e
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3D.op_Subtraction.html
@@ -0,0 +1,48 @@
+
+
+
+
+ +
+Overload List
++
+ public static Vector3D Multiplication Operator(Vector3D,float); ++
+
+ public static Vector3D Multiplication Operator(float,ref Vector3D); ++
See Also
++ Vector3D Class | IrrKlang Namespace
++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3DConstructor.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3DConstructor.html
new file mode 100644
index 0000000..a511b44
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3DConstructor.html
@@ -0,0 +1,54 @@
+
+
+
+
+ +
+
+ [Visual Basic]
+
+ Vector3D.op_Subtraction(o1, o2)
+
+ + Vector3D.op_Subtraction(o1, o2)
See Also
++ Vector3D Class | IrrKlang Namespace
++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3DConstructor1.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3DConstructor1.html
new file mode 100644
index 0000000..cd5baca
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3DConstructor1.html
@@ -0,0 +1,47 @@
+
+
+
+
+ +
+Overload List
+Initializes a new instance of the Vector3D class.
++ public Vector3D(); ++
+
+ public Vector3D(float,float,float); ++
See Also
++ Vector3D Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3DConstructor2.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3DConstructor2.html
new file mode 100644
index 0000000..3fc3647
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3DConstructor2.html
@@ -0,0 +1,46 @@
+
+
+
+
+ +
+
+ [Visual Basic]
+
Overloads Public Sub New( _
ByVal nx As Single, _
ByVal ny As Single, _
ByVal nz As Single _
)
+
+ Overloads Public Sub New( _
ByVal nx As Single, _
ByVal ny As Single, _
ByVal nz As Single _
)
See Also
++ Vector3D Class | IrrKlang Namespace | Vector3D Constructor Overload List
++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3DFields.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3DFields.html
new file mode 100644
index 0000000..d24a3a9
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3DFields.html
@@ -0,0 +1,51 @@
+
+
+
+
+ Initializes a new instance of the Vector3D class.
+
+ [Visual Basic]
+
Overloads Public Sub New()
+ Overloads Public Sub New()
+ [C#]
+
public Vector3D();
+ public Vector3D();
See Also
++ Vector3D Class | IrrKlang Namespace | Vector3D Constructor Overload List
++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3DMembers.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3DMembers.html
new file mode 100644
index 0000000..c4d110e
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3DMembers.html
@@ -0,0 +1,109 @@
+
+
+
+
+ The fields of the Vector3D structure are listed below. For a complete list of Vector3D structure members, see the Vector3D Members topic.
+Public Instance Fields
+ +See Also
++ Vector3D Class | IrrKlang Namespace
+ ++ +
+
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3DMethods.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3DMethods.html
new file mode 100644
index 0000000..a2ff24d
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3DMethods.html
@@ -0,0 +1,68 @@
+
+
+
+
+ Public Static (Shared) Operators
+
+
+
+
+   Addition Operator | |
| Division Operator | |
| Equality Operator | |
| Multiplication Operator | Overloaded. |
| Subtraction Operator |
Public Instance Constructors
+
+
+
+
+ |
+
+ Vector3D
+ |
+ Overloaded. Initializes a new instance of the Vector3D class. | +
Public Instance Fields
+ +Public Instance Properties
+ +Public Instance Methods
+
+
+
+
+ | CrossProduct | Returns cross product with an other vector |
| DotProduct | Returns the dot product with another vector. |
| Equals | Compares the vector to another vector. |
| GetDistanceFrom | Returns distance from an other point. Here, the vector is interpreted as point in 3 dimensional space. |
| GetDistanceFromSQ | Returns squared distance from an other point. Here, the vector is interpreted as point in 3 dimensional space. |
| GetHashCode (inherited from ValueType) | + Returns the hash code for this instance. + |
| GetInterpolated | returns interpolated vector |
| GetLength | Returns length of the vector. |
| GetLengthSQ | Returns squared length of the vector. This is useful because it is much faster then GetLength(). |
| GetType (inherited from Object) | + Gets the Type of the current instance. + |
| Invert | Inverts the vector. |
| IsBetweenPoints | Returns if the point represented by this vector is between to points |
| Normalize | Normalizes the vector. |
| Set | Overloaded. |
| SetLength | Sets the lenght of the vector to a new value |
| ToString |
See Also
++ Vector3D Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3DOperators.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3DOperators.html
new file mode 100644
index 0000000..dd8ede7
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3DOperators.html
@@ -0,0 +1,53 @@
+
+
+
+
+ The methods of the Vector3D structure are listed below. For a complete list of Vector3D structure members, see the Vector3D Members topic.
+Public Instance Methods
+
+
+
+
+ | CrossProduct | Returns cross product with an other vector |
| DotProduct | Returns the dot product with another vector. |
| Equals | Compares the vector to another vector. |
| GetDistanceFrom | Returns distance from an other point. Here, the vector is interpreted as point in 3 dimensional space. |
| GetDistanceFromSQ | Returns squared distance from an other point. Here, the vector is interpreted as point in 3 dimensional space. |
| GetHashCode (inherited from ValueType) | + Returns the hash code for this instance. + |
| GetInterpolated | returns interpolated vector |
| GetLength | Returns length of the vector. |
| GetLengthSQ | Returns squared length of the vector. This is useful because it is much faster then GetLength(). |
| GetType (inherited from Object) | + Gets the Type of the current instance. + |
| Invert | Inverts the vector. |
| IsBetweenPoints | Returns if the point represented by this vector is between to points |
| Normalize | Normalizes the vector. |
| Set | Overloaded. |
| SetLength | Sets the lenght of the vector to a new value |
| ToString |
See Also
++ Vector3D Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3DProperties.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3DProperties.html
new file mode 100644
index 0000000..c2e60d3
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.Vector3DProperties.html
@@ -0,0 +1,50 @@
+
+
+
+
+ The operators of the Vector3D structure are listed below. For a complete list of Vector3D structure members, see the Vector3D Members topic.
+Public Static (Shared) Operators
+
+
+
+
+ | Addition Operator | |
| Division Operator | |
| Equality Operator | |
| Multiplication Operator | Overloaded. |
| Subtraction Operator |
See Also
++ Vector3D Class | Vector3D Members | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.html
new file mode 100644
index 0000000..c332838
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlang.html
@@ -0,0 +1,190 @@
+
+
+
+
+ The properties of the Vector3D structure are listed below. For a complete list of Vector3D structure members, see the Vector3D Members topic.
+Public Instance Properties
+ +See Also
++ Vector3D Class | IrrKlang Namespace
+ ++ +
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlangHierarchy.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlangHierarchy.html
new file mode 100644
index 0000000..a1a2436
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/IrrKlangHierarchy.html
@@ -0,0 +1,88 @@
+
+
+
+
+ the main namespace where every class of the sound engine can be found
+ +Classes
+
+
+
+
+ | Class | +Description | +
|---|---|
| + IAudioRecorder + | +Interface to an audio recorder. | +
| + ISound + | +Represents a sound which is currently played. You can stop the sound or change the volume or whatever using this interface. Don't create sounds using new ISound, this won't work anyway. You can get an instance of an ISonud class by calling ISoundEngine::Play2D or Play3D. | +
| + ISoundDeviceList + | +A list of sound devices for a sound driver. Use irrklang::createSoundDeviceList() to create this list. The function createIrrKlangDevice() has a parameter 'deviceID' which takes the value returned by ISoundDeviceList::getDeviceID() and uses that device then. The list of devices in ISoundDeviceList usually also includes the default device which is the first entry and has an empty deviceID string ("") and the description "default device".*/ | +
| + ISoundEffectControl + | +Interface to control the active sound effects (echo, reverb,...) of an ISound object, a playing sound. Sound effects such as chorus, distorsions, echo, reverb and similar can be controlled using this. An instance of this interface can be obtained via ISound::getSoundEffectControl(). The sound containing this interface has to be started via ISoundEngine::play2D() or ISoundEngine::play3D() with the flag enableSoundEffects=true, otherwise no acccess to this interface will be available. For the DirectSound driver, these are effects available since DirectSound8. For most effects, sounds should have a sample rate of 44 khz and should be at least 150 milli seconds long for optimal quality when using the DirectSound driver. | +
| + ISoundEngine + | ++ |
| + ISoundSource + | +A sound source describes an input file (.ogg, .mp3 or .wav) and its default settings. It provides some informations about the sound source like the play lenght and can have default settings for volume, distances for 3d etc. | +
Interfaces
+
+
+
+
+ | Interface | +Description | +
|---|---|
| + IFileFactory + | +Interface to overwrite opening files. Derive your own class from IFileFactory, overwrite the openFile() method and return your own System::IO::Stream to overwrite file access of irrKlang. Use ISoundEngine::addFileFactory() to let irrKlang know about your class. Example code can be found in the tutorial 04.OverrideFileAccess. | +
| + ISoundStopEventReceiver + | +Interface to be implemented by the user, which recieves sound stop events. The interface has only one method to be implemented by the user: OnSoundStopped(). Implement this interface and set it via ISound::setSoundStopEventReceiver(). The sound stop event is guaranteed to be called when a sound or sound stream is finished, either because the sound reached its playback end, its sound source was removed, ISoundEngine::stopAllSounds() has been called or the whole engine was deleted. | +
Structures
+
+
+
+
+ | Structure | +Description | +
|---|---|
| + AudioFormat + | ++ |
| + EventForwarder + | +Internal class, do not use. | +
| + FileFactoryForwarder + | +Internal class, do not use. | +
| + StreamForwarder + | +Internal class, do not use. | +
| + Vector3D + | +3d vector class with lots of operators and methods. This class has been ported directly from the native C++ Irrlicht Engine, so it may not be 100% complete yet and the design may not be 100% .NET like. | +
Enumerations
+
+
+
+
+ | Enumeration | +Description | +
|---|---|
| + SampleFormat + | ++ |
| + SoundDeviceListType + | +type of a sound device list | +
| + SoundEngineOptionFlag + | +An enumeration for all options for starting up the sound engine When using createSoundEngine, use a combination of this these options parameter to start up the engine. | +
| + SoundOutputDriver + | +An enum for all types of output drivers irrKlang supports. | +
| + StopEventCause + | +An enumeration listing all reasons for a fired sound stop event | +
| + StreamMode + | +An enum for all types of output stream modes | +
+ +
sync toc
+
+
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/default.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/default.html
new file mode 100644
index 0000000..40ea70e
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/default.html
@@ -0,0 +1,97 @@
+
+
+
+
+
+
+
+ 
+ Overview
+
+
+ Overview
+
+ 
+ IrrKlang
+
+
+ IrrKlang
+
+
+
+
+ AudioFormat Structure
+
+
+
+
+ AudioFormat Structure
+
+
+
+
+ AudioFormat Members
+
+
+ AudioFormat Members
+
+
+ AudioFormat Constructor
+
+
+ AudioFormat Constructor
+
+
+ Fields
+
+
+
+ Fields
+
+
+
+ Properties
+
+
+ Properties
+
+
+
+
+ BytesPerSecond Property
+
+
+ BytesPerSecond Property
+
+
+ FrameSize Property
+
+
+ FrameSize Property
+
+
+ SampleDataSize Property
+
+
+ SampleDataSize Property
+
+
+ SampleSize Property
+
+
+ SampleSize Property
+
+
+ IAudioRecorder Class
+
+
+
+ IAudioRecorder Class
+
+
+
+
+ IAudioRecorder Members
+
+
+ IAudioRecorder Members
+
+
+ IAudioRecorder Constructor
+
+
+
+ IAudioRecorder Constructor
+
+
+
+ Properties
+
+
+
+
+ Properties
+
+
+
+ ISound Class
+
+
+ ISound Class
+
+
+
+
+ ISound Members
+
+
+ ISound Members
+
+
+ ISound Constructor
+
+
+ ISound Constructor
+
+
+ Properties
+
+
+ Properties
+
+
+
+
+ Finished Property
+
+
+ Finished Property
+
+
+ Looped Property
+
+
+ Looped Property
+
+
+ MaxDistance Property
+
+
+ MaxDistance Property
+
+
+ MinDistance Property
+
+
+ MinDistance Property
+
+
+ Pan Property
+
+
+ Pan Property
+
+
+ Paused Property
+
+
+ Paused Property
+
+
+ PlaybackSpeed Property
+
+
+ PlaybackSpeed Property
+
+
+ PlayLength Property
+
+
+ PlayLength Property
+
+
+ PlayPosition Property
+
+
+ PlayPosition Property
+
+
+ Position Property
+
+
+
+ Position Property
+
+
+ Velocity Property
+
+
+ Velocity Property
+
+
+ Volume Property
+
+
+ Volume Property
+
+
+ Methods
+
+
+ Methods
+
+
+
+
+ Dispose Method
+
+
+ Dispose Method
+
+
+ Finalize Method
+
+
+ Finalize Method
+
+
+ setSoundStopEventReceiver Method
+
+
+
+ setSoundStopEventReceiver Method
+
+
+
+ Stop Method
+
+
+ Stop Method
+
+
+ ISoundDeviceList Class
+
+
+
+ ISoundDeviceList Class
+
+
+
+ ISoundEffectControl Class
+
+
+ ISoundEffectControl Class
+
+
+
+
+
+
+
+ Methods
+
+
+ Methods
+
+
+
+
+ DisableAllEffects Method
+
+
+
+
+
+
+
+
+
+
+
+ DisableAllEffects Method
+
+
+ EnableChorusSoundEffect Method
+
+
+
+
+
+ EnableChorusSoundEffect Method
+
+
+
+ EnableEchoSoundEffect Method
+
+
+
+ EnableEchoSoundEffect Method
+
+
+
+ EnableFlangerSoundEffect Method
+
+
+
+ EnableFlangerSoundEffect Method
+
+
+
+ EnableGargleSoundEffect Method
+
+
+
+
+ EnableGargleSoundEffect Method
+
+
+
+ EnableParamEqSoundEffect Method
+
+
+
+
+ EnableParamEqSoundEffect Method
+
+
+
+ Finalize Method
+
+
+ Finalize Method
+
+
+ ISoundEngine Class
+
+
+ ISoundEngine Class
+
+
+
+
+ ISoundEngine Members
+
+
+ ISoundEngine Members
+
+
+ ISoundEngine Constructor
+
+
+
+ ISoundEngine Constructor
+
+
+
+ Properties
+
+
+
+ Properties
+
+
+
+ Methods
+
+
+ Methods
+
+
+
+
+ AddFileFactory Method
+
+
+
+ AddFileFactory Method
+
+
+ AddSoundSourceFromFile Method
+
+
+
+
+
+
+ AddSoundSourceFromFile Method
+
+
+
+ Finalize Method
+
+
+
+
+
+ Finalize Method
+
+
+ LoadPlugins Method
+
+
+
+
+
+ LoadPlugins Method
+
+
+ RemoveSoundSource Method
+
+
+
+
+
+ RemoveSoundSource Method
+
+
+ SetRolloffFactor Method
+
+
+ SetRolloffFactor Method
+
+
+ StopAllSounds Method
+
+
+ StopAllSounds Method
+
+
+ Update Method
+
+
+ Update Method
+
+
+ ISoundSource Class
+
+
+
+ ISoundSource Class
+
+
+
+
+ ISoundSource Members
+
+
+ ISoundSource Members
+
+
+ ISoundSource Constructor
+
+
+ ISoundSource Constructor
+
+
+ Properties
+
+
+
+ Properties
+
+
+
+
+ AudioFormat Property
+
+
+
+
+ AudioFormat Property
+
+
+ DefaultVolume Property
+
+
+
+
+ DefaultVolume Property
+
+
+ Name Property
+
+
+ Name Property
+
+
+ PlayLength Property
+
+
+ PlayLength Property
+
+
+ SampleData Property
+
+
+ SampleData Property
+
+
+ StreamMode Property
+
+
+ StreamMode Property
+
+
+ SampleFormat Enumeration
+
+
+
+
+
+
+
+ SampleFormat Enumeration
+
+
+ StreamMode Enumeration
+
+
+ StreamMode Enumeration
+
+
+ Vector3D Structure
+
+
+ Vector3D Structure
+
+
+
+
+ Vector3D Members
+
+
+
+
+
+ Vector3D Members
+
+
+ Methods
+
+
+ Methods
+
+
+
+
+ CrossProduct Method
+
+
+ CrossProduct Method
+
+
+ DotProduct Method
+
+
+ DotProduct Method
+
+
+ Equals Method
+
+
+ Equals Method
+
+
+ GetDistanceFrom Method
+
+
+ GetDistanceFrom Method
+
+
+ GetDistanceFromSQ Method
+
+
+ GetDistanceFromSQ Method
+
+
+ GetInterpolated Method
+
+
+ GetInterpolated Method
+
+
+ GetLength Method
+
+
+ GetLength Method
+
+
+ GetLengthSQ Method
+
+
+ GetLengthSQ Method
+
+
+ Invert Method
+
+
+ Invert Method
+
+
+ IsBetweenPoints Method
+
+
+ IsBetweenPoints Method
+
+
+ Normalize Method
+
+
+
+ Normalize Method
+
+
+ SetLength Method
+
+
+ SetLength Method
+
+
+ ToString Method
+
+
+ ToString Method
+
+
+ Operators
+
+
+ Operators
+
+
+
+
+ Addition Operator
+
+
+ Addition Operator
+
+
+ Division Operator
+
+
+ Division Operator
+
+
+ Equality Operator
+
+
+ Equality Operator
+
+
+ Multiplication Operator
+
+
+
+ Multiplication Operator
+
+
+
+ Subtraction Operator
+
+
+ Subtraction Operator
+
+
+ Welcome to the irrKlang Sound Engine API documentation. Here you'll find
+ any information you'll need to develop applications with the irrKlang Sound
+ Engine. If you look for a tutorial on how to start, take a look at the homepage
+ of the irrKlang sound Engine at www.ambiera.com/irrklang
+ or into the SDK in the directory \examples.net.
+
+ The irrKlang library is intended to be an easy-to-use 3d and 2d sound engine,
+ so this documentation is an important part of it. If you have any questions
+ or suggestions, please take a look into the ambiera.com forum or just send
+ a mail.
Overview
+ This documentation is only about the .NET part of the engine, for languages
+ such as C#, VisualBasic.NET, Delphi.NET and similar. If you want to know how
+ to use the native engine using C++, please take a look into the other help
+ file, which is named irrKlang.chm.
+
+
+ irrKlang .NET can run as stand alone .DLL and does not need the native irrKlang.DLL.
+ But please note that plugin .DLL files like the mp3 playback .DLL file ikpMP3.DLL
+ will still be needed if you want to use the features of those plugins (mp3
+ playback in that case)
-
+
- +
How to use irrKlang.NET
+Take a look in the /examples.net folder of the SDK, there you'll find some + examples for C# and VisualBasic.NET which are using irrKlang.NET. Copy irrKlang.DLL + and all plugin .DLLs (ikp*.DLL) into the folder where your application is. + The following simple example shows how to use irrKlang to play back a music file: +
+-
+
[C#]
+ using System;
+ using IrrKlang;
+
+ namespace HelloWorld
+ {
+ class Example
+ {
+ [STAThread]
+ static void Main(string[] + args)
+ {
+ // start up the engine
+ ISoundEngine engine = new + ISoundEngine();
+ +
+ + using System;
+ using IrrKlang;
+
+ namespace HelloWorld
+ {
+ class Example
+ {
+ [STAThread]
+ static void Main(string[] + args)
+ {
+ // start up the engine
+ ISoundEngine engine = new + ISoundEngine();
+ +
+ // play a sound file
+ engine.play2D("../../media/ophelia.mp3");
+ // wait until user presses
+ ok to end application
System.Windows.Forms.MessageBox.Show("Playing, + press ok.");
+} // end main()
+} // end class
+} // end namespace
+
+
+ +
+
+
\ No newline at end of file
diff --git a/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/index.html b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/index.html
new file mode 100644
index 0000000..a45efa8
--- /dev/null
+++ b/SQCSim2021/external/irrKlang-1.6.0/doc/dotnet/index.html
@@ -0,0 +1,21 @@
+
+
+
+
+ + +