Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages
shdl.h
00001 /* 00002 Copyright (C) 2001 by Martin Geisse <mgeisse@gmx.net> 00003 00004 This library is free software; you can redistribute it and/or 00005 modify it under the terms of the GNU Library General Public 00006 License as published by the Free Software Foundation; either 00007 version 2 of the License, or (at your option) any later version. 00008 00009 This library is distributed in the hope that it will be useful, 00010 but WITHOUT ANY WARRANTY; without even the implied warranty of 00011 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 00012 Library General Public License for more details. 00013 00014 You should have received a copy of the GNU Library General Public 00015 License along with this library; if not, write to the Free 00016 Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 00017 */ 00018 00019 #ifndef __CS_SHDL_H__ 00020 #define __CS_SHDL_H__ 00021 00022 #include "csextern.h" 00023 #include "isound/handle.h" 00024 struct iSoundData; 00025 00026 class CS_CSPLUGINCOMMON_EXPORT csSoundHandle : public iSoundHandle 00027 { 00028 public: 00029 SCF_DECLARE_IBASE; 00030 // the sound data for this handle 00031 csRef<iSoundData> Data; 00032 // is this sound registered? 00033 bool Registered; 00034 // This is a streamed sound and the stream is started 00035 bool ActiveStream; 00036 // loop the stream 00037 bool LoopStream; 00038 00039 // constructor 00040 csSoundHandle(iSoundData*); 00041 // destructor 00042 virtual ~csSoundHandle(); 00043 // release the sound data 00044 void ReleaseSoundData(); 00045 // update the sound handle 00046 void Update_Time(csTicks ElapsedTime); 00047 void UpdateCount(long NumSamples); 00048 // implementation-specific update method 00049 virtual void vUpdate(void *buf, long NumSamples) = 0; 00050 00051 // is this a static or streamed sound? 00052 virtual bool IsStatic(); 00053 // play an instance of this sound 00054 virtual csPtr<iSoundSource> Play(bool Loop); 00055 // Start playing the stream (only for streamed sound) 00056 virtual void StartStream(bool Loop); 00057 // Stop playing the stream 00058 virtual void StopStream(); 00059 // Reset the stream to the beginning 00060 virtual void ResetStream(); 00061 }; 00062 00063 #endif // __CS_SHDL_H__
Generated for Crystal Space by doxygen 1.3.9.1