Inheritance diagram for iSoundMixer:

Detailed Description

Sound mixer interface.

General
virtual tBool	SwitchIn ()=0
	To call when the application is activated. More...

virtual tBool	SwitchOut ()=0
	To call when the application is deactivated. More...

virtual void	SetAmplification (tI32 ampli)=0
	Set the amplification of the mixer. {Property}. More...

virtual tI32	GetAmplification (void) const =0
	Get the amplification of the mixer. {Property}. More...

virtual void	SetSaturationCheck (tBool check)=0
	Set the saturation check of the mixer. {Property}. More...

virtual tBool	GetSaturationCheck (void) const =0
	Get the saturation check of the mixer. {Property}. More...

virtual void	SetReverseStereo (tBool reverse)=0
	Set the reverse stereo of the mixer. {Property}. More...

virtual tBool	GetReverseStereo (void) const =0
	Get the reverse stereo of the mixer. {Property}. More...

virtual void	SetMasterVolume (tI32 vol)=0
	Set the master volume of the mixer. {Property}. More...

virtual tI32	GetMasterVolume () const =0
	Get the master volume of the mixer. {Property}. More...

Channels
virtual tU32	GetNumChannels () const =0
	Get the number of channels available. More...

virtual tBool	StartChannel (tU32 nchan)=0
	Start playing the specified channel. More...

virtual tBool	StopChannel (tU32 nchan)=0
	Stop playing the specified channel. More...

virtual void	StopAllChannels (void)=0
	Stop playing all channels. More...

virtual void	SetChannelMasterVolume (tU32 nchan, tI32 vol)=0
	Set the master volume of the specified channel. {Property}. More...

virtual tI32	GetChannelMasterVolume (tU32 nchan) const =0
	Get the master volume of the specified channel. {Property}. More...

virtual void	SetChannelMasterPan (tU32 nchan, tI32 pan)=0
	Set the master pan of the specified channel. {Property}. More...

virtual tI32	GetChannelMasterPan (tU32 nchan) const =0
	Get the master pan of the specified channel. {Property}. More...

virtual tBool	SetChannelBuffer (tU32 anChan, iSoundBuffer *apBuffer)=0
	Set the buffer of the specified channel. {Property}. More...

virtual iSoundBuffer *	GetChannelBuffer (tU32 anChan) const =0
	Get the buffer of the specified channel. {Property}. More...

virtual void	SetChannelVolume (tU32 nchan, tI32 vol)=0
	Set the volume of the specified channel. {Property}. More...

virtual tI32	GetChannelVolume (tU32 nchan) const =0
	Get the volume of the specified channel. {Property}. More...

virtual void	SetChannelPan (tU32 nchan, tI32 pan)=0
	Set the panning of the specified channel. {Property}. More...

virtual tI32	GetChannelPan (tU32 nchan) const =0
	Get the panning of the specified channel. {Property}. More...

virtual void	SetChannelFrequency (tU32 nchan, tI32 frequency)=0
	Set the frequency of the specified channel. {Property}. More...

virtual tI32	GetChannelFrequency (tU32 nchan) const =0
	Get the frequency of the specified channel. {Property}. More...

virtual void	SetChannelLoop (tU32 nchan, tBool loop)=0
	Set whether the specified channel loops. {Property}. More...

virtual tBool	GetChannelLoop (tU32 nchan) const =0
	Get whether the specified channel loops. {Property}. More...

virtual void	SetChannelPause (tU32 nchan, tBool pause)=0
	Set whether the specified channel is paused. {Property}. More...

virtual tBool	GetChannelPause (tU32 nchan) const =0
	Get whether the specified channel is paused. {Property}. More...

virtual tBool	GetIsChannelBusy (tU32 nchan) const =0
	Get whether the specified channel is busy (playing, or, playing and paused). {Property}. More...

virtual void	SetChannelUserID (tU32 nchan, tIntPtr anUserId)=0
	Set the user id of the specified channel. More...

virtual tIntPtr	GetChannelUserID (tU32 nchan) const =0
	Get the user id of the specified channel. {Property}. More...

Update
virtual tBool	UpdateMixer ()=0
	Update the sound mixer. More...

Additional Inherited Members
Public Member Functions inherited from iUnknown
virtual tBool	IsOK () const =0
	Check if the object is valid. More...

virtual tI32	AddRef ()=0
	Signal that one more reference of the object has been created. More...

virtual tI32	Release ()=0
	Release a reference of the object. More...

virtual void	DeleteThis ()=0
	Bypass any reference counting and delete this object. More...

virtual void	Invalidate ()=0
	Invalidate the object. More...

virtual iUnknown *	QueryInterface (const tUUID &aIID)=0
	Query an interface. More...

virtual void	ListInterfaces (iMutableCollection *apLst, tU32 anFlags) const =0
	Fill a UUID list containing the UUIDs of the implemented interfaces. More...

