eChannelSDLMixer Class Reference

#include <eChannelSDLMixer.h>

Collaboration diagram for eChannelSDLMixer:

[legend]

List of all members.

Public Member Functions
	eChannelSDLMixer ()
void	SetVolume (int volume)
int	GetId ()
void	SetId (int newID)
void	Set3d (eCoord home, eCoord soundPos, eCoord homeDirection)
void	PlaySound (eWavData &sound)
void	LoopSound (eWavData &sound)
void	StopSound ()
void	UnplaySound ()
Uint32	StartTime ()
bool	IsContinuous ()
void	Update ()
bool	isDirty ()
bool	isBusy ()
void	SetOwner (eGameObject *owner)
void	DelayStarting ()
bool	IsDelayed ()
void	Undelay ()
void	SetHome (eGameObject *home)
eGameObject *	GetOwner ()
Static Public Attributes
static int	numChannels
Private Attributes
eWavData	m_Sound
bool	m_Delayed
bool	m_StartNow
int	m_Volume
int	m_ChannelID
Uint32	m_StartTime
bool	m_isDirty
bool	m_isPlaying
eGameObject *	m_Owner
eGameObject *	m_Home
bool	m_continuous

---

Detailed Description

Definition at line 83 of file eChannelSDLMixer.h.

---

Constructor & Destructor Documentation

eChannelSDLMixer::eChannelSDLMixer

(

)

---

Member Function Documentation

void eChannelSDLMixer::SetVolume

(

int

volume

)

int eChannelSDLMixer::GetId

(

)

[inline]

Definition at line 87 of file eChannelSDLMixer.h.

{ return m_ChannelID; };

void eChannelSDLMixer::SetId

(

int

newID

)

[inline]

Definition at line 88 of file eChannelSDLMixer.h.

References m_ChannelID.

{ return m_ChannelID; };

void eChannelSDLMixer::Set3d	(	eCoord	home,
		eCoord	soundPos,
		eCoord	homeDirection
	)

void eChannelSDLMixer::PlaySound

(

eWavData &

sound

)

void eChannelSDLMixer::LoopSound

(

eWavData &

sound

)

void eChannelSDLMixer::StopSound

(

)

[inline]

Definition at line 93 of file eChannelSDLMixer.h.

                     {
#ifndef DEDICATED
        m_isDirty = true; m_isPlaying = false; Mix_HaltChannel(m_ChannelID);
#endif

void eChannelSDLMixer::UnplaySound

(

)

Uint32 eChannelSDLMixer::StartTime

(

)

[inline]

Definition at line 103 of file eChannelSDLMixer.h.

{ return m_StartTime; };

bool eChannelSDLMixer::IsContinuous

(

)

[inline]

Definition at line 104 of file eChannelSDLMixer.h.

References m_StartTime.

{ return m_StartTime; };

void eChannelSDLMixer::Update

(

)

bool eChannelSDLMixer::isDirty

(

)

[inline]

Definition at line 110 of file eChannelSDLMixer.h.

References m_isDirty.

{ return m_isDirty; };

bool eChannelSDLMixer::isBusy

(

)

[inline]

Definition at line 113 of file eChannelSDLMixer.h.

References m_isPlaying.

{ return m_isPlaying; };

void eChannelSDLMixer::SetOwner

(

eGameObject *

owner

)

void eChannelSDLMixer::DelayStarting

(

)

[inline]

Definition at line 116 of file eChannelSDLMixer.h.

{ m_Delayed = true; m_StartNow = false; };

bool eChannelSDLMixer::IsDelayed

(

)

[inline]

Definition at line 117 of file eChannelSDLMixer.h.

References m_Delayed, and m_StartNow.

{ m_Delayed = true; m_StartNow = false; };

void eChannelSDLMixer::Undelay

(

)

[inline]

Definition at line 118 of file eChannelSDLMixer.h.

References m_Delayed.

{ return m_Delayed; };

void eChannelSDLMixer::SetHome

(

eGameObject *

home

)

[inline]

Definition at line 119 of file eChannelSDLMixer.h.

References m_StartNow.

{ m_StartNow = true; };

eGameObject* eChannelSDLMixer::GetOwner

(

)

[inline]

Definition at line 120 of file eChannelSDLMixer.h.

{ m_Home = home; };

---

Member Data Documentation

int eChannelSDLMixer::numChannels [static]

Definition at line 120 of file eChannelSDLMixer.h.

eWavData eChannelSDLMixer::m_Sound [private]

Definition at line 128 of file eChannelSDLMixer.h.

bool eChannelSDLMixer::m_Delayed [private]

Definition at line 129 of file eChannelSDLMixer.h.

Referenced by IsDelayed(), and Undelay().

bool eChannelSDLMixer::m_StartNow [private]

Definition at line 130 of file eChannelSDLMixer.h.

Referenced by IsDelayed(), and SetHome().

int eChannelSDLMixer::m_Volume [private]

Definition at line 131 of file eChannelSDLMixer.h.

int eChannelSDLMixer::m_ChannelID [private]

Definition at line 132 of file eChannelSDLMixer.h.

Referenced by SetId().

Uint32 eChannelSDLMixer::m_StartTime [private]

Definition at line 133 of file eChannelSDLMixer.h.

Referenced by IsContinuous().

bool eChannelSDLMixer::m_isDirty [private]

Definition at line 134 of file eChannelSDLMixer.h.

Referenced by isDirty().

bool eChannelSDLMixer::m_isPlaying [private]

Definition at line 135 of file eChannelSDLMixer.h.

Referenced by isBusy().

eGameObject* eChannelSDLMixer::m_Owner [private]

Definition at line 136 of file eChannelSDLMixer.h.

eGameObject* eChannelSDLMixer::m_Home [private]

Definition at line 137 of file eChannelSDLMixer.h.

bool eChannelSDLMixer::m_continuous [private]

Definition at line 138 of file eChannelSDLMixer.h.

---

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

• src/engine/sound/sdl_mixer/eChannelSDLMixer.h

---