.TH "SpecialEvent" 3 "28 Jan 2004" "libkmid Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SpecialEvent \- This struct stores text, lyrics and change tempo events among others. Struct used to store certain events.  

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

.in +1c
.ti -1c
.RI "int \fBid\fP"
.br
.RI "\fIAn integer ID, that is assigned in order to each SpecialEvent. \fP"
.ti -1c
.RI "\fBulong\fP \fBdiffmilliseconds\fP"
.br
.RI "\fIDelta milliseconds from the previous SpecialEvent. \fP"
.ti -1c
.RI "\fBulong\fP \fBabsmilliseconds\fP"
.br
.RI "\fIThe absolute millisecond (from the beginning of the song) at which this SpecialEvent object is played. \fP"
.ti -1c
.RI "int \fBticks\fP"
.br
.RI "\fIMIDI ticks (from the beginning of the song) at which this event is played. \fP"
.ti -1c
.RI "int \fBtype\fP"
.br
.RI "\fIType of event. \fP"
.ti -1c
.RI "char \fBtext\fP [1024]"
.br
.RI "\fIText field . \fP"
.ti -1c
.RI "\fBulong\fP \fBtempo\fP"
.br
.RI "\fITempo field . \fP"
.ti -1c
.RI "int \fBnum\fP"
.br
.RI "\fINumerator . \fP"
.ti -1c
.RI "int \fBden\fP"
.br
.RI "\fIDenominator . \fP"
.ti -1c
.RI "\fBSpecialEvent\fP * \fBnext\fP"
.br
.RI "\fIThis struct stores text, lyrics and change tempo events among others. \fP"
.in -1c
.SH "Detailed Description"
.PP 
This struct stores text, lyrics and change tempo events among others. Struct used to store certain events. 

It includes the main information for an event. That is, the absolute millisecond at which this event is played (from the beginning of the song), the delta milliseconds from the previous SpecialEvent, an ID, etc.
.PP
This struct is used as nodes for a linked list, which you can get using \fBMidiPlayer::specialEvents\fP().
.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 47 of file player.h.
.SH "Member Data Documentation"
.PP 
.SS "int \fBSpecialEvent::id\fP"
.PP
An integer ID, that is assigned in order to each SpecialEvent. Definition at line 52 of file player.h.
.SS "\fBulong\fP \fBSpecialEvent::diffmilliseconds\fP"
.PP
Delta milliseconds from the previous SpecialEvent. \fBSee also:\fP
.RS 4
\fBabsmilliseconds\fP 
.RE
.PP
Definition at line 59 of file player.h.
.SS "\fBulong\fP \fBSpecialEvent::absmilliseconds\fP"
.PP
The absolute millisecond (from the beginning of the song) at which this SpecialEvent object is played. \fBSee also:\fP
.RS 4
\fBdiffmilliseconds\fP 
.RE
.PP
Definition at line 67 of file player.h.
.SS "int \fBSpecialEvent::ticks\fP"
.PP
MIDI ticks (from the beginning of the song) at which this event is played. Definition at line 72 of file player.h.
.SS "int \fBSpecialEvent::type\fP"
.PP
Type of event. This currently includes:
.PP
.IP "\(bu" 2
0 - Nothing, end of linked list. 
.IP "\(bu" 2
1 - Text Event . See \fBtext\fP. 
.IP "\(bu" 2
3 - Change Tempo Event . See \fBtempo\fP. 
.IP "\(bu" 2
5 - Lyrics Event . See \fBtext\fP. 
.IP "\(bu" 2
6 - Change number of beats per measure . See \fBnum\fP and \fBden\fP. 
.IP "\(bu" 2
7 - Beat . See \fBnum\fP and \fBden\fP.
.PP
The 'Change number of beats per measure' and 'beat' events are not really in the midi file, but they are added to the linked list in case you have an use for it. Definition at line 88 of file player.h.
.SS "char \fBSpecialEvent::text\fP[1024]"
.PP
Text field . It has a meaning only for Text and Lyrics events. Definition at line 93 of file player.h.
.SS "\fBulong\fP \fBSpecialEvent::tempo\fP"
.PP
Tempo field . It has a meaning only for Change Tempo events. Definition at line 98 of file player.h.
.SS "int \fBSpecialEvent::num\fP"
.PP
Numerator . It has a meaning only for Change number of beats per measure and beat events. Definition at line 103 of file player.h.
.SS "int \fBSpecialEvent::den\fP"
.PP
Denominator . It has a meaning only for Change number of beats per measure and beat events. Definition at line 108 of file player.h.
.SS "struct \fBSpecialEvent\fP* \fBSpecialEvent::next\fP"
.PP
This struct stores text, lyrics and change tempo events among others. It includes the main information for an event. That is, the absolute millisecond at which this event is played (from the beginning of the song), the delta milliseconds from the previous SpecialEvent, an ID, etc.
.PP
This struct is used as nodes for a linked list, which you can get using \fBMidiPlayer::specialEvents\fP(). Definition at line 120 of file player.h.

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