RMidiControllerCustomCommands Class Reference

Constructor.

Stop receiving events from the MIDI controller.

Get the current volume setting of a logical channel.

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

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

Query if a bank has been loaded to the memory.

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

Get the current stereo balance value.

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.

Gets the instrument assigned to a specified channel.

Gets the identifier of an instrument.

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

Gets the name of the given instrument.

Gets the muting status of a specific channel.

Gets the muting status of a specific track.

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

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

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

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

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

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

See also: SetPlaybackRate() for milli-percentage details.

Gets the current maximum number of notes the engine can handle This can be greater than the value returned by RMidiControllerCustomCommands::Polyphony

Maximum volume setting that may be applied overall.

Gets the MIME type of the MIDI resource currently open.

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

See also: SetPlaybackRate() for milli-percentage details.

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

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

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

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

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

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

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

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.

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.

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.

Gets the polyphony of the MIDI engine.

Gets the current metrical position of the MIDI resource being played.

Start receiving events from the controller. This can only be called once the controller is open.

Get the MIDI event from the MIDI controller.

Sends a single MIDI message to the MIDI engine.

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

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

Set the current stereo balance value.

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

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

Set the volume of a channel.

Sets a logical channel to use the given instrument.

Set the max polyphony the engine can handle.

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

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.

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

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.

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

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

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.

Mutes or unmutes a particular track.

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).

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

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.

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

Get the stop time currently set for the MIDI resource.

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.

Removes all custom sound banks from memory.

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.

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.

Gets the overall volume of the MIDI client.