NAME

MIDI::XML::Port - Class MIDI Port messages.

SYNOPSIS

  use MIDI::XML::Port;
  $Port = MIDI::XML::Port->new();
  $Port->delta(0);
  $Port->port(2);
  @event = $Port->as_event();
  $midi_track = MIDI::Track->new();
  push( @{$midi_track->events_r},\@event;
  @xml = $Port->as_MidiXML();
  print join("\n",@xml);

DESCRIPTION

MIDI::XML::Port is a class encapsulating MIDI Port meta messages. A Port message includes either a delta time or absolute time as implemented by MIDI::XML::Message and the MIDI Poer event encoded in 4 bytes as follows:

0xFF 0x21 0x01 0xnn

nn = port number

EXPORT

None.

METHODS AND ATTRIBUTES

$Port = MIDI::XML::Port->new()

This creates a new MIDI::XML::Port object.

$Port = MIDI::XML::Port->new($event);

Creates a new Port object initialized with the values of a MIDI::Event port array.

$delta_time = $Port->delta() or $Port->delta($delta_time);

Returns the message time as a delta time or undef if it is an absolute time. Optionally sets the message time to the specified delta time. To avoid contradictory times, the absolute time is set to undef when a delta time is set.

This functionality is provided by the MIDI::XML::Message base class.

$absolute_time = $Port->absolute() or $Port->absolute($absolute_time);

Returns the message time as an absolute time or undef if it is a delta time. Optionally sets the message time to the specified absolute time. To avoid contradictory times, the delta time is set to undef when an absolute time is set. The absolute time should be zero according to the specification.

This functionality is provided by the MIDI::XML::Message base class.

$time = $Port->time();

Returns the message time, absolute or delta, whichever was last set.

This functionality is provided by the MIDI::XML::Message base class.

$port = $Port->port() or $Port->port($port);

Returns and optionally sets the port number.

$ordinal = $Port->ordinal();

Returns a value to be used to order events that occur at the same time.

@event = $Port->as_event();

Returns a MIDI::Event port array initialized with the values of the Port object. MIDI::Event does not expect absolute times and will interpret them as delta times. Calling this method when the time is absolute will not generate a warning or error but it is unlikely that the results will be satisfactory.

@xml = $Port->as_MidiXML();

Returns an array of elements formatted according to the MidiXML DTD. These elements may be assembled by track into entire documents with the following suggested DOCTYPE declaration:

        <!DOCTYPE MIDI PUBLIC
                "-//Recordare//DTD MusicXML 0.7 MIDI//EN"
                "http://www.musicxml.org/dtds/midixml.dtd">

AUTHOR

Brian M. Ames, <bmames@apk.net>

SEE ALSO

MIDI::Event.

COPYRIGHT and LICENSE

Copyright 2002 Brian M. Ames. This software may be used under the terms of the GPL and Artistic licenses, the same as Perl itself.