#include <midistandardcustomcommands.h>

This item is not part of the S60 5th Edition SDK

Class `MMidiCustomCommandImplementor`

class MMidiCustomCommandImplementor;

Description

Mixin class to be derived from by controller plugins wishing to support the MIDI controller custom commands.

Members

Defined in MMidiCustomCommandImplementor:

MmcChannelVolumeL(TInt,TReal32 &)Get the current volume setting of a logical channel.
MmcChannelsSupportedL(TInt &)Get the maximum number of logical channels supported by the MIDI engine.
MmcCloseL()Closes any currently open resources, such as files, descriptors or URLs in use. ...
MmcCustomBankLoadedL(TInt,TBool &)Query if a bank has been loaded to the memory.
MmcDurationMicroBeatsL(TInt64 &)Gets the length of the currently open MIDI resource in micro-beats
MmcGetBalanceL(TInt &)Get the current stereo balance value.
MmcGetBankIdL(TBool,TInt,TInt &)Gets the identifier of a sound bank. Bank identifier (aka bank number) is a 14-b...
MmcGetInstrumentIdL(TInt,TBool,TInt,TInt &)Gets the identifier of an instrument.
MmcGetInstrumentL(TInt,TInt &,TInt &)Gets the instrument assigned to a specified channel.
MmcGetRepeatsL(TInt &)Gets the number of times the current opened resources have to be repeated.
MmcInstrumentNameL(TInt,TBool,TInt)Gets the name of the given instrument.
MmcIsChannelMuteL(TInt,TBool &)Gets the muting status of a specific channel.
MmcIsTrackMuteL(TInt,TBool &)Gets the muting status of a specific track.
MmcLoadCustomBankDataL(const TDesC8 &,TInt &)Loads one or more custom sound banks from a descriptor into memory for use. If s...
MmcLoadCustomBankL(const TDesC &,TInt &)Loads one or more custom sound banks from a file into memory for use. If several...
MmcLoadCustomInstrumentDataL(const TDesC8 &,TInt,TInt,TInt,TInt)Loads an individual instrument from descriptor into custom sound bank memory for...
MmcLoadCustomInstrumentL(const TDesC &,TInt,TInt,TInt,TInt)Loads an individual instrument from file into custom sound bank memory for use. ...
MmcMaxChannelVolumeL(TReal32 &)Gets the Maximum volume setting that may be applied to a logical channel.
MmcMaxPlaybackRateL(TInt &)Gets the maximum playback rate in milli-percentage from the MIDI engine.
MmcMaxPolyphonyL(TInt &)Gets the max polyphony level the engine can handle.
MmcMaxVolumeL(TInt &)Maximum volume setting that may be applied overall.
MmcMimeTypeL(TDes8 &)Gets the MIME type of the MIDI resource currently open.
MmcMinPlaybackRateL(TInt &)Gets the minimum playback rate in milli-percentage from the MIDI engine.
MmcNoteOffL(TInt,TInt,TInt)Synchronous function to terminate playback of a note. If no corresponding note i...
MmcNoteOnL(TInt,TInt,TInt)Synchronous function to commence playback of a note. Multiple calls to this func...
MmcNumTracksL(TInt &)Gets the number of tracks present in the currently open MIDI resource.
MmcNumberOfBanksL(TBool,TInt &)Gets the number of standard or custom sound banks currently available.
MmcNumberOfInstrumentsL(TInt,TBool,TInt &)Gets the number of instruments available in a given sound bank.
MmcPercussionKeyNameL(TInt,TInt,TBool,TInt)Gets the name of a particular percussion key corresponding to a given note.
MmcPitchTranspositionCentsL(TInt &)Gets the pitch shift in use for the currently open MIDI resource.
MmcPlayNoteL(TInt,TInt,const TTimeIntervalMicroSeconds &,TInt,TInt)Synchronous function to play a single note. Multiple calls to this function will...
MmcPlayNoteL(TInt,TInt,const TTimeIntervalMicroSeconds &,const TTimeIntervalMicroSeconds &,TInt,TInt)Synchronous function to play a single note at a specified time. Multiple calls t...
MmcPlaybackRateL(TInt &)Gets the current playback rate factor of the currently open MIDI resource. The p...
MmcPolyphonyL(TInt &)Gets the number of currently active voices.
MmcPositionMicroBeatsL(TInt64 &)Gets the current metrical position of the MIDI resource being played
MmcSendMessageL(const TDesC8 &,TInt &)Sends a single MIDI message to the MIDI engine.
MmcSendMessageL(const TDesC8 &,const TTimeIntervalMicroSeconds &,TInt &)Sends a single MIDI message, with time stamp, to the MIDI engine.
MmcSendMipMessageL(const TArray< TMipMessageEntry > &)Sends a mip message to the MIDI engine. This is a convenience function, because ...
MmcSetBalanceL(TInt)Set the current stereo balance value.
MmcSetBankL(TBool)Tell the MIDI engine to use a custom bank or a standard bank.
MmcSetChannelMuteL(TInt,TBool)Set the muting state of a channel without changing its volume setting. When unmu...
MmcSetChannelVolumeL(TInt,TReal32)Set the volume of a channel.
MmcSetInstrumentL(TInt,TInt,TInt)Sets a logical channel to use the given instrument.
MmcSetMaxPolyphonyL(TInt)Set the max polyphony level the engine can handle.
MmcSetPitchTranspositionL(TInt,TInt &)Sets the pitch shift to apply to the currently open MIDI resource. May be called...
MmcSetPlaybackRateL(TInt)Sets the playback rate for the playback of the current MIDI resource. The playba...
MmcSetPositionMicroBeatsL(TInt64)Change the position of the currently playing MIDI resource to the given position...
MmcSetRepeatsL(TInt,const TTimeIntervalMicroSeconds &)Set the number of times to repeat the current MIDI resource. After Stop() has be...
MmcSetStopTimeL(const TTimeIntervalMicroSeconds &)Sets the stop time to use for the currently open MIDI resource
MmcSetSyncUpdateCallbackIntervalL(const TTimeIntervalMicroSeconds &,TInt64)Sets the frequency at which MMIDIClientUtilityObserver::MmcuoSyncUpdateL() is ca...
MmcSetTempoL(TInt)Sets the tempo at which the current MIDI resource should be played. May be calle...
MmcSetTrackMuteL(TInt,TBool)Mutes or unmutes a particular track.
MmcSetVolumeL(TInt)Set the overall volume of the MIDI client. This setting scales all channel volum...
MmcSetVolumeRampL(const TTimeIntervalMicroSeconds &)Length of time over which the volume is faded up from zero to the current settin...
MmcStopL(const TTimeIntervalMicroSeconds &)Stops playback of a resource but does not change the current position or release...
MmcStopNotesL(TInt)Stops the playback of all notes on the given channel, by means of an All Notes O...
MmcStopTimeL(TTimeIntervalMicroSeconds &)Get the stop time currently set for the MIDI resource.
MmcTempoMicroBeatsPerMinuteL(TInt &)Gets the current tempo of the currently open MIDI resource. The tempo is indepen...
MmcUnloadAllCustomBanksL()Removes all custom sound banks from memory.
MmcUnloadCustomBankL(TInt)Removes a custom sound bank from memory. Only valid for sound banks previously l...
MmcUnloadCustomInstrumentL(TInt,TInt)Removes an instrument from custom sound bank memory. Only valid for instruments ...
MmcVolumeL(TInt &)Gets the overall volume of the MIDI client.

