nw::snd::SoundHandle Class Reference

#include <snd_SoundHandle.h>

Public Types
enum	PauseState {   PAUSE_STATE_NORMAL , PAUSE_STATE_PAUSING , PAUSE_STATE_PAUSED , PAUSE_STATE_UNPAUSING ,   PAUSE_STATE_INVALID }

Public Member Functions
	SoundHandle ()
	~SoundHandle ()
void	StartPrepared ()
void	Stop (int fadeFrames)
void	Pause (bool flag, int fadeFrames)
bool	IsPrepared () const
bool	IsPause () const
PauseState	GetPauseState () const
void	FadeIn (int frames)
void	SetVolume (f32 volume, int frames=0)
void	SetPan (f32 pan)
void	SetPitch (f32 pitch)
void	SetOutputLine (u32 lineFlag)
void	ResetOutputLine ()
void	SetOutputVolume (OutputDevice device, f32 volume)
void	SetMainOutVolume (f32 volume)
void	SetDrcOutVolume (f32 volume, u32 drcIndex=0)
void	SetRemoteOutVolume (u32 remoteIndex, f32 volume)
bool	IsAttachedSound () const
void	DetachSound ()
void	SetId (u32 id)
u32	GetId () const
const SoundParam *	GetAmbientParam () const
void *	GetUserParam () const
void	detail_AttachSound (internal::BasicSound *sound)
void	detail_AttachSoundAsTempHandle (internal::BasicSound *sound)
internal::BasicSound *	detail_GetAttachedSound ()
const internal::BasicSound *	detail_GetAttachedSound () const

Private Member Functions
	NW_DISALLOW_COPY_AND_ASSIGN (SoundHandle)

Private Attributes
internal::BasicSound *	m_pSound

Member Enumeration Documentation

PauseState

enum nw::snd::SoundHandle::PauseState

Enumerator
PAUSE_STATE_NORMAL
PAUSE_STATE_PAUSING
PAUSE_STATE_PAUSED
PAUSE_STATE_UNPAUSING
PAUSE_STATE_INVALID

Constructor & Destructor Documentation

SoundHandle()

nw::snd::SoundHandle::SoundHandle ( )

inline

~SoundHandle()

nw::snd::SoundHandle::~SoundHandle ( )

inline

Member Function Documentation

StartPrepared()

void nw::snd::SoundHandle::StartPrepared ( )

inline

Stop()

void nw::snd::SoundHandle::Stop ( int fadeFrames )

inline

Pause()

void nw::snd::SoundHandle::Pause ( bool flag, int fadeFrames )

inline

IsPrepared()

bool nw::snd::SoundHandle::IsPrepared ( ) const

inline

IsPause()

bool nw::snd::SoundHandle::IsPause ( ) const

inline

GetPauseState()

PauseState nw::snd::SoundHandle::GetPauseState ( ) const

inline

FadeIn()

void nw::snd::SoundHandle::FadeIn ( int frames )

inline

SetVolume()

void nw::snd::SoundHandle::SetVolume ( f32 volume, int frames = 0 )

inline

SetPan()

void nw::snd::SoundHandle::SetPan ( f32 pan )

inline

SetPitch()

void nw::snd::SoundHandle::SetPitch ( f32 pitch )

inline

SetOutputLine()

void nw::snd::SoundHandle::SetOutputLine ( u32 lineFlag )

inline

ResetOutputLine()

void nw::snd::SoundHandle::ResetOutputLine ( )

inline

SetOutputVolume()

void nw::snd::SoundHandle::SetOutputVolume ( OutputDevice device, f32 volume )

inline

SetMainOutVolume()

void nw::snd::SoundHandle::SetMainOutVolume ( f32 volume )

inline

SetDrcOutVolume()

void nw::snd::SoundHandle::SetDrcOutVolume ( f32 volume, u32 drcIndex = 0 )

inline

SetRemoteOutVolume()

void nw::snd::SoundHandle::SetRemoteOutVolume ( u32 remoteIndex, f32 volume )

inline

IsAttachedSound()

bool nw::snd::SoundHandle::IsAttachedSound ( ) const

inline

DetachSound()

void nw::snd::SoundHandle::DetachSound

(

)

SetId()

void nw::snd::SoundHandle::SetId ( u32 id )

inline

GetId()

u32 nw::snd::SoundHandle::GetId ( ) const

inline

GetAmbientParam()

const SoundParam * nw::snd::SoundHandle::GetAmbientParam ( ) const

inline

GetUserParam()

void * nw::snd::SoundHandle::GetUserParam ( ) const

inline

detail_AttachSound()

void nw::snd::SoundHandle::detail_AttachSound

(

internal::BasicSound *

sound

)

detail_AttachSoundAsTempHandle()

void nw::snd::SoundHandle::detail_AttachSoundAsTempHandle

(

internal::BasicSound *

sound

)

detail_GetAttachedSound() [1/2]

internal::BasicSound * nw::snd::SoundHandle::detail_GetAttachedSound ( )

inline

detail_GetAttachedSound() [2/2]

const internal::BasicSound * nw::snd::SoundHandle::detail_GetAttachedSound ( ) const

inline

NW_DISALLOW_COPY_AND_ASSIGN()

nw::snd::SoundHandle::NW_DISALLOW_COPY_AND_ASSIGN ( SoundHandle )

private

Member Data Documentation

m_pSound

internal::BasicSound* nw::snd::SoundHandle::m_pSound

private