CSndWrapLinux::CPlayThreadBase Class Reference

This class handles the playing of sound files. More...

#include <SndWrapLinux.h>

Inheritance diagram for CSndWrapLinux::CPlayThreadBase:

Public Member Functions
	CPlayThreadBase (const eC_UInt uiStackSize, const ThreadPriority_t kThreadPriority)
virtual	~CPlayThreadBase ()
	Destructor.
const CSound &	GetSound () const
ThreadPriority_t	GetThreadPriority () const
virtual void	Pause ()=0
virtual void	Play (const CSound &kSound)=0
virtual void	Resume ()=0
const void	SetSound (const CSound &kSound)
virtual void	Stop ()=0
Public Member Functions inherited from CGUIThread
void *	GetArg () const
ThreadPriority_t	GetPriority ()
void *	GetThreadId () const
void	InitShutdown ()
eC_Bool	IsRunning () const
eC_Bool	IsShutdownCompleted () const
void	SetArg (void *pArg)
void	SetPriority (const ThreadPriority_t &ePriority)
eC_Int	Start (void *pArg)
void	Terminate ()
void	WaitForShutdown ()

Additional Inherited Members
Protected Member Functions inherited from CGUIThread
	CGUIThread (const eC_UInt &uiStackSize)
virtual	~CGUIThread ()
virtual void	Cleanup ()
virtual void	Execute (void *pArg)=0
ThreadPriority_t	MapPriority (const eC_Int &iPriority)
eC_Int	MapPriority (const ThreadPriority_t &ePriority)
virtual void	Setup ()
Protected Attributes inherited from CGUIThread
volatile eC_Bool	m_bRunning
	Whether this thread is currently running.
void *	m_pArg
	Pointer to arguments to be passed to the thread.
void *	m_pThreadId
	This thread's unique ID.
eC_UInt	m_uiStackSize
	Size for this thread's stack.

Detailed Description

This class handles the playing of sound files.

To avoid blocking the whole application while playing a sound file, the playing has to be done inside it's own thread.

Constructor & Destructor Documentation

CPlayThreadBase()

CSndWrapLinux::CPlayThreadBase::CPlayThreadBase ( const eC_UInt  uiStackSize, const ThreadPriority_t  kThreadPriority  )

inline

Constructor

Parameters

uiStackSize	size of stack
kThreadPriority	priority

Member Function Documentation

GetSound()

const CSound & CSndWrapLinux::CPlayThreadBase::GetSound ( ) const

inline

Gets the sound which is playing.

Returns

Sound which is playing.

GetThreadPriority()

ThreadPriority_t CSndWrapLinux::CPlayThreadBase::GetThreadPriority ( ) const

inline

Returns the set thread priority.

Returns

Thread priority.

Pause()

virtual void CSndWrapLinux::CPlayThreadBase::Pause ( )

pure virtual

Pauses playback.

Play()

virtual void CSndWrapLinux::CPlayThreadBase::Play ( const CSound &  kSound )

pure virtual

Starts the thread.

Parameters

kSound

The sound which shall be played.

Resume()

virtual void CSndWrapLinux::CPlayThreadBase::Resume ( )

pure virtual

Resumes playback.

SetSound()

const void CSndWrapLinux::CPlayThreadBase::SetSound ( const CSound &  kSound )

inline

Sets the sound which is playing.

Parameters

kSound

Sound to set.

Stop()

virtual void CSndWrapLinux::CPlayThreadBase::Stop ( )

pure virtual

Stops playback.

---

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

• SndWrapLinux.h