RageSound Class Reference

Inheritance diagram for RageSound:

Collaboration diagram for RageSound:

Public Member Functions
	RageSound (const RageSound &cpy)
auto	operator= (const RageSound &cpy) -> RageSound &
auto	Load (const std::string &sFile, bool bPrecache, const RageSoundLoadParams *pParams=nullptr) -> bool
auto	Load (const std::string &sFile) -> bool
void	LoadSoundReader (RageSoundReader *pSound)
auto	GetSoundReader () -> RageSoundReader *
void	Unload ()
auto	IsLoaded () const -> bool
void	DeleteSelfWhenFinishedPlaying ()
void	StartPlaying (float fGiven=0, bool forcedTime=false)
void	StopPlaying ()
auto	GetError () const -> std::string
void	Play (bool is_action, const RageSoundParams *params=nullptr)
void	PlayCopy (bool is_action, const RageSoundParams *pParams=nullptr) const
void	Stop ()
auto	Pause (bool bPause) -> bool
auto	GetLengthSeconds () -> float
auto	GetPositionSeconds (bool *approximate=nullptr, RageTimer *Timestamp=nullptr) -> float
auto	GetLoadedFilePath () const -> std::string override
auto	IsPlaying () const -> bool
auto	GetPlaybackRate () const -> float
auto	GetStartTime () const -> RageTimer override
void	SetParams (const RageSoundParams &p)
auto	GetParams () const -> const RageSoundParams &
auto	SetProperty (const std::string &sProperty, float fValue) -> bool
void	SetStopModeFromString (const std::string &sStopMode)
void	SetPositionSeconds (float fGiven)
void	SetPlayBackCallback (const std::shared_ptr< LuaReference > &f, unsigned int bufSize=1024)
void	ExecutePlayBackCallback (Lua *L)
virtual void	PushSelf (lua_State *L)
auto	GetDataToPlay (float *pBuffer, int iSize, int64_t &iStreamFrame, int &iBytesRead) -> int override
void	CommitPlayingPosition (int64_t iHardwareFrame, int64_t iStreamFrame, int iGotFrames) override

Public Attributes
bool	m_bPaused { false }
std::atomic< bool >	pendingPlayBackCall { false }

Member Function Documentation

CommitPlayingPosition()

void RageSound::CommitPlayingPosition ( int64_t  iHardwareFrame, int64_t  iStreamFrame, int  iGotFrames  )

overridevirtual

Implements RageSoundBase.

GetDataToPlay()

int RageSound::GetDataToPlay ( float *  pBuffer, int  iSize, int64_t &  iStreamFrame, int &  iBytesRead  ) -> int

overridevirtual

Implements RageSoundBase.

GetLoadedFilePath()

auto RageSound::GetLoadedFilePath ( ) const -> std::string

inlineoverridevirtual

Implements RageSoundBase.

GetStartTime()

RageTimer RageSound::GetStartTime ( ) const -> RageTimer

overridevirtual

Reimplemented from RageSoundBase.

---

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

• /home/runner/work/etterna/etterna/src/RageUtil/Sound/RageSound.h
• /home/runner/work/etterna/etterna/src/RageUtil/Sound/RageSound.cpp