IEngineSound Class Reference

#include <sound.h>

Inheritance diagram for IEngineSound:

Collaboration diagram for IEngineSound:

Public Member Functions
virtual int	Init ()=0
virtual int	Update ()=0
virtual void	Shutdown () override=0
Public Member Functions inherited from ISound
virtual bool	IsSoundEnabled ()=0
virtual int	LoadOpus (const char *pFilename, int StorageType=IStorage::TYPE_ALL)=0
virtual int	LoadWV (const char *pFilename, int StorageType=IStorage::TYPE_ALL)=0
virtual int	LoadOpusFromMem (const void *pData, unsigned DataSize, bool ForceLoad=false)=0
virtual int	LoadWVFromMem (const void *pData, unsigned DataSize, bool ForceLoad=false)=0
virtual void	UnloadSample (int SampleId)=0
virtual float	GetSampleTotalTime (int SampleId)=0
virtual float	GetSampleCurrentTime (int SampleId)=0
virtual void	SetSampleCurrentTime (int SampleId, float Time)=0
virtual void	SetChannel (int ChannelId, float Volume, float Panning)=0
virtual void	SetListenerPosition (vec2 Position)=0
virtual void	SetVoiceVolume (CVoiceHandle Voice, float Volume)=0
virtual void	SetVoiceFalloff (CVoiceHandle Voice, float Falloff)=0
virtual void	SetVoicePosition (CVoiceHandle Voice, vec2 Position)=0
virtual void	SetVoiceTimeOffset (CVoiceHandle Voice, float TimeOffset)=0
virtual void	SetVoiceCircle (CVoiceHandle Voice, float Radius)=0
virtual void	SetVoiceRectangle (CVoiceHandle Voice, float Width, float Height)=0
virtual CVoiceHandle	PlayAt (int ChannelId, int SampleId, int Flags, float Volume, vec2 Position)=0
virtual CVoiceHandle	Play (int ChannelId, int SampleId, int Flags, float Volume)=0
virtual void	Pause (int SampleId)=0
virtual void	Stop (int SampleId)=0
virtual void	StopAll ()=0
virtual void	StopVoice (CVoiceHandle Voice)=0
virtual bool	IsPlaying (int SampleId)=0
virtual int	MixingRate () const =0
virtual void	Mix (short *pFinalOut, unsigned Frames)=0
virtual void	PauseAudioDevice ()=0
virtual void	UnpauseAudioDevice ()=0
Public Member Functions inherited from IInterface
	IInterface ()
virtual void	Shutdown ()
virtual	~IInterface ()

Additional Inherited Members
Public Types inherited from ISound
enum	{   FLAG_LOOP = 1 << 0 , FLAG_POS = 1 << 1 , FLAG_NO_PANNING = 1 << 2 , FLAG_PREVIEW = 1 << 3 ,   FLAG_ALL = FLAG_LOOP | FLAG_POS | FLAG_NO_PANNING | FLAG_PREVIEW }
enum	{ SHAPE_CIRCLE , SHAPE_RECTANGLE }
Protected Member Functions inherited from ISound
CVoiceHandle	CreateVoiceHandle (int Index, int Age)
Protected Member Functions inherited from IInterface
IKernel *	Kernel ()

Member Function Documentation

Init()

virtual int IEngineSound::Init ( )

pure virtual

Implemented in CSound.

Shutdown()

virtual void IEngineSound::Shutdown ( )

overridepure virtual

Reimplemented from IInterface.

Implemented in CSound.

Update()

virtual int IEngineSound::Update ( )

pure virtual

Implemented in CSound.

---

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

• src/engine/sound.h