IrrKlang.NET

IrrKlang.NET documentation

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();


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