hssMusic Class Reference

#include <hssData.h>

List of all members.


Detailed Description

Music class.

Use this class to load a ProTracker module.
You can play n times this object with hssEngine::playMusic(), from one call to another you can vary the Music's properties like volume or loop flag, this affects only the next hssEngine::playMusic() call.

Don't deallocated or reloaded a Music obj that are playing or your app will crash!

Supports ProTracker modules (.mod) with up to 32 channels.


Public Member Functions

HSS_API_H void volume (u32 v)
 Set music volume.
HSS_API_H u32 volume ()
 Get music volume.
HSS_API_H void frequency (u32 f)
 Set music frequency.
HSS_API_H u32 frequency ()
 Get music frequency.
HSS_API_H void speed (u32 s)
 Set music speed.
HSS_API_H u32 speed ()
 Get music speed.
HSS_API_H void loop (bool l)
 Set music loop flag.
HSS_API_H bool loop ()
 Get music loop flag.
HSS_API_H void pan (u32 p)
 Set music pan separation value.
HSS_API_H u32 pan ()
 Get music pan separation value.
HSS_API_H s32 load (const _TCHAR *modname)
 Load a music from file.
HSS_API_H s32 load (void *membuf, bool copytomem)
 Load a music from memory.


Member Function Documentation

HSS_API_C void hssMusic::volume ( u32  v  ) 

Set music volume.

Parameters:
v new music volume. Can vary from 0 to 64. 0 = silence, 64 = full volume.

HSS_API_C u32 hssMusic::volume (  ) 

Get music volume.

HSS_API_C void hssMusic::frequency ( u32  f  ) 

Set music frequency.

Parameters:
f new music frequency.

HSS_API_C u32 hssMusic::frequency (  ) 

Get music frequency.

HSS_API_C void hssMusic::speed ( u32  s  ) 

Set music speed.

Parameters:
s new music speed.

HSS_API_C u32 hssMusic::speed (  ) 

Get music speed.

HSS_API_C void hssMusic::loop ( bool  l  ) 

Set music loop flag.

Parameters:
l new music loop properties. false = disable loop, true = enable loop.

HSS_API_C bool hssMusic::loop (  ) 

Get music loop flag.

Returns:
false = loop disabled, true = loop enabled.

HSS_API_C void hssMusic::pan ( u32  p  ) 

Set music pan separation value.

Value can vary between 255 (full pan separation) and 0 (mono output)

HSS_API_C u32 hssMusic::pan (  ) 

Get music pan separation value.

Returns:
the pan separation value.

HSS_API_C s32 hssMusic::load ( const _TCHAR *  modname  ) 

Load a music from file.

Supports ProTracker module (.mod) with up to 32 channels.

Parameters:
modname filename of module to load.
Returns:
HSS_OK on success, error code on failure.

HSS_API_C s32 hssMusic::load ( void *  membuf,
bool  copytomem 
)

Load a music from memory.

Supports ProTracker module (.mod) with up to 32 channels.

Parameters:
membuf pointer to memory where ProTracker module was placed.
copytomem tell if the module will be copied to a new memory block.
Returns:
HSS_OK on success, error code on failure.


Generated on Sun Nov 19 14:15:14 2006 for Hekkus Sound System by  doxygen 1.5.1-p1