ISoundItem Class Reference

#include <ISoundItem.h>

Inheritance diagram for ISoundItem:

Public Member Functions
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

Constructor & Destructor Documentation

~ISoundItem()

virtual ISoundItem::~ISoundItem ( )

inlinevirtual

Member Function Documentation

Attach()

virtual void ISoundItem::Attach ( CSoundData *  itemData )

pure virtual

Implemented in CBufferItem, CSoundBase, CSoundItem, and CStreamItem.

EnsurePlay()

virtual void ISoundItem::EnsurePlay ( )

pure virtual

Implemented in CSoundBase.

FadeAndDelete()

virtual void ISoundItem::FadeAndDelete ( double  fadeTime )

pure virtual

Implemented in CSoundBase.

FadeAndPause()

virtual void ISoundItem::FadeAndPause ( double  fadeTime )

pure virtual

Implemented in CSoundBase.

FadeToIn()

virtual void ISoundItem::FadeToIn ( float  newVolume, double  fadeDuration  )

pure virtual

Finished()

virtual bool ISoundItem::Finished ( )

pure virtual

Implemented in CSoundBase.

GetLooping()

virtual bool ISoundItem::GetLooping ( )

pure virtual

Implemented in CSoundBase.

GetName()

virtual const Path ISoundItem::GetName ( )

pure virtual

Implemented in CSoundBase.

IdleTask()

virtual bool ISoundItem::IdleTask ( )

pure virtual

Implemented in CBufferItem, CSoundBase, CSoundItem, and CStreamItem.

IsFading()

virtual bool ISoundItem::IsFading ( )

pure virtual

Implemented in CSoundBase.

IsPlaying()

virtual bool ISoundItem::IsPlaying ( )

pure virtual

Implemented in CSoundBase.

Pause()

virtual void ISoundItem::Pause ( )

pure virtual

Implemented in CSoundBase.

Play()

virtual void ISoundItem::Play ( )

pure virtual

Implemented in CSoundBase.

PlayAndDelete()

virtual void ISoundItem::PlayAndDelete ( )

pure virtual

Implemented in CSoundBase.

PlayLoop()

virtual void ISoundItem::PlayLoop ( )

pure virtual

Implemented in CSoundBase.

Resume()

virtual void ISoundItem::Resume ( )

pure virtual

Implemented in CSoundBase.

SetCone()

virtual void ISoundItem::SetCone ( float  innerCone, float  outerCone, float  coneGain  )

pure virtual

SetGain()

virtual void ISoundItem::SetGain ( float  gain )

pure virtual

SetLocation()

virtual void ISoundItem::SetLocation ( const CVector3D &  position )

pure virtual

Implemented in CSoundBase.

SetLooping()

virtual void ISoundItem::SetLooping ( bool  loop )

pure virtual

Implemented in CBufferItem, CSoundBase, and CStreamItem.

SetPitch()

virtual void ISoundItem::SetPitch ( float  pitch )

pure virtual

SetRollOff()

virtual void ISoundItem::SetRollOff ( float  gain, float  minDist, float  maxDist  )

pure virtual

Stop()

virtual void ISoundItem::Stop ( )

pure virtual

Implemented in CSoundBase.

StopAndDelete()

virtual void ISoundItem::StopAndDelete ( )

pure virtual

Implemented in CSoundBase.

---

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

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