MBS Plugin Documentation

Search:

Statistics   -   FAQ   -   Plugin Parts (All, Dependencies)   -   Class hierarchie

New in Version 7.0 7.1 7.2 7.3 7.4 7.5 7.6 7.7 7.8 8.0 8.1 8.2 8.3 8.4 8.5 8.6 8.7 9.0

The list of the   themes,   classes,   controls,   modules,   global methods by category,   global methods by name,   screenshots,   licenses   and   examples.

Platforms to show: All Mac Windows Linux Cross-Platform

MidiPlaybackMBS.Callback as integer
method, MIDI, MBS MacOSX Plugin (MidiPlayback), class MidiPlaybackMBS, Console safe, Plugin version: 6.0, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Needed for the MidiPortMBS class to know which function to call
Example: 
dim p as MidiPlaybackMBS
dim m as MidiPortMBS
// do something useful
m.SetCallback p.Callback, p
Notes:
Return the address of the callback method used to process Midi data.
The method is to be used together with the SetCallback method in the MidiPortMBS class.
class MidiPlaybackMBS
class, MIDI, MBS MacOSX Plugin (MidiPlayback), class MidiPlaybackMBS, Console safe, Plugin version: 5.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: A class to do Midi playback on Mac OS X.
MidiPlaybackMBS.Constructor
method, MIDI, MBS MacOSX Plugin (MidiPlayback), class MidiPlaybackMBS, Console safe, Plugin version: 8.7, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Initializes the midi playback.
Notes: After calling the constructor the Inited flag is true on success.
MidiPlaybackMBS.Constructor(UsesInternalReverb as boolean)
method, MIDI, MBS MacOSX Plugin (MidiPlayback), class MidiPlaybackMBS, Console safe, Plugin version: 8.7, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Initializes the midi playback.
Notes: After calling the constructor the Inited flag is true on success.
MidiPlaybackMBS.CPULoad as single
method, MIDI, MBS MacOSX Plugin (MidiPlayback), class MidiPlaybackMBS, Console safe, Plugin version: 5.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The CPU load of the graph.
Notes:
Returns a short-term running average of the current CPU load of the graph.
MidiPlaybackMBS.GraphHandle as Integer
property, MIDI, MBS MacOSX Plugin (MidiPlayback), class MidiPlaybackMBS, Console safe, Plugin version: 8.7, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The handle for the AUGraph.
Notes: (Read only property)
MidiPlaybackMBS.Inited as boolean
property, MIDI, MBS MacOSX Plugin (MidiPlayback), class MidiPlaybackMBS, Console safe, Plugin version: 8.7, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Whether the constructor was successful.
Notes:
This property is false if the constructor failed to initialize.
(Read only property)
MidiPlaybackMBS.InstrumentCount as integer
method, MIDI, MBS MacOSX Plugin (MidiPlayback), class MidiPlaybackMBS, Console safe, Plugin version: 5.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The number of instruments.
MidiPlaybackMBS.InstrumentID(index as integer) as integer
method, MIDI, MBS MacOSX Plugin (MidiPlayback), class MidiPlaybackMBS, Console safe, Plugin version: 5.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The ID of the instrument with the given index.
MidiPlaybackMBS.InstrumentIDOnChannel(Channel as integer) as integer
method, MIDI, MBS MacOSX Plugin (MidiPlayback), class MidiPlaybackMBS, Console safe, Plugin version: 5.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Which instrument is playing on which channel.
Notes: (Read and Write runtime property)
MidiPlaybackMBS.InstrumentName(index as integer) as string
method, MIDI, MBS MacOSX Plugin (MidiPlayback), class MidiPlaybackMBS, Console safe, Plugin version: 5.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The name of the instrument with the given index.
MidiPlaybackMBS.Lasterror as Integer
property, MIDI, MBS MacOSX Plugin (MidiPlayback), class MidiPlaybackMBS, Console safe, Plugin version: 5.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The last error code.
Notes: (Read only property)
MidiPlaybackMBS.LoadSoundBankFile(file as folderitem)
method, MIDI, MBS MacOSX Plugin (MidiPlayback), class MidiPlaybackMBS, Console safe, Plugin version: 8.5, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Loads a sound bank file.
Example: 
Sub LoadSoundFont (SoundFontName as string)
  
  dim j as integer
  dim f as folderitem
  dim e as string
  
  //GET SOUNDFONT
  f = Volume(0).Child("Library").Child("Audio").Child("Sounds").Child("Banks").Child(SoundFontName)
  
  if f <> Nil then
    //INSTALL SOUNDFONT
    me.LoadSoundBankFile(f)
    Window1.PopupMenu1.DeleteAllRows
    for j = 0 to 127
      if me.InstrumentName(j) <> "" then
        Window1.PopupMenu1.addrow me.InstrumentName(j)
      end if
    next
    Window1.PopupMenu1.ListIndex = 0
  else
    e = "Could not locate the SoundFont: "+ SoundFontName
    e = e + " Please make sure the file is a valid soundfont file"
    e = e + " and is located in the folder YourHardDrive/Library/Audio/Sounds/Banks"
    e = e + " and has the extension .sf2"
    MsgBox e
  end if
  
