CBufferItem Class Reference

#include <CBufferItem.h>

Inheritance diagram for CBufferItem:

Collaboration diagram for CBufferItem:

Public Member Functions
	CBufferItem (CSoundData *sndData)
virtual	~CBufferItem ()
virtual void	SetLooping (bool loops)
virtual bool	IdleTask ()
virtual void	Attach (CSoundData *itemData)
Public Member Functions inherited from CSoundBase
	CSoundBase ()
virtual	~CSoundBase ()
bool	InitOpenAL ()
void	ResetVars ()
void	EnsurePlay ()
void	SetGain (ALfloat gain)
void	SetRollOff (ALfloat gain, float minDist, float maxDist)
void	SetPitch (ALfloat pitch)
void	SetDirection (const CVector3D &direction)
void	SetCone (ALfloat innerCone, ALfloat outerCone, ALfloat coneGain)
void	SetLastPlay (bool last)
void	ReleaseOpenAL ()
bool	IsFading ()
bool	Finished ()
void	Play ()
void	PlayAndDelete ()
void	PlayLoop ()
void	Stop ()
void	StopAndDelete ()
void	FadeToIn (ALfloat newVolume, double fadeDuration)
bool	GetLooping ()
bool	IsPlaying ()
void	SetLocation (const CVector3D &position)
void	FadeAndDelete (double fadeTime)
void	FadeAndPause (double fadeTime)
void	Pause ()
void	Resume ()
const Path	GetName ()
virtual void	SetLooping (bool loops)
virtual bool	IdleTask ()
virtual void	Attach (CSoundData *itemData)
Public Member Functions inherited from ISoundItem
virtual	~ISoundItem ()
virtual bool	GetLooping ()=0
virtual void	SetLooping (bool loop)=0
virtual bool	IsPlaying ()=0
virtual const Path	GetName ()=0
virtual bool	IdleTask ()=0
virtual bool	IsFading ()=0
virtual bool	Finished ()=0
virtual void	Play ()=0
virtual void	Stop ()=0
virtual void	Attach (CSoundData *itemData)=0
virtual void	EnsurePlay ()=0
virtual void	PlayAndDelete ()=0
virtual void	StopAndDelete ()=0
virtual void	FadeToIn (float newVolume, double fadeDuration)=0
virtual void	FadeAndDelete (double fadeTime)=0
virtual void	FadeAndPause (double fadeTime)=0
virtual void	PlayLoop ()=0
virtual void	SetCone (float innerCone, float outerCone, float coneGain)=0
virtual void	SetPitch (float pitch)=0
virtual void	SetGain (float gain)=0
virtual void	SetLocation (const CVector3D &position)=0
virtual void	SetRollOff (float gain, float minDist, float maxDist)=0
virtual void	Pause ()=0
virtual void	Resume ()=0

Protected Member Functions
void	ReleaseOpenALBuffer ()
Protected Member Functions inherited from CSoundBase
void	SetNameFromPath (VfsPath &itemPath)
void	ResetFade ()
bool	HandleFade ()

Additional Inherited Members
Protected Attributes inherited from CSoundBase
ALuint	m_ALSource
CSoundData *	m_SoundData
bool	m_LastPlay
bool	m_Looping
bool	m_ShouldBePlaying
bool	m_PauseAfterFade
bool	m_IsPaused
double	m_StartFadeTime
double	m_EndFadeTime
ALfloat	m_StartVolume
ALfloat	m_EndVolume
std::mutex	m_ItemMutex

Constructor & Destructor Documentation

CBufferItem()

CBufferItem::CBufferItem

(

CSoundData *

sndData

)

~CBufferItem()

CBufferItem::~CBufferItem ( )

virtual

Member Function Documentation

Attach()

void CBufferItem::Attach ( CSoundData *  itemData )

virtual

Reimplemented from CSoundBase.

IdleTask()

bool CBufferItem::IdleTask ( )

virtual

Reimplemented from CSoundBase.

ReleaseOpenALBuffer()

void CBufferItem::ReleaseOpenALBuffer ( )

protected

SetLooping()

void CBufferItem::SetLooping ( bool  loops )

virtual

Reimplemented from CSoundBase.

---

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

• /home/docker/jenkins/workspace/technical-docs/source/soundmanager/items/CBufferItem.h
• /home/docker/jenkins/workspace/technical-docs/source/soundmanager/items/CBufferItem.cpp