/ 
MIDI-XML-0.02
River stage zero No dependents
/ MIDI::XML::CuePoint

NAME

MIDI::XML::SequenceNumber - MIDI Cue Point messages.

SYNOPSIS

use MIDI::XML::CuePoint;
$Cue_Point = MIDI::XML::CuePoint->new();
$Cue_Point->absolute(0);
$Cue_Point->text('Motorcycle starts');
@event = $Cue_Point->as_event();
$midi_track = MIDI::Track->new();
push( @{$midi_track->events_r},\@event;
@xml = $Cue_Point->as_MidiXML();
print join("\n",@xml);

DESCRIPTION

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

0xFF 0x07 length text

EXPORT

None.

METHODS AND ATTRIBUTES

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

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

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

Creates a new CuePoint object initialized with the values of a MIDI::Event cue_point array.

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

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

@event = $Text->as_event();

Returns a MIDI::Event cue_point array initialized with the values of the CuePoint 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 MidiXML 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.