iSndSysRenderer Struct Reference
[Sound system]
#include <isndsys/ss_renderer.h>
Inheritance diagram for iSndSysRenderer:

Public Member Functions | |
| virtual csPtr< iSndSysSource > | CreateSource (iSndSysStream *stream)=0 |
| Creates a source when provided with a Sound Stream. | |
| virtual csPtr< iSndSysStream > | CreateStream (iSndSysData *data, int mode3d)=0 |
| Uses the provided iSound2Data to create a sound stream with the given 3D rendering mode. | |
| virtual csRef< iSndSysListener > | GetListener ()=0 |
| Get the global Listener object. | |
| virtual float | GetVolume ()=0 |
| Get Volume (range 0.0 = silence 1.0 = as provided 2.0 = twice as loud). | |
| virtual bool | RegisterCallback (iSndSysRendererCallback *pCallback)=0 |
| Register a component to receive notification of renderer events. | |
| virtual bool | RemoveSource (iSndSysSource *source)=0 |
| Remove a source from the sound renderer's list of sources. | |
| virtual bool | RemoveStream (iSndSysStream *stream)=0 |
| Remove a stream from the sound renderer's list of streams. | |
| SCF_INTERFACE (iSndSysRenderer, 0, 2, 1) | |
| SCF2006 - See http://www.crystalspace3d.org/cseps/csep-0010.html. | |
| virtual void | SetVolume (float vol)=0 |
| Set Volume (range 0.0 = silence 1.0 = as provided 2.0 = twice as loud). | |
| virtual bool | UnregisterCallback (iSndSysRendererCallback *pCallback)=0 |
| Unregister a previously registered callback component. | |
Detailed Description
- Todo:
- Document me!
Should Sound Streams get processing time even if no Sound Sources are attached?
Definition at line 54 of file ss_renderer.h.
Member Function Documentation
| virtual csPtr<iSndSysSource> iSndSysRenderer::CreateSource | ( | iSndSysStream * | stream | ) | [pure virtual] |
Creates a source when provided with a Sound Stream.
| virtual csPtr<iSndSysStream> iSndSysRenderer::CreateStream | ( | iSndSysData * | data, | |
| int | mode3d | |||
| ) | [pure virtual] |
Uses the provided iSound2Data to create a sound stream with the given 3D rendering mode.
| virtual csRef<iSndSysListener> iSndSysRenderer::GetListener | ( | ) | [pure virtual] |
Get the global Listener object.
| virtual float iSndSysRenderer::GetVolume | ( | ) | [pure virtual] |
Get Volume (range 0.0 = silence 1.0 = as provided 2.0 = twice as loud).
| virtual bool iSndSysRenderer::RegisterCallback | ( | iSndSysRendererCallback * | pCallback | ) | [pure virtual] |
Register a component to receive notification of renderer events.
| virtual bool iSndSysRenderer::RemoveSource | ( | iSndSysSource * | source | ) | [pure virtual] |
Remove a source from the sound renderer's list of sources.
| virtual bool iSndSysRenderer::RemoveStream | ( | iSndSysStream * | stream | ) | [pure virtual] |
Remove a stream from the sound renderer's list of streams.
| iSndSysRenderer::SCF_INTERFACE | ( | iSndSysRenderer | , | |
| 0 | , | |||
| 2 | , | |||
| 1 | ||||
| ) |
SCF2006 - See http://www.crystalspace3d.org/cseps/csep-0010.html.
| virtual void iSndSysRenderer::SetVolume | ( | float | vol | ) | [pure virtual] |
Set Volume (range 0.0 = silence 1.0 = as provided 2.0 = twice as loud).
| virtual bool iSndSysRenderer::UnregisterCallback | ( | iSndSysRendererCallback * | pCallback | ) | [pure virtual] |
Unregister a previously registered callback component.
The documentation for this struct was generated from the following file:
- isndsys/ss_renderer.h
Generated for Crystal Space by doxygen 1.4.7
