MMidiClientUtilityObserver Class Reference

#include <midiclientutility.h>

class MMidiClientUtilityObserver

Public Member Functions
pure virtual void	MmcuoInstrumentChanged(TInt, TInt, TInt)
pure virtual void	MmcuoMetaDataEntryFound(const TInt, const TTimeIntervalMicroSeconds &)
pure virtual void	MmcuoMipMessageReceived(const RArray< TMipMessageEntry > &)
pure virtual void	MmcuoMuteChanged(TInt, TBool)
pure virtual void	MmcuoPolyphonyChanged(TInt)
pure virtual void	MmcuoStateChanged(TMidiState, TMidiState, const TTimeIntervalMicroSeconds &, TInt)
pure virtual void	MmcuoSyncUpdate(const TTimeIntervalMicroSeconds &, TInt64)
pure virtual void	MmcuoTempoChanged(TInt)
pure virtual void	MmcuoVolumeChanged(TInt, TReal32)

Detailed Description

Active object utility class to allow MIDI events to be signalled asynchronously.

Member Function Documentation

MmcuoInstrumentChanged ( TInt, TInt, TInt )

void	MmcuoInstrumentChanged	(	TInt	aChannel,
			TInt	aBankId,
			TInt	aInstrumentId
		)	[pure virtual]

An instrument has been changed on a channel.

Parameters
aChannel	Channel where the change of instrument occurred. 0 <= aChannel < ChannelsSupportedL().
aBankId	Identifier of the bank that the instrument belongs to, occupying no more than 14 bits. The bank ID is a concatenation of MIDI bank MSB and LSB values.
aInstrumentId	Identifier of the instrument that has been changed. 0 <= aInstrumentId <= 127.

MmcuoMetaDataEntryFound ( const TInt, const TTimeIntervalMicroSeconds & )

void	MmcuoMetaDataEntryFound	(	const TInt	aMetaDataEntryId,
			const TTimeIntervalMicroSeconds &	aPosition
		)	[pure virtual]

A timed meta data entry has been found in the MIDI data stream, eg a timed song lyric in an SMF file.

Parameters
aMetaDataEntryId	Index of the meta data entry - if this entry has not been encountere before, it will be added to the list of meta data entries. Previously encountered timed entries still generate this callback.
aPosition	Position in microseconds relative to the start of the MIDI resource that the MIDI meta data entry was found at.

MmcuoMipMessageReceived ( const RArray< TMipMessageEntry > & )

void

MmcuoMipMessageReceived

(

const RArray< TMipMessageEntry > &

aMessage

)

[pure virtual]

A MIP message has been found in the MIDI data stream.

Parameters
aMessage	Reference to an array of MIP message entries (logical {channel, MIP} value pairs) contained in the message.

MmcuoMuteChanged ( TInt, TBool )

void	MmcuoMuteChanged	(	TInt	aChannel,
			TBool	aMuted
		)	[pure virtual]

The MIDI resource has encountered a mute message in the MIDI data stream.

Parameters
aChannel	Logical channel to which the message applies. 0 <= aChannel < ChannelsSupportedL().
aMuted	New muting state of the channel - ETrue is muted, EFalse is unmuted.

MmcuoPolyphonyChanged ( TInt )

void

MmcuoPolyphonyChanged

(

TInt

aNewPolyphony

)

[pure virtual]

The polyphony of the MIDI engine has changed.

Parameters
aNewPolyphony	The new polyphony value.

MmcuoStateChanged ( TMidiState, TMidiState, const TTimeIntervalMicroSeconds &, TInt )

void	MmcuoStateChanged	(	TMidiState	aOldState,
			TMidiState	aNewState,
			const TTimeIntervalMicroSeconds &	aTime,
			TInt	aError
		)	[pure virtual]

A state change has occurred in the MIDI client utility.

Parameters
aOldState	Old state.
aNewState	New state.
aTime	The time in microseconds at which playback stopped relative to the start of the MIDI resource.
aError	Error code.

MmcuoSyncUpdate ( const TTimeIntervalMicroSeconds &, TInt64 )

void	MmcuoSyncUpdate	(	const TTimeIntervalMicroSeconds &	aMicroSeconds,
			TInt64	aMicroBeats
		)	[pure virtual]

Callback in response to a call to CMIDIClientUtility::SetSyncUpdateCallbackIntervalL(). By default there are no callbacks. Otherwise the callback is called at an interval set by the client.

Parameters
aMicroSeconds	Position in microseconds relative to the start of the resource - only set if the sync update set function was called with the microseconds parameter set.
aMicroBeats	Position in microbeats relative to the start of the resource - only set if the sync update set function was called with the microbeats parameter set and the microseconds parameter set to 0.

MmcuoTempoChanged ( TInt )

void

MmcuoTempoChanged

(

TInt

aMicroBeatsPerMinute

)

[pure virtual]

The MIDI resource has encountered a tempo change message in the MIDI data stream.

Parameters
aMicroBeatsPerMinute	New tempo value in micro beats per minute (BPM*1000000).

MmcuoVolumeChanged ( TInt, TReal32 )

void	MmcuoVolumeChanged	(	TInt	aChannel,
			TReal32	aVolumeInDecibels
		)	[pure virtual]

The MIDI resource has encountered a volume change message in the MIDI data stream.

Parameters
aChannel	Logical channel to which the message applies. 0 <= aChannel < ChannelsSupportedL().
aVolumeInDecibels	New volume setting being used.