Channel Class Reference

#include <Channel.h>

Collaboration diagram for Channel:

Public Member Functions
	Channel ()=delete
	Channel (IXAudio2SubmixVoice *submix, IXAudio2SubmixVoice *reverb=nullptr)
	Channel (const Channel &in)=default
Channel &	operator= (const Channel &in)=default
	~Channel ()
snd_err	Pan (float pan)
snd_err	setEmitterPos (float x, float y, float z)
snd_err	setEmitterOrientation (float xF, float yF, float zF, float xU, float yU, float zU)
snd_err	Volume (float volume)
snd_err	ActivateFilter (FilterType type)
snd_err	DeactivateFilter (FilterType type)
snd_err	SetCutoff (float cutoff)
snd_err	GetCutoff (float &cutoff)
snd_err	SetReverbLevel (float level)
snd_err	SetReverbTime (float time)
snd_err	SetReverbPreDelay (float time)
snd_err	SetReverbSize (float size)
snd_err	SetReverbDensity (float density)
X3DAUDIO_VECTOR	GetPos () const
X3DAUDIO_EMITTER *	GetEmitter () const
X3DAUDIO_DSP_SETTINGS *	GetDSPSettings () const
IXAudio2SubmixVoice *	GetSubmixVoice () const

Private Attributes
IXAudio2SubmixVoice *	voice
IXAudio2SubmixVoice *	reverbReturn
XAUDIO2_FILTER_PARAMETERS *	params
XAUDIO2FX_REVERB_PARAMETERS	reverbParams
X3DAUDIO_VECTOR	vPosition
X3DAUDIO_EMITTER *	emitter
X3DAUDIO_DSP_SETTINGS *	dspSettings
float	cutoffFrequency

Friends
class	Sound

Constructor & Destructor Documentation

Channel() [1/3]

Channel::Channel ( )

delete

Channel() [2/3]

Channel::Channel	(	IXAudio2SubmixVoice *	submix,
		IXAudio2SubmixVoice *	reverb = nullptr
	)

Channel() [3/3]

Channel::Channel ( const Channel &  in )

default

~Channel()

Channel::~Channel

(

)

Member Function Documentation

ActivateFilter()

snd_err Channel::ActivateFilter

(

FilterType

type

)

DeactivateFilter()

snd_err Channel::DeactivateFilter

(

FilterType

type

)

GetCutoff()

snd_err Channel::GetCutoff

(

float &

cutoff

)

GetDSPSettings()

X3DAUDIO_DSP_SETTINGS* Channel::GetDSPSettings ( ) const

inline

GetEmitter()

X3DAUDIO_EMITTER* Channel::GetEmitter ( ) const

inline

GetPos()

X3DAUDIO_VECTOR Channel::GetPos ( ) const

inline

GetSubmixVoice()

IXAudio2SubmixVoice * Channel::GetSubmixVoice

(

)

const

operator=()

Channel& Channel::operator= ( const Channel &  in )

default

Pan()

snd_err Channel::Pan

(

float

pan

)

SetCutoff()

snd_err Channel::SetCutoff

(

float

cutoff

)

setEmitterOrientation()

snd_err Channel::setEmitterOrientation	(	float	xF,
		float	yF,
		float	zF,
		float	xU,
		float	yU,
		float	zU
	)

setEmitterPos()

snd_err Channel::setEmitterPos	(	float	x,
		float	y,
		float	z
	)

SetReverbDensity()

snd_err Channel::SetReverbDensity

(

float

density

)

SetReverbLevel()

snd_err Channel::SetReverbLevel

(

float

level

)

SetReverbPreDelay()

snd_err Channel::SetReverbPreDelay

(

float

time

)

SetReverbSize()

snd_err Channel::SetReverbSize

(

float

size

)

SetReverbTime()

snd_err Channel::SetReverbTime

(

float

time

)

Volume()

snd_err Channel::Volume

(

float

volume

)

Friends And Related Function Documentation

Sound

friend class Sound

friend

Member Data Documentation

cutoffFrequency

float Channel::cutoffFrequency

private

dspSettings

X3DAUDIO_DSP_SETTINGS* Channel::dspSettings

private

emitter

X3DAUDIO_EMITTER* Channel::emitter

private

params

XAUDIO2_FILTER_PARAMETERS* Channel::params

private

reverbParams

XAUDIO2FX_REVERB_PARAMETERS Channel::reverbParams

private

reverbReturn

IXAudio2SubmixVoice* Channel::reverbReturn

private

voice

IXAudio2SubmixVoice* Channel::voice

private

vPosition

X3DAUDIO_VECTOR Channel::vPosition

private

---

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

• Channel.h
• Channel.cpp