Docs For Class FileHeader

Class FileHeader

Description

Implements interfaces:

Chunk

Represents a MIDI file header

since: 1.0

Located in /FileHeader.php (line 19)

Class Constant Summary

LENGTH = 14

Variable Summary

int $midiFormat

int $numTracks

int $timeDivision

Method Summary

FileHeader __construct (int $midiFormat, int $numTracks, int $timeDivision)

array getData ()

int getLength ()

binary toBinary ()

string __toString ()

Variables

int $midiFormat (line 24)

access: protected

int $numTracks (line 29)

access: protected

int $timeDivision (line 34)

access: protected

Methods

Constructor __construct (line 52)

Constructor

since: 1.0
access: public

FileHeader __construct (int $midiFormat, int $numTracks, int $timeDivision)

int $midiFormat: The MIDI file format; valid values are 0, 1 or 2
int $numTracks: The number of tracks in the MIDI file
int $timeDivision: The number of clock ticks per quarter note (240 is the standard)

getData (line 72)

return: [0] => midi format, [1] => # of tracks, [2] => time division
since: 1.0
access: public
usedby: TextFormatter::formatFileHeader()
usedby: HtmlFormatter::formatFileHeader()

array getData ()

Implementation of:

Chunk::getData(): Gets the data associated with this chunk

getLength (line 63)

since: 1.0
access: public

int getLength ()

Implementation of:

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

toBinary (line 86)

since: 1.0
access: public
usedby: File::getData()
uses: Util::pack()

binary toBinary ()

Implementation of:

Chunk::toBinary(): Gets the binary representation of this chunk

__toString (line 100)

since: 1.0
access: public

string __toString ()

Implementation of:

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

Class Constants

LENGTH = 14 (line 41)

The length of a MIDI file header

usedby: FileParser::parseFileHeader()
usedby: FileParser::getRawFileHeader()

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