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

Video::VideoDecoder::AudioTrack Class Reference

An abstract representation of an audio track. More...

#include <video_decoder.h>

Inheritance diagram for Video::VideoDecoder::AudioTrack:
Collaboration diagram for Video::VideoDecoder::AudioTrack:

List of all members.

Public Member Functions

 AudioTrack (Audio::Mixer::SoundType soundType)
virtual ~AudioTrack ()
TrackType getTrackType () const
 Get the type of track.
virtual bool endOfTrack () const
 Return if the track has finished.
void start ()
 Start playing this track.
void stop ()
 Stop playing this track.
void start (const Audio::Timestamp &limit)
byte getVolume () const
 Get the volume for this track.
void setVolume (byte volume)
 Set the volume for this track.
int8 getBalance () const
 Get the balance for this track.
void setBalance (int8 balance)
 Set the balance for this track.
uint32 getRunningTime () const
 Get the time the AudioStream behind this track has been running.
void setMute (bool mute)
 Mute the track.

Protected Member Functions

void pauseIntern (bool shouldPause)
 Function called by pause() for subclasses to implement.
virtual Audio::AudioStreamgetAudioStream () const =0
 Get the AudioStream that is the representation of this AudioTrack.

Private Attributes

Audio::SoundHandle _handle
Audio::Mixer::SoundType _soundType
byte _volume
int8 _balance
bool _muted

Detailed Description

An abstract representation of an audio track.

Definition at line 680 of file video_decoder.h.


Constructor & Destructor Documentation

Video::VideoDecoder::AudioTrack::AudioTrack ( Audio::Mixer::SoundType  soundType  ) 

Definition at line 595 of file video_decoder.cpp.

virtual Video::VideoDecoder::AudioTrack::~AudioTrack (  )  [inline, virtual]

Definition at line 683 of file video_decoder.h.


Member Function Documentation

bool Video::VideoDecoder::AudioTrack::endOfTrack (  )  const [virtual]

Return if the track has finished.

Implements Video::VideoDecoder::Track.

Definition at line 602 of file video_decoder.cpp.

virtual Audio::AudioStream* Video::VideoDecoder::AudioTrack::getAudioStream (  )  const [protected, pure virtual]
int8 Video::VideoDecoder::AudioTrack::getBalance (  )  const [inline]

Get the balance for this track.

Definition at line 714 of file video_decoder.h.

uint32 Video::VideoDecoder::AudioTrack::getRunningTime (  )  const

Get the time the AudioStream behind this track has been running.

Definition at line 653 of file video_decoder.cpp.

TrackType Video::VideoDecoder::AudioTrack::getTrackType (  )  const [inline, virtual]

Get the type of track.

Implements Video::VideoDecoder::Track.

Definition at line 685 of file video_decoder.h.

byte Video::VideoDecoder::AudioTrack::getVolume (  )  const [inline]

Get the volume for this track.

Definition at line 704 of file video_decoder.h.

void Video::VideoDecoder::AudioTrack::pauseIntern ( bool  shouldPause  )  [protected, virtual]

Function called by pause() for subclasses to implement.

Reimplemented from Video::VideoDecoder::Track.

Definition at line 670 of file video_decoder.cpp.

void Video::VideoDecoder::AudioTrack::setBalance ( int8  balance  ) 

Set the balance for this track.

Definition at line 614 of file video_decoder.cpp.

void Video::VideoDecoder::AudioTrack::setMute ( bool  mute  ) 

Mute the track.

Definition at line 660 of file video_decoder.cpp.

void Video::VideoDecoder::AudioTrack::setVolume ( byte  volume  ) 

Set the volume for this track.

Definition at line 607 of file video_decoder.cpp.

void Video::VideoDecoder::AudioTrack::start ( const Audio::Timestamp limit  ) 

Definition at line 638 of file video_decoder.cpp.

void Video::VideoDecoder::AudioTrack::start (  ) 

Start playing this track.

Definition at line 621 of file video_decoder.cpp.

void Video::VideoDecoder::AudioTrack::stop (  ) 

Stop playing this track.

Definition at line 634 of file video_decoder.cpp.


Member Data Documentation

Definition at line 744 of file video_decoder.h.

Definition at line 745 of file video_decoder.h.

Definition at line 743 of file video_decoder.h.


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


Generated on Sat Jul 20 2019 05:03:41 for ResidualVM by doxygen 1.7.1
curved edge   curved edge