ScummVM API documentation
Video::VideoDecoder::SeekableAudioTrack Class Referenceabstract

#include <video_decoder.h>

Inheritance diagram for Video::VideoDecoder::SeekableAudioTrack:
Video::VideoDecoder::AudioTrack Video::VideoDecoder::Track Video::VideoDecoder::StreamFileAudioTrack

Public Member Functions

 SeekableAudioTrack (Audio::Mixer::SoundType soundType)
 
bool isSeekable () const
 
bool seek (const Audio::Timestamp &time)
 
Audio::Timestamp getDuration () const
 
- Public Member Functions inherited from Video::VideoDecoder::AudioTrack
 AudioTrack (Audio::Mixer::SoundType soundType)
 
TrackType getTrackType () const
 
virtual bool endOfTrack () const
 
void start ()
 
void stop ()
 
void start (const Audio::Timestamp &limit)
 
byte getVolume () const
 
void setVolume (byte volume)
 
uint32 getRate () const
 
void setRate (uint32 rate)
 
void setRate (Common::Rational rate)
 
int8 getBalance () const
 
void setBalance (int8 balance)
 
Audio::Mixer::SoundType getSoundType () const
 
void setSoundType (Audio::Mixer::SoundType soundType)
 
uint32 getRunningTime () const
 
void setMute (bool mute)
 
- Public Member Functions inherited from Video::VideoDecoder::Track
virtual bool isRewindable () const
 
virtual bool rewind ()
 
void pause (bool shouldPause)
 
bool isPaused () const
 

Protected Member Functions

Audio::AudioStreamgetAudioStream () const
 
virtual Audio::SeekableAudioStreamgetSeekableAudioStream () const =0
 
- Protected Member Functions inherited from Video::VideoDecoder::AudioTrack
void pauseIntern (bool shouldPause)
 

Additional Inherited Members

- Public Types inherited from Video::VideoDecoder::Track
enum  TrackType { kTrackTypeNone, kTrackTypeVideo, kTrackTypeAudio }
 

Detailed Description

An AudioTrack that implements isSeekable() and seek() using SeekableAudioStream.

Member Function Documentation

◆ isSeekable()

bool Video::VideoDecoder::SeekableAudioTrack::isSeekable ( ) const
inlinevirtual

Return if the track is seekable.

Reimplemented from Video::VideoDecoder::Track.

◆ seek()

bool Video::VideoDecoder::SeekableAudioTrack::seek ( const Audio::Timestamp time)
virtual

Seek to the given time.

Parameters
timeThe time to seek to, from the beginning of the video.
Returns
true on success, false otherwise.

Reimplemented from Video::VideoDecoder::Track.

◆ getDuration()

Audio::Timestamp Video::VideoDecoder::SeekableAudioTrack::getDuration ( ) const
virtual

Get the duration of the track (starting from this track's start time).

By default, this returns 0 for unknown.

Reimplemented from Video::VideoDecoder::Track.

◆ getAudioStream()

Audio::AudioStream* Video::VideoDecoder::SeekableAudioTrack::getAudioStream ( ) const
protectedvirtual

Get the AudioStream that is the representation of this AudioTrack

Implements Video::VideoDecoder::AudioTrack.

◆ getSeekableAudioStream()

virtual Audio::SeekableAudioStream* Video::VideoDecoder::SeekableAudioTrack::getSeekableAudioStream ( ) const
protectedpure virtual

Get the SeekableAudioStream pointer to be used by this class for seek(), getDuration(), and getAudioStream()

Implemented in Video::VideoDecoder::StreamFileAudioTrack.


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