SoundHandleClass Class Reference

#include <soundhandle.h>

Inherited by Sound2DHandleClass, Sound3DHandleClass, and SoundStreamHandleClass.

Public Member Functions
	SoundHandleClass (void)
virtual	~SoundHandleClass (void)
virtual Sound3DHandleClass *	As_Sound3DHandleClass (void)
virtual Sound2DHandleClass *	As_Sound2DHandleClass (void)
virtual SoundStreamHandleClass *	As_SoundStreamHandleClass (void)
virtual ListenerHandleClass *	As_ListenerHandleClass (void)
virtual H3DSAMPLE	Get_H3DSAMPLE (void)
virtual HSAMPLE	Get_HSAMPLE (void)
virtual HSTREAM	Get_HSTREAM (void)
virtual void	Set_Miles_Handle (uint32 handle)=0
virtual void	Initialize (SoundBufferClass *buffer)
virtual void	Start_Sample (void)=0
virtual void	Stop_Sample (void)=0
virtual void	Resume_Sample (void)=0
virtual void	End_Sample (void)=0
virtual void	Set_Sample_Pan (S32 pan)=0
virtual S32	Get_Sample_Pan (void)=0
virtual void	Set_Sample_Volume (S32 volume)=0
virtual S32	Get_Sample_Volume (void)=0
virtual void	Set_Sample_Loop_Count (U32 count)=0
virtual U32	Get_Sample_Loop_Count (void)=0
virtual void	Set_Sample_MS_Position (U32 ms)=0
virtual void	Get_Sample_MS_Position (S32 *len, S32 *pos)=0
virtual void	Set_Sample_User_Data (S32 i, U32 val)=0
virtual U32	Get_Sample_User_Data (S32 i)=0
virtual S32	Get_Sample_Playback_Rate (void)=0
virtual void	Set_Sample_Playback_Rate (S32 rate)=0

Protected Attributes
SoundBufferClass *	Buffer

Detailed Description

Definition at line 61 of file soundhandle.h.

Constructor & Destructor Documentation

SoundHandleClass()

SoundHandleClass::SoundHandleClass

(

void

)

Definition at line 46 of file soundhandle.cpp.

~SoundHandleClass()

SoundHandleClass::~SoundHandleClass ( void )

virtual

Definition at line 58 of file soundhandle.cpp.

Member Function Documentation

As_ListenerHandleClass()

virtual ListenerHandleClass * SoundHandleClass::As_ListenerHandleClass ( void )

inlinevirtual

Reimplemented in ListenerHandleClass.

Definition at line 81 of file soundhandle.h.

As_Sound2DHandleClass()

virtual Sound2DHandleClass * SoundHandleClass::As_Sound2DHandleClass ( void )

inlinevirtual

Reimplemented in Sound2DHandleClass.

Definition at line 79 of file soundhandle.h.

As_Sound3DHandleClass()

virtual Sound3DHandleClass * SoundHandleClass::As_Sound3DHandleClass ( void )

inlinevirtual

Reimplemented in Sound3DHandleClass.

Definition at line 78 of file soundhandle.h.

As_SoundStreamHandleClass()

virtual SoundStreamHandleClass * SoundHandleClass::As_SoundStreamHandleClass ( void )

inlinevirtual

Reimplemented in SoundStreamHandleClass.

Definition at line 80 of file soundhandle.h.

End_Sample()

virtual void SoundHandleClass::End_Sample ( void )

pure virtual

Implemented in ListenerHandleClass, Sound2DHandleClass, Sound3DHandleClass, and SoundStreamHandleClass.

Get_H3DSAMPLE()

virtual H3DSAMPLE SoundHandleClass::Get_H3DSAMPLE ( void )

inlinevirtual

Reimplemented in Sound3DHandleClass.

Definition at line 86 of file soundhandle.h.

Get_HSAMPLE()

virtual HSAMPLE SoundHandleClass::Get_HSAMPLE ( void )

inlinevirtual

Reimplemented in Sound2DHandleClass, and SoundStreamHandleClass.

Definition at line 87 of file soundhandle.h.

Get_HSTREAM()

virtual HSTREAM SoundHandleClass::Get_HSTREAM ( void )

inlinevirtual

Reimplemented in SoundStreamHandleClass.

Definition at line 88 of file soundhandle.h.

Get_Sample_Loop_Count()

virtual U32 SoundHandleClass::Get_Sample_Loop_Count ( void )

pure virtual

Implemented in ListenerHandleClass, Sound2DHandleClass, Sound3DHandleClass, and SoundStreamHandleClass.

Get_Sample_MS_Position()

virtual void SoundHandleClass::Get_Sample_MS_Position ( S32 * len, S32 * pos )

pure virtual

Implemented in ListenerHandleClass, Sound2DHandleClass, Sound3DHandleClass, and SoundStreamHandleClass.

Get_Sample_Pan()

virtual S32 SoundHandleClass::Get_Sample_Pan ( void )

pure virtual

Implemented in ListenerHandleClass, Sound2DHandleClass, Sound3DHandleClass, and SoundStreamHandleClass.

Get_Sample_Playback_Rate()

virtual S32 SoundHandleClass::Get_Sample_Playback_Rate ( void )

pure virtual

Implemented in ListenerHandleClass, Sound2DHandleClass, Sound3DHandleClass, and SoundStreamHandleClass.

Get_Sample_User_Data()

virtual U32 SoundHandleClass::Get_Sample_User_Data ( S32 i )

pure virtual

Implemented in Sound2DHandleClass, Sound3DHandleClass, and SoundStreamHandleClass.

Get_Sample_Volume()

virtual S32 SoundHandleClass::Get_Sample_Volume ( void )

pure virtual

Implemented in ListenerHandleClass, Sound2DHandleClass, Sound3DHandleClass, and SoundStreamHandleClass.

Initialize()

void SoundHandleClass::Initialize ( SoundBufferClass * buffer )

virtual

Reimplemented in ListenerHandleClass, Sound2DHandleClass, Sound3DHandleClass, and SoundStreamHandleClass.

Definition at line 79 of file soundhandle.cpp.

Resume_Sample()

virtual void SoundHandleClass::Resume_Sample ( void )

pure virtual

Implemented in ListenerHandleClass, Sound2DHandleClass, Sound3DHandleClass, and SoundStreamHandleClass.

Set_Miles_Handle()

virtual void SoundHandleClass::Set_Miles_Handle ( uint32 handle )

pure virtual

Implemented in Sound2DHandleClass, Sound3DHandleClass, and SoundStreamHandleClass.

Set_Sample_Loop_Count()

virtual void SoundHandleClass::Set_Sample_Loop_Count ( U32 count )

pure virtual

Implemented in ListenerHandleClass, Sound2DHandleClass, Sound3DHandleClass, and SoundStreamHandleClass.

Set_Sample_MS_Position()

virtual void SoundHandleClass::Set_Sample_MS_Position ( U32 ms )

pure virtual

Implemented in ListenerHandleClass, Sound2DHandleClass, Sound3DHandleClass, and SoundStreamHandleClass.

Set_Sample_Pan()

virtual void SoundHandleClass::Set_Sample_Pan ( S32 pan )

pure virtual

Implemented in ListenerHandleClass, Sound2DHandleClass, Sound3DHandleClass, and SoundStreamHandleClass.

Set_Sample_Playback_Rate()

virtual void SoundHandleClass::Set_Sample_Playback_Rate ( S32 rate )

pure virtual

Implemented in ListenerHandleClass, Sound2DHandleClass, Sound3DHandleClass, and SoundStreamHandleClass.

Set_Sample_User_Data()

virtual void SoundHandleClass::Set_Sample_User_Data ( S32 i, U32 val )

pure virtual

Implemented in Sound2DHandleClass, Sound3DHandleClass, and SoundStreamHandleClass.

Set_Sample_Volume()

virtual void SoundHandleClass::Set_Sample_Volume ( S32 volume )

pure virtual

Implemented in ListenerHandleClass, Sound2DHandleClass, Sound3DHandleClass, and SoundStreamHandleClass.

Start_Sample()

virtual void SoundHandleClass::Start_Sample ( void )

pure virtual

Implemented in ListenerHandleClass, Sound2DHandleClass, Sound3DHandleClass, and SoundStreamHandleClass.

Stop_Sample()

virtual void SoundHandleClass::Stop_Sample ( void )

pure virtual

Implemented in ListenerHandleClass, Sound2DHandleClass, Sound3DHandleClass, and SoundStreamHandleClass.

Member Data Documentation

Buffer

SoundBufferClass* SoundHandleClass::Buffer

protected

Definition at line 125 of file soundhandle.h.

---

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

• Code/Libraries/Source/WWVegas/WWAudio/soundhandle.h
• Code/Libraries/Source/WWVegas/WWAudio/soundhandle.cpp