Docs For Class EventParser

Description

Class for parsing MIDI events

since: 1.0

Located in /Parsing/EventParser.php (line 24)

Parser
   |
   --EventParser

Variable Summary

int|null $continuationEvent

Method Summary

EventParser __construct ()

ChannelEvent getChannelEvent (int $type, int $channel, int $param1, [int|null $param2 = null])

MetaEvent getMetaEvent (int $type, string|binary $data)

SystemExclusiveEvent getSystemExclusiveEvent (string|binary $data)

Event parse ()

ChannelEvent parseChannelEvent (int $eventType, bool $isContinuation)

MetaEvent parseMetaEvent ()

SystemExclusiveEvent parseSystemExclusiveEvent ()

Variables

int|null $continuationEvent (line 31)

The current continuation event type

access: protected

Inherited Variables

Inherited from Parser

Parser::$file
Parser::$state

Methods

Constructor __construct (line 38)

Constructor

since: 1.0
access: public

EventParser __construct ()

Redefinition of:

Parser::__construct(): Constructor

getChannelEvent (line 56)

Channel event factory

since: 1.0
throws: MidiException
access: public
usedby: EventParser::parseChannelEvent()

ChannelEvent getChannelEvent (int $type, int $channel, int $param1, [int|null $param2 = null])

int $type: See EventType
int $channel: Valid values: 0-15
int $param1
int|null $param2

getMetaEvent (line 99)

Meta event factory

If the event type does not exist, then an UnknownMetaEvent object is returned.

since: 1.0
access: public
usedby: EventParser::parseMetaEvent()
uses: Util::unpack()

MetaEvent getMetaEvent (int $type, string|binary $data)

int $type: See MetaEventType
string|binary $data

getSystemExclusiveEvent (line 157)

System exclusive event factory

since: 1.0
access: public
usedby: EventParser::parseSystemExclusiveEvent()

SystemExclusiveEvent getSystemExclusiveEvent (string|binary $data)

string|binary $data

parse (line 172)

since: 1.0
throws: ParseException
access: public
usedby: TrackParser::parse()
uses: Util::unpack()
uses: Parser::read()
uses: EventParser::parseChannelEvent()
uses: EventParser::parseMetaEvent()
uses: EventParser::parseSystemExclusiveEvent()

Event parse ()

Redefinition of:

Parser::parse(): Parses the buffer stream and returns the next chunk

parseChannelEvent (line 215)

Parses the buffer stream for a channel event

since: 1.0
access: protected
usedby: EventParser::parse()
uses: Util::unpack()
uses: EventParser::getChannelEvent()

ChannelEvent parseChannelEvent (int $eventType, bool $isContinuation)

int $eventType: See EventType
bool $isContinuation: Whether the event is a continuation of a previous event

parseMetaEvent (line 243)

Parses the buffer stream for a meta event

since: 1.0
access: protected
usedby: EventParser::parse()
uses: Util::unpack()
uses: Parser::read()
uses: Parser::getDelta()
uses: EventParser::getMetaEvent()

MetaEvent parseMetaEvent ()

parseSystemExclusiveEvent (line 262)

Parses the buffer stream for a system exclusive event

since: 1.0
access: protected
usedby: EventParser::parse()
uses: EventParser::getSystemExclusiveEvent()
uses: Parser::getDelta()
uses: Parser::read()

SystemExclusiveEvent parseSystemExclusiveEvent ()

Inherited Methods

Inherited From Parser

Parser::__construct()
Parser::afterLoad()
Parser::afterSetFile()
Parser::createFileObject()
Parser::getDelta()
Parser::getState()
Parser::load()
Parser::parse()
Parser::read()
Parser::setFile()
Parser::setState()