Member functions

`MmcSetPositionMicroBeatsL(TInt64)`

virtual void MmcSetPositionMicroBeatsL(TInt64 aMicroBeats)=0;

Description

Change the position of the currently playing MIDI resource to the given position. May be called whenever a MIDI resource is open.

Parameters


                                 						TInt64 aMicroBeats

Metrical position to move to. Clamped to (0, DurationMicroBeats()).

`MmcPositionMicroBeatsL(TInt64 &)`

virtual void MmcPositionMicroBeatsL(TInt64 &aMicroBeats)=0;

Description

Gets the current metrical position of the MIDI resource being played

Parameters


                                 						TInt64 &aMicroBeats

(BPM*1000000) relative to the start of the resource

`MmcPlayNoteL(TInt,TInt,const TTimeIntervalMicroSeconds &,TInt,TInt)`

virtual void MmcPlayNoteL(TInt aChannel, TInt aNote, const TTimeIntervalMicroSeconds &aDuration, TInt aNoteOnVelocity, TInt aNoteOffVelocity)=0;

Description

Synchronous function to play a single note. Multiple calls to this function will be accommodated as far as the MIDI engine can manage. The same functionality could be implemented using the SendMessage function

Parameters

`TInt aChannel`	Logical channel to play note on. 0 <= aChannel <= 15.
`TInt aNote`	Note to play. 0 <= aNote <= 127
`const TTimeIntervalMicroSeconds &aDuration`	Length of time to play note for.
`TInt aNoteOnVelocity`	Velocity with which to start the note. 0 <= aNoteOnVelocity <= 127.
`TInt aNoteOffVelocity`	Velocity with which to stop the note. 0 <= aNoteOffVelocity <= 127.

`MmcPlayNoteL(TInt,TInt,const TTimeIntervalMicroSeconds &,const TTimeIntervalMicroSeconds &,TInt,TInt)`

virtual void MmcPlayNoteL(TInt aChannel, TInt aNote, const TTimeIntervalMicroSeconds &aStartTime, const TTimeIntervalMicroSeconds &aDuration, TInt aNoteOnVelocity, TInt aNoteOffVelocity)=0;

Description

Synchronous function to play a single note at a specified time. Multiple calls to this function will be accommodated as far as the MIDI engine can manage. The same functionality could be implemented using the SendMessage function

Parameters

`TInt aChannel`	Logical channel to play note on. 0 <= aChannel <= 15.
`TInt aNote`	Note to play. 0 <= aNote <= 127
`const TTimeIntervalMicroSeconds &aStartTime`	Specifies the time at which to start playing the note, relative to the MIDI resource playing time or the time elapsed since Play() was called if no resource is present.
`const TTimeIntervalMicroSeconds &aDuration`	Length of time to play note for.
`TInt aNoteOnVelocity`	Velocity with which to start the note. 0 <= aNoteOnVelocity <= 127.
`TInt aNoteOffVelocity`	Velocity with which to stop the note. 0 <= aNoteOffVelocity <= 127.

`MmcStopNotesL(TInt)`

