Package midi :: Class KeySignatureEvent

Class KeySignatureEvent

object --+        
         |        
     Event --+    
             |    
     MetaEvent --+
                 |
                KeySignatureEvent

Sets the key signature, made up of a number of sharps/flats and either major or minor.

Nested Classes

[hide private]

Inherited from Event: __metaclass__

Instance Methods

[hide private]

__str__(self)
str(x)

source code

decode_data(self)
Takes the data that's been read into data instance variable and sets instance attributes from the values in it. source code

encode_data(self)
Produces byte data to represent this event on the basis of instance variables.

source code

Inherited from MetaEvent: decode, encode

Inherited from Event: __cmp__, __init__, adjust_msdelay, copy, encode_delta_tick

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __subclasshook__

Class Methods

[hide private]

Inherited from MetaEvent: is_event, is_meta_event

Class Variables

[hide private]

name = 'Key Signature'

metacommand = 89

accidentals = 0
Number of sharps/flats.

major = True
Major or minor: True for major, False for minor.

Inherited from MetaEvent: allow_running, data, statusmsg

Inherited from Event: length

Instance Variables

[hide private]

Inherited from Event: channel, msdelay, order, tick, track, type

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

str(self)
(Informal representation operator)

source code

str(x)

Overrides: object.__str__: (inherited documentation)

decode_data(self)

source code

Takes the data that's been read into data instance variable and sets instance attributes from the values in it. What this does is specific to the event type.

At the simplest, it could do nothing, just leaving the raw data in data, but more likely it will decode values from the data.

Overrides: Event.decode_data: (inherited documentation)

encode_data(self)

source code

Produces byte data to represent this event on the basis of instance variables. This is the data that will be written to a MIDI stream (not including the tick and status message).

Returns:: byte data as a string
Overrides: Event.encode_data: (inherited documentation)

Class Variable Details

[hide private]

accidentals

Number of sharps/flats. Positive sharps, negative flats.

Value:

Class KeySignatureEvent

__str__(self) (Informal representation operator)

decode_data(self)

encode_data(self)

accidentals

str(self)
(Informal representation operator)