TBASS_ChannelIsActive

<< Click to Display Table of Contents >>

Navigation:  ThinBASIC Modules > TBASS (Sound Module) > Channels >

TBASS_ChannelIsActive

 

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