End Sub
Notes:
This function can load files with .sf2 extension placed in the location: Library/Audio/Sounds/Banks.

Lasterror is set.
MidiPlaybackMBS.MaxCPULoad as single
method, MIDI, MBS MacOSX Plugin (MidiPlayback), class MidiPlaybackMBS, Console safe, Plugin version: 8.7, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The Maximum CPU load of the graph
Notes: Returns the max CPU load of the graph since this call was last made or the graph was last started.
MidiPlaybackMBS.ReverbVolume as single
method, MIDI, MBS MacOSX Plugin (MidiPlayback), class MidiPlaybackMBS, Console safe, Plugin version: 8.7, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The reverb volume.
Notes:
The value range is -120 to 40 dB.
(Read and Write runtime property)
MidiPlaybackMBS.SendMidiEvent(Status as integer, Data1 as integer, Data2 as integer, OffsetSampleFrame as integer)
method, MIDI, MBS MacOSX Plugin (MidiPlayback), class MidiPlaybackMBS, Console safe, Plugin version: 5.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Sends midi data for playback.
MidiPlaybackMBS.StreamFromDisk as boolean
method, MIDI, MBS MacOSX Plugin (MidiPlayback), class MidiPlaybackMBS, Console safe, Plugin version: 8.7, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Whether we are streaming from disk.
Notes:
Currently setting this value can crash the application.
(Read and Write runtime property)
MidiPlaybackMBS.Tuning as single
method, MIDI, MBS MacOSX Plugin (MidiPlayback), class MidiPlaybackMBS, Console safe, Plugin version: 8.7, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The tuning setting.
Notes:
Value is in cents from -1200 to 1200.
(Read and Write runtime property)
MidiPlaybackMBS.UsesInternalReverb as boolean
method, MIDI, MBS MacOSX Plugin (MidiPlayback), class MidiPlaybackMBS, Console safe, Plugin version: 8.7, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: One of the audio unit properties.
Example: 
dim m as new MidiPlaybackMBS

if not m.init then
  MsgBox "Failed to initialize."
  Return
end if

MsgBox "UsesInternalRever: "+str(m.UsesInternalReverb)
m.UsesInternalReverb=true
MsgBox "UsesInternalRever: "+str(m.UsesInternalReverb)
Notes:
Lasterror is set.
(Read and Write runtime property)
MidiPlaybackMBS.Volume as single
method, MIDI, MBS MacOSX Plugin (MidiPlayback), class MidiPlaybackMBS, Console safe, Plugin version: 8.7, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The volume.
Notes:
The value is in dB from -120 to 40.
(Read and Write runtime property)

The items on this page are in the following plugins: MBS MacOSX Plugin.