CMMFMidiEvent Class Reference

#include <mmf/common/midistandardcustomcommands.h>

Link against: midistandardcustomcommands.lib

class CMMFMidiEvent : public CBase

Inherits from

CMMFMidiEvent
- CBase

Public Attributes
TInt	iBankId
TInt	iChannel
TInt	iErrorCode
TUid	iEventType
TInt	iInstrumentId
TInt	iMetaDataEntryId
TInt64	iMicroBeats
TTimeIntervalMicroSeconds	iMicroSeconds
RArray< TMipMessageEntry >	iMipMessage
TBool	iMute
TMidiState	iNewState
TMidiState	iOldState
TInt	iPolyphony
TInt	iTempoMicroBeats
TReal32	iVolumeInDecibels

Public Member Functions
	CMMFMidiEvent(TUid, TInt)
	CMMFMidiEvent()
	~CMMFMidiEvent()
IMPORT_C void	CopyL(const CMMFMidiEvent &)
IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C void	InternalizeL(RReadStream &)
void	ZeroMembers()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Detailed Description

Describe a MIDI event. Contains a UID to define the actual event type, and an integer to define the event code.

Member Attribute Documentation

iBankId

TInt

iBankId

Identifier of a bank occupying, at most, 14 bits.

iChannel

TInt

iChannel

Channel

iErrorCode

TInt	iErrorCode

The error code associated with the MIDI event.

iEventType

TUid	iEventType

A UID to define the type of MIDI event.

iInstrumentId

TInt	iInstrumentId

Identifier of a specific instrument.

iMetaDataEntryId

TInt	iMetaDataEntryId

Meta data entry. Client will retrieve meta data entry by calling GetMetaDataEntryL() using this TInt to indicate which meta data entry to retrieve.

iMicroBeats

TInt64

iMicroBeats

General purpose time stamp in micro beats per minute.

iMicroSeconds

TTimeIntervalMicroSeconds

iMicroSeconds

General purpose time stamp in microseconds.

iMipMessage

RArray< TMipMessageEntry >

iMipMessage

Array of logical {channel, MIP} value pairs.

iMute

TBool

iMute

Mute state of a track or of a channel.

iNewState

TMidiState

iNewState

Current state of the MIDI client utility object.

iOldState

TMidiState

iOldState

Old state of the MIDI client utility object.

iPolyphony

TInt	iPolyphony

Polyphony of the MIDI engine.

iTempoMicroBeats

TInt	iTempoMicroBeats

Tempo value in micro beats per minute.

iVolumeInDecibels

TReal32

iVolumeInDecibels

Volume in decibel of a logical channel.

Constructor & Destructor Documentation

CMMFMidiEvent ( TUid, TInt )

IMPORT_C	CMMFMidiEvent	(	TUid	aEventType,
			TInt	aErrorCode
		)

Constructor.

Parameters
aEventType	A UID to define the type of MIDI event.
aErrorCode	The error code associated with the MIDI event.

CMMFMidiEvent ( )

IMPORT_C

CMMFMidiEvent

(

)

Default constructor.

~CMMFMidiEvent ( )

IMPORT_C

~CMMFMidiEvent

(

)

Destructor.

Member Function Documentation

CopyL ( const CMMFMidiEvent & )

IMPORT_C void

CopyL

(

const CMMFMidiEvent &

aOther

)

Copies a MIDI event into this CMMFMidiEvent.

Parameters
aOther	The CMMFMidiEvent to copy from.

ExternalizeL ( RWriteStream & )

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

Externalize the object to a stream. All the member variables will be written to the stream.

Parameters
aStream	The write stream object.

InternalizeL ( RReadStream & )

IMPORT_C void

InternalizeL

(

RReadStream &

aStream

)

Internalize the object from a stream. All the member variables will be read from the stream.

Parameters
aStream	The read stream object.

ZeroMembers ( )

void

ZeroMembers

(

)

Set to default values all the data members.