audiere::StopEvent Class Reference

#include <audiere.h>

Inheritance diagram for audiere::StopEvent:

[legend]Collaboration diagram for audiere::StopEvent:

[legend]List of all members.

Public Types
enum	Reason { STOP_CALLED, STREAM_ENDED }
Public Member Functions
EventType	getType ()
virtual OutputStream *	getOutputStream ()=0
virtual Reason	getReason ()=0
Protected Member Functions
	~StopEvent ()

---

Detailed Description

An event object that gets passed to implementations of StopCallback when a stream has stopped playing.

Definition at line 610 of file audiere.h.

---

Member Enumeration Documentation

enum audiere::StopEvent::Reason

A code representing the reason the stream stopped playback. Enumerator: STOP_CALLED  stop() was called from an external source. STREAM_ENDED  The stream reached its end. Definition at line 618 of file audiere.h.

---

Constructor & Destructor Documentation

audiere::StopEvent::~StopEvent (   )  [inline, protected]

Definition at line 612 of file audiere.h.

---

Member Function Documentation

virtual OutputStream* audiere::StopEvent::getOutputStream (   )  [pure virtual]

Returns: Pointer to the OutputStream that stopped playback.

virtual Reason audiere::StopEvent::getReason (   )  [pure virtual]

Returns: Reason for the stop event.

EventType audiere::StopEvent::getType (   )  [inline, virtual]

Returns the EventType code for this event. Implements audiere::Event. Definition at line 615 of file audiere.h. References audiere::ET_STOP.

---

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

• audiere.h

---