virtual void MmcStopNotesL(TInt aChannel)=0;

Description

Stops the playback of all notes on the given channel, by means of an All Notes Off MIDI message

Parameters


                                 						TInt aChannel

Logical channel to stop notes on. 0 <= aChannel <= 15

`MmcNoteOnL(TInt,TInt,TInt)`

virtual void MmcNoteOnL(TInt aChannel, TInt aNote, TInt aVelocity)=0;

Description

Synchronous function to commence playback of a note. Multiple calls to this function will be accommodated as far as the MIDI engine can manage

Parameters

`TInt aChannel`	Logical channel to play note on. 0 <= aChannel <= 15.
`TInt aNote`	Note to play. 0 <= aNote <= 127.
`TInt aVelocity`	Velocity with which to start the note. The legal integer range is 0 <= aVelocity <= 127, but the value zero actually causes the message to be interpreted as a Note Off message instead of a Note On.

`MmcNoteOffL(TInt,TInt,TInt)`

virtual void MmcNoteOffL(TInt aChannel, TInt aNote, TInt aVelocity)=0;

Description

Synchronous function to terminate playback of a note. If no corresponding note is found then no error is raised

Parameters

`TInt aChannel`	Logical channel on which the note is playing. 0 <= aChannel <= 15.
`TInt aNote`	Note to terminate. 0 <= aNote <= 127.
`TInt aVelocity`	Velocity with which to stop the note. 0 <= aVelocity <= 127. There is no standard behaviour corresponding with note off velocity.

`MmcPlaybackRateL(TInt &)`

virtual void MmcPlaybackRateL(TInt &aPlayBackRate)=0;

Description

Gets the current playback rate factor of the currently open MIDI resource. The playback rate is independent from tempo, i.e., it can be used to give an overall speed factor for playback.

Parameters


                                 						TInt &aPlayBackRate

Current playback rate in percent times 1000, i.e., 100000 means original playback speed, 200000 means double speed, and 50000 means half speed playback.

`MmcSetPlaybackRateL(TInt)`

virtual void MmcSetPlaybackRateL(TInt aPlayBackRate)=0;

Description

Sets the playback rate for the playback of the current MIDI resource. The playback rate is independent from tempo, i.e., it can be used to give an overall speed factor for playback. May be called whether playback is in progress or not.

Parameters


                                 						TInt aPlayBackRate

Playback rate in percent times 1000, i.e., 100000 means original playback speed, 200000 means double speed, and 50000 means half speed playback.

`MmcMaxPlaybackRateL(TInt &)`

virtual void MmcMaxPlaybackRateL(TInt &aMaxRate)=0;

Description

Gets the maximum playback rate in milli-percentage from the MIDI engine.

Parameters


                                 						TInt &aMaxRate

Playback rate supported by MIDI player.

`MmcMinPlaybackRateL(TInt &)`

virtual void MmcMinPlaybackRateL(TInt &aMinRate)=0;

Description

Gets the minimum playback rate in milli-percentage from the MIDI engine.

Parameters


                                 						TInt &aMinRate

Minimum playback rate supported by MIDI player.

`MmcTempoMicroBeatsPerMinuteL(TInt &)`

virtual void MmcTempoMicroBeatsPerMinuteL(TInt &aMicroBeatsPerMinute)=0;

Description

Gets the current tempo of the currently open MIDI resource. The tempo is independent from the playback rate, i.e., the resulting playback speed will be affected by both.

Parameters


                                 						TInt &aMicroBeatsPerMinute

Tempo at the current position of the currently open resource in microbeats per minute, i.e. BPM * 1000000. Filled in by the controller framework.

`MmcSetTempoL(TInt)`

virtual void MmcSetTempoL(TInt aMicroBeatsPerMinute)=0;

Description

Sets the tempo at which the current MIDI resource should be played. May be called whether playback is in progress or not. The tempo is independent from the playback rate, i.e., the resulting playback speed will be affected by both.

Parameters


                                 						TInt aMicroBeatsPerMinute

Tempo in microbeats per minute (BPM*1000000) to set.

`MmcPitchTranspositionCentsL(TInt &)`

virtual void MmcPitchTranspositionCentsL(TInt &aPitch)=0;

Description

Gets the pitch shift in use for the currently open MIDI resource.

Parameters


                                 						TInt &aPitch

Shift in cents, i.e. semitones * 100. One octave equals 1200 cents.

`MmcSetPitchTranspositionL(TInt,TInt &)`

virtual void MmcSetPitchTranspositionL(TInt aCents, TInt &aCentsApplied)=0;

Description

Sets the pitch shift to apply to the currently open MIDI resource. May be called during playback.

Parameters

`TInt aCents`	Pitch shift in cents, i.e. semitones * 100. One octave equals 1200 cents.
`TInt &aCentsApplied`	Actual pitch shift applied - may differ from the requested value due to limitations of the MIDI engine.

`MmcDurationMicroBeatsL(TInt64 &)`

virtual void MmcDurationMicroBeatsL(TInt64 &aDuration)=0;

Description

Gets the length of the currently open MIDI resource in micro-beats

Parameters


                                 						TInt64 &aDuration

Duration in microbeats (beats * 1000000).

`MmcNumTracksL(TInt &)`

virtual void MmcNumTracksL(TInt &aTracks)=0;

Description

