Public Types | Public Member Functions | Static Public Member Functions | Friends

AudioSound Class Reference

Inheritance diagram for AudioSound:
TypedReferenceCount TypedObject ReferenceCount MemoryBase MemoryBase NullAudioSound

List of all members.

Public Types

enum  SoundStatus { BAD, READY, PLAYING }

Public Member Functions

virtual bool configure_filters (FilterProperties *config)
 Configure the local DSP filter chain.
virtual TypeHandle force_init_type ()
virtual void get_3d_attributes (PN_stdfloat *px, PN_stdfloat *py, PN_stdfloat *pz, PN_stdfloat *vx, PN_stdfloat *vy, PN_stdfloat *vz)
virtual PN_stdfloat get_3d_max_distance () const
virtual PN_stdfloat get_3d_min_distance () const
virtual bool get_active () const =0
virtual PN_stdfloat get_balance () const =0
virtual const string & get_finished_event () const =0
virtual bool get_loop () const =0
virtual unsigned long get_loop_count () const =0
virtual const string & get_name () const =0
virtual PN_stdfloat get_play_rate () const =0
virtual int get_priority ()
virtual PN_stdfloat get_speaker_level (int index)
 For use only with Miles.
virtual PN_stdfloat get_speaker_mix (int speaker)
 For use only with FMOD.
virtual PN_stdfloat get_time () const =0
virtual TypeHandle get_type () const
virtual PN_stdfloat get_volume () const =0
virtual PN_stdfloat length () const =0
virtual void output (ostream &out) const
virtual void play ()=0
virtual void set_3d_attributes (PN_stdfloat px, PN_stdfloat py, PN_stdfloat pz, PN_stdfloat vx, PN_stdfloat vy, PN_stdfloat vz)
virtual void set_3d_max_distance (PN_stdfloat dist)
virtual void set_3d_min_distance (PN_stdfloat dist)
virtual void set_active (bool flag=true)=0
virtual void set_balance (PN_stdfloat balance_right=0.0)=0
virtual void set_finished_event (const string &event)=0
virtual void set_loop (bool loop=true)=0
virtual void set_loop_count (unsigned long loop_count=1)=0
virtual void set_play_rate (PN_stdfloat play_rate=1.0f)=0
virtual void set_priority (int priority)
virtual void set_speaker_levels (PN_stdfloat level1, PN_stdfloat level2=-1.0f, PN_stdfloat level3=-1.0f, PN_stdfloat level4=-1.0f, PN_stdfloat level5=-1.0f, PN_stdfloat level6=-1.0f, PN_stdfloat level7=-1.0f, PN_stdfloat level8=-1.0f, PN_stdfloat level9=-1.0f)
 For use only with Miles.
virtual void set_speaker_mix (PN_stdfloat frontleft, PN_stdfloat frontright, PN_stdfloat center, PN_stdfloat sub, PN_stdfloat backleft, PN_stdfloat backright, PN_stdfloat sideleft, PN_stdfloat sideright)
 For use only with FMOD.
virtual void set_time (PN_stdfloat start_time=0.0)=0
virtual void set_volume (PN_stdfloat volume=1.0)=0
virtual SoundStatus status () const =0
virtual void stop ()=0
virtual void write (ostream &out) const

Static Public Member Functions

static TypeHandle get_class_type ()
static void init_type ()
 This function is declared non-inline to work around a compiler bug in g++ 2.96.

Friends

class AudioManager

Detailed Description

Definition at line 26 of file audioSound.h.

Member Function Documentation

bool AudioSound::configure_filters ( FilterProperties *  config) [virtual]

Configure the local DSP filter chain.

There is no guarantee that any given configuration will be supported by the implementation. The only way to find out what's supported is to call configure_filters. If it returns true, the configuration is supported.

Definition at line 126 of file audioSound.cxx.

References FilterProperties::get_config().

PN_stdfloat AudioSound::get_speaker_level ( int  index) [virtual]

For use only with Miles.

Definition at line 99 of file audioSound.cxx.

PN_stdfloat AudioSound::get_speaker_mix ( int  speaker) [virtual]

For use only with FMOD.

Definition at line 78 of file audioSound.cxx.

static void AudioSound::init_type ( ) [inline, static]

This function is declared non-inline to work around a compiler bug in g++ 2.96.

Making it inline seems to cause problems in the optimizer.

Reimplemented from TypedReferenceCount.

Reimplemented in NullAudioSound.

Definition at line 155 of file audioSound.h.

References AudioManager::init_type().

Referenced by NullAudioSound::init_type(), and AudioManager::init_type().

void AudioSound::set_speaker_levels ( PN_stdfloat  level1,
PN_stdfloat  level2 = -1.0f,
PN_stdfloat  level3 = -1.0f,
PN_stdfloat  level4 = -1.0f,
PN_stdfloat  level5 = -1.0f,
PN_stdfloat  level6 = -1.0f,
PN_stdfloat  level7 = -1.0f,
PN_stdfloat  level8 = -1.0f,
PN_stdfloat  level9 = -1.0f 
) [virtual]

For use only with Miles.

Definition at line 110 of file audioSound.cxx.

void AudioSound::set_speaker_mix ( PN_stdfloat  frontleft,
PN_stdfloat  frontright,
PN_stdfloat  center,
PN_stdfloat  sub,
PN_stdfloat  backleft,
PN_stdfloat  backright,
PN_stdfloat  sideleft,
PN_stdfloat  sideright 
) [virtual]

For use only with FMOD.

Definition at line 89 of file audioSound.cxx.

The documentation for this class was generated from the following files: