Free Electron
Public Member Functions | Private Member Functions | Private Attributes | List of all members
fe::ext::VoiceAL Class Reference

Voice using OpenAL. More...

#include <VoiceAL.h>

Inheritance diagram for fe::ext::VoiceAL:
Inheritance graph
[legend]

Public Member Functions

void initialize (void)
 
virtual Result setReferenceDistance (Real distance)
 
virtual Result setLocation (const SpatialVector &location)
 
virtual Result setDirection (const SpatialVector &direction)
 
virtual Result setVelocity (const SpatialVector &velocity)
 
virtual Result setPitch (F32 pitch)
 
virtual Result setVolume (F32 volume)
 
virtual Result play (void)
 
virtual Result pause (void)
 
virtual Result stop (void)
 
virtual Result rewind (void)
 
virtual Result queue (String name)
 Add another sound to be played in order. More...
 
virtual Result loop (BWORD on)
 Play current sound repeatedly. More...
 
virtual Result persist (BWORD on)
 Continue playing without external references. More...
 
virtual I32 remaining (void)
 Return number of sounds playing or pending. More...
 
- Public Member Functions inherited from fe::Initialized
void initializeAll (void)
 
void setActive (bool a_active)
 
- Public Member Functions inherited from fe::Component
const Stringname (void) const
 Return the components chosen name. More...
 
const String verboseName (void) const
 Return the annotated chosen name. More...
 
void setName (const String &name)
 Rename the component to anything you want. More...
 
hp< Registryregistry (void) const
 Get the Registry that created this component. More...
 
void adjoin (sp< Component > spComponent)
 Tie this component's lifetime to another. More...
 
sp< Componentcreate (const String &implementation, BWORD quiet=FALSE) const
 Convienience function to registry()->create() More...
 
void disjoin (void)
 Untie component from Hub, if connected. More...
 
void setLibrary (sp< Library > spLibrary)
 Store a reference to the library used to instantiate this component. More...
 
sp< Librarylibrary (void)
 Get the library that created the component. More...
 
void setSingleton (BWORD set)
 Specify whether component is a singleton. More...
 
BWORD isSingleton (void)
 Return whether component is a singleton. More...
 
virtual void acquire (void)
 Specialized reference increment. More...
 
virtual void release (void)
 Specialized reference decrement. More...
 
- Public Member Functions inherited from fe::Handled< Component >
const hp< Component > & getHandle (void) const
 Get a safe handle to this object. More...
 
- Public Member Functions inherited from fe::Protectable
virtual I32 protection (void) const
 
virtual void protect (void)
 
virtual void unprotect (void)
 
virtual Protectableclone (Protectable *pInstance=NULL)
 
- Public Member Functions inherited from fe::Counted
virtual void acquire (int &rCount)
 Increment the reference count (and get the count) More...
 
virtual void abandon (void)
 Decrement the reference count. More...
 
int count (void) const
 Return the count of references. More...
 
void setName (const String &)
 
void trackReference (void *pReference, String what)
 
void untrackReference (void *pReference)
 
void registerRegion (void *pT, U32 bytes)
 

Private Member Functions

Result checkError (String text)
 
I32 queued (void)
 
I32 processed (void)
 
Result prune (void)
 
Result clear (void)
 

Private Attributes

ALuint m_source
 
hp< AudioALm_hpAudioAL
 
sp< AudioALm_spAudioAL
 
BWORD m_persistent
 

Additional Inherited Members

- Static Public Member Functions inherited from fe::Counted
static String reportTracker (void)
 
static U32 trackerCount (void)
 
- Protected Types inherited from fe::Initialized
typedef void(* InitializeFunction) (Initialized *)
 
- Protected Member Functions inherited from fe::Initialized
void addInitializer (InitializeFunction function)
 
- Protected Member Functions inherited from fe::Handled< Component >
void abandonHandle (void)
 
- Protected Member Functions inherited from fe::Counted
int releaseInternal (void)
 Decrement the reference count. More...
 
void suppressReport (void)
 

Detailed Description

Voice using OpenAL.

Member Function Documentation

◆ loop()

Result fe::ext::VoiceAL::loop ( BWORD  on)
virtual

Play current sound repeatedly.

Implements fe::ext::VoiceI.

◆ persist()

Result fe::ext::VoiceAL::persist ( BWORD  on)
virtual

Continue playing without external references.

Implements fe::ext::VoiceI.

◆ queue()

Result fe::ext::VoiceAL::queue ( String  name)
virtual

Add another sound to be played in order.

Implements fe::ext::VoiceI.

◆ remaining()

I32 fe::ext::VoiceAL::remaining ( void  )
virtual

Return number of sounds playing or pending.

Implements fe::ext::VoiceI.

References fe::Counted::count().


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