Om  1.0.0
A universal framework for multimedia simulation
Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
om::sound::base::MIDI Class Reference

A class that stores a MIDI sequence. More...

#include <omSoundMIDI.h>

Inheritance diagram for om::sound::base::MIDI:
om::sound::base::MIDIInputStream

Public Member Functions

virtual Bool canSeek () const
 Return whether or not seeking is allowed in this input stream. More...
 
virtual Bool canSeek (const Time &timeOffset) const
 Return whether or not this stream's current position can be moved by the specified time offset. More...
 
virtual Time seek (const Time &timeOffset)
 Move the current position in the stream by the specified signed time offset in seconds. More...
 
virtual Time getTimeRemaining () const
 Return the number of seconds remaining in the MIDI input stream. More...
 
virtual Time getTime () const
 Return the current position of the stream in seconds relative to the start of the stream. More...
 
- Public Member Functions inherited from om::sound::base::MIDIInputStream
virtual ~MIDIInputStream ()
 Destroy this MIDI input stream and release any resources associated with it. More...
 
Size read (MIDIBuffer &buffer, const Time &length)
 Read MIDI events into the buffer for the next time interval of the specified length. More...
 
Bool hasTimeRemaining () const
 Return whether or not this MIDI input stream has any time remaining in the stream. More...
 

Static Public Attributes

static const om::resources::ResourceType RESOURCE_TYPE
 The resource type for a MIDI resource. More...
 

Protected Member Functions

virtual Size readEvents (MIDIBuffer &buffer, const Time &length)
 Read the specified number of MIDI events from the input stream into the output buffer. More...
 

Detailed Description

A class that stores a MIDI sequence.

Member Function Documentation

virtual Bool om::sound::base::MIDI::canSeek ( ) const
virtual

Return whether or not seeking is allowed in this input stream.

Reimplemented from om::sound::base::MIDIInputStream.

virtual Bool om::sound::base::MIDI::canSeek ( const Time timeOffset) const
virtual

Return whether or not this stream's current position can be moved by the specified time offset.

Reimplemented from om::sound::base::MIDIInputStream.

virtual Time om::sound::base::MIDI::seek ( const Time timeOffset)
virtual

Move the current position in the stream by the specified signed time offset in seconds.

Reimplemented from om::sound::base::MIDIInputStream.

virtual Time om::sound::base::MIDI::getTimeRemaining ( ) const
virtual

Return the number of seconds remaining in the MIDI input stream.

Implements om::sound::base::MIDIInputStream.

virtual Time om::sound::base::MIDI::getTime ( ) const
virtual

Return the current position of the stream in seconds relative to the start of the stream.

Implements om::sound::base::MIDIInputStream.

virtual Size om::sound::base::MIDI::readEvents ( MIDIBuffer buffer,
const Time length 
)
protectedvirtual

Read the specified number of MIDI events from the input stream into the output buffer.

Implements om::sound::base::MIDIInputStream.

Member Data Documentation

const om::resources::ResourceType om::sound::base::MIDI::RESOURCE_TYPE
static

The resource type for a MIDI resource.


The documentation for this class was generated from the following file: