ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

Grim::SoundTrack Class Reference

#include <track.h>

Inheritance diagram for Grim::SoundTrack:
Collaboration diagram for Grim::SoundTrack:

List of all members.

Public Types

enum  FadeMode { FadeNone, FadeIn, FadeOut }

Public Member Functions

 SoundTrack ()
virtual ~SoundTrack ()
virtual bool openSound (const Common::String &filename, const Common::String &voiceName, const Audio::Timestamp *start=nullptr)=0
virtual bool isPlaying ()=0
virtual bool play ()
virtual void pause ()
virtual void stop ()
void fadeIn ()
void fadeOut ()
void setFadeMode (FadeMode fadeMode)
void setFade (float fade)
float getFade () const
FadeMode getFadeMode () const
void setBalance (int balance)
void setVolume (int volume)
void setPosition (bool positioned, const Math::Vector3d &pos=Math::Vector3d())
void updatePosition ()
void setSync (int sync)
int getEffectiveVolume ()
int getVolume () const
int getBalance () const
int getSync () const
virtual Audio::Timestamp getPos ()=0
Common::String getSoundName ()
void setSoundName (const Common::String &name)
virtual bool hasLooped ()
virtual void setLooping (bool looping)
virtual bool isLooping () const
bool isPaused () const
bool isPositioned () const
Math::Vector3d getWorldPos () const
Audio::Mixer::SoundType getSoundType () const

Protected Attributes

Common::String _soundName
Audio::AudioStream_stream
Audio::SoundHandle_handle
Audio::Mixer::SoundType _soundType
DisposeAfterUse::Flag _disposeAfterPlaying
bool _paused
bool _positioned
Math::Vector3d _pos
FadeMode _fadeMode
float _fade
float _attenuation
int _balance
int _volume
int _sync

Detailed Description

Definition at line 46 of file track.h.


Member Enumeration Documentation

Enumerator:
FadeNone 
FadeIn 
FadeOut 

Definition at line 48 of file track.h.


Constructor & Destructor Documentation

Grim::SoundTrack::SoundTrack (  ) 

Definition at line 36 of file track.cpp.

Grim::SoundTrack::~SoundTrack (  )  [virtual]

Definition at line 53 of file track.cpp.


Member Function Documentation

void Grim::SoundTrack::fadeIn (  )  [inline]

Definition at line 77 of file track.h.

void Grim::SoundTrack::fadeOut (  )  [inline]

Definition at line 78 of file track.h.

int Grim::SoundTrack::getBalance (  )  const [inline]

Definition at line 90 of file track.h.

int Grim::SoundTrack::getEffectiveVolume (  ) 

Definition at line 148 of file track.cpp.

float Grim::SoundTrack::getFade (  )  const [inline]

Definition at line 81 of file track.h.

FadeMode Grim::SoundTrack::getFadeMode (  )  const [inline]

Definition at line 82 of file track.h.

virtual Audio::Timestamp Grim::SoundTrack::getPos (  )  [pure virtual]
Common::String Grim::SoundTrack::getSoundName (  ) 

Definition at line 58 of file track.cpp.

Audio::Mixer::SoundType Grim::SoundTrack::getSoundType (  )  const [inline]

Definition at line 101 of file track.h.

int Grim::SoundTrack::getSync (  )  const [inline]

Definition at line 91 of file track.h.

int Grim::SoundTrack::getVolume (  )  const [inline]

Definition at line 89 of file track.h.

Math::Vector3d Grim::SoundTrack::getWorldPos (  )  const [inline]

Definition at line 100 of file track.h.

virtual bool Grim::SoundTrack::hasLooped (  )  [inline, virtual]

Reimplemented in Grim::MP3Track.

Definition at line 95 of file track.h.

virtual bool Grim::SoundTrack::isLooping (  )  const [inline, virtual]

Reimplemented in Grim::AIFFTrack.

Definition at line 97 of file track.h.

bool Grim::SoundTrack::isPaused (  )  const [inline]

Definition at line 98 of file track.h.

virtual bool Grim::SoundTrack::isPlaying (  )  [pure virtual]
bool Grim::SoundTrack::isPositioned (  )  const [inline]

Definition at line 99 of file track.h.

virtual bool Grim::SoundTrack::openSound ( const Common::String filename,
const Common::String voiceName,
const Audio::Timestamp start = nullptr 
) [pure virtual]
void Grim::SoundTrack::pause (  )  [virtual]

Definition at line 129 of file track.cpp.

bool Grim::SoundTrack::play (  )  [virtual]

Reimplemented in Grim::AIFFTrack, and Grim::SCXTrack.

Definition at line 116 of file track.cpp.

void Grim::SoundTrack::setBalance ( int  balance  ) 

Definition at line 107 of file track.cpp.

void Grim::SoundTrack::setFade ( float  fade  ) 

Definition at line 141 of file track.cpp.

void Grim::SoundTrack::setFadeMode ( FadeMode  fadeMode  )  [inline]

Definition at line 79 of file track.h.

virtual void Grim::SoundTrack::setLooping ( bool  looping  )  [inline, virtual]

Reimplemented in Grim::AIFFTrack, and Grim::SCXTrack.

Definition at line 96 of file track.h.

void Grim::SoundTrack::setPosition ( bool  positioned,
const Math::Vector3d pos = Math::Vector3d() 
)

Definition at line 73 of file track.cpp.

void Grim::SoundTrack::setSoundName ( const Common::String name  ) 

Definition at line 62 of file track.cpp.

void Grim::SoundTrack::setSync ( int  sync  )  [inline]

Definition at line 87 of file track.h.

void Grim::SoundTrack::setVolume ( int  volume  ) 

Definition at line 66 of file track.cpp.

void Grim::SoundTrack::stop (  )  [virtual]

Definition at line 136 of file track.cpp.

void Grim::SoundTrack::updatePosition (  ) 

Definition at line 79 of file track.cpp.


Member Data Documentation

float Grim::SoundTrack::_attenuation [protected]

Definition at line 64 of file track.h.

int Grim::SoundTrack::_balance [protected]

Definition at line 65 of file track.h.

float Grim::SoundTrack::_fade [protected]

Definition at line 63 of file track.h.

Definition at line 62 of file track.h.

Definition at line 56 of file track.h.

bool Grim::SoundTrack::_paused [protected]

Definition at line 59 of file track.h.

Definition at line 61 of file track.h.

Definition at line 60 of file track.h.

Definition at line 54 of file track.h.

Definition at line 57 of file track.h.

Definition at line 55 of file track.h.

int Grim::SoundTrack::_sync [protected]

Definition at line 67 of file track.h.

int Grim::SoundTrack::_volume [protected]

Definition at line 66 of file track.h.


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


Generated on Sat Sep 21 2019 05:03:46 for ResidualVM by doxygen 1.7.1
curved edge   curved edge