Gets the number of tracks present in the currently open MIDI resource.

Parameters


                                 						TInt &aTracks

Number of tracks.

`MmcSetTrackMuteL(TInt,TBool)`

virtual void MmcSetTrackMuteL(TInt aTrack, TBool aMuted)=0;

Description

Mutes or unmutes a particular track.

Parameters

`TInt aTrack`	Index of the track to mute - 0 <= aTrack < NumTracks().
`TBool aMuted`	ETrue to mute the track, EFalse to unmute it.

`MmcMimeTypeL(TDes8 &)`

virtual void MmcMimeTypeL(TDes8 &aMimeType)=0;

Description

Gets the MIME type of the MIDI resource currently open.

Parameters


                                 						TDes8 &aMimeType

Descriptor containing the MIDI mime type.

`MmcSetSyncUpdateCallbackIntervalL(const TTimeIntervalMicroSeconds &,TInt64)`

virtual void MmcSetSyncUpdateCallbackIntervalL(const TTimeIntervalMicroSeconds &aMicroSeconds, TInt64 aMicroBeats=0)=0;

Description

Sets the frequency at which MMIDIClientUtilityObserver::MmcuoSyncUpdateL() is called to allow other components to synchronise with playback of this MIDI resource.

Parameters

`const TTimeIntervalMicroSeconds &aMicroSeconds`	Temporal interval to callback at. Used in preference to aMicroBeats if both are set.
`TInt64 aMicroBeats`	Metrical interval to callback at. Set both parameters to zero to cancel.

`MmcSendMessageL(const TDesC8 &,TInt &)`

virtual void MmcSendMessageL(const TDesC8 &aMidiMessage, TInt &aBytes)=0;

Description

Sends a single MIDI message to the MIDI engine.

Parameters

`const TDesC8 &aMidiMessage`	Descriptor containing the MIDI message data. If there are several MIDI messages in the buffer, only the first one is processed.
`TInt &aBytes`	Number of bytes of the message buffer actually processed.

`MmcSendMessageL(const TDesC8 &,const TTimeIntervalMicroSeconds &,TInt &)`

virtual void MmcSendMessageL(const TDesC8 &aMidiMessage, const TTimeIntervalMicroSeconds &aTime, TInt &aBytes)=0;

Description

Sends a single MIDI message, with time stamp, to the MIDI engine.

Parameters

`const TDesC8 &aMidiMessage`	Descriptor containing the MIDI message data. If there are several MIDI messages in the buffer, only the first one is processed.
`const TTimeIntervalMicroSeconds &aTime`	The time at which to execute the message, relative to the MIDI resource playing time or the time elapsed since Play() was called if no resource is present.
`TInt &aBytes`	Number of bytes of the message buffer actually processed.

`MmcSendMipMessageL(const TArray< TMipMessageEntry > &)`

virtual void MmcSendMipMessageL(const TArray< TMipMessageEntry > &aEntry)=0;

Description

Sends a mip message to the MIDI engine. This is a convenience function, because the same functionality could be achieved with the SendMessage() function.

Parameters

const TArray< TMipMessageEntry > &aEntry

Array of logical {channel, MIP} value pairs to send, highest priority first.

`MmcNumberOfBanksL(TBool,TInt &)`

virtual void MmcNumberOfBanksL(TBool aCustom, TInt &aNumBanks)=0;

Description

Gets the number of standard or custom sound banks currently available.

Parameters

`TBool aCustom`	Specifies whether to reference a custom or standard sound bank.
`TInt &aNumBanks`	Number of custom or standard sound banks available.

`MmcGetBankIdL(TBool,TInt,TInt &)`

virtual void MmcGetBankIdL(TBool aCustom, TInt aBankIndex, TInt &aBankId)=0;

Description

Gets the identifier of a sound bank. Bank identifier (aka bank number) is a 14-bit value consisting of MIDI bank MSB and LSB values.

Parameters

`TBool aCustom`	Specifies whether to reference a custom or standard sound bank.
`TInt aBankIndex`	Index of sound bank where 0 <= aBankIndex < NumberOfBanks().
`TInt &aBankId`	Identifier of the specified bank occupying, at most, 14 bits.

`MmcLoadCustomBankL(const TDesC &,TInt &)`

virtual void MmcLoadCustomBankL(const TDesC &aFileName, TInt &aBankId)=0;

Description

Loads one or more custom sound banks from a file into memory for use. If several banks are loaded with consequent LoadCustomBanksL() function calls, the banks are combined if the bank sets have conflicting bank numbers.

Parameters

`const TDesC16 &aFileName`	Name of the file containing the custom sound bank.
`TInt &aBankId`	Identifier of the custom sound bank loaded, occupying no more than 14 bits.

`MmcLoadCustomBankDataL(const TDesC8 &,TInt &)`

virtual void MmcLoadCustomBankDataL(const TDesC8 &aBankData, TInt &aBankId)=0;

Description

Loads one or more custom sound banks from a descriptor into memory for use. If several banks are loaded with consequent LoadCustomBanksL() function calls, the banks are combined if the bank sets have conflicting bank numbers.

Parameters

`const TDesC8 &aBankData`	Descriptor containing the custom sound bank.
`TInt &aBankId`	Identifier of the custom sound bank loaded, occupying no more than 14 bits.

