TChannel: | Methods |
Stop | Stop audio channel playback |
SetPaused | Pause or unpause audio channel playback |
SetVolume | Set audio channel volume |
SetPan | Set audio channel stereo pan |
SetDepth | Set audio channel depth |
SetRate | Set audio channel playback rate |
Playing | Determine whether audio channel is playing |
Method Stop() | |
Description | Stop audio channel playback |
Information | Shuts down the audio channel. Further commands on this audio channel will have no effect. |
Method SetPaused( paused ) | |
Description | Pause or unpause audio channel playback |
Information | If paused is True, the audio channel is paused. Otherwise, the audio channel is unpaused. |
Method SetVolume( volume# ) | |
Description | Set audio channel volume |
Information | volume should be in the range 0 (silence) to 1 (full volume). |
Method SetPan( pan# ) | |
Description | Set audio channel stereo pan |
Information | pan should be in the range -1 (full left) to 1 (full right). |
Method SetDepth( depth# ) | |
Description | Set audio channel depth |
Information | depth should be in the range -1 (back) to 1 (front). |
Method SetRate( rate# ) | |
Description | Set audio channel playback rate |
Information | rate is a multiplier used to modify the audio channel's frequency. For example, a rate of .5 will cause the audio channel to play at half speed (ie: an octave down) while a rate of 2 will cause the audio channel to play at double speed (ie: an octave up). |
Method Playing() | |
Returns | True if channel is currently playing |
Description | Determine whether audio channel is playing |
Information | Playing will return False if the audio channel is either paused, or has been stopped using Stop. |