CRM64Pro GDK v0.18.0
A free cross-platform game development kit built on top of SDL 3.0
Loading...
Searching...
No Matches
CRM64Pro::AudioTrackfinal

Audio Track object class. More...

Detailed Description

Audio Track object class.

Public Member Functions

bool info (Sint32 iMode=0) override
 Request AudioTrack information.
const string & getName () const override
 Get the name.
Sint32 getID () const override
 Get the ID.
bool getInfo (string *sType, AudioInfo *pAI) const
 Get AudioTrack detailed information.
Sint32 play (Sint32 iRepeats=0)
 Play the track.
Sint32 fadeIn (Sint32 iTimeMS=1000, Sint32 iRepeats=0)
 Play the track with a fade-in effect.
bool fadeOut (Sint32 iTimeMS=1000)
 Fade out all instances of this track to silence, then stop.
bool stop ()
 Immediately stop all instances of this track.
bool pause ()
 Pause all instances of this track.
bool resume ()
 Resume all instances of this track.
ePlaybackStatus status () const
 Get the playback status.
Sint32 getPlaybackPosition () const
 Get the current playback position.
bool seek (Sint32 iTimeMS)
 Seek the active playback instance.
bool setPitch (float fPitch)
 Set Pitch (Frequency Ratio).
float getPitch () const
 Get current pitch property.
bool setPanning (Uint8 iLeft, Uint8 iRight)
 Set Stereo Panning.
bool getPanning (Uint8 *iLeft, Uint8 *iRight) const
 Get stereo panning.
bool setLoopPoints (double dStartSec, double dEndSec)
 Set Loop Points.
bool getLoopPoints (double *dStartSec, double *dEndSec) const
 Get loop points.
bool setSpatialDistance (Uint8 iDistance)
 Set spatial distance attenuation.
Uint8 getSpatialDistance () const
 Get spatial distance attenuation.
bool setSpatialPosition (Sint16 iAngle, Uint8 iDistance)
 Set spatial position.
bool getSpatialPosition (Sint16 *iAngle, Uint8 *iDistance) const
 Get spatial position.
bool setTag (eAudioTrackTag eTag)
 Set audio tag category.
eAudioTrackTag getTag () const
 Get audio tag category.
Sint32 saveToFile (const string &sFile)
 Export the AudioTrack to an external file.
Sint32 save (const string &sCDCFile, const string &sResourceName="")
 Save the AudioTrack into a CDC file.
Sint32 save (Sint32 idCDC, const string &sResourceName="")
 Save the AudioTrack into a CDC file.