class CMidiClientUtility : public CBase |
Utility class to provide a standard client interface to a MIDI controller.
Private Attributes | |
---|---|
CBody * | iBody |
IMPORT_C TReal32 | ChannelVolumeL | ( | TInt | aChannel | ) | const |
Get the current volume setting of a logical channel
TInt aChannel | Logical channel to query. 0 <= aChannel <= 15. |
IMPORT_C TInt | ChannelsSupportedL | ( | ) | const |
Gets the maximum number of logical channels supported by the MIDI engine.
IMPORT_C void | Close | ( | ) |
Asynchronous function which closes any currently open resources, such as files, descriptors or URLs in use. Does nothing if there is nothing currently open.
IMPORT_C TBool | CustomBankLoadedL | ( | TInt | aBankCollectionIndex | ) | const |
Query if a bank has been loaded to the memory
TInt aBankCollectionIndex | Identifier of the custom sound bank to check if it's in memory or not |
IMPORT_C void | CustomCommandAsync | ( | const TMMFMessageDestinationPckg & | aDestination, |
TInt | aFunction, | |||
const TDesC8 & | aDataTo1, | |||
const TDesC8 & | aDataTo2, | |||
TDes8 & | aDataFrom, | |||
TRequestStatus & | aStatus | |||
) |
Asynchronously pass implementation-specific commands to the MIDI engine and receive a response
const TMMFMessageDestinationPckg & aDestination | aDestination Recipient of the message. Should be initialised with KUidInterfaceMIDI and a TInt describing the server-side object to which the command should be delivered. The TInt will usually be KMMFObjectHandleController, to deliver the message to the controller plugin, which is the default value. |
TInt aFunction | Index of the function to perform |
const TDesC8 & aDataTo1 | First command data buffer to send, eg command parameters |
const TDesC8 & aDataTo2 | Second command data buffer to send, eg data parameters |
TDes8 & aDataFrom | Buffer to receive data in response to the command. The user must ensure that it is large enough to hold all the data returned. |
TRequestStatus & aStatus | Status flag belonging to an active object that will have it's RunL() called when this request complete |
IMPORT_C void | CustomCommandAsync | ( | const TMMFMessageDestinationPckg & | aDestination, |
TInt | aFunction, | |||
const TDesC8 & | aDataTo1, | |||
const TDesC8 & | aDataTo2, | |||
TRequestStatus & | aStatus | |||
) |
Asynchronously pass implementation-specific commands to the MIDI engine
const TMMFMessageDestinationPckg & aDestination | aDestination Recipient of the message. Should be initialised with KUidInterfaceMIDI and a TInt describing the server-side object to which the command should be delivered. The TInt will usually be KMMFObjectHandleController, to deliver the message to the controller plugin, which is the default value. |
TInt aFunction | Index of the function to perform |
const TDesC8 & aDataTo1 | First command data buffer to send, eg command parameters |
const TDesC8 & aDataTo2 | Second command data buffer to send, eg data parameters |
TRequestStatus & aStatus | Status flag belonging to an active object that will have it's RunL() called when this request complete |
IMPORT_C void | CustomCommandSyncL | ( | const TMMFMessageDestinationPckg & | aDestination, |
TInt | aFunction, | |||
const TDesC8 & | aDataTo1, | |||
const TDesC8 & | aDataTo2, | |||
TDes8 & | aDataFrom | |||
) |
Synchronously pass implementation-specific commands to the MIDI engine and receive a response
const TMMFMessageDestinationPckg & aDestination | Recipient of the message. Should be initialised with KUidInterfaceMIDI and a TInt describing the server-side object to which the command should be delivered. The TInt will usually be KMMFObjectHandleController, to deliver the message to the controller plugin, which is the default value. |
TInt aFunction | Index of the function to perform |
const TDesC8 & aDataTo1 | First command data buffer to send, eg command parameters |
const TDesC8 & aDataTo2 | Second command data buffer to send, eg data parameters |
TDes8 & aDataFrom | Buffer to receive data in response to the command. The user must ensure that it is large enough to hold all the data returned. |
IMPORT_C void | CustomCommandSyncL | ( | const TMMFMessageDestinationPckg & | aDestination, |
TInt | aFunction, | |||
const TDesC8 & | aDataTo1, | |||
const TDesC8 & | aDataTo2 | |||
) |
Synchronously pass implementation-specific commands to the MIDI engine.
const TMMFMessageDestinationPckg & aDestination | Recipient of the message. Should be initialised with KUidInterfaceMIDI and a TInt describing the server-side object to which the command should be delivered. The TInt will usually be KMMFObjectHandleController, to deliver the message to the controller plugin, which is the default value. |
TInt aFunction | Index of the function to perform |
const TDesC8 & aDataTo1 | First command data buffer to send, eg command parameters |
const TDesC8 & aDataTo2 | Second command data buffer to send, eg data parameters |
IMPORT_C TInt64 | DurationMicroBeatsL | ( | ) | const |
Gets the length of the currently open MIDI resource in micro-beats
IMPORT_C TTimeIntervalMicroSeconds | DurationMicroSecondsL | ( | ) | const |
Gets the length of the currently open MIDI resource in micro-seconds
IMPORT_C TInt | GetBankIdL | ( | TBool | aCustom, |
TInt | aBankIndex | |||
) | const |
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
IMPORT_C MMMFDRMCustomCommand * | GetDRMCustomCommand | ( | ) |
Gets a controller's DRM custom command implementation.
IMPORT_C TInt | GetInstrumentIdL | ( | TInt | aBankId, |
TBool | aCustom, | |||
TInt | aInstrumentIndex | |||
) | const |
Gets the identifier of an instrument.
IMPORT_C void | GetInstrumentL | ( | TInt | aChannel, |
TInt & | aInstrumentId, | |||
TInt & | aBankId | |||
) |
Gets the instrument assigned to a specified channel
IMPORT_C CMMFMetaDataEntry * | GetMetaDataEntryL | ( | TInt | aMetaDataIndex | ) | const |
Retrieve the specified XMF,SMF meta data entry.
TInt aMetaDataIndex | Index of the meta data entry to retrieve |
IMPORT_C TInt | GetRepeats | ( | ) | const |
Gets the number of times the current opened resources has to be repeated
IMPORT_C HBufC * | InstrumentNameL | ( | TInt | aBankId, |
TBool | aCustom, | |||
TInt | aInstrumentId | |||
) | const |
Gets the name of the given instrument.
IMPORT_C TBool | IsChannelMuteL | ( | TInt | aChannel | ) | const |
Gets the muting status of a specific channel
TInt aChannel | The channel to query |
IMPORT_C TBool | IsTrackMuteL | ( | TInt | aTrack | ) | const |
Gets the muting status of a specific track
TInt aTrack | The track to query |
IMPORT_C void | LoadCustomBankDataL | ( | const TDesC8 & | aBankData, |
TInt & | aBankCollectionIndex | |||
) |
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 colliding bank numbers
IMPORT_C void | LoadCustomBankL | ( | const TDesC & | aFileName, |
TInt & | aBankCollectionIndex | |||
) |
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 colliding bank numbers
IMPORT_C void | LoadCustomInstrumentDataL | ( | const TDesC8 & | aInstrumentData, |
TInt | aBankDataId, | |||
TInt | aInstrumentDataId, | |||
TInt | aMemoryBankId, | |||
TInt | aMemoryInstrumentId | |||
) |
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
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. |
IMPORT_C void | LoadCustomInstrumentL | ( | const TDesC & | aFileName, |
TInt | aFileBankId, | |||
TInt | aFileInstrumentId, | |||
TInt | aMemoryBankId, | |||
TInt | aMemoryInstrumentId | |||
) |
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
const TDesC & 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. |
IMPORT_C TReal32 | MaxChannelVolumeL | ( | ) | const |
Gets the Maximum volume setting that may be applied to a logical channel
IMPORT_C TInt | MaxPlaybackRateL | ( | ) | const |
Gets the maximum playback rate in milli-percentage from the MIDI engine. SetPlaybackRate() for milli-percentage details
IMPORT_C TInt | MaxPolyphonyL | ( | ) | const |
Get the maximum polyphony level that the engine can handle
IMPORT_C const TDesC8 & | MimeTypeL | ( | ) |
Gets the MIME type of the MIDI resource currently open
IMPORT_C TInt | MinPlaybackRateL | ( | ) | const |
Gets the minimum playback rate in milli-percentage from the MIDI engine. SetPlaybackRate() for milli-percentage details.
IMPORT_C CMidiClientUtility * | NewL | ( | MMidiClientUtilityObserver & | aObserver, |
TInt | aPriority = EMdaPriorityNormal, | |||
TInt | aPref = EMdaPriorityPreferenceTimeAndQuality | |||
) | [static] |
Static factory function for creating a MIDI client utility object. This function is synchronous, unlike the other factory functions, because it doesn't need to perform any MIDI resource initialisation The underlying controller that is created will be given its own heap.
Note: The Priority Value and Priority Preference are used primarily when deciding what to do when several audio clients attempt to play or record simultaneously. In addition to the Priority Value and Preference, the adaptation may consider other parameters such as the SecureId and Capabilities of the client process. Whatever, the decision as to what to do in such situations is up to the audio adaptation, and may vary between different phones. Portable applications are advised not to assume any specific behaviour.
MMidiClientUtilityObserver & aObserver | Reference to an object to receive callbacks on completion of asynchronous functions. |
TInt aPriority = EMdaPriorityNormal | The Priority Value - this client's relative priority. This is a value between EMdaPriorityMin and EMdaPriorityMax and represents a relative priority. A higher value indicates a more important request. |
TInt aPref = EMdaPriorityPreferenceTimeAndQuality | The Priority Preference - an additional audio policy parameter. The suggested default is EMdaPriorityPreferenceNone. Further values are given by TMdaPriorityPreference, and additional values may be supported by given phones and/or platforms, but should not be depended upon by portable code. |
IMPORT_C CMidiClientUtility * | NewL | ( | MMidiClientUtilityObserver & | aObserver, |
TInt | aPriority, | |||
TInt | aPref, | |||
TBool | aUseSharedHeap | |||
) | [static] |
Static factory function for creating a MIDI client utility object. This function is synchronous, unlike the other factory functions, because it doesn't need to perform any MIDI resource initialisation.
Note: The Priority Value and Priority Preference are used primarily when deciding what to do when several audio clients attempt to play or record simultaneously. In addition to the Priority Value and Preference, the adaptation may consider other parameters such as the SecureId and Capabilities of the client process. Whatever, the decision as to what to do in such situations is up to the audio adaptation, and may vary between different phones. Portable applications are advised not to assume any specific behaviour.
MMidiClientUtilityObserver & aObserver | Reference to an object to receive callbacks on completion of asynchronous functions. |
TInt aPriority | The Priority Value - this client's relative priority. This is a value between EMdaPriorityMin and EMdaPriorityMax and represents a relative priority. A higher value indicates a more important request. |
TInt aPref | The Priority Preference - an additional audio policy parameter. The suggested default is EMdaPriorityPreferenceNone. Further values are given by TMdaPriorityPreference, and additional values may be supported by given phones and/or platforms, but should not be depended upon by portable code. |
TBool aUseSharedHeap | Select if the underlying controller will have its own heap or share a single heap with other controller instances. The default behaviour, or if this value is EFalse, is that each controller is created with its own heap. The alternative, if the value is ETrue, is that controllers share a special heap with other controllers created the same way. Each heap uses a chunk, so this avoids situations where the number of chunks per process is limited. The default behaviour is generally to be preferred, and should give lower overall memory usage. However, if many controllers are to be created for a particular thread, then ETrue should be provided to prevent running out of heaps or chunks. |
IMPORT_C void | NoteOffL | ( | TInt | aChannel, |
TInt | aNote, | |||
TInt | aVelocity | |||
) |
Synchronous function to terminate playback of a note. If no corresponding note is found then no error is raised.
IMPORT_C void | NoteOnL | ( | TInt | aChannel, |
TInt | aNote, | |||
TInt | aVelocity | |||
) |
Synchronous function to commence playback of a note. Multiple calls to this function will be accommodated as far as the MIDI engine can manage
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. |
IMPORT_C TInt | NumTracksL | ( | ) | const |
Gets the number of tracks present in the currently open MIDI resource
IMPORT_C TInt | NumberOfBanksL | ( | TBool | aCustom | ) | const |
Gets the number of standard or custom sound banks currently available
TBool aCustom | Specifies whether to reference a custom or standard sound bank |
IMPORT_C TInt | NumberOfInstrumentsL | ( | TInt | aBankId, |
TBool | aCustom | |||
) | const |
Gets the number of instruments available in a given sound bank
IMPORT_C TInt | NumberOfMetaDataEntriesL | ( | ) | const |
Get the number of meta data entries currently known about in the currently open resource. XMF,SMF meta data are part of the XMF,SMF file header and can thus be examined before playback. If there is no XMF,SMF resource open, will return zero. Standard MIDI file meta data entries encountered during playback will be passed back via MMIDIClientUtilityObserver::MmcuoMetaDataEntryFound()
IMPORT_C void | OpenDes | ( | const TDesC8 & | aDescriptor | ) |
Asynchronous function to open a descriptor containing MIDI data and perform initialisation ready for playback
const TDesC8 & aDescriptor | descriptor containing MIDI data |
IMPORT_C void | OpenFile | ( | const TDesC & | aFileName | ) |
Asynchronous function to open a file containing MIDI data and perform initialisation ready for playback
const TDesC & aFileName | Name of the MIDI file to open |
IMPORT_C void | OpenFile | ( | const RFile & | aFile | ) |
Asynchronous function to open a file containing MIDI data and perform initialisation ready for playback
const RFile & aFile | Open shared protected session handle to the midi file to read |
IMPORT_C void | OpenFile | ( | const TMMSource & | aSource | ) |
Asynchronous function to open a file containing MIDI data and perform initialisation ready for playback
const TMMSource & aSource |
IMPORT_C void | OpenUrl | ( | const TDesC & | aUrl, |
TInt | aIapId = KUseDefaultIap , | |||
const TDesC8 & | aMimeType = KNullDesC8 | |||
) |
Asynchronous function to open a URL containing MIDI data and perform initialisation ready for playback
const TDesC & aUrl | Uniform Resource Locator for a MIDI data stream |
TInt aIapId = KUseDefaultIap | Identifier of the Internet Access Point to use - available from CommDB, the comms connections database. Defaults to using the default access point, as defined by CommDB |
const TDesC8 & aMimeType = KNullDesC8 | Mime type of the MIDI data stream to be played. Defaults to nothing in which case the an attempt will be made to recognise the type of the MIDI data automatically. |
IMPORT_C HBufC * | PercussionKeyNameL | ( | TInt | aNote, |
TInt | aBankId, | |||
TBool | aCustom, | |||
TInt | aInstrumentId | |||
) | const |
Gets the name of a particular percussion key corresponding to a given note.
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 |
IMPORT_C TInt | PitchTranspositionCentsL | ( | ) | const |
Gets the pitch shift in use for the currently open MIDI resource
IMPORT_C void | Play | ( | ) |
Asynchronous function to initiate or resume playback of a previously opened resource. Also used to start an internal timer to establish a zero-time for the media stream time relative to which commands with timestamps are timed against
IMPORT_C void | PlayNoteL | ( | TInt | aChannel, |
TInt | aNote, | |||
const TTimeIntervalMicroSeconds & | aDuration, | |||
TInt | aNoteOnVelocity, | |||
TInt | aNoteOffVelocity | |||
) |
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
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. |
IMPORT_C void | PlayNoteL | ( | TInt | aChannel, |
TInt | aNote, | |||
const TTimeIntervalMicroSeconds & | aStartTime, | |||
const TTimeIntervalMicroSeconds & | aDuration, | |||
TInt | aNoteOnVelocity, | |||
TInt | aNoteOffVelocity | |||
) |
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
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. |
IMPORT_C TInt | PlaybackRateL | ( | ) | const |
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
IMPORT_C TInt64 | PositionMicroBeatsL | ( | ) | const |
Gets the current metrical position of the MIDI resource being played
IMPORT_C TTimeIntervalMicroSeconds | PositionMicroSecondsL | ( | ) | const |
Gets the current temporal position of the MIDI resource being played.
IMPORT_C TInt | SendMessageL | ( | const TDesC8 & | aMidiMessage | ) |
Sends a single MIDI message to the MIDI engine
const TDesC8 & aMidiMessage | Descriptor containing the MIDI message data. If there are several MIDI messages in the buffer, only the first one is processed |
IMPORT_C TInt | SendMessageL | ( | const TDesC8 & | aMidiMessage, |
const TTimeIntervalMicroSeconds & | aTime | |||
) |
Sends a single MIDI message, with time stamp, to the MIDI engine
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 |
IMPORT_C void | SendMipMessageL | ( | const RArray < TMipMessageEntry > & | aEntry | ) |
Sends a mip message to the MIDI engine. This is a convenience function, because the same functionality could be achieved with the SendMessage() function
const RArray < TMipMessageEntry > & aEntry | Array of logical {channel, MIP} value pairs to send, highest priority first |
IMPORT_C void | SetBalanceL | ( | TInt | aBalance = KMMFBalanceCenter | ) |
Set the current stereo balance value
TInt aBalance = KMMFBalanceCenter | Balance value to set. Defaults to KMMFBalanceCenter to restore equal left-right balance |
IMPORT_C void | SetBankL | ( | TBool | aCustom | ) |
SetBankL is deprecated due to Mobile XMF specification requirement that user instruments (custom instruments) override standard instruments.
Tell the MIDI engine to use a custom bank or a standard bank
TBool aCustom | If Etrue the custom bank in memory is used otherwise the standard bank is used leaving the custom bank in memory |
IMPORT_C void | SetChannelMuteL | ( | TInt | aChannel, |
TBool | aMuted | |||
) |
Set the muting state of a channel without changing its volume setting. When unmuted the channel goes back to its previous volume setting
IMPORT_C void | SetChannelVolumeL | ( | TInt | aChannel, |
TReal32 | aVolumeInDecibels | |||
) |
Set the volume of a channel.
TInt aChannel | Logical channel to set the volume on. 0 <= aChannel <= 15 |
TReal32 aVolumeInDecibels | Volume currently set on the specified channel in decibels. The minimum channel volume supported value is -infinity dB, which is the smallest possible value that TReal32 supports. The maximum channel volume can be set via MaxChannelVolumeL() |
IMPORT_C void | SetInstrumentL | ( | TInt | aChannel, |
TInt | aBankId, | |||
TInt | aInstrumentId | |||
) |
Sets a logical channel to use the given instrument.
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 <= iInstrumentId <= 127. |
IMPORT_C void | SetMaxPolyphonyL | ( | TInt | aMaxNotes | ) |
Set the max polyphony the engine can handle
TInt aMaxNotes | Max polyphony level, 0 <= PolyphonyL() <= aMaxNotes |
IMPORT_C TInt | SetPitchTranspositionL | ( | TInt | aCents | ) |
Sets the pitch shift to apply to the currently open MIDI resource. May be called during playback aCents parameter is not checked - if the value is out of range, it is expected KErrArgument is return by MIDI engine.
TInt aCents | Pitch shift in cents, i.e. semitones * 100. One octave equals 1200 cents |
IMPORT_C void | SetPlaybackRateL | ( | TInt | aRate | ) |
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.
TInt aRate | Playback rate in percent times 1000, i.e., 100000 means original playback speed, 200000 means double speed, and 50000 means half speed playback |
IMPORT_C void | SetPositionMicroBeatsL | ( | TInt64 | aMicroBeats | ) |
Change the position of the currently playing MIDI resource to the given position. May be called whenever a MIDI resource is open.
TInt64 aMicroBeats | Metrical position to move to. Clamped to (0, DurationMicroBeatsL()). |
IMPORT_C void | SetPositionMicroSecondsL | ( | const TTimeIntervalMicroSeconds & | aPosition | ) |
Change the position of the currently playing MIDI resource to the given position. May be called whenever a MIDI resource is open
const TTimeIntervalMicroSeconds & aPosition | Temporal position to move to. Clamped to (0, DurationMicroSecondsL()). |
IMPORT_C void | SetPriorityL | ( | TInt | aPriority, |
TInt | aPref | |||
) |
Set the priority with which this client plays MIDI data
IMPORT_C void | SetRepeatsL | ( | TInt | aRepeatNumberOfTimes, |
const TTimeIntervalMicroSeconds & | aTrailingSilence | |||
) |
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
TInt aRepeatNumberOfTimes | Number of time to repeat the resource during playback. This includes the first playing |
const TTimeIntervalMicroSeconds & aTrailingSilence | Time in microseconds to pause between repeats |
IMPORT_C void | SetStopTimeL | ( | const TTimeIntervalMicroSeconds & | aStopTime | ) |
Sets the stop time to use for the currently open MIDI resource
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 |
IMPORT_C void | SetSyncUpdateCallbackIntervalL | ( | const TTimeIntervalMicroSeconds & | aMicroSeconds, |
TInt64 | aMicroBeats = 0 | |||
) |
Sets the frequency at which MMIDIClientUtilityObserver::MmcuoSyncUpdateL( ) is called to allow other components to synchronise with playback of this MIDI resource
const TTimeIntervalMicroSeconds & aMicroSeconds | Temporal interval to callback at. Used in preference to aMicroBeats if both are set |
TInt64 aMicroBeats = 0 | Metrical interval to callback at. Set both parameters to zero to cancel. |
IMPORT_C void | SetTempoL | ( | TInt | aMicroBeatsPerMinute | ) |
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
TInt aMicroBeatsPerMinute | Tempo in microbeats per minute (BPM*1000000) to set |
IMPORT_C void | SetTrackMuteL | ( | TInt | aTrack, |
TBool | aMuted | |||
) | const |
Mutes or unmutes a particular track
IMPORT_C void | SetVolumeL | ( | TInt | aVolume | ) |
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 is (overall volume * channel volume / max volume).
TInt aVolume | Overall volume setting to use |
IMPORT_C void | SetVolumeRampL | ( | const TTimeIntervalMicroSeconds & | aRampDuration | ) |
Length of time over which the volume is faded up from zero to the current settings when playback is started.
const TTimeIntervalMicroSeconds & aRampDuration | Duration of the ramping period. |
IMPORT_C TMidiState | State | ( | ) | const |
Gets the current state of the MIDI client utility with regard to MIDI resources
IMPORT_C void | Stop | ( | const TTimeIntervalMicroSeconds & | aFadeOutDuration | ) |
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
const TTimeIntervalMicroSeconds & aFadeOutDuration | Length of time over which the volume is faded out from the current settings to zero. |
IMPORT_C void | StopNotes | ( | TInt | aChannel | ) |
Stops the playback of all notes on the given channel, by means of an All Notes Off MIDI message
TInt aChannel | Logical channel to stop notes on. 0 <= aChannel <= 15 |
IMPORT_C void | StopTimeL | ( | TTimeIntervalMicroSeconds & | aStopTime | ) | const |
Get the stop time currently set for the MIDI resource
TTimeIntervalMicroSeconds & aStopTime | Time at which playback will stop, relative to the start of the resource |
IMPORT_C TInt | TempoMicroBeatsPerMinuteL | ( | ) | const |
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.
IMPORT_C void | UnloadAllCustomBanksL | ( | ) |
Removes all custom sound banks from memory.
IMPORT_C void | UnloadCustomBankL | ( | TInt | aBankCollectionIndex | ) |
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.
TInt aBankCollectionIndex | Identifier of the custom sound bank to unload, occupying no more than 14 bits |
IMPORT_C void | UnloadCustomInstrumentL | ( | TInt | aCustomBankId, |
TInt | aInstrumentId | |||
) |
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
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.