`MmcUnloadCustomBankL(TInt)`

virtual void MmcUnloadCustomBankL(TInt aBankId)=0;

Description

Removes a custom sound bank from memory. Only valid for sound banks previously loaded from file. Once unloaded the custom sound bank is no longer available for use.

Parameters


                                 						TInt aBankId

Identifier of the custom sound bank to unload,occupying no more than 14 bits.

`MmcCustomBankLoadedL(TInt,TBool &)`

virtual void MmcCustomBankLoadedL(TInt aBankId, TBool &aBankLoaded)=0;

Description

Query if a bank has been loaded to the memory.

Parameters

`TInt aBankId`	Identifier of the custom sound bank to check if it's in memory or not.
`TBool &aBankLoaded`	ETrue if the specified bank is in memory, EFalse otherwise.

`MmcUnloadAllCustomBanksL()`

virtual void MmcUnloadAllCustomBanksL()=0;

Description

Removes all custom sound banks from memory.

`MmcNumberOfInstrumentsL(TInt,TBool,TInt &)`

virtual void MmcNumberOfInstrumentsL(TInt aBankId, TBool aCustom, TInt &aNumInstruments)=0;

Description

Gets the number of instruments available in a given sound bank.

Parameters

`TInt aBankId`	Identifier of sound bank to reference, occupying no more than 14 bits.
`TBool aCustom`	Specifies whether to reference a custom or standard sound bank.
`TInt &aNumInstruments`	Count of the number of instruments available for the specified sound bank.

`MmcGetInstrumentIdL(TInt,TBool,TInt,TInt &)`

virtual void MmcGetInstrumentIdL(TInt aBankId, TBool aCustom, TInt aInstrumentIndex, TInt &aInstrumentId)=0;

Description

Gets the identifier of an instrument.

Parameters

`TInt aBankId`	Identifier of the sound bank to reference, occupying no more than 14 bits.
`TBool aCustom`	Specifies whether to reference a custom or standard sound bank.
`TInt aInstrumentIndex`	Index of the instrument to reference where 0 <= aInstrumentIndex < NumberOfInstrumentsL().
`TInt &aInstrumentId`	Identifier of specified instrument. This may differ from the index since the index simply enumerates the instruments, whereas identifiers may not be contiguous, especially where certain instruments correspond to General MIDI-defined instruments but not all instruments are present. Instrument identifiers are between 0 and 127 inclusive.

`MmcInstrumentNameL(TInt,TBool,TInt)`

virtual const TDesC& MmcInstrumentNameL(TInt aBankId, TBool aCustom, TInt aInstrumentId)=0;

Description

Gets the name of the given instrument.

Parameters

`TInt aBankId`	Identifier of the bank that the instrument belongs to, occupying no more than 14 bits.
`TBool aCustom`	Specifies whether to reference a custom or standard sound bank.
`TInt aInstrumentId`	Identifier of the instrument under scrutiny. 0 <= aInstrumentId <= 127.

Return value

const TDesC16 &

Buffer containing the name of the specified instrument. If it has no name then an empty descriptor is returned.

`MmcSetInstrumentL(TInt,TInt,TInt)`

virtual void MmcSetInstrumentL(TInt aChannel, TInt aBankId, TInt aInstrumentId)=0;

Description

Sets a logical channel to use the given instrument.

Parameters

`TInt aChannel`	Logical channel to set the instrument for. 0 <= aChannel <= 15.
`TInt 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.
`TInt aInstrumentId`	Identifier of the instrument under scrutiny. 0 <= aInstrumentId <= 127.

`MmcLoadCustomInstrumentL(const TDesC &,TInt,TInt,TInt,TInt)`

virtual void MmcLoadCustomInstrumentL(const TDesC &aFileName, TInt aFileBankId, TInt aFileInstrumentId, TInt aMemoryBankId, TInt aMemoryInstrumentId)=0;

Description

Loads an individual instrument from file into custom sound bank memory for use. The bank and instrument ids given in the file can be mapped into different bank and instrument ids in memory.

Parameters

`const TDesC16 &aFileName`	Name of the file containing the instrument.
`TInt aFileBankId`	Identifier of the bank in the file from which to load the instrument, occupying no more than 14 bits.
`TInt aFileInstrumentId`	Identifier of the instrument to load. 0 <= aInstrumentId <= 127.
`TInt aMemoryBankId`	Identifier of the custom bank in memory to load the instrument into, occupying no more than 14 bits.
`TInt aMemoryInstrumentId`	Identifier of the instrument in memory to load the new instrument into. 0 <= aInstrumentId <= 127.

`MmcLoadCustomInstrumentDataL(const TDesC8 &,TInt,TInt,TInt,TInt)`

virtual void MmcLoadCustomInstrumentDataL(const TDesC8 &aInstrumentData, TInt aBankDataId, TInt aInstrumentDataId, TInt aMemoryBankId, TInt aMemoryInstrumentId)=0;

Description

Loads an individual instrument from descriptor into custom sound bank memory for use. The bank and instrument ids given in the descriptor can be mapped into different bank and instrument ids in memory.

Parameters

`const TDesC8 &aInstrumentData`	Descriptor containing the instrument.
`TInt aBankDataId`	Identifier of the bank in the descriptor from which to load the instrument, occupying no more than 14 bits.
`TInt aInstrumentDataId`	Identifier of the instrument to load. 0 <= aInstrumentId <= 127.
`TInt aMemoryBankId`	Identifier of the custom bank in memory to load the instrument into, occupying no more than 14 bits.
`TInt aMemoryInstrumentId`	Identifier of the instrument in memory to load the new instrument into. 0 <= aInstrumentId <= 127.

`MmcUnloadCustomInstrumentL(TInt,TInt)`

virtual void MmcUnloadCustomInstrumentL(TInt aCustomBankId, TInt aInstrumentId)=0;

Description

Removes an instrument from custom sound bank memory. Only valid for instruments previously loaded from file. Once unloaded the instrument is no longer available for use.

Parameters

`TInt aCustomBankId`	Identifier of the custom sound bank containing the instrument to unload, occupying no more than 14 bits.
`TInt aInstrumentId`	Identifier of the instrument to unload. 0 <= aInstrumentId <= 127.

`MmcPercussionKeyNameL(TInt,TInt,TBool,TInt)`

virtual const TDesC& MmcPercussionKeyNameL(TInt aNote, TInt aBankId, TBool aCustom, TInt aInstrumentId)=0;

Description

Gets the name of a particular percussion key corresponding to a given note.

Parameters

`TInt aNote`	Note to query. 0 <= aNote <= 127.
`TInt 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.
`TBool aCustom`	Specifies whether to reference a custom or standard sound bank.
`TInt aInstrumentId`	Identifier of an instrument.

