This documentation was styled with a demo skin from the Premium Pack 4 add-on for Help & Manual. The contents of the skin are encrypted and not configurable. You can only publish HM projects with this skin. You cannot edit it or change it.
This version is copyright and may only be used for local testing purposes. It may not be distributed.
Please purchase the full version of the Premium Pack to get the configurable skins and remove this notice. The package will also include the Toolbox configuration utility for Premium Pack skins.
Description
Checks if a sample, stream, or MOD music is active (playing) or stalled. Can also check if a recording is in progress.
Syntax
n = TBASS_ChannelIsActive(hChannel)
Returns
Number
The return value is one of the folowing:
Flag |
Meaning |
%TBASS_ACTIVE_STOPPED |
The channel is not active, or handle is not a valid channel. |
%TBASS_ACTIVE_PLAYING |
The channel is playing (or recording). |
%TBASS_ACTIVE_PAUSED |
The channel is paused. |
%TBASS_ACTIVE_STALLED |
Playback of the stream has been stalled due to there not being enough sample data to continue playing. The playback will automatically resume once there's sufficient data to do so. |
Parameters
Name |
Type |
Optional |
Meaning |
hChannel |
Number |
No |
The channel handle... a HCHANNEL, HMUSIC, HSTREAM, or HRECORD. |
Remarks
Restrictions
See also
Examples