MIDI::ChannelEvent Class Reference

This class represents channel events. More...

#include <ChannelEvent.h>

Inherits MIDI::Event.

Inherited by MIDI::ChannelControllerEvent.

Collaboration diagram for MIDI::ChannelEvent:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 ChannelEvent ()
 Default Constructor.
 ChannelEvent (const ChannelEvent &o)
 Copy Constructor.
 ChannelEvent (dword timeDelta, byte command, int channel, int param1, int param2)
 Constructor.
EventType type ()
byte command ()
int channel ()
int param1 ()
int param2 ()
virtual DataBuffer data (bool shorten=false)
virtual void debug ()
 Prints out information about this event. Is for debug purposes.

Detailed Description

This class represents channel events.

Channel events are events that are send to the synthesizer.

Each channel event has 4 fields:

Definition at line 41 of file ChannelEvent.h.


Constructor & Destructor Documentation

MIDI::ChannelEvent::ChannelEvent (  ) 

Default Constructor.

Definition at line 33 of file ChannelEvent.cpp.

MIDI::ChannelEvent::ChannelEvent ( const ChannelEvent o  ) 

Copy Constructor.

Definition at line 37 of file ChannelEvent.cpp.

MIDI::ChannelEvent::ChannelEvent ( dword  timeDelta,
byte  command,
int  channel,
int  param1,
int  param2 
)

Constructor.

Definition at line 41 of file ChannelEvent.cpp.


Member Function Documentation

int MIDI::ChannelEvent::channel (  ) 
Returns:
Channel number that this event applies to

Definition at line 55 of file ChannelEvent.cpp.

byte MIDI::ChannelEvent::command (  ) 

Command that this event represents. See MIDI specification for a complete list of possible values.

Returns:
type or command

Definition at line 50 of file ChannelEvent.cpp.

DataBuffer MIDI::ChannelEvent::data ( bool  shorten = false  )  [virtual]
Parameters:
shorten Whether to not include the command and channel
Returns:
This meta event represented as data in a MIDI file

Definition at line 70 of file ChannelEvent.cpp.

void MIDI::ChannelEvent::debug (  )  [virtual]

Prints out information about this event. Is for debug purposes.

Reimplemented from MIDI::Event.

Reimplemented in MIDI::ChannelControllerEvent.

Definition at line 87 of file ChannelEvent.cpp.

int MIDI::ChannelEvent::param1 (  ) 
Returns:
Value of first data parameter

Definition at line 60 of file ChannelEvent.cpp.

int MIDI::ChannelEvent::param2 (  ) 
Returns:
Value of second data parameter

Definition at line 65 of file ChannelEvent.cpp.

EventType MIDI::ChannelEvent::type (  )  [virtual]
Returns:
MIDI_CHEVENT, since this is a channel event

Implements MIDI::Event.

Definition at line 45 of file ChannelEvent.cpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Typedefs Enumerations Enumerator Defines

Generated on Tue Jan 5 16:09:42 2010 for libmidi by  doxygen 1.6.1