Functions to query ALmixer. More...

Functions
ALint	ALmixer_IsActiveChannel (ALint which_channel)
	Returns true if the specified channel is currently playing or paused, or if -1 is passed the number of channels that are currently playing or paused. More...

ALint	ALmixer_IsActiveSource (ALuint al_source)
	Returns true if the specified source is currently playing or paused, or if -1 is passed the number of sources that are currently playing or paused. More...

ALint	ALmixer_IsPlayingChannel (ALint which_channel)
	Returns true if the specified channel is currently playing. More...

ALint	ALmixer_IsPlayingSource (ALuint al_source)
	Returns true if the specified sources is currently playing. More...

ALint	ALmixer_IsPausedChannel (ALint which_channel)
	Returns true if the specified channel is currently paused. More...

ALint	ALmixer_IsPausedSource (ALuint al_source)
	Returns true if the specified sources is currently paused. More...

ALuint	ALmixer_CountAllFreeChannels (void)
	Returns the number of channels that are currently available for playback (not playing, not paused). More...

ALuint	ALmixer_CountUnreservedFreeChannels (void)
	Returns the number of channels that are currently available for playback (not playing, not paused), excluding the channels that have been reserved. More...

ALuint	ALmixer_CountAllUsedChannels (void)
	Returns the number of channels that are currently in use (playing/paused). More...

ALuint	ALmixer_CountUnreservedUsedChannels (void)
	Returns the number of channels that are currently in use (playing/paused), excluding the channels that have been reserved. More...

ALuint	ALmixer_CountTotalChannels (void)
	Returns the number of allocated channels. More...

ALuint	ALmixer_CountReservedChannels (void)
	Returns the number of reserved channels. More...

ALboolean	ALmixer_IsDecoderAvailable (const char *usr_ext)
	Returns whether a decoder is available to decode the requested extension. More...

Detailed Description

Functions to query ALmixer.

Function Documentation

◆ ALmixer_CountAllFreeChannels()

ALuint ALmixer_CountAllFreeChannels ( void )

Returns the number of channels that are currently available for playback (not playing, not paused).

Returns: The number of channels that are currently free.

◆ ALmixer_CountAllUsedChannels()

ALuint ALmixer_CountAllUsedChannels ( void )

Returns the number of channels that are currently in use (playing/paused).

Returns: The number of channels that are currently in use.

See also: ALmixer_ReserveChannels

◆ ALmixer_CountReservedChannels()

ALuint ALmixer_CountReservedChannels ( void )

Returns the number of reserved channels.

This is just a convenience alias to ALmixer_ReserveChannels(-1).

See also: ALmixer_ReserveChannels

◆ ALmixer_CountTotalChannels()

ALuint ALmixer_CountTotalChannels ( void )

Returns the number of allocated channels.

This is just a convenience alias to ALmixer_AllocateChannels(-1).

See also: ALmixer_AllocateChannels

◆ ALmixer_CountUnreservedFreeChannels()

ALuint ALmixer_CountUnreservedFreeChannels ( void )

Returns the number of channels that are currently available for playback (not playing, not paused), excluding the channels that have been reserved.

Returns: The number of channels that are currently in free, excluding the channels that have been reserved.

See also: ALmixer_ReserveChannels

◆ ALmixer_CountUnreservedUsedChannels()

ALuint ALmixer_CountUnreservedUsedChannels ( void )

Returns the number of channels that are currently in use (playing/paused), excluding the channels that have been reserved.

Returns: The number of channels that are currently in use excluding the channels that have been reserved.

See also: ALmixer_ReserveChannels

◆ ALmixer_IsActiveChannel()

ALint ALmixer_IsActiveChannel ( ALint which_channel )

Returns true if the specified channel is currently playing or paused, or if -1 is passed the number of channels that are currently playing or paused.

Parameters

which_channel The channel you want to know about or -1 to get the count of currently playing/paused channels.

Returns: For a specific channel, 1 if the channel is playing or paused, 0 if not. Or returns the count of currently playing/paused channels. Or -1 on an error.

◆ ALmixer_IsActiveSource()

ALint ALmixer_IsActiveSource ( ALuint al_source )

Returns true if the specified source is currently playing or paused, or if -1 is passed the number of sources that are currently playing or paused.

Parameters

al_source The channel you want to know about or -1 to get the count of currently playing/paused sources.

Returns: For a specific sources, 1 if the channel is playing or paused, 0 if not. Or returns the count of currently playing/paused sources. Or -1 on an error.

◆ ALmixer_IsDecoderAvailable()

ALboolean ALmixer_IsDecoderAvailable ( const char * usr_ext )

Returns whether a decoder is available to decode the requested extension.

Parameters

usr_ext A file extension like "mp3", "ogg", "wav", "mp4", etc. Do not include the . (dot).

Returns: True if a decoder is available.

◆ ALmixer_IsPausedChannel()

ALint ALmixer_IsPausedChannel ( ALint which_channel )

Returns true if the specified channel is currently paused.

or if -1 is passed the number of channels that are currently paused.

Parameters

which_channel The channel you want to know about or -1 to get the count of currently paused channels.

Returns: For a specific channel, 1 if the channel is paused, 0 if not. Or returns the count of currently paused channels. Or -1 on an error.

◆ ALmixer_IsPausedSource()

ALint ALmixer_IsPausedSource ( ALuint al_source )

Returns true if the specified sources is currently paused.

or if -1 is passed the number of sources that are currently paused.

Parameters

al_source The source you want to know about or -1 to get the count of currently paused sources.

Returns: For a specific source, 1 if the source is paused, 0 if not. Or returns the count of currently paused sources. Or -1 on an error.

◆ ALmixer_IsPlayingChannel()

ALint ALmixer_IsPlayingChannel ( ALint which_channel )

Returns true if the specified channel is currently playing.

or if -1 is passed the number of channels that are currently playing.

Parameters

which_channel The channel you want to know about or -1 to get the count of currently playing channels.

Returns: For a specific channel, 1 if the channel is playing, 0 if not. Or returns the count of currently playing channels. Or -1 on an error.

◆ ALmixer_IsPlayingSource()

ALint ALmixer_IsPlayingSource ( ALuint al_source )

Returns true if the specified sources is currently playing.

or if -1 is passed the number of sources that are currently playing.

Parameters

al_source The sources you want to know about or -1 to get the count of currently playing sources.

Returns: For a specific source, 1 if the source is playing, 0 if not. Or returns the count of currently playing sources. Or -1 on an error.