ScummVM API documentation
Public Member Functions | Public Attributes | List of all members
AGS3::SoundClipWaveBase Struct Reference
Inheritance diagram for AGS3::SoundClipWaveBase:
AGS3::SOUNDCLIP AGS3::SoundClipWave< SOUND_TYPE >

Public Member Functions

 SoundClipWaveBase (Audio::AudioStream *stream, bool repeat=false)
 
void setType (Audio::Mixer::SoundType type)
 
void poll () override
 
int play () override
 
int play_from (int position) override
 
void pause () override
 
void resume () override
 
bool is_playing () override
 
bool is_paused () override
 
void seek (int offset) override
 
void seek_ms (int pos_ms) override
 
int get_pos () override
 
int get_pos_ms () override
 
int get_length_ms () override
 
void set_panning (int newPanning) override
 
void set_speed (int new_speed) override
 
void adjust_volume () override
 
- Public Member Functions inherited from AGS3::SOUNDCLIP
virtual int get_sound_type () const =0
 
int get_volume100 () const
 
int get_volume255 () const
 
int get_panning () const
 
int get_speed () const
 
bool is_muted () const
 
void set_volume100 (int volume)
 
void set_volume255 (int volume)
 
void set_volume_direct (int vol_percent, int vol_absolute)
 
void set_mute (bool mute)
 
void apply_volume_modifier (int mod)
 
void apply_directional_modifier (int mod)
 
bool is_ready ()
 
bool update ()
 

Public Attributes

Audio::Mixer * _mixer
 
Audio::AudioStream * _stream
 
Audio::SoundHandle _soundHandle
 
SoundClipState _state
 
bool _waitingToPlay = false
 
- Public Attributes inherited from AGS3::SOUNDCLIP
int _sourceClipID
 
int _sourceClipType
 
bool _repeat
 
int _priority
 
int _xSource
 
int _ySource
 
int _maximumPossibleDistanceAway
 
int _vol255
 
int _vol100
 
int _volModifier
 
int _panning
 
int _panningAsPercentage
 
int _directionalVolModifier
 

Additional Inherited Members

- Protected Member Functions inherited from AGS3::SOUNDCLIP
int get_final_volume () const
 
- Protected Attributes inherited from AGS3::SOUNDCLIP
bool _muted = false
 
int _speed = 0
 
bool _paramsChanged = false
 

Member Function Documentation

◆ seek()

void AGS3::SoundClipWaveBase::seek ( int  offset)
overridevirtual

Seeks to the position, where pos units depend on the audio type:

  • MIDI - the beat number
  • MOD / XM / S3M - the pattern number
  • WAV / VOC - the sample number
  • OGG / MP3 - milliseconds

Implements AGS3::SOUNDCLIP.

◆ seek_ms()

void AGS3::SoundClipWaveBase::seek_ms ( int  pos_ms)
overridevirtual

Seeks to the position in milliseconds

Implements AGS3::SOUNDCLIP.

◆ get_pos()

int AGS3::SoundClipWaveBase::get_pos ( )
overridevirtual

Return current position in frames

Implements AGS3::SOUNDCLIP.

◆ get_pos_ms()

int AGS3::SoundClipWaveBase::get_pos_ms ( )
overridevirtual

Return the position in milliseconds

Implements AGS3::SOUNDCLIP.

◆ get_length_ms()

int AGS3::SoundClipWaveBase::get_length_ms ( )
overridevirtual

Return total track length in ms (or 0)

Implements AGS3::SOUNDCLIP.

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