CGUIPlaybackSoundCmd Class Reference

Plays a sound when executed. More...

#include <GUIPlaybackSoundCmd.h>

Inheritance diagram for CGUIPlaybackSoundCmd:

Public Member Functions
	CGUIPlaybackSoundCmd (const eC_String &rkFileName)
	CGUIPlaybackSoundCmd (const SoundResource_t eSoundID)
virtual	~CGUIPlaybackSoundCmd ()
virtual void	ReadFromStream ()
virtual void	WriteToStream (const eC_Bool bWriteClassID=false)
Public Member Functions inherited from CGUICommand
void	AddAdditionalCmd (CGUICommandPtr pkCmd, eC_Bool bOneTime=false)
CGUICommandPtr	GetAdditionalCmd (const eC_UInt &uiIndex) const
eC_UInt	GetNumberOfAdditionalCmds () const
eC_UInt	GetPriority () const
eC_UInt	GetTimeUntilNextExecution () const
eC_Bool	IsFinished () const
virtual void	ReadFromStream ()
void	RemoveAdditionalCmd (CGUICommandPtr pkCmd)
void	RemoveAllAdditionalCmds ()
	Removes all additional commands from this command's list.
void	SetPriority (eC_UInt uiPriority)
void	SetTimeUntilNextExecution (eC_UInt uiTime)
virtual void	WriteToStream (const eC_Bool bWriteClassID=false)
Public Member Functions inherited from CGUIStreamableObject
const eC_String &	GetXMLTag () const
virtual void	ReadFromStream ()
void	SetXMLTag (const eC_String &kXMLTag)
virtual void	WriteToStream (const eC_Bool bWriteClassID=false)
Public Member Functions inherited from NSmartPtr::RefCounted
	RefCounted ()
	Create RefCounted object. The reference count is initialized to 0.
virtual	~RefCounted ()
	Destroy reference counted object.
void	AddRef ()
	Increase reference count.
eC_Int	RefCount () const
void	Release ()
bool	Unique () const

Protected Member Functions
virtual void	Do ()
	Plays the sound. More...
Protected Member Functions inherited from CGUICommand
	CGUICommand (const eC_UInt uiPriority=0, const eC_UInt uiTimeUntilFirstExecution=0, const eC_Bool bFinished=true)
virtual	~CGUICommand ()
	Destructor.
virtual void	Do ()=0
void	SetToBeFinished (eC_Bool bIsFinished)
Protected Member Functions inherited from CGUIStreamableObject
eC_UInt	ReadStreamingHeader (const eC_UInt &uiClassVersion, const eC_UInt &uiClassMinVersion=0) const
void	WriteStreamingFooter (const eC_Bool &bWriteClassID) const
void	WriteStreamingHeader (const eC_Bool &bWriteClassID, const eC_Char *const pkClassIDTag, const eC_Int &iClassID, const eC_UInt &uiClassVersion) const

Protected Attributes
SoundResource_t	m_eID
	ID of the sound to be played.

Additional Inherited Members
Static Public Attributes inherited from CGUICommand
static const eC_Char	XMLTAG_ADDITIONALCMDCOUNT []
	XML tag to be used when writing the additional command count into a stream.
static const eC_Char	XMLTAG_COMMANDCLASSID []
	XML tag to be used when writing the command class ID into a stream.
static const eC_Char	XMLTAG_REMOVE_AFTER_EXECUTION []
	XML tag to be used when writing the remove after execution flag.
Static Public Attributes inherited from CGUIStreamableObject
static const eC_Char	XMLTAG_CLASSVERSION []

Detailed Description

Plays a sound when executed.

Constructor & Destructor Documentation

CGUIPlaybackSoundCmd() [1/2]

CGUIPlaybackSoundCmd::CGUIPlaybackSoundCmd

(

const SoundResource_t

eSoundID

)

Constructor.

Parameters

eSoundID

ID of the sound to be played.

CGUIPlaybackSoundCmd() [2/2]

CGUIPlaybackSoundCmd::CGUIPlaybackSoundCmd

(

const eC_String &

rkFileName

)

Constructor that registers a dynamic sound.

Parameters

rkFileName

The file name for which the dynamic sound is registered.

~CGUIPlaybackSoundCmd()

virtual CGUIPlaybackSoundCmd::~CGUIPlaybackSoundCmd ( )

virtual

Destructor. Releases the internal sound ID.

Member Function Documentation

Do()

virtual void CGUIPlaybackSoundCmd::Do ( )

protectedvirtual

Plays the sound.

Implements CGUICommand.

ReadFromStream()

virtual void CGUIPlaybackSoundCmd::ReadFromStream ( )

virtual

Reads attributes from the streaming file. Only for use with GUIFactoryManager.

See also

CGUIObject::ReadFromStream()

Reimplemented from CGUICommand.

WriteToStream()

virtual void CGUIPlaybackSoundCmd::WriteToStream ( const eC_Bool  bWriteClassID = false )

virtual

Writes attributes to the streaming file. A CGUIStreamWriter has to be initialized.

Parameters

bWriteClassID

This flag is used to switch writing of the class ID, leading and trailing tags. When implementing a new streamable object, check this flag. If it is true, first write the class ID, then continue with this object's attributes, and finally call the base class implementation with this flag set to false (this is the default).

Reimplemented from CGUICommand.

---

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

• GUIPlaybackSoundCmd.h