virtual tI32	SetNumRefs (tI32 anNumRefs)=0
	Set the reference counter directly. More...

virtual tI32	GetNumRefs () const =0
	Get the number of references to this object. More...

Member Function Documentation

virtual tBool SwitchIn ( )

pure virtual

To call when the application is activated.

Remarks: Usually the owner of the mixer will call it.

virtual tBool SwitchOut ( )

pure virtual

To call when the application is deactivated.

Remarks: Usually the owner of the mixer will call it.

virtual void SetAmplification ( tI32 ampli )

pure virtual

Set the amplification of the mixer. {Property}.

virtual tI32 GetAmplification ( void ) const

pure virtual

Get the amplification of the mixer. {Property}.

virtual void SetSaturationCheck ( tBool check )

pure virtual

Set the saturation check of the mixer. {Property}.

virtual tBool GetSaturationCheck ( void ) const

pure virtual

Get the saturation check of the mixer. {Property}.

virtual void SetReverseStereo ( tBool reverse )

pure virtual

Set the reverse stereo of the mixer. {Property}.

virtual tBool GetReverseStereo ( void ) const

pure virtual

Get the reverse stereo of the mixer. {Property}.

virtual void SetMasterVolume ( tI32 vol )

pure virtual

Set the master volume of the mixer. {Property}.

virtual tI32 GetMasterVolume ( ) const

pure virtual

Get the master volume of the mixer. {Property}.

virtual tU32 GetNumChannels ( ) const

pure virtual

Get the number of channels available.

virtual tBool StartChannel ( tU32 nchan )

pure virtual

Start playing the specified channel.

virtual tBool StopChannel ( tU32 nchan )

pure virtual

Stop playing the specified channel.

virtual void StopAllChannels ( void )

pure virtual

Stop playing all channels.

virtual void SetChannelMasterVolume	(	tU32	nchan,
		tI32	vol
	)

pure virtual

Set the master volume of the specified channel. {Property}.

virtual tI32 GetChannelMasterVolume ( tU32 nchan ) const

pure virtual

Get the master volume of the specified channel. {Property}.

virtual void SetChannelMasterPan	(	tU32	nchan,
		tI32	pan
	)

pure virtual

Set the master pan of the specified channel. {Property}.

virtual tI32 GetChannelMasterPan ( tU32 nchan ) const

pure virtual

Get the master pan of the specified channel. {Property}.

virtual tBool SetChannelBuffer	(	tU32	anChan,
		iSoundBuffer *	apBuffer
	)

pure virtual

Set the buffer of the specified channel. {Property}.

virtual iSoundBuffer* GetChannelBuffer ( tU32 anChan ) const

pure virtual

Get the buffer of the specified channel. {Property}.

virtual void SetChannelVolume	(	tU32	nchan,
		tI32	vol
	)

pure virtual

Set the volume of the specified channel. {Property}.

virtual tI32 GetChannelVolume ( tU32 nchan ) const

pure virtual

Get the volume of the specified channel. {Property}.

virtual void SetChannelPan	(	tU32	nchan,
		tI32	pan
	)

pure virtual

Set the panning of the specified channel. {Property}.

virtual tI32 GetChannelPan ( tU32 nchan ) const

pure virtual

Get the panning of the specified channel. {Property}.

virtual void SetChannelFrequency	(	tU32	nchan,
		tI32	frequency
	)

pure virtual

Set the frequency of the specified channel. {Property}.

virtual tI32 GetChannelFrequency ( tU32 nchan ) const

pure virtual

Get the frequency of the specified channel. {Property}.

virtual void SetChannelLoop	(	tU32	nchan,
		tBool	loop
	)

pure virtual

Set whether the specified channel loops. {Property}.

virtual tBool GetChannelLoop ( tU32 nchan ) const

pure virtual

Get whether the specified channel loops. {Property}.

virtual void SetChannelPause	(	tU32	nchan,
		tBool	pause
	)

pure virtual

Set whether the specified channel is paused. {Property}.

virtual tBool GetChannelPause ( tU32 nchan ) const

pure virtual

Get whether the specified channel is paused. {Property}.

virtual tBool GetIsChannelBusy ( tU32 nchan ) const

pure virtual

Get whether the specified channel is busy (playing, or, playing and paused). {Property}.

virtual void SetChannelUserID	(	tU32	nchan,
		tIntPtr	anUserId
	)

pure virtual

Set the user id of the specified channel.

Remarks: Stop channel reset the user id to zero. {Property}

virtual tIntPtr GetChannelUserID ( tU32 nchan ) const

pure virtual

Get the user id of the specified channel. {Property}.

virtual tBool UpdateMixer ( )

pure virtual

Update the sound mixer.

Detailed Description

General

Channels

Update

Additional Inherited Members

Member Function Documentation