TBASS_ChannelStop

<< Click to Display Table of Contents >>

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

TBASS_ChannelStop

 

Description

 

Stops a sample, stream, MOD music, or recording.

 

Syntax

 

n = TBASS_ChannelStop(hChannel)

 

Returns

 

Number

If successful, then the channel's length is returned, else -1 is returned.. Use TBASS_ErrorGetCode to get the error code.

 

Parameters

 

Name

Type

Optional

Meaning

hChannel

Number

No

The channel handle... a HCHANNEL, HMUSIC, HSTREAM, or HRECORD.

 

Remarks

 

Stopping a user stream (created with TBASS_StreamCreate) will flush it's buffer contents. Use TBASS_ChannelPause if you wish to stop a user stream and then resume it without flushing it.

 

Restrictions

 

See also

 

Examples