CrystalSpace

Public API Reference

iSndSysData Struct Reference
[Sound system]

The sound data is an interface to the container object controlling raw sound data. More...

#include <isndsys/ss_data.h>

Inheritance diagram for iSndSysData:

Inheritance graph
[legend]
List of all members.

Public Member Functions

virtual iSndSysStreamCreateStream (csSndSysSoundFormat *renderformat, int mode3d)=0
 This function should be called from the Renderer where a proper renderformat can be provided.
virtual size_t GetDataSize ()=0
 Return the size of the data stored in bytes.
virtual const csSndSysSoundFormatGetFormat ()=0
 Get the format of the sound data.
virtual size_t GetSampleCount ()=0
 Get size of this sound in samples.

Detailed Description

The sound data is an interface to the container object controlling raw sound data.

After obtaining an iSound2Data interface (most likely by loading a sound file) at least one iSound2Stream must be obtained.

This interface is implemented at least once per Sound Element.

Definition at line 46 of file ss_data.h.


Member Function Documentation

virtual iSndSysStream* iSndSysData::CreateStream csSndSysSoundFormat renderformat,
int  mode3d
[pure virtual]
 

This function should be called from the Renderer where a proper renderformat can be provided.

Creates a stream associated with this sound data positioned at the beginning of the sound data and initially paused if possible.

Remarks:
Not intended to be called by an application.

virtual size_t iSndSysData::GetDataSize  )  [pure virtual]
 

Return the size of the data stored in bytes.

This is informational only and is not guaranteed to be a number usable for sound calculations. For example, an audio file compressed with variable rate compression may result in a situation where FILE_SIZE is not equal to SAMPLE_COUNT * SAMPLE_SIZE since SAMPLE_SIZE may vary throughout the audio data.

virtual const csSndSysSoundFormat* iSndSysData::GetFormat  )  [pure virtual]
 

Get the format of the sound data.

virtual size_t iSndSysData::GetSampleCount  )  [pure virtual]
 

Get size of this sound in samples.


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.4.6