Docs For Class KeySignatureEvent

Class KeySignatureEvent

Description

Represents a set key signature event

This event sets the key signature for the song. It should always be in the first track. There can be multiple key signature events per song.

since: 1.0

Located in /Event/KeySignatureEvent.php (line 25)

MetaEvent
   |
   --KeySignatureEvent

Method Summary

KeySignatureEvent __construct (int $accidentals, int $mode)

string getParamDescription ()

int getSubtype ()

Variables

Inherited Variables

Inherited from MetaEvent

MetaEvent::$data
MetaEvent::$length

Methods

Constructor __construct (line 33)

since: 1.0
access: public

KeySignatureEvent __construct (int $accidentals, int $mode)

int $accidentals: 256 - # of flats, 0 + # of sharps
int $mode
:
1. for major, 1 for minor

Redefinition of:

MetaEvent::__construct(): Constructor

getParamDescription (line 43)

since: 1.0
access: public
uses: Key::getKeySignature()

string getParamDescription ()

getSubtype (line 54)

since: 1.0
access: public
uses: MetaEventType::KEY_SIGNATURE

int getSubtype ()

Redefinition of:

MetaEvent::getSubtype(): Gets the meta event subtype for this event

Inherited Methods

Inherited From MetaEvent

MetaEvent::__construct()
MetaEvent::getData()
MetaEvent::getLength()
MetaEvent::getSubtype()
MetaEvent::getType()
MetaEvent::toBinary()
MetaEvent::__toString()

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