CEL

Public API Reference

iPcSoundSource Struct Reference

This is the sound source property class. More...

#include <propclass/sound.h>

Inheritance diagram for iPcSoundSource:

List of all members.

Public Member Functions

virtual const char * GetMode () const =0
 Return the mode for this sound.
virtual const char * GetSoundName () const =0
 Get the name of the sound wrapper that is used.
virtual iSndSysSourceGetSoundSource ()=0
 Get the sound source.
virtual void Pause ()=0
 Pause sound.
virtual void Play ()=0
 Play sound.
virtual void SetMode (const char *modename)=0
 Set the mode for this sound.
virtual void SetSoundName (const char *name)=0
 Set the name of the sound wrapper to use.
virtual void Stop ()=0
 Stop sound.
virtual void Unpause ()=0
 Unpause sound.

Detailed Description

This is the sound source property class.

This property class supports the following actions (add prefix 'cel.sound.source.action.' if you want to access this action through a message):

This property class supports the following properties:

Definition at line 76 of file sound.h.


Member Function Documentation

virtual const char* iPcSoundSource::GetMode (  )  const [pure virtual]

Return the mode for this sound.

One of 'disable', 'absolute', or 'relative'.

virtual const char* iPcSoundSource::GetSoundName (  )  const [pure virtual]

Get the name of the sound wrapper that is used.

virtual iSndSysSource* iPcSoundSource::GetSoundSource (  )  [pure virtual]

Get the sound source.

virtual void iPcSoundSource::Pause (  )  [pure virtual]

Pause sound.

virtual void iPcSoundSource::Play (  )  [pure virtual]

Play sound.

virtual void iPcSoundSource::SetMode ( const char *  modename  )  [pure virtual]

Set the mode for this sound.

Should be one of 'disable' (default), 'absolute', or 'relative'.

virtual void iPcSoundSource::SetSoundName ( const char *  name  )  [pure virtual]

Set the name of the sound wrapper to use.

virtual void iPcSoundSource::Stop (  )  [pure virtual]

Stop sound.

virtual void iPcSoundSource::Unpause (  )  [pure virtual]

Unpause sound.


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

Generated for CEL: Crystal Entity Layer 2.0 by doxygen 1.6.1