Return value

const TDesC16 &

Descriptor containing the name of the percussion key. If the key does not have a name then an empty descriptor is returned.

`MmcStopTimeL(TTimeIntervalMicroSeconds &)`

virtual void MmcStopTimeL(TTimeIntervalMicroSeconds &aStopTime)=0;

Description

Get the stop time currently set for the MIDI resource.

Parameters


                                 						TTimeIntervalMicroSeconds &aStopTime

Time at which playback will stop, relative to the start of the resource.

`MmcSetStopTimeL(const TTimeIntervalMicroSeconds &)`

virtual void MmcSetStopTimeL(const TTimeIntervalMicroSeconds &aStopTime)=0;

Description

Sets the stop time to use for the currently open MIDI resource

Parameters

const TTimeIntervalMicroSeconds &aStopTime

Time at which playback will stop, relative to the start of the resource. Clamped to 0 and the duration of the resource.

`MmcPolyphonyL(TInt &)`

virtual void MmcPolyphonyL(TInt &aNumNotes)=0;

Description

Gets the number of currently active voices.

Parameters


                                 						TInt &aNumNotes

The number of currently active voices.

`MmcChannelsSupportedL(TInt &)`

virtual void MmcChannelsSupportedL(TInt &aChannels)=0;

Description

Get the maximum number of logical channels supported by the MIDI engine.

Parameters


                                 						TInt &aChannels

The maximum number of logical channels that the MIDI engine supports, 0 <= aChannels <=15.

`MmcChannelVolumeL(TInt,TReal32 &)`

virtual void MmcChannelVolumeL(TInt aChannel, TReal32 &aChannelVol)=0;

Description

Get the current volume setting of a logical channel.

Parameters

`TInt aChannel`	Logical channel to query. 0 <= aChannel <= 15.
`TReal32 &aChannelVol`	Volume currently set on the specified channel in decibels.

`MmcMaxChannelVolumeL(TReal32 &)`

virtual void MmcMaxChannelVolumeL(TReal32 &aMaxVol)=0;

Description

Gets the Maximum volume setting that may be applied to a logical channel.

Parameters


                                 						TReal32 &aMaxVol

Maximum volume setting. Minimum value is -infinity dB, which is the smallest possible value that TReal32 supports.

`MmcSetChannelVolumeL(TInt,TReal32)`

virtual void MmcSetChannelVolumeL(TInt aChannel, TReal32 aVolume)=0;

Description

Set the volume of a channel.

Parameters

`TInt aChannel`	Logical channel to set the volume on. 0 <= aChannel <= 15.
`TReal32 aVolume`	The channel volume can be set within a range. The minimum channel volume is -infinity dB, which is the smallest possible value that TReal32 supports while the maximum channel volume is set via MaxVolumeL() which represents the volume level in dB corresponding to the MIDI Channel Volume controller.

`MmcSetChannelMuteL(TInt,TBool)`

virtual void MmcSetChannelMuteL(TInt aChannel, TBool aMuted)=0;

Description

Set the muting state of a channel without changing its volume setting. When unmuted the channel goes back to its previous volume setting.

Parameters

`TInt aChannel`	Logical channel to set the mute state of. 0 <= aChannel <= 15.
`TBool aMuted`	ETrue to mute the channel, EFalse to unmute it.

`MmcVolumeL(TInt &)`

virtual void MmcVolumeL(TInt &aVolume)=0;

Description

Gets the overall volume of the MIDI client.

Parameters


                                 						TInt &aVolume

The current overall volume setting.

`MmcMaxVolumeL(TInt &)`

virtual void MmcMaxVolumeL(TInt &aMaxVolume)=0;

Description

Maximum volume setting that may be applied overall.

Parameters


                                 						TInt &aMaxVolume

Maximum volume setting. Minimum value is always zero which is silent.

`MmcSetVolumeL(TInt)`

