QueueTimer Class Reference

Queue timer container. More...

#include <alsaqueue.h>

Public Member Functions
	QueueTimer ()
	Default constructor.
	QueueTimer (const QueueTimer &other)
	Copy constructor. More...
	QueueTimer (snd_seq_queue_timer_t *other)
	Constructor. More...
virtual	~QueueTimer ()
	Destructor.
QueueTimer *	clone ()
	Copy the current object and return the copy. More...
QueueTimer &	operator= (const QueueTimer &other)
	Assignment operator. More...
int	getInfoSize () const
	Gets the size of the ALSA queue timer object. More...
int	getQueueId ()
	The queue's numeric identifier. More...
snd_seq_queue_timer_type_t	getType ()
	Gets the timer type. More...
const snd_timer_id_t *	getId ()
	Gets the timer identifier record. More...
unsigned int	getResolution ()
	Gets the timer resolution. More...
void	setType (snd_seq_queue_timer_type_t value)
	Sets the timer type. More...
void	setId (snd_timer_id_t *value)
	Sets the timer identifier record. More...
void	setId (const TimerId &id)
	Sets the timer identifier. More...
void	setResolution (unsigned int value)
	Sets the timer resolution. More...

Detailed Description

Queue timer container.

This class is used to hold some properties about the Timer used with an ALSA queue object.

Examples

metronome.cpp, and sysinfo.cpp.

Definition at line 169 of file alsaqueue.h.

Constructor & Destructor Documentation

QueueTimer() [1/2]

QueueTimer

(

const QueueTimer &

other

)

Copy constructor.

Parameters

other

An existing QueueTimer object reference

Definition at line 565 of file alsaqueue.cpp.

QueueTimer() [2/2]

QueueTimer ( snd_seq_queue_timer_t *  other )

explicit

Constructor.

Parameters

other

An ALSA queue timer object pointer

Definition at line 555 of file alsaqueue.cpp.

Member Function Documentation

clone()

QueueTimer * clone

(

)

Copy the current object and return the copy.

Returns

The pointer to the new object

Definition at line 583 of file alsaqueue.cpp.

References QueueTimer::QueueTimer().

getId()

const snd_timer_id_t * getId

(

)

Gets the timer identifier record.

Returns

The timer identifier record pointer

Examples

sysinfo.cpp.

Definition at line 631 of file alsaqueue.cpp.

getInfoSize()

int getInfoSize

(

)

const

Gets the size of the ALSA queue timer object.

Returns

The size of the ALSA object

Definition at line 693 of file alsaqueue.cpp.

getQueueId()

int getQueueId

(

)

The queue's numeric identifier.

Returns

The queue's numeric identifier

Definition at line 605 of file alsaqueue.cpp.

getResolution()

unsigned int getResolution

(

)

Gets the timer resolution.

Returns

The timer resolution

Definition at line 640 of file alsaqueue.cpp.

getType()

snd_seq_queue_timer_type_t getType

(

)

Gets the timer type.

The timer type can be one of the following constants:

• SND_SEQ_TIMER_ALSA: ALSA timer
• SND_SEQ_TIMER_MIDI_CLOCK: MIDI Clock (CLOCK event)
• SND_SEQ_TIMER_MIDI_TICK: MIDI Timer Tick (TICK event)

Returns

the timer type.

See also

setType()

Definition at line 622 of file alsaqueue.cpp.

operator=()

QueueTimer & operator=

(

const QueueTimer &

other

)

Assignment operator.

Parameters

other

An existing QueueTimer object reference

Returns

This object

Definition at line 593 of file alsaqueue.cpp.

setId() [1/2]

void setId

(

const TimerId &

id

)

Sets the timer identifier.

Parameters

id	Timer identifier object

Since

0.3.0

Definition at line 675 of file alsaqueue.cpp.

References QueueTimer::setId().

setId() [2/2]

void setId

(

snd_timer_id_t *

value

)

Sets the timer identifier record.

Parameters

value

The timer identifier record pointer

Examples

metronome.cpp.

Definition at line 665 of file alsaqueue.cpp.

Referenced by QueueTimer::setId().

setResolution()

void setResolution

(

unsigned int

value

)

Sets the timer resolution.

Parameters

value

The timer resolution

Definition at line 684 of file alsaqueue.cpp.

setType()

void setType

(

snd_seq_queue_timer_type_t

value

)

Sets the timer type.

The timer type can be one of the following constants:

• SND_SEQ_TIMER_ALSA: ALSA timer
• SND_SEQ_TIMER_MIDI_CLOCK: MIDI Clock (CLOCK event)
• SND_SEQ_TIMER_MIDI_TICK: MIDI Timer Tick (TICK event)

Parameters

value

The timer type

See also

getType()

Definition at line 656 of file alsaqueue.cpp.

---

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

• alsaqueue.h
• alsaqueue.cpp