.TH "FMOut" 3 "28 Jan 2004" "libkmid Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
FMOut \- FM device output class . Sends MIDI events to FM devices.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <fmout.h>\fP
.PP
Inherits \fBMidiOut\fP.
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBFMOut\fP (int d=0, int total=12)"
.br
.RI "\fIConstructor. \fP"
.ti -1c
.RI "\fB~FMOut\fP ()"
.br
.RI "\fIDestructor. \fP"
.ti -1c
.RI "virtual void \fBopenDev\fP (int sqfd)"
.br
.RI "\fISee \fBMidiOut::openDev\fP(). \fP"
.ti -1c
.RI "virtual void \fBcloseDev\fP (void)"
.br
.RI "\fISee \fBMidiOut::closeDev\fP(). \fP"
.ti -1c
.RI "virtual void \fBinitDev\fP (void)"
.br
.RI "\fISee \fBMidiOut::initDev\fP(). \fP"
.ti -1c
.RI "virtual void \fBnoteOn\fP (\fBuchar\fP chn, \fBuchar\fP note, \fBuchar\fP vel)"
.br
.RI "\fISee \fBMidiOut::noteOn\fP(). \fP"
.ti -1c
.RI "virtual void \fBnoteOff\fP (\fBuchar\fP chn, \fBuchar\fP note, \fBuchar\fP vel)"
.br
.RI "\fISee \fBMidiOut::noteOff\fP(). \fP"
.ti -1c
.RI "virtual void \fBkeyPressure\fP (\fBuchar\fP chn, \fBuchar\fP note, \fBuchar\fP vel)"
.br
.RI "\fISee \fBMidiOut::keyPressure\fP(). \fP"
.ti -1c
.RI "virtual void \fBchnPatchChange\fP (\fBuchar\fP chn, \fBuchar\fP patch)"
.br
.RI "\fISee \fBMidiOut::chnPatchChange\fP(). \fP"
.ti -1c
.RI "virtual void \fBchnPressure\fP (\fBuchar\fP chn, \fBuchar\fP vel)"
.br
.RI "\fISee \fBMidiOut::chnPressure\fP(). \fP"
.ti -1c
.RI "virtual void \fBchnPitchBender\fP (\fBuchar\fP chn, \fBuchar\fP lsb, \fBuchar\fP msb)"
.br
.RI "\fISee \fBMidiOut::chnPitchBender\fP(). \fP"
.ti -1c
.RI "virtual void \fBchnController\fP (\fBuchar\fP chn, \fBuchar\fP ctl, \fBuchar\fP v)"
.br
.RI "\fISee \fBMidiOut::chnController\fP(). \fP"
.ti -1c
.RI "virtual void \fBsysex\fP (\fBuchar\fP *data, \fBulong\fP size)"
.br
.RI "\fIIt's an empty function, as FM devices don't support System Exclusive messages. \fP"
.ti -1c
.RI "virtual void \fBsetVolumePercentage\fP (int i)"
.br
.RI "\fISee \fBMidiOut::setVolumePercentage\fP(). \fP"
.ti -1c
.RI "int \fBpatch\fP (int p)"
.br
.RI "\fIReturns \fCp\fP if the patch p has been loaded, or another patch (already loaded) if \fCp\fP hasn't been loaded. \fP"
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "void \fBsetFMPatchesDirectory\fP (const  char *dir)"
.br
.RI "\fISets the directory where the FM patches are stored, that is, where the std.o3, std.sb, drums.o3 and drums.sb files can be found. \fP"
.in -1c
.SH "Detailed Description"
.PP 
FM device output class . Sends MIDI events to FM devices. 

FMOut is used to send MIDI events to FM devices, such as AdLib cards, or OPL3 synthesizers.
.PP
FMOut inherits \fBMidiOut\fP and supports the same simple API.
.PP
The preferred way to use this class is by selecting a FM device on the \fBMidiManager\fP and using a \fBMidiManager\fP object directly
.PP
\fBVersion:\fP
.RS 4
0.9.5 17/01/2000 
.RE
.PP
\fBAuthor:\fP
.RS 4
Antonio Larrosa Jimenez <larrosa@kde.org> 
.RE
.PP

.PP
Definition at line 43 of file fmout.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "FMOut::FMOut (int d = 0, int total = 12)"
.PP
Constructor. See \fBMidiOut::MidiOut\fP() for more information. Definition at line 45 of file fmout.cc.
.SS "FMOut::~\fBFMOut\fP ()"
.PP
Destructor. Definition at line 60 of file fmout.cc.
.PP
References closeDev().
.SH "Member Function Documentation"
.PP 
.SS "void FMOut::openDev (int sqfd)\fC [virtual]\fP"
.PP
See \fBMidiOut::openDev\fP(). Reimplemented from \fBMidiOut\fP.
.PP
Definition at line 72 of file fmout.cc.
.SS "void FMOut::closeDev (void)\fC [virtual]\fP"
.PP
See \fBMidiOut::closeDev\fP(). Reimplemented from \fBMidiOut\fP.
.PP
Definition at line 89 of file fmout.cc.
.PP
References MidiOut::ok().
.PP
Referenced by ~FMOut().
.SS "void FMOut::initDev (void)\fC [virtual]\fP"
.PP
See \fBMidiOut::initDev\fP(). Reimplemented from \fBMidiOut\fP.
.PP
Definition at line 97 of file fmout.cc.
.PP
References chnController(), chnPatchChange(), chnPitchBender(), chnPressure(), MidiOut::ok(), and sysex().
.SS "void FMOut::noteOn (\fBuchar\fP chn, \fBuchar\fP note, \fBuchar\fP vel)\fC [virtual]\fP"
.PP
See \fBMidiOut::noteOn\fP(). Reimplemented from \fBMidiOut\fP.
.PP
Definition at line 218 of file fmout.cc.
.PP
References noteOff(), MidiMapper::patch(), and patch().
.SS "void FMOut::noteOff (\fBuchar\fP chn, \fBuchar\fP note, \fBuchar\fP vel)\fC [virtual]\fP"
.PP
See \fBMidiOut::noteOff\fP(). Reimplemented from \fBMidiOut\fP.
.PP
Definition at line 251 of file fmout.cc.
.PP
Referenced by noteOn().
.SS "void FMOut::keyPressure (\fBuchar\fP chn, \fBuchar\fP note, \fBuchar\fP vel)\fC [virtual]\fP"
.PP
See \fBMidiOut::keyPressure\fP(). Reimplemented from \fBMidiOut\fP.
.PP
Definition at line 266 of file fmout.cc.
.SS "void FMOut::chnPatchChange (\fBuchar\fP chn, \fBuchar\fP patch)\fC [virtual]\fP"
.PP
See \fBMidiOut::chnPatchChange\fP(). Reimplemented from \fBMidiOut\fP.
.PP
Definition at line 274 of file fmout.cc.
.PP
References MidiMapper::patch().
.PP
Referenced by initDev().
.SS "void FMOut::chnPressure (\fBuchar\fP chn, \fBuchar\fP vel)\fC [virtual]\fP"
.PP
See \fBMidiOut::chnPressure\fP(). Reimplemented from \fBMidiOut\fP.
.PP
Definition at line 285 of file fmout.cc.
.PP
Referenced by initDev().
.SS "void FMOut::chnPitchBender (\fBuchar\fP chn, \fBuchar\fP lsb, \fBuchar\fP msb)\fC [virtual]\fP"
.PP
See \fBMidiOut::chnPitchBender\fP(). Reimplemented from \fBMidiOut\fP.
.PP
Definition at line 295 of file fmout.cc.
.PP
Referenced by initDev().
.SS "void FMOut::chnController (\fBuchar\fP chn, \fBuchar\fP ctl, \fBuchar\fP v)\fC [virtual]\fP"
.PP
See \fBMidiOut::chnController\fP(). Reimplemented from \fBMidiOut\fP.
.PP
Definition at line 306 of file fmout.cc.
.PP
Referenced by initDev().
.SS "void FMOut::sysex (\fBuchar\fP * data, \fBulong\fP size)\fC [virtual]\fP"
.PP
It's an empty function, as FM devices don't support System Exclusive messages. Reimplemented from \fBMidiOut\fP.
.PP
Definition at line 321 of file fmout.cc.
.PP
Referenced by initDev().
.SS "void FMOut::setVolumePercentage (int i)\fC [virtual]\fP"
.PP
See \fBMidiOut::setVolumePercentage\fP(). Reimplemented from \fBMidiOut\fP.
.PP
Definition at line 337 of file fmout.cc.
.PP
References KStdAccel::close(), and KStdAccel::open().
.SS "int FMOut::patch (int p)"
.PP
Returns \fCp\fP if the patch p has been loaded, or another patch (already loaded) if \fCp\fP hasn't been loaded. Definition at line 207 of file fmout.cc.
.PP
Referenced by noteOn().
.SS "void FMOut::setFMPatchesDirectory (const char * dir)\fC [static]\fP"
.PP
Sets the directory where the FM patches are stored, that is, where the std.o3, std.sb, drums.o3 and drums.sb files can be found. It will store a copy of the parameter, so you should delete the memory used by the parameter you passed. Definition at line 326 of file fmout.cc.

.SH "Author"
.PP 
Generated automatically by Doxygen for libkmid Library from the source code.