virtual void MmcSetVolumeL(TInt aVolume)=0;

Description

Set the overall volume of the MIDI client. This setting scales all channel volumes respectively so the actual volume that a channel is played at becomes (overall volume * channel volume / max volume).

Parameters


                                 						TInt aVolume

Overall volume setting to use.

`MmcSetVolumeRampL(const TTimeIntervalMicroSeconds &)`

virtual void MmcSetVolumeRampL(const TTimeIntervalMicroSeconds &aRampDuration)=0;

Description

Length of time over which the volume is faded up from zero to the current settings when playback is started.

Parameters

const TTimeIntervalMicroSeconds &aRampDuration

Duration of the ramping period.

`MmcGetBalanceL(TInt &)`

virtual void MmcGetBalanceL(TInt &aBalance)=0;

Description

Get the current stereo balance value.

Parameters


                                 						TInt &aBalance

Balance value ranging from KMMFBalanceMaxLeft to KMMFBalanceMaxRight.

`MmcSetBalanceL(TInt)`

virtual void MmcSetBalanceL(TInt aBalance)=0;

Description

Set the current stereo balance value.

Parameters


                                 						TInt aBalance

Balance value to set. Defaults to KMMFBalanceCenter to restore equal left-right balance.

`MmcSetMaxPolyphonyL(TInt)`

virtual void MmcSetMaxPolyphonyL(TInt aMaxNotes)=0;

Description

Set the max polyphony level the engine can handle.

Parameters


                                 						TInt aMaxNotes

Max polyphony level, 0 <= PolyphonyL() <= aMaxNotes.

`MmcGetRepeatsL(TInt &)`

virtual void MmcGetRepeatsL(TInt &aNumRepeats)=0;

Description

Gets the number of times the current opened resources have to be repeated.

Parameters


                                 						TInt &aNumRepeats

The number of time the current opened resources have to be repeated.

`MmcSetRepeatsL(TInt,const TTimeIntervalMicroSeconds &)`

virtual void MmcSetRepeatsL(TInt aRepeatNumberOfTimes, const TTimeIntervalMicroSeconds &aTrailingSilence)=0;

Description

Set the number of times to repeat the current MIDI resource. After Stop() has been called, repeat number of times and the trailing silence are reset.

Parameters

`TInt aRepeatNumberOfTimes`	Number of times to repeat the resource during playback. This includes the first playing.
`const TTimeIntervalMicroSeconds &aTrailingSilence`	`Time` in microseconds to pause between repeats.

`MmcSetBankL(TBool)`

virtual void MmcSetBankL(TBool aCustom)=0;

Description

Tell the MIDI engine to use a custom bank or a standard bank.

Parameters


                                 						TBool aCustom

If Etrue the custom bank in memory is used otherwise the standard bank is used leaving the custom bank in memory.

`MmcIsTrackMuteL(TInt,TBool &)`

virtual void MmcIsTrackMuteL(TInt aTrack, TBool &aTrackMute)=0;

Description

Gets the muting status of a specific track.

Parameters

`TInt aTrack`	The track to query.
`TBool &aTrackMute`	The mute status of the track.

`MmcIsChannelMuteL(TInt,TBool &)`

virtual void MmcIsChannelMuteL(TInt aChannel, TBool &aChannelMute)=0;

Description

Gets the muting status of a specific channel.

Parameters

`TInt aChannel`	The channel to query.
`TBool &aChannelMute`	The mute status of the channel.

`MmcGetInstrumentL(TInt,TInt &,TInt &)`

virtual void MmcGetInstrumentL(TInt aChannel, TInt &aInstrumentId, TInt &aBankId)=0;

Description

Gets the instrument assigned to a specified channel.

Parameters

`TInt aChannel`	Logical channel, 0 <= aChannel <= 15.
`TInt &aInstrumentId`	Identifier of the instrument assigned to aChannel. 0 <= aInstrumentId <= 127.
`TInt &aBankId`	Identifier of the bank that the instrument belongs to, occupying no more than 14 bits.

`MmcCloseL()`

virtual void MmcCloseL()=0;

Description

Closes any currently open resources, such as files, descriptors or URLs in use. Does nothing if there is nothing currently open.

`MmcStopL(const TTimeIntervalMicroSeconds &)`

virtual void MmcStopL(const TTimeIntervalMicroSeconds &aFadeOutDuration)=0;

Description

Stops playback of a resource but does not change the current position or release any resources. Pauses the internal timer if no resource is open.

Parameters

const TTimeIntervalMicroSeconds &aFadeOutDuration

Length of time over which the volume is faded out from the current settings to zero.

`MmcMaxPolyphonyL(TInt &)`

virtual void MmcMaxPolyphonyL(TInt &aMaxNotes)=0;

Description

Gets the max polyphony level the engine can handle.

Parameters


                                 						TInt &aMaxNotes

Class MMidiCustomCommandImplementor

Description

Members

Member functions

MmcSetPositionMicroBeatsL(TInt64)

Description

Parameters

MmcPositionMicroBeatsL(TInt64 &)

Description

Parameters

MmcPlayNoteL(TInt,TInt,const TTimeIntervalMicroSeconds &,TInt,TInt)

Description

Parameters

MmcPlayNoteL(TInt,TInt,const TTimeIntervalMicroSeconds &,const TTimeIntervalMicroSeconds &,TInt,TInt)

