Public Member Functions

IAudio Class Reference

#include <audio.h>

Inheritance diagram for IAudio:
OpenAL

List of all members.

Public Member Functions

virtual ~IAudio ()
virtual bool init (void)=0
virtual void uninit (void)=0
virtual pBuffer createBuffer (const wchar *file, FILEFORMAT format=fileByExt)=0
virtual pSound createSound (pBuffer buffer, bool dynamic=false, float3 *position=0, float3 *velocity=0, float3 *direction=0, float distance=100.0f, float coneAngle=360.0f, bool loop=false, float volume=1.0f)=0
virtual pMusic createMusic (const wchar *file, bool loop=true, float volume=1.0f, FILEFORMAT format=fileByExt)=0
virtual void free (pBuffer &buffer)=0
virtual void free (pSound &sound)=0
virtual void free (pMusic &music)=0
virtual void listener (float3 position, float3 velocity, float3 direction)=0
virtual void options (float doppler=1.0f, float speedofsound=343.3f)=0
virtual void update (void)=0
virtual bool supports (FILEFORMAT fileformat, bool forSound=true)=0

Detailed Description

Definition at line 32 of file audio.h.


Constructor & Destructor Documentation

virtual IAudio::~IAudio (  )  [inline, virtual]

Definition at line 35 of file audio.h.


Member Function Documentation

virtual pBuffer IAudio::createBuffer ( const wchar file,
FILEFORMAT  format = fileByExt 
) [pure virtual]

================================================== Create a sound buffer. -------------------------------------------------- ==================================================

Implemented in OpenAL.

virtual pMusic IAudio::createMusic ( const wchar file,
bool  loop = true,
float  volume = 1.0f,
FILEFORMAT  format = fileByExt 
) [pure virtual]

================================================== Create music from a file. -------------------------------------------------- Music musst be created from a file, because music is streamed. ==================================================

Implemented in OpenAL.

virtual pSound IAudio::createSound ( pBuffer  buffer,
bool  dynamic = false,
float3 position = 0,
float3 velocity = 0,
float3 direction = 0,
float  distance = 100.0f,
float  coneAngle = 360.0f,
bool  loop = false,
float  volume = 1.0f 
) [pure virtual]

================================================== Create a sound from a sound buffer. -------------------------------------------------- ==================================================

virtual void IAudio::free ( pMusic music  )  [pure virtual]

================================================== Free music. -------------------------------------------------- ==================================================

virtual void IAudio::free ( pBuffer buffer  )  [pure virtual]

================================================== Free buffer. -------------------------------------------------- ==================================================

virtual void IAudio::free ( pSound sound  )  [pure virtual]

================================================== Free sound. -------------------------------------------------- ==================================================

virtual bool IAudio::init ( void   )  [pure virtual]

================================================== Initialize the class. -------------------------------------------------- Initialize the audio class. ==================================================

Implemented in OpenAL.

virtual void IAudio::listener ( float3  position,
float3  velocity,
float3  direction 
) [pure virtual]

================================================== Listener options. -------------------------------------------------- ==================================================

Implemented in OpenAL.

virtual void IAudio::options ( float  doppler = 1.0f,
float  speedofsound = 343.3f 
) [pure virtual]

================================================== Other options. -------------------------------------------------- ==================================================

Implemented in OpenAL.

virtual bool IAudio::supports ( FILEFORMAT  fileformat,
bool  forSound = true 
) [pure virtual]

================================================== Check if file format is supported -------------------------------------------------- If 'forSound' is set true, check if file format is supported for sounds. If false, check if file format is supported for music. ==================================================

Implemented in OpenAL.

virtual void IAudio::uninit ( void   )  [pure virtual]

================================================== Uninitialize the interface. -------------------------------------------------- After calling uninit(), the class musst be reinitialized to use its methods. ==================================================

Implemented in OpenAL.

virtual void IAudio::update ( void   )  [pure virtual]

================================================== Update the audio class. -------------------------------------------------- Sould be done in each frame of the application. ==================================================

Implemented in OpenAL.


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