MidiQueue Class Reference

Queue management. More...

#include <alsaqueue.h>

Inheritance diagram for MidiQueue:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 MidiQueue (MidiClient *seq, QObject *parent=0)
 Constructor.
 MidiQueue (MidiClient *seq, const QueueInfo &info, QObject *parent=0)
 Constructor.
 MidiQueue (MidiClient *seq, const QString name, QObject *parent=0)
 Constructor.
 MidiQueue (MidiClient *seq, const int queue_id, QObject *parent=0)
 Constructor.
virtual ~MidiQueue ()
 Destructor.
int getId () const
void start ()
 Start the queue.
void stop ()
 Stop the queue.
void continueRunning ()
 Start the queue without resetting the last position.
void clear ()
 Clear the queue, dropping any scheduled events.
void setTickPosition (snd_seq_tick_time_t pos)
 Sets the queue position in musical time (ticks).
void setRealTimePosition (snd_seq_real_time_t *pos)
 Sets the queue position in real time (clock) units: seconds and nanoseconds.
QueueInfogetInfo ()
 Gets a QueueInfo object reference.
QueueStatusgetStatus ()
 Gets a QueueStatus object reference.
QueueTempogetTempo ()
 Gets a QueueTempo object reference.
QueueTimergetTimer ()
 Gets a QueueTimer object reference.
int getUsage ()
 Gets the queue usage flag.
void setInfo (const QueueInfo &value)
 Applies a QueueInfo object to the queue.
void setTempo (const QueueTempo &value)
 Applies a QueueTempo object to the queue.
void setTimer (const QueueTimer &value)
 Applies q QueueTimer object to the queue.
void setUsage (int used)
 Sets the queue usage flag.


Detailed Description

Queue management.

This class represents an ALSA sequencer queue object.

Examples:

drumgrid.cpp, dumpmid.cpp, guiplayer.cpp, metronome.cpp, playsmf.cpp, and sysinfo.cpp.

Definition at line 188 of file alsaqueue.h.


Constructor & Destructor Documentation

MidiQueue ( MidiClient seq,
QObject parent = 0 
) [explicit]

Constructor.

Parameters:
seq An existing MidiClient instance
parent An optional parent object

Definition at line 687 of file alsaqueue.cpp.

References CHECK_ERROR, and MidiClient::getHandle().

MidiQueue ( MidiClient seq,
const QueueInfo info,
QObject parent = 0 
)

Constructor.

Parameters:
seq An existing MidiClient instance
info A QueueInfo object reference
parent An optional parent object

Definition at line 701 of file alsaqueue.cpp.

References CHECK_ERROR, and MidiClient::getHandle().

MidiQueue ( MidiClient seq,
const QString  name,
QObject parent = 0 
)

Constructor.

Parameters:
seq An existing MidiClient instance
name The name for the new queue
parent An optional parent object

Definition at line 716 of file alsaqueue.cpp.

References CHECK_ERROR, and MidiClient::getHandle().

MidiQueue ( MidiClient seq,
const int  queue_id,
QObject parent = 0 
)

Constructor.

Note: this constructor doesn't allocate a new queue, it uses an existing one.

Parameters:
seq An existing MidiClient instance
queue_id An existing queue numeric identifier
parent An optional parent object

Definition at line 732 of file alsaqueue.cpp.

~MidiQueue (  )  [virtual]

Destructor.

Definition at line 743 of file alsaqueue.cpp.

References CHECK_ERROR, and MidiClient::getHandle().


Member Function Documentation

void clear (  ) 

Clear the queue, dropping any scheduled events.

Definition at line 879 of file alsaqueue.cpp.

References MidiClient::getHandle().

Referenced by SequencerOutputThread::run().

void continueRunning (  ) 

Start the queue without resetting the last position.

This method should start running the queue from the last position set.

Definition at line 870 of file alsaqueue.cpp.

References CHECK_WARNING, and MidiClient::getHandle().

