hssChannel Class Reference

#include <hssChannel.h>

List of all members.


Detailed Description

Sound channel class.

When a sound are played the Sound class assign it to a Channel.
Use this class to modify the state of a playing or paused hssMusic or hssSound.


Public Member Functions

virtual HSS_API_H void volume (u32 v)
 Set channel volume.
HSS_API_H u32 volume ()
 Get channel volume.
HSS_API_H void frequency (u32 f)
 Set channel frequency.
HSS_API_H u32 frequency ()
 Get channel frequency.
HSS_API_H void speed (u32 s)
 Set channel speed.
HSS_API_H u32 speed ()
 Get channel speed.
HSS_API_H void loop (bool l)
 Set channel loop flag.
HSS_API_H bool loop ()
 Get channel loop flag.
virtual HSS_API_H void pan (u32 p)
 Set sample pan value.
HSS_API_H u32 pan ()
 Get sample pan value.
virtual HSS_API_H void position (u32 p)
 Set channel sound position.
virtual HSS_API_H u32 position ()
 Get channel sound position.
virtual HSS_API_H u32 length ()
 Get channel sound lenght.
HSS_API_H void stop ()
 Stop this channel.
HSS_API_H void pause ()
 Pause this channel.
HSS_API_H void resume ()
 Resume this channel.
HSS_API_H bool playing ()
 Returns if the channel is currently playing or not.
HSS_API_H bool paused ()
 Returns if the channel is currently playing or not.


Member Function Documentation

HSS_API_C void hssChannel::volume ( u32  v  )  [virtual]

Set channel volume.

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

HSS_API_C u32 hssChannel::volume (  ) 

Get channel volume.

HSS_API_C void hssChannel::frequency ( u32  f  ) 

Set channel frequency.

Parameters:
f new channel frequency.

HSS_API_C u32 hssChannel::frequency (  ) 

Get channel frequency.

HSS_API_C void hssChannel::speed ( u32  s  ) 

Set channel speed.

Parameters:
s new channel speed.

HSS_API_C u32 hssChannel::speed (  ) 

Get channel speed.

HSS_API_C void hssChannel::loop ( bool  l  ) 

Set channel loop flag.

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

HSS_API_C bool hssChannel::loop (  ) 

Get channel loop flag.

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

HSS_API_C void hssChannel::pan ( u32  p  )  [virtual]

Set sample pan value.

Parameters:
p new pan value.

HSS_API_C u32 hssChannel::pan (  ) 

Get sample pan value.

Returns:
the pan value.

HSS_API_C void hssChannel::position ( u32  p  )  [virtual]

Set channel sound position.

Parameters:
p new position:
for SFXs pass the new position in bytes
for the Modules pass the new position in rows.

HSS_API_C u32 hssChannel::position (  )  [virtual]

Get channel sound position.

Returns:
for SFXs return the bytes played so far
for Modules return the rows played so far.

HSS_API_C u32 hssChannel::length (  )  [virtual]

Get channel sound lenght.

Returns:
for SFXs return the lenght in bytes
for Modules return the lenght in rows.

HSS_API_C void hssChannel::stop (  ) 

Stop this channel.

Stop a playing or paused channel.

HSS_API_C void hssChannel::pause (  ) 

Pause this channel.

Pause a playing channel.

HSS_API_C void hssChannel::resume (  ) 

Resume this channel.

Resume a previous paused channel.

HSS_API_C bool hssChannel::playing (  ) 

Returns if the channel is currently playing or not.

Returns:
true if playing, false if paused or stopped.

HSS_API_C bool hssChannel::paused (  ) 

Returns if the channel is currently playing or not.

Returns:
true if paused, false if playing or stopped.


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