NAME

MIDI::XML::DeviceName - MIDI Device Name messages.

SYNOPSIS

  use MIDI::XML::DeviceName;
  $Device_Name = MIDI::XML::DeviceName->new();
  $Device_Name->absolute(0);
  $Device_Name->text('Lulu Jaw Harp');
  @event = $Device_Name->as_event();
  $midi_track = MIDI::Track->new();
  push( @{$midi_track->events_r},\@event;
  @xml = $Device_Name->as_MidiXML();
  print join("\n",@xml);

DESCRIPTION

MIDI::XML::DeviceName is a class encapsulating MIDI Device Name meta messages. A Device Name message includes either a delta time or absolute time as implemented by MIDI::XML::Message and the MIDI Device Name event encoded as follows:

0xFF 0x09 length text

EXPORT

None.

METHODS AND ATTRIBUTES

$Text = MIDI::XML::DeviceName->new()

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

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

Creates a new DeviceName object initialized with the values of a MIDI::Event device_name array.

$delta_time = $Device_Name->delta() or $Device_Name->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 = $Device_Name->absolute() or $Device_Name->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 = $Device_Name->time();

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

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

$text = $Text->text() or $Text->text($text);

Returns and optionally sets the text value.

$ordinal = $Seq_No->ordinal();

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

@event = $Text->as_event();

Returns a MIDI::Event set_sequence_number array initialized with the values of the SequenceNumber 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 = $Text->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">

RAVINGS

MMA Recommended Practice RP-019 describes the use of the Device Name event.

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.