Referenced by SequencerOutputThread::run().

int getId (  )  const [inline]

Definition at line 198 of file alsaqueue.h.

Referenced by SequencerOutputThread::SequencerOutputThread().

QueueInfo & getInfo (  ) 

Gets a QueueInfo object reference.

Returns:
A QueueInfo object reference
Examples:
sysinfo.cpp.

Definition at line 755 of file alsaqueue.cpp.

References CHECK_WARNING, and MidiClient::getHandle().

QueueStatus & getStatus (  ) 

Gets a QueueStatus object reference.

Returns:
A QueueStatus object reference
Examples:
sysinfo.cpp.

Definition at line 765 of file alsaqueue.cpp.

References CHECK_WARNING, and MidiClient::getHandle().

Referenced by SequencerOutputThread::syncOutput().

QueueTempo & getTempo (  ) 

Gets a QueueTempo object reference.

Returns:
A QueueTempo object reference
Examples:
sysinfo.cpp.

Definition at line 775 of file alsaqueue.cpp.

References CHECK_WARNING, and MidiClient::getHandle().

QueueTimer & getTimer (  ) 

Gets a QueueTimer object reference.

Returns:
A QueueTimer object reference
Examples:
sysinfo.cpp.

Definition at line 785 of file alsaqueue.cpp.

References CHECK_WARNING, and MidiClient::getHandle().

int getUsage (  ) 

Gets the queue usage flag.

Returns:
1 = client is allowed to access the queue, 0 = not allowed.

Definition at line 826 of file alsaqueue.cpp.

References CHECK_WARNING, and MidiClient::getHandle().

void setInfo ( const QueueInfo value  ) 

Applies a QueueInfo object to the queue.

Parameters:
value A QueueInfo object reference

Definition at line 795 of file alsaqueue.cpp.

References CHECK_WARNING, and MidiClient::getHandle().

void setRealTimePosition ( snd_seq_real_time_t *  pos  ) 

Sets the queue position in real time (clock) units: seconds and nanoseconds.

Parameters:
pos Real time (clock) position in seconds/nanoseconds.

Definition at line 901 of file alsaqueue.cpp.

References SequencerEvent::getHandle(), and MidiClient::outputDirect().

void setTempo ( const QueueTempo value  ) 

Applies a QueueTempo object to the queue.

Parameters:
value A QueueTempo object reference

Definition at line 805 of file alsaqueue.cpp.

References CHECK_WARNING, and MidiClient::getHandle().

void setTickPosition ( snd_seq_tick_time_t  pos  ) 

Sets the queue position in musical time (ticks).

Parameters:
pos Musical time in ticks.

Definition at line 889 of file alsaqueue.cpp.

References SequencerEvent::getHandle(), and MidiClient::outputDirect().

Referenced by SequencerOutputThread::run().

void setTimer ( const QueueTimer value  ) 

Applies q QueueTimer object to the queue.

Parameters:
value A QueueTimer object reference

Definition at line 815 of file alsaqueue.cpp.

References CHECK_WARNING, and MidiClient::getHandle().

void setUsage ( int  used  ) 

Sets the queue usage flag.

Parameters:
used 1 = client is allowed to access the queue, 0 = not allowed.

Definition at line 836 of file alsaqueue.cpp.

References CHECK_WARNING, and MidiClient::getHandle().

void start (  ) 

Start the queue.

This method should start running the queue from the initial position.

Definition at line 846 of file alsaqueue.cpp.

References CHECK_WARNING, and MidiClient::getHandle().

Referenced by SequencerOutputThread::run().

void stop (  ) 

Stop the queue.

This method should stop running the queue.

Definition at line 857 of file alsaqueue.cpp.

References CHECK_WARNING, and MidiClient::getHandle().

Referenced by SequencerOutputThread::run().


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

Generated on Wed Sep 8 10:12:52 2010 for drumstick by  doxygen 1.5.9