BASS.NET API for the Un4seen BASS Audio Library

BassMixBASS_Mixer_ChannelIsActive Method

BASS.NET API for the Un4seen BASS Audio Library
Checks if a mixer source channel is active.

Namespace:  Un4seen.Bass.AddOn.Mix
Assembly:  Bass.Net (in Bass.Net.dll) Version: 2.4.17.5
Syntax

[DllImportAttribute("bassmix")]
public static BASSActive BASS_Mixer_ChannelIsActive(
	int handle
)

Parameters

handle
Type: SystemInt32
The handle of the mixer source channel to check (which was add via BASS_Mixer_StreamAddChannel(Int32, Int32, BASSFlag) or BASS_Mixer_StreamAddChannel(Int32, Int32, BASSFlag) or BASS_Mixer_StreamAddChannelEx(Int32, Int32, BASSFlag, Int64, Int64)) beforehand).

Return Value

Type: BASSActive
The return value is one of the folowing (see BASSActive):
BASS_ACTIVE_STOPPEDThe source is not active, or handle is not a valid mixer source channel.
BASS_ACTIVE_PLAYINGThe source is playing.
BASS_ACTIVE_PAUSEDThe source is paused.
BASS_ACTIVE_STALLEDThe source is paused.
BASS_ACTIVE_WAITINGThe channel is waiting to start because it was delayed by BASS_Mixer_StreamAddChannelEx(Int32, Int32, BASSFlag, Int64, Int64).
BASS_ACTIVE_QUEUEDThe channel is waiting in a queue.
Remarks

This function gives the status of a source channel as the mixer currently sees it, which may be ahead of what is heard if the mixer is playing due to buffering. The source channel's status is unaffected by the mixer's status, eg. whether it is playing or stopped.

A BASS_SYNC_STALL sync can be set via BASS_Mixer_ChannelSetSync(Int32, BASSSync, Int64, SYNCPROC, IntPtr) to be notified when a channel stalls/resumes.

ERROR CODEDescription
BASS_ERROR_HANDLEThe channel is not plugged into a mixer.

See Also

Reference