Panda3D
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
AudioManager Class Referenceabstract
Inheritance diagram for AudioManager:
TypedReferenceCount TypedObject ReferenceCount MemoryBase MemoryBase FmodAudioManager NullAudioManager OpenALAudioManager

Public Types

enum  SpeakerId {
  SPK_none, SPK_frontleft, SPK_frontright, SPK_center,
  SPK_sub, SPK_backleft, SPK_backright, SPK_sideleft,
  SPK_sideright, SPK_COUNT
}
 
enum  SpeakerModeCategory {
  SPEAKERMODE_raw, SPEAKERMODE_mono, SPEAKERMODE_stereo, SPEAKERMODE_quad,
  SPEAKERMODE_surround, SPEAKERMODE_5point1, SPEAKERMODE_7point1, SPEAKERMODE_max,
  SPEAKERMODE_COUNT
}
 
enum  StreamMode { SM_heuristic, SM_sample, SM_stream }
 

Public Member Functions

virtual PN_stdfloat audio_3d_get_distance_factor () const
 
virtual PN_stdfloat audio_3d_get_doppler_factor () const
 
virtual PN_stdfloat audio_3d_get_drop_off_factor () const
 
virtual void audio_3d_get_listener_attributes (PN_stdfloat *px, PN_stdfloat *py, PN_stdfloat *pz, PN_stdfloat *vx, PN_stdfloat *vy, PN_stdfloat *vz, PN_stdfloat *fx, PN_stdfloat *fy, PN_stdfloat *fz, PN_stdfloat *ux, PN_stdfloat *uy, PN_stdfloat *uz)
 
virtual void audio_3d_set_distance_factor (PN_stdfloat factor)
 
virtual void audio_3d_set_doppler_factor (PN_stdfloat factor)
 
virtual void audio_3d_set_drop_off_factor (PN_stdfloat factor)
 
virtual void audio_3d_set_listener_attributes (PN_stdfloat px, PN_stdfloat py, PN_stdfloat pz, PN_stdfloat vx, PN_stdfloat vy, PN_stdfloat vz, PN_stdfloat fx, PN_stdfloat fy, PN_stdfloat fz, PN_stdfloat ux, PN_stdfloat uy, PN_stdfloat uz)
 
virtual void clear_cache ()=0
 
virtual bool configure_filters (FilterProperties *config)
 Configures the global DSP filter chain. More...
 
virtual TypeHandle force_init_type ()
 
virtual bool get_active () const =0
 
virtual unsigned int get_cache_limit () const =0
 
virtual unsigned int get_concurrent_sound_limit () const =0
 
virtual int get_speaker_setup ()
 
virtual TypeHandle get_type () const
 
virtual PN_stdfloat get_volume () const =0
 
virtual bool is_valid ()=0
 
virtual void output (std::ostream &out) const
 