Description

Parameters

MmcStopNotesL(TInt)

Description

Parameters

MmcNoteOnL(TInt,TInt,TInt)

Description

Parameters

MmcNoteOffL(TInt,TInt,TInt)

Description

Parameters

MmcPlaybackRateL(TInt &)

Description

Parameters

MmcSetPlaybackRateL(TInt)

Description

Parameters

MmcMaxPlaybackRateL(TInt &)

Description

Parameters

MmcMinPlaybackRateL(TInt &)

Description

Parameters

MmcTempoMicroBeatsPerMinuteL(TInt &)

Description

Parameters

MmcSetTempoL(TInt)

Description

Parameters

MmcPitchTranspositionCentsL(TInt &)

Description

Parameters

MmcSetPitchTranspositionL(TInt,TInt &)

Description

Parameters

MmcDurationMicroBeatsL(TInt64 &)

Description

Parameters

MmcNumTracksL(TInt &)

Description

Parameters

MmcSetTrackMuteL(TInt,TBool)

Description

Parameters

MmcMimeTypeL(TDes8 &)

Description

Parameters

MmcSetSyncUpdateCallbackIntervalL(const TTimeIntervalMicroSeconds &,TInt64)

Description

Parameters

MmcSendMessageL(const TDesC8 &,TInt &)

Description

Parameters

MmcSendMessageL(const TDesC8 &,const TTimeIntervalMicroSeconds &,TInt &)

Description

Parameters

MmcSendMipMessageL(const TArray< TMipMessageEntry > &)

Description

Parameters

MmcNumberOfBanksL(TBool,TInt &)

Description

Parameters

MmcGetBankIdL(TBool,TInt,TInt &)

Description

Parameters

MmcLoadCustomBankL(const TDesC &,TInt &)

Class `MMidiCustomCommandImplementor`

`MmcSetPositionMicroBeatsL(TInt64)`

`MmcPositionMicroBeatsL(TInt64 &)`

`MmcPlayNoteL(TInt,TInt,const TTimeIntervalMicroSeconds &,TInt,TInt)`

`MmcPlayNoteL(TInt,TInt,const TTimeIntervalMicroSeconds &,const TTimeIntervalMicroSeconds &,TInt,TInt)`

`MmcStopNotesL(TInt)`

`MmcNoteOnL(TInt,TInt,TInt)`

`MmcNoteOffL(TInt,TInt,TInt)`

`MmcPlaybackRateL(TInt &)`

`MmcSetPlaybackRateL(TInt)`

`MmcMaxPlaybackRateL(TInt &)`

`MmcMinPlaybackRateL(TInt &)`

`MmcTempoMicroBeatsPerMinuteL(TInt &)`

`MmcSetTempoL(TInt)`

`MmcPitchTranspositionCentsL(TInt &)`

`MmcSetPitchTranspositionL(TInt,TInt &)`

`MmcDurationMicroBeatsL(TInt64 &)`

`MmcNumTracksL(TInt &)`

`MmcSetTrackMuteL(TInt,TBool)`

`MmcMimeTypeL(TDes8 &)`

`MmcSetSyncUpdateCallbackIntervalL(const TTimeIntervalMicroSeconds &,TInt64)`

`MmcSendMessageL(const TDesC8 &,TInt &)`

`MmcSendMessageL(const TDesC8 &,const TTimeIntervalMicroSeconds &,TInt &)`

`MmcSendMipMessageL(const TArray< TMipMessageEntry > &)`

`MmcNumberOfBanksL(TBool,TInt &)`

`MmcGetBankIdL(TBool,TInt,TInt &)`

`MmcLoadCustomBankL(const TDesC &,TInt &)`

`MmcLoadCustomBankDataL(const TDesC8 &,TInt &)`

`MmcUnloadCustomBankL(TInt)`

`MmcCustomBankLoadedL(TInt,TBool &)`

`MmcUnloadAllCustomBanksL()`

`MmcNumberOfInstrumentsL(TInt,TBool,TInt &)`

`MmcGetInstrumentIdL(TInt,TBool,TInt,TInt &)`

`MmcInstrumentNameL(TInt,TBool,TInt)`

`MmcSetInstrumentL(TInt,TInt,TInt)`

`MmcLoadCustomInstrumentL(const TDesC &,TInt,TInt,TInt,TInt)`

`MmcLoadCustomInstrumentDataL(const TDesC8 &,TInt,TInt,TInt,TInt)`

`MmcUnloadCustomInstrumentL(TInt,TInt)`

`MmcPercussionKeyNameL(TInt,TInt,TBool,TInt)`

`MmcStopTimeL(TTimeIntervalMicroSeconds &)`

`MmcSetStopTimeL(const TTimeIntervalMicroSeconds &)`

`MmcPolyphonyL(TInt &)`

`MmcChannelsSupportedL(TInt &)`

`MmcChannelVolumeL(TInt,TReal32 &)`

`MmcMaxChannelVolumeL(TReal32 &)`

`MmcSetChannelVolumeL(TInt,TReal32)`

`MmcSetChannelMuteL(TInt,TBool)`

`MmcVolumeL(TInt &)`

`MmcMaxVolumeL(TInt &)`

`MmcSetVolumeL(TInt)`