ScummVM API documentation
Ultima::Ultima8::AudioProcess Class Reference
Inheritance diagram for Ultima::Ultima8::AudioProcess:
Ultima::Ultima8::Process

Classes

struct  SampleInfo
 

Public Member Functions

 INTRINSIC (I_playSFX)
 
 INTRINSIC (I_playAmbientSFX)
 
 INTRINSIC (I_playSFXCru)
 
 INTRINSIC (I_playAmbientSFXCru)
 
 INTRINSIC (I_isSFXPlaying)
 
 INTRINSIC (I_isSFXPlayingForObject)
 
 INTRINSIC (I_setVolumeSFX)
 
 INTRINSIC (I_setVolumeForObjectSFX)
 
 INTRINSIC (I_stopSFX)
 
 INTRINSIC (I_stopSFXCru)
 
 INTRINSIC (I_stopAllSFX)
 
void run () override
 
void playSFX (int sfxNum, int priority, ObjId objId, int loops, bool no_duplicates, uint32 pitchShift, uint16 volume, int16 calcVol, int8 balance, bool ambient)
 
void playSFX (int sfxNum, int priority, ObjId objId, int loops, bool no_duplicates=false, uint32 pitchShift=PITCH_SHIFT_NONE, uint16 volume=0x80, bool ambient=false)
 
void stopSFX (int sfxNum, ObjId objId)
 stop sfx on object. set sfxNum = -1 to stop all for object.
 
bool isSFXPlaying (int sfxNum)
 
bool isSFXPlayingForObject (int sfxNum, ObjId objId)
 
void setVolumeSFX (int sfxNum, uint8 volume)
 
void setVolumeForObjectSFX (ObjId objId, int sfxNum, uint8 volume)
 
bool playSpeech (const Std::string &barked, int shapenum, ObjId objId, uint32 pitchShift=PITCH_SHIFT_NONE, uint16 volume=255)
 
void stopSpeech (const Std::string &barked, int shapenum, ObjId objId)
 
bool isSpeechPlaying (const Std::string &barked, int shapenum)
 
uint32 getSpeechLength (const Std::string &barked, int shapenum) const
 get length (in milliseconds) of speech
 
int playSample (AudioSample *sample, int priority, int loops, bool isSpeech=false, uint32 pitchShift=PITCH_SHIFT_NONE, int16 volume=255, int8 balance=0, bool ambient=false)
 
void pauseAllSamples ()
 pause all currently playing samples
 
void unpauseAllSamples ()
 unpause all currently playing samples
 
void stopAllExceptSpeech ()
 stop all samples except speech
 
bool loadData (Common::ReadStream *rs, uint32 version)
 
void saveData (Common::WriteStream *ws) override
 save Process data
 
- Public Member Functions inherited from Ultima::Ultima8::Process
 Process (ObjId _itemNum=0, uint16 type=0)
 
uint32 getProcessFlags () const
 
bool is_active () const
 
bool is_terminated () const
 
bool is_suspended () const
 
void fail ()
 terminate the process and recursively fail all processes waiting for it
 
virtual void terminate ()
 terminate the process. This wakes up all processes waiting for it.
 
void terminateDeferred ()
 terminate next frame
 
void setRunPaused ()
 run even when paused
 
void waitFor (ProcId pid)
 suspend until process 'pid' returns. If pid is 0, suspend indefinitely
 
void waitFor (Process *proc)
 suspend until process returns. If proc is 0, suspend indefinitely
 
void suspend ()
 suspend process
 
void wakeUp (uint32 result)
 Wake up when the process we were waiting for has finished.
 
virtual void onWakeUp ()
 A hook to add aditional behavior on wakeup, before anything else happens.
 
void setItemNum (ObjId it)
 
void setType (uint16 ty)
 
void setTicksPerRun (uint32 val)
 
ProcId getPid () const
 
ObjId getItemNum () const
 
uint16 getType () const
 
uint32 getTicksPerRun () const
 
virtual Common::String dumpInfo () const
 dump some info about this process to a string
 
bool loadData (Common::ReadStream *rs, uint32 version)
 load Process data
 
bool validateWaiters () const
 

Static Public Member Functions

static AudioProcessget_instance ()
 Get the current instance of the Audio Processes.
 

Public Attributes

Std::list< SampleInfo_sampleInfo
 

Static Public Attributes

static const uint32 PITCH_SHIFT_NONE
 

Additional Inherited Members

- Public Types inherited from Ultima::Ultima8::Process
enum  processflags {
  PROC_ACTIVE = 0x0001, PROC_SUSPENDED = 0x0002, PROC_TERMINATED = 0x0004, PROC_TERM_DEFERRED = 0x0008,
  PROC_FAILED = 0x0010, PROC_RUNPAUSED = 0x0020, PROC_TERM_DISPOSE = 0x0040, PROC_PREVENT_SAVE = 0x0080
}
 
- Protected Attributes inherited from Ultima::Ultima8::Process
ProcId _pid
 process id
 
uint32 _flags
 
uint32 _ticksPerRun
 
ObjId _itemNum
 item we are assigned to
 
uint16 _type
 
uint32 _result
 process result
 
Std::vector< ProcId > _waiting
 

Member Function Documentation

◆ playSample()

int Ultima::Ultima8::AudioProcess::playSample ( AudioSample sample,
int  priority,
int  loops,
bool  isSpeech = false,
uint32  pitchShift = PITCH_SHIFT_NONE,
int16  volume = 255,
int8  balance = 0,
bool  ambient = false 
)

play a sample (without storing a SampleInfo) returns channel sample is played on, or -1


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