Aria  2.7.5.2
ArSoundsQueue::Item Class Reference

#include <ArSoundsQueue.h>

Public Member Functions

void done ()
 
void interrupt ()
 
 Item (std::string _data, ItemType _type, std::string _params="", int priority=0)
 
 Item (std::string _data, ItemType _type, std::string _params, int priority, std::list< PlayItemFunctor * > callbacks)
 
 Item (const ArSoundsQueue::Item &toCopy)
 
bool operator== (const Item &other) const
 
void play ()
 

Public Attributes

std::string data
 
std::list< ArFunctor * > doneCallbacks
 
std::list< InterruptItemFunctor * > interruptCallbacks
 
std::string params
 
std::list
< PlaybackConditionFunctor * > 
playbackConditionCallbacks
 
std::list< PlayItemFunctor * > playCallbacks
 
int priority
 
ItemType type
 

Detailed Description

A sound item in the queue, with callbacks for dealing with the item and the data to pass to those callbacks.

Examples:
soundsQueueExample.cpp.

Member Function Documentation

void ArSoundsQueue::Item::done ( )

Called by sound queue thread after playing this item by calling done callbacks.

void ArSoundsQueue::Item::interrupt ( )

Called by sound queue to interrupt this item by calling interrupt callbacks.

bool ArSoundsQueue::Item::operator== ( const Item other) const
inline

Note: does not compare priority!

void ArSoundsQueue::Item::play ( )

Called by sound queue to play this item by calling play callbacks.


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