.TH "PlayerController" 3 "28 Jan 2004" "libkmid Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
PlayerController \- PlayerController is a struct that is used by the \fBMidiPlayer\fP object to tell other parts of the application about the status of the MIDI playing. Struct used to have control over the player engine.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <player.h>\fP
.PP
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "volatile \fBulong\fP \fBticksTotal\fP"
.br
.ti -1c
.RI "volatile \fBulong\fP \fBticksPlayed\fP"
.br
.ti -1c
.RI "volatile double \fBmillisecsPlayed\fP"
.br
.ti -1c
.RI "volatile \fBulong\fP \fBbeginmillisec\fP"
.br
.ti -1c
.RI "volatile int \fBtempo\fP"
.br
.ti -1c
.RI "volatile int \fBnum\fP"
.br
.ti -1c
.RI "volatile int \fBden\fP"
.br
.ti -1c
.RI "volatile int \fBSPEVprocessed\fP"
.br
.ti -1c
.RI "volatile int \fBSPEVplayed\fP"
.br
.ti -1c
.RI "volatile int \fBOK\fP"
.br
.RI "\fIWhen pause is released, if the caller must know when the player has opened the devices and is playing again, then it just has to check to see when OK changes the value to 1. \fP"
.ti -1c
.RI "volatile int \fBplaying\fP"
.br
.RI "\fIWhen the player is playing (or paused), playing is set to 1. \fP"
.ti -1c
.RI "volatile int \fBpaused\fP"
.br
.RI "\fIWhen the player is paused, paused is set to 1. \fP"
.ti -1c
.RI "volatile int \fBmoving\fP"
.br
.RI "\fIWhen the player seeking the position of the song, moving is set to 1. \fP"
.ti -1c
.RI "volatile int \fBfinished\fP"
.br
.RI "\fIWhen the player has finished playing a song, finished is set to 1. \fP"
.ti -1c
.RI "volatile int \fBmessage\fP"
.br
.ti -1c
.RI "volatile \fBulong\fP \fBgotomsec\fP"
.br
.ti -1c
.RI "volatile int \fBerror\fP"
.br
.RI "\fIWhen error is 1, an error has ocurred (i.e. \fP"
.ti -1c
.RI "volatile int \fBgm\fP"
.br
.RI "\fIIf gm is 1, the song follows the General Midi standard, if gm is 0, the song is in MT 32 format. \fP"
.ti -1c
.RI "volatile int \fBvolumepercentage\fP"
.br
.RI "\fI100 means no change, 50 halfs the volume, 200 doubles it (if possible), etc. \fP"
.ti -1c
.RI "volatile bool \fBforcepgm\fP [16]"
.br
.RI "\fIActivate or disactivate the force to use a patch for a given channel. \fP"
.ti -1c
.RI "volatile int \fBpgm\fP [16]"
.br
.RI "\fIForce a given patch in each channel at 'this' moment, as determined by \fBforcepgm\fP. \fP"
.ti -1c
.RI "volatile double \fBratioTempo\fP"
.br
.RI "\fIRatio to multiply the tempo to. \fP"
.ti -1c
.RI "volatile bool \fBisSendingAllNotesOff\fP"
.br
.ti -1c
.RI "volatile \fBMidiEvent\fP * \fBev\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
PlayerController is a struct that is used by the \fBMidiPlayer\fP object to tell other parts of the application about the status of the MIDI playing. Struct used to have control over the player engine. 

\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 137 of file player.h.
.SH "Member Data Documentation"
.PP 
.SS "volatile int \fBPlayerController::OK\fP"
.PP
When pause is released, if the caller must know when the player has opened the devices and is playing again, then it just has to check to see when OK changes the value to 1. Definition at line 156 of file player.h.
.PP
Referenced by MidiPlayer::play().
.SS "volatile int \fBPlayerController::playing\fP"
.PP
When the player is playing (or paused), playing is set to 1. Definition at line 161 of file player.h.
.PP
Referenced by MidiPlayer::play().
.SS "volatile int \fBPlayerController::paused\fP"
.PP
When the player is paused, paused is set to 1. Definition at line 166 of file player.h.
.PP
Referenced by MidiPlayer::play().
.SS "volatile int \fBPlayerController::moving\fP"
.PP
When the player seeking the position of the song, moving is set to 1. Definition at line 171 of file player.h.
.PP
Referenced by MidiPlayer::play().
.SS "volatile int \fBPlayerController::finished\fP"
.PP
When the player has finished playing a song, finished is set to 1. Definition at line 176 of file player.h.
.PP
Referenced by MidiPlayer::play().
.SS "volatile int \fBPlayerController::error\fP"
.PP
When error is 1, an error has ocurred (i.e. it coultn't open the device) Definition at line 195 of file player.h.
.PP
Referenced by MidiPlayer::play().
.SS "volatile int \fBPlayerController::gm\fP"
.PP
If gm is 1, the song follows the General Midi standard, if gm is 0, the song is in MT 32 format. Definition at line 201 of file player.h.
.PP
Referenced by MidiPlayer::play().
.SS "volatile int \fBPlayerController::volumepercentage\fP"
.PP
100 means no change, 50 halfs the volume, 200 doubles it (if possible), etc. \fBSee also:\fP
.RS 4
\fBDeviceManager::setVolumePercentage()\fP 
.RE
.PP
Definition at line 208 of file player.h.
.PP
Referenced by MidiPlayer::play().
.SS "volatile bool \fBPlayerController::forcepgm\fP[16]"
.PP
Activate or disactivate the force to use a patch for a given channel. \fBSee also:\fP
.RS 4
\fBpgm\fP 
.RE
.PP
Definition at line 214 of file player.h.
.PP
Referenced by MidiPlayer::play(), and MidiPlayer::setPos().
.SS "volatile int \fBPlayerController::pgm\fP[16]"
.PP
Force a given patch in each channel at 'this' moment, as determined by \fBforcepgm\fP. Definition at line 220 of file player.h.
.PP
Referenced by MidiPlayer::play(), and MidiPlayer::setPos().
.SS "volatile double \fBPlayerController::ratioTempo\fP"
.PP
Ratio to multiply the tempo to. Definition at line 225 of file player.h.
.PP
Referenced by MidiPlayer::loadSong(), MidiPlayer::play(), MidiPlayer::setPos(), and MidiPlayer::setTempoRatio().

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