CrystalSpace

Public API Reference

isndsys/ss_data.h

Go to the documentation of this file.
00001 /*
00002     Copyright (C) 2004 by Andrew Mann
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_SNDSYS_DATA_H__
00020 #define __CS_SNDSYS_DATA_H__
00021 
00026 #include "csutil/scf.h"
00027 
00031 struct csSndSysSoundFormat;
00032 struct iSndSysStream;
00033 
00034 #define CS_SNDSYS_DATA_UNKNOWN_SIZE -1
00035 
00044 struct iSndSysData : public virtual iBase
00045 {
00047   SCF_INTERFACE(iSndSysData,0,2,0);
00048 
00050   virtual const csSndSysSoundFormat *GetFormat() = 0;
00051 
00053   virtual size_t GetFrameCount() = 0;
00054 
00063   virtual size_t GetDataSize() = 0;
00064 
00073   virtual iSndSysStream *CreateStream (csSndSysSoundFormat *renderformat,
00074         int mode3d) = 0;
00075 
00077   //   A filename isn't a bad idea!
00078   virtual void SetDescription(const char *pDescription) = 0;
00079 
00081   //   This may return 0 if no description is set.
00082   virtual const char *GetDescription() = 0;
00083 };
00084 
00087 #endif // __CS_SNDSYS_DATA_H__

Generated for Crystal Space 1.2.1 by doxygen 1.5.3