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

Previous items

MidiObjectMBS.kMIDIPropertyTransmitsClock as CFStringMBS
property, MIDI, MBS MacOSX Plugin (Midi), class MidiObjectMBS, Console safe, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: One of the properties for MIDI on Mac OS X.
Notes:
Only available after you called the Init Method.

New for CoreMIDI 1.3. This is set on devices/entities, and is ab integer properties, 0/1
(Read only property)
MidiObjectMBS.kMIDIPropertyTransmitsMTC as CFStringMBS
property, MIDI, MBS MacOSX Plugin (Midi), class MidiObjectMBS, Console safe, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: One of the properties for MIDI on Mac OS X.
Notes:
Only available after you called the Init Method.

New for CoreMIDI 1.3. This is set on devices/entities, and is ab integer properties, 0/1
(Read only property)
MidiObjectMBS.kMIDIPropertyTransmitsNotes as CFStringMBS
property, MIDI, MBS MacOSX Plugin (Midi), class MidiObjectMBS, Console safe, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: One of the properties for MIDI on Mac OS X.
Notes:
Only available after you called the Init Method.

New for CoreMIDI 1.3. This is set on devices/entities, and is ab integer properties, 0/1
(Read only property)
MidiObjectMBS.kMIDIPropertyTransmitsProgramChanges as CFStringMBS
property, MIDI, MBS MacOSX Plugin (Midi), class MidiObjectMBS, Console safe, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: One of the properties for MIDI on Mac OS X.
Notes:
Only available after you called the Init Method.

New for CoreMIDI 1.3. This is set on devices/entities, and is ab integer properties, 0/1
(Read only property)
MidiObjectMBS.kMIDIPropertyUniqueID as CFStringMBS
property, MIDI, MBS MacOSX Plugin (Midi), class MidiObjectMBS, Console safe, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: One of the properties for MIDI on Mac OS X.
Notes:
Only available after you called the Init Method.
devices, entities, endpoints all have unique ID's, integer
The system assigns unique ID's to all objects. Creators of virtual endpoints may set this property on their endpoints, though doing so may fail if the chosen ID is not unique.
(Read only property)
MidiObjectMBS.kMIDIPropertyUserPatchNameFile as CFStringMBS
property, MIDI, MBS MacOSX Plugin (Midi), class MidiObjectMBS, Console safe, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: One of the properties for MIDI on Mac OS X.
Notes:
Only available after you called the Init Method.

device/entity/endpoint property, CFData containing AliasHandle

An alias to the device's current user patch name file.

Added in CoreMIDI 1.1. DEPRECATED as of CoreMIDI 1.3.
Use kMIDIPropertyNameConfiguration instead.
(Read only property)
MidiObjectMBS.Lasterror as Integer
property, MIDI, MBS MacOSX Plugin (Midi), class MidiObjectMBS, Console safe, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The last error code reported.
Notes:
0 if the function was successfull.
-1 if the function is not available or the RB parameters were bad. (e.g. nil)
else a Mac OS error code.

Some Midi specific error codes:

kMIDIInvalidClient-10830
kMIDIInvalidPort-10831
kMIDIWrongEndpointType-10832want source, got destination, or vice versa
kMIDINoConnection-10833attempt to close a non-existant connection
kMIDIUnknownEndpoint-10834
kMIDIUnknownProperty-10835
kMIDIWrongPropertyType-10836
kMIDINoCurrentSetup-10837there is no current setup, or it contains no devices
kMIDIMessageSendErr-10838communication with server failed
kMIDIServerStartErr-10839couldn't start the server
kMIDISetupFormatErr-10840unparseable saved state
kMIDIWrongThread-10841driver is calling non I/O function in server from a thread other than server's main one:
kMIDIObjectNotFound-10842
kMIDIIDNotUnique-10843
(Read and Write property)
MidiObjectMBS.ObjectProperty(name as CFStringMBS) as CFObjectMBS
method, MIDI, MBS MacOSX Plugin (Midi), class MidiObjectMBS, Console safe, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Get or Set an object's dictionary-type property.
Notes:
Lasterror is set.
New for CoreMIDI 1.3.
Renamed from Property to ObjectProperty in v4.3 for REALbasic 6 compatibility.
(Read and Write runtime property)
MidiObjectMBS.Properties(deep as boolean) as CFObjectMBS
method, MIDI, MBS MacOSX Plugin (Midi), class MidiObjectMBS, Console safe, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Get all of an object's properties.
Notes:
Deep parameter: true if the object's child objects are to be included (e.g. a device's entities, or an entity's endpoints).
Properties which an object inherits from its owning object (if any) are not included.

New for CoreMIDI 1.1.

Returns nil on any error.
Lasterror is set.
MidiObjectMBS.Release as Boolean
property, MIDI, MBS MacOSX Plugin (Midi), class MidiObjectMBS, Console safe, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Wether the destructor should release the object handle.
Notes: (Read and Write property)
MidiObjectMBS.RemoveProperty(name as CFStringMBS)
method, MIDI, MBS MacOSX Plugin (Midi), class MidiObjectMBS, Console safe, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Remove an object's property.
Notes: Lasterror is set.
MidiObjectMBS.SafeMultiThreading as Boolean
property, MIDI, MBS MacOSX Plugin (Midi), class MidiObjectMBS, Console safe, Plugin version: 5.3, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Whether to use safe or faster threading.
Notes:
Events from CoreMidi are received in an extra thread and if SafeMultiThreading=true then the event is posted on the main thread you can handle it there. If SafeMultiThreading=false the event is processed in the CoreMidi thread which can lead into crashes with Realbasic, but is faster.

This will crash with SafeMultiThreading=False depending on what you do in the Midi event handlers.

Default value is true.
(Read and Write property)
MidiObjectMBS.StringProperty(name as CFStringMBS) as CFStringMBS
method, MIDI, MBS MacOSX Plugin (Midi), class MidiObjectMBS, Console safe, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Get or Set an object's string-type property.
Example:
dim m as MidiClientMBS
dim i, n as integer
dim e as MidiEndpointMBS
dim d as MidiDeviceMBS
dim s as CFStringMBS

m = new MidiClientMBS
m.Init NewCFStringMBS("Test")
d = m.GetDevice(0)

s = d.StringProperty(d.kMIDIPropertyManufacturer)

MsgBox s.str

Notes:
Lasterror is set.
(Read and Write runtime property)

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