libkmid Library API Documentation

libkmid.h

00001 /*  libkmid.h     - class KMidSimpleAPI that makes it easy to use libkmid
00002             and a C wrapper.
00003     This file is part of LibKMid 0.9.5
00004     Copyright (C) 2000  Antonio Larrosa Jimenez
00005     LibKMid's homepage : http://www.arrakis.es/~rlarrosa/libkmid.html
00006  
00007     This library is free software; you can redistribute it and/or
00008     modify it under the terms of the GNU Library General Public
00009     License as published by the Free Software Foundation; either
00010     version 2 of the License, or (at your option) any later version.
00011  
00012     This library is distributed in the hope that it will be useful,
00013     but WITHOUT ANY WARRANTY; without even the implied warranty of
00014     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00015     Library General Public License for more details.
00016  
00017     You should have received a copy of the GNU Library General Public License
00018     along with this library; see the file COPYING.LIB.  If not, write to
00019     the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
00020     Boston, MA 02111-1307, USA.
00021  
00022     Send comments and bug fixes to Antonio Larrosa <larrosa@kde.org>
00023  
00024 ***************************************************************************/
00025 #ifndef _LIBKMID_H
00026 #define _LIBKMID_H 
00027 
00028 #ifdef __cplusplus
00029 
00054 class KMidSimpleAPI 
00055 {
00056   private:
00057     class KMidSimpleAPIPrivate;
00058     KMidSimpleAPIPrivate *d;
00059 
00060   public:
00061 
00071     static int kMidInit(void);
00072 
00076     static int kMidLoad(const char *filename);
00077 
00092     static int kMidPlay(int loop=0);
00093 
00100     static int kMidStop(void);
00101 
00106     static void kMidDestruct(void);
00107 
00112     static int kMidIsPlaying(void);
00113 
00121     static int kMidDevices(void);
00122 
00132     static const char *kMidName(int i);
00133 
00143     static const char *kMidType(int i);
00144 
00151     static void kMidSetDevice(int i);
00152 
00162     static void kMidSetMidiMapper(const char *mapfilename);
00163 
00167     static const char *kMidVersion(void);
00168 
00176     static const char *kMidCopyright(void);
00177 
00178 };
00179 
00180 
00181 
00182 extern "C" {
00183 
00184 #endif
00185 
00186  
00187   int    kMidInit(void);
00188   int    kMidLoad(const char *filename);
00189   int    kMidPlay(void);
00190   int    kMidStop(void);
00191   void   kMidDestruct(void);
00192   int    kMidIsPlaying(void);
00193   int    kMidDevices(void);
00194   const char * kMidName(int i);
00195   const char * kMidType(int i);
00196   void   kMidSetDevice(int i);
00197   void   kMidSetMidiMapper(const char *mapfilename);
00198   const char * kMidVersion(void);
00199   const char * kMidCopyright(void);
00200 
00201 
00202 
00203 #ifdef __cplusplus
00204 
00205 }
00206 
00210 extern struct kMidData 
00211 {
00212   class DeviceManager *midi;
00213   class MidiPlayer *player;
00214   class MidiMapper *map;
00215   struct PlayerController *pctl;
00216   int pctlsmID;
00217   int pid;
00218 } kMid;
00219 #endif
00220 
00221 
00222 #endif
KDE Logo
This file is part of the documentation for kdelibs Version 3.1.0.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Wed Oct 8 12:21:59 2003 by doxygen 1.2.18 written by Dimitri van Heesch, © 1997-2001