TimerParams Class Reference

ALSA Timer parameters container. More...

#include <alsatimer.h>

Public Member Functions
	TimerParams ()
	Default constructor.
	TimerParams (const TimerParams &other)
	Copy constructor. More...
	TimerParams (const snd_timer_params_t *other)
	Constructor. More...
virtual	~TimerParams ()
	Destructor.
TimerParams *	clone ()
	Copy the current object. More...
TimerParams &	operator= (const TimerParams &other)
	Assignment operator. More...
int	getSizeOfInfo () const
	Gets the size of the ALSA timer parameters object. More...
void	setAutoStart (bool auto_start)
	Sets the automatic start flag. More...
bool	getAutoStart ()
	Gets the automatic start flag. More...
void	setExclusive (bool exclusive)
	Sets the exclusive flag. More...
bool	getExclusive ()
	Gets the timer's exclusive flag. More...
void	setEarlyEvent (bool early_event)
	Sets the timer early event. More...
bool	getEarlyEvent ()
	Gets the timer early event. More...
void	setTicks (long ticks)
	Sets the timer ticks. More...
long	getTicks ()
	Gets the timer ticks. More...
void	setQueueSize (long queue_size)
	Sets the queue size (32-1024) More...
long	getQueueSize ()
	Gets the queue size. More...
void	setFilter (unsigned int filter)
	Sets the event filter. More...
unsigned int	getFilter ()
	Gets the event filter. More...

Detailed Description

ALSA Timer parameters container.

This class provides several parameters about a Timer.

Definition at line 201 of file alsatimer.h.

Constructor & Destructor Documentation

TimerParams() [1/2]

TimerParams

(

const TimerParams &

other

)

Copy constructor.

Parameters

other

Existing TimerParams object reference

Definition at line 743 of file alsatimer.cpp.

TimerParams() [2/2]

TimerParams ( const snd_timer_params_t *  other )

explicit

Constructor.

Parameters

other

Pointer to an ALSA timer parameters object

Definition at line 733 of file alsatimer.cpp.

Member Function Documentation

clone()

TimerParams * clone

(

)

Copy the current object.

Returns

Pointer to the new object

Definition at line 762 of file alsatimer.cpp.

References TimerParams::TimerParams().

getAutoStart()

bool getAutoStart

(

)

Gets the automatic start flag.

Returns

True if the timer starts automatically

Definition at line 796 of file alsatimer.cpp.

getEarlyEvent()

bool getEarlyEvent

(

)

Gets the timer early event.

Returns

Timer early event

Definition at line 836 of file alsatimer.cpp.

getExclusive()

bool getExclusive

(

)

Gets the timer's exclusive flag.

Returns

True if the timer has the exclusive flag

Definition at line 816 of file alsatimer.cpp.

getFilter()

unsigned int getFilter

(

)

Gets the event filter.

Returns

Event filter

Definition at line 896 of file alsatimer.cpp.

getQueueSize()

long getQueueSize

(

)

Gets the queue size.

Returns

Queue size

Definition at line 876 of file alsatimer.cpp.

getSizeOfInfo()

int getSizeOfInfo

(

)

const

Gets the size of the ALSA timer parameters object.

Returns

Size of the ALSA object

Definition at line 906 of file alsatimer.cpp.

getTicks()

long getTicks

(

)

Gets the timer ticks.

Returns

Timer ticks

Definition at line 856 of file alsatimer.cpp.

operator=()

TimerParams & operator=

(

const TimerParams &

other

)

Assignment operator.

Parameters

other

Existing TimerParams object reference

Returns

This object

Definition at line 773 of file alsatimer.cpp.

setAutoStart()

void setAutoStart

(

bool

auto_start

)

Sets the automatic start flag.

Parameters

auto_start

Value for the automatic start flag

Definition at line 786 of file alsatimer.cpp.

setEarlyEvent()

void setEarlyEvent

(

bool

early_event

)

Sets the timer early event.

Parameters

early_event

Timer early event

Definition at line 826 of file alsatimer.cpp.

setExclusive()

void setExclusive

(

bool

exclusive

)

Sets the exclusive flag.

Parameters

exclusive

True if the timer has the exclusive flag

Definition at line 806 of file alsatimer.cpp.

setFilter()

void setFilter

(

unsigned int

filter

)

Sets the event filter.

Parameters

filter

Event filter

Definition at line 886 of file alsatimer.cpp.

setQueueSize()

void setQueueSize

(

long

queue_size

)

Sets the queue size (32-1024)

Parameters

queue_size

Queue size

Definition at line 866 of file alsatimer.cpp.

setTicks()

void setTicks

(

long

ticks

)

Sets the timer ticks.

Parameters

ticks

Timer ticks

Definition at line 846 of file alsatimer.cpp.

---

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

• alsatimer.h
• alsatimer.cpp