A "mixer" represents a hierarchical grouping of sounds for controlling volumes. More...

#include <mixer.h>

Public Member Functions
void	setName (const char *)
	Set the name of the mixer.

const char *	getName () const
	Get the name of the mixer.

void	setVolume (float)
	Set the local volume.

float	getVolume () const
	Get the local volume.

float	getMixedVolume () const
	Gets the volume used for mixing (affected by ancestors).

void	setParent (CkMixer *)
	Set the parent of the mixer.

CkMixer *	getParent ()
	Get the parent of the mixer.

void	destroy ()
	Destroys the mixer.

Static Public Member Functions
static CkMixer *	getMaster ()
	Returns the master mixer, which is the root of the mixer hierarchy.

static CkMixer *	newMixer (const char name, CkMixer parent=NULL)
	Creates a new mixer.

static CkMixer *	find (const char *name)
	Finds a mixer by name; returns NULL if not found.

Detailed Description

A "mixer" represents a hierarchical grouping of sounds for controlling volumes.

Member Function Documentation

void CkMixer::destroy ( )

Destroys the mixer.

static CkMixer* CkMixer::find ( const char * name )

static

Finds a mixer by name; returns NULL if not found.

static CkMixer* CkMixer::getMaster ( )

static

Returns the master mixer, which is the root of the mixer hierarchy.

float CkMixer::getMixedVolume ( ) const

Gets the volume used for mixing (affected by ancestors).

const char* CkMixer::getName ( ) const

Get the name of the mixer.

CkMixer* CkMixer::getParent ( )

Get the parent of the mixer.

float CkMixer::getVolume ( ) const

Get the local volume.

(The actual volume used during mixing will also depend on ancestors.)

static CkMixer* CkMixer::newMixer	(	const char *	name,
		CkMixer *	parent = `NULL`
	)

static

Creates a new mixer.

void CkMixer::setName ( const char * )

Set the name of the mixer.

The name should be 31 characters or less.

void CkMixer::setParent ( CkMixer * )

Set the parent of the mixer.

Setting to NULL sets the master mixer as the parent.

void CkMixer::setVolume ( float )

Set the local volume.

(The actual volume used during mixing will also depend on ancestors.)

The documentation for this class was generated from the following file: