Class ChannelEvent

Description

Implements interfaces:

Represents events that are associated with a channel

  • abstract:
  • since: 1.0

Located in /Event/ChannelEvent.php (line 24)


	
			
Direct descendents
Class Description
ChannelAftertouchEvent Represents a channel aftertouch channel event
ControllerEvent Represents controller updates for a particular channel
NoteAftertouchEvent Represents the note aftertouch channel event
NoteOffEvent Represents a note off channel event
NoteOnEvent Represents a note on channel event
PitchBendEvent Represents the pitch bend channel event
ProgramChangeEvent Represents a program change event
Variable Summary
Method Summary
ChannelEvent __construct (int $channel, int $param1, [int $param2 = null], [bool $isContinuation = false])
array getData ()
int getLength ()
bool isContinuation ()
bool setContinuation (bool $isContinuation)
binary toBinary ()
string __toString ()
Variables
int $channel (line 31)

The channel this event is associated with (0-15)

  • access: protected
bool $isContinuation (line 46)
  • access: private
int $param1 (line 36)
  • access: protected
int $param2 (line 41)
  • access: protected
Methods
Constructor __construct (line 58)

Constructor

  • since: 1.0
  • access: public
ChannelEvent __construct (int $channel, int $param1, [int $param2 = null], [bool $isContinuation = false])
  • int $channel: 4-bit integer
  • int $param1: 8-bit integer
  • int $param2: 8-bit integer
  • bool $isContinuation
getData (line 100)

Gets the data associated with this event

  • return: [0] => channel, [1] => param1, [2] => param2
  • since: 1.0
  • access: public
array getData ()

Implementation of:
Chunk::getData()
Gets the data associated with this chunk
getLength (line 115)

Gets the length of this event in bytes

  • since: 1.0
  • access: public
int getLength ()

Implementation of:
Chunk::getLength()
Gets the length of this chunk in bytes

Redefined in descendants as:
isContinuation (line 138)

Gets whether this event is a continuation event

  • since: 1.0
  • access: public
bool isContinuation ()
setContinuation (line 127)

Sets whether this event is a continuation event

  • since: 1.0
  • access: public
bool setContinuation (bool $isContinuation)
  • bool $isContinuation
toBinary (line 87)

Gets a binary representation of this event

binary toBinary ()

Implementation of:
Chunk::toBinary()
Gets the binary representation of this chunk
__toString (line 75)

Gets a string representation of this event

string __toString ()

Implementation of:
Chunk::__toString()
Gets the string representation of this chunk

Documentation generated on Sun, 25 Oct 2009 22:38:13 -0700 by phpDocumentor 1.4.3