iSndSysSource Struct Reference (Crystal Space 2.0 Public API Reference)

| ## Public API Reference

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions
iSndSysSource Struct Reference
Sound system

A sound source is the origin of a sound in Crystal Space. More...

`#include <isndsys/ss_source.h>`

Inheritance diagram for iSndSysSource:

List of all members.

## Public Member Functions
virtual iSndSysSource * | GetPtr ()=0
| Retrieve a direct pointer to this object.
virtual csRef< iSndSysStream > | GetStream ()=0
| Retrieve the iSoundStream attached to this source.
virtual float | GetVolume ()=0
| Get volume (0.0 = silence, 1.0 = as provided, 2.0 = twice as loud)
virtual void | SetVolume (float volume)=0
| Set volume (0.0 = silence, 1.0 = as provided, 2.0 = twice as loud)

## Detailed Description

A sound source is the origin of a sound in Crystal Space.

It is the object through which a sound is played. Just like a speaker, only it isn't in space.

Definition at line 48 of file ss_source.h.

## Member Function Documentation

virtual iSndSysSource* iSndSysSource::GetPtr | ( |  | ) | `[pure virtual]`

Retrieve a direct pointer to this object.

virtual csRef<iSndSysStream> iSndSysSource::GetStream | ( |  | ) | `[pure virtual]`

Retrieve the iSoundStream attached to this source.

virtual float iSndSysSource::GetVolume | ( |  | ) | `[pure virtual]`

Get volume (0.0 = silence, 1.0 = as provided, 2.0 = twice as loud)

virtual void iSndSysSource::SetVolume | ( | float | volume | ) | `[pure virtual]`

Set volume (0.0 = silence, 1.0 = as provided, 2.0 = twice as loud)

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

- isndsys/ss_source.h