virtual PT (AudioSound) get_sound(const Filename &file_name
 
virtual PT (AudioSound) get_sound(MovieAudio *source
 
 PT (AudioSound) get_null_sound()
 
virtual void reduce_sounds_playing_to (unsigned int count)=0
 
virtual void set_active (bool flag)=0
 
virtual void set_cache_limit (unsigned int count)=0
 
virtual void set_concurrent_sound_limit (unsigned int limit=0)=0
 
virtual void set_speaker_configuration (LVecBase3 *speaker1, LVecBase3 *speaker2=nullptr, LVecBase3 *speaker3=nullptr, LVecBase3 *speaker4=nullptr, LVecBase3 *speaker5=nullptr, LVecBase3 *speaker6=nullptr, LVecBase3 *speaker7=nullptr, LVecBase3 *speaker8=nullptr, LVecBase3 *speaker9=nullptr)
 For use only with Miles. More...
 
virtual void set_speaker_setup (SpeakerModeCategory cat)
 
virtual void set_volume (PN_stdfloat volume)=0
 
virtual void shutdown ()
 Call this at exit time to shut down the audio system. More...
 
virtual void stop_all_sounds ()=0
 
virtual void uncache_sound (const Filename &file_name)=0
 
virtual void update ()
 Must be called every frame. More...
 
virtual void write (std::ostream &out) const
 
- Public Member Functions inherited from TypedReferenceCount
 TypedReferenceCount (const TypedReferenceCount &copy)
 
void operator= (const TypedReferenceCount &copy)
 
- Public Member Functions inherited from TypedObject
 TypedObject (const TypedObject &copy)=default
 
TypedObjectas_typed_object ()
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
const TypedObjectas_typed_object () const
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
int get_best_parent_from_Set (const std::set< int > &) const
 
int get_type_index () const
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...
 
bool is_exact_type (TypeHandle handle) const
 Returns true if the current object is the indicated type exactly. More...
 
bool is_of_type (TypeHandle handle) const
 Returns true if the current object is or derives from the indicated type. More...
 
TypedObjectoperator= (const TypedObject &copy)=default
 
- Public Member Functions inherited from ReferenceCount
int get_ref_count () const
 
WeakReferenceListget_weak_list () const
 Returns the WeakReferenceList associated with this ReferenceCount object. More...
 
bool has_weak_list () const
 Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. More...
 
void local_object ()
 This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. More...
 
void ref () const
 Explicitly increments the reference count. More...
 
bool ref_if_nonzero () const
 Atomically increases the reference count of this object if it is not zero. More...
 
bool test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool test_ref_count_nonzero () const
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
virtual bool unref () const
 Explicitly decrements the reference count. More...
 
WeakReferenceListweak_ref ()
 Adds the indicated PointerToVoid as a weak reference to this object. More...
 
void weak_unref ()
 Removes the indicated PointerToVoid as a weak reference to this object. More...
 

Static Public Member Functions

static TypeHandle get_class_type ()
 
static Filename get_dls_pathname ()
 
static void init_type ()
 
static PT (AudioManager) create_AudioManager()
 
static void register_AudioManager_creator (Create_AudioManager_proc *proc)
 
- Static Public Member Functions inherited from TypedReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from TypedObject
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. More...
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 

Public Attributes

 get_dls_pathname
 Returns the full pathname to the DLS file, as specified by the Config.prc file, or the default for the current OS if appropriate. More...
 
virtual bool int mode =SM_heuristic) = 0
 
virtual bool positional = false
 
- Public Attributes inherited from TypedObject
 get_type
 
- Public Attributes inherited from ReferenceCount
 get_ref_count
 Returns the current reference count. More...
 

Friends

class AudioSound
 

Detailed Description

Definition at line 28 of file audioManager.h.

Member Function Documentation

◆ configure_filters()

bool AudioManager::configure_filters ( FilterProperties config)
virtual

Configures the global 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 196 of file audioManager.cxx.

References FilterProperties::get_config().

◆ set_speaker_configuration()

void AudioManager::set_speaker_configuration ( LVecBase3 *  speaker1,
LVecBase3 *  speaker2 = nullptr,
LVecBase3 *  speaker3 = nullptr,
LVecBase3 *  speaker4 = nullptr,
LVecBase3 *  speaker5 = nullptr,
LVecBase3 *  speaker6 = nullptr,
LVecBase3 *  speaker7 = nullptr,
LVecBase3 *  speaker8 = nullptr,
LVecBase3 *  speaker9 = nullptr 
)
virtual

For use only with Miles.

Definition at line 333 of file audioManager.cxx.

◆ shutdown()

void AudioManager::shutdown ( )
virtual

Call this at exit time to shut down the audio system.

This will invalidate all currently-active AudioManagers and AudioSounds in the system. If you change your mind and want to play sounds again, you will have to recreate all of these objects.

Reimplemented in OpenALAudioManager.

Definition at line 146 of file audioManager.cxx.

◆ update()

void AudioManager::update ( )
virtual

Must be called every frame.

Failure to call this every frame could cause problems for some audio managers.

Reimplemented in OpenALAudioManager, and FmodAudioManager.

Definition at line 210 of file audioManager.cxx.

Member Data Documentation

◆ get_dls_pathname

Filename AudioManager::get_dls_pathname

Returns the full pathname to the DLS file, as specified by the Config.prc file, or the default for the current OS if appropriate.

Returns empty string if the DLS file is unavailable.

Definition at line 176 of file audioManager.h.


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