Main Page   Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members  

snx::SoundInfo Struct Reference
[The Sonix API.]

info struct that describes one sound entry. More...

#include <SoundInfo.h>

List of all members.

Public Types

enum  DataSource { FILESYSTEM, DATA_16_MONO, DATA_8_MONO }

Public Methods

 SoundInfo ()

Public Attributes

std::string alias
 name of the sound. this is the "handle", or how you refer to the sound. More...

DataSource datasource
 which of the following resources to use... More...

std::string filename
 source of the sound... More...

gmtl::Vec3f position
 3D position. More...

bool ambient
 is the sound ambient (true) or positional (false)? More...

bool retriggerable
 can the sound be retriggered while playing? More...

int repeat
 number of times to repeat (static), -1 is infinite. More...

float pitchbend
 from 0 to 1. 0 is not a legal value. More...

float cutoff
 from 0 to 1. More...

float volume
 from 0 to 1. More...

bool streaming
 should we stream the sound from disk? More...

bool triggerOnNextBind
 do not use. internal use only. More...

int repeatCountdown
 do not use. internal use only. More...

Detailed Description

info struct that describes one sound entry.

typically, you will fill this out and pass it to a SoundHandle object to configure your sound.

Definition at line 67 of file SoundInfo.h.

Member Enumeration Documentation

enum snx::SoundInfo::DataSource
 

Enumeration values:
FILESYSTEM 
DATA_16_MONO 
DATA_8_MONO 

Definition at line 92 of file SoundInfo.h. 

00093    {
00094       FILESYSTEM, DATA_16_MONO, DATA_8_MONO
00095    };

Constructor & Destructor Documentation

snx::SoundInfo::SoundInfo (    )  [inline]
 

Definition at line 69 of file SoundInfo.h.

References alias, ambient, cutoff, datasource, filename, FILESYSTEM, pitchbend, position, repeat, repeatCountdown, retriggerable, streaming, triggerOnNextBind, and volume. 

00069                : alias(), 
00070                  datasource( FILESYSTEM ), 
00071                  filename(),
00072                  ambient( false ),
00073                  retriggerable( false ),
00074                  repeat( 1 ),
00075                  pitchbend( 1.0f ),
00076                  cutoff( 1.0f ),
00077                  volume( 1.0f ),
00078                  streaming( false ),
00079                  triggerOnNextBind( false ), 
00080                  repeatCountdown( 0 )
00081    {
00082       //position.makeIdent();
00083       position[0] = 0.0f;
00084       position[1] = 0.0f;
00085       position[2] = 0.0f;
00086    }

Member Data Documentation

std::string snx::SoundInfo::alias
 

name of the sound. this is the "handle", or how you refer to the sound.

Definition at line 90 of file SoundInfo.h.

Referenced by SoundInfo.

DataSource snx::SoundInfo::datasource
 

which of the following resources to use...

Definition at line 98 of file SoundInfo.h.

Referenced by SoundInfo.

std::string snx::SoundInfo::filename
 

source of the sound...

for audioworks, the file should be .wav 11025hz mono for openal, the file should be .wav mono

Definition at line 104 of file SoundInfo.h.

Referenced by SoundInfo.

gmtl::Vec3f snx::SoundInfo::position
 

3D position.

Definition at line 107 of file SoundInfo.h.

Referenced by SoundInfo.

bool snx::SoundInfo::ambient
 

is the sound ambient (true) or positional (false)?

Definition at line 110 of file SoundInfo.h.

Referenced by SoundInfo.

bool snx::SoundInfo::retriggerable
 

can the sound be retriggered while playing?

Definition at line 113 of file SoundInfo.h.

Referenced by SoundInfo.

int snx::SoundInfo::repeat
 

number of times to repeat (static), -1 is infinite.

Definition at line 116 of file SoundInfo.h.

Referenced by SoundInfo.

float snx::SoundInfo::pitchbend
 

from 0 to 1. 0 is not a legal value.

Definition at line 119 of file SoundInfo.h.

Referenced by SoundInfo.

float snx::SoundInfo::cutoff
 

from 0 to 1.

Definition at line 122 of file SoundInfo.h.

Referenced by SoundInfo.

float snx::SoundInfo::volume
 

from 0 to 1.

Definition at line 125 of file SoundInfo.h.

Referenced by SoundInfo.

bool snx::SoundInfo::streaming
 

should we stream the sound from disk?

Definition at line 128 of file SoundInfo.h.

Referenced by SoundInfo.

bool snx::SoundInfo::triggerOnNextBind
 

do not use. internal use only.

Definition at line 132 of file SoundInfo.h.

Referenced by snx::SoundImplementation::configure, SoundInfo, snx::StubSoundImplementation::stop, and snx::StubSoundImplementation::trigger.

int snx::SoundInfo::repeatCountdown
 

do not use. internal use only.

Definition at line 134 of file SoundInfo.h.

Referenced by SoundInfo.

The documentation for this struct was generated from the following file:
Generated on Sun May 2 14:39:33 2004 for Juggler Sonix by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002