Xojo Conferences
MBSOct2019CologneDE

Platforms to show: All Mac Windows Linux Cross-Platform

Next items

MidiObjectMBS.kMIDIPropertyAdvanceScheduleTimeMuSec as CFStringMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method MIDI MBS MacCF Plugin 3.1 Yes No No Yes, macOS only No
Function: One of the properties for MIDI on Mac OS X.
Notes:
Only available after you called the Init Method.

device/entity/endpoint property, integer
Set by the owning driver; should not be touched by other clients.
If it is > 0, then it is a recommendation of how many microseconds in advance clients should schedule output. Clients should treat this value as a minimum. For devices with a > 0 advance schedule time, drivers will receive outgoing messages to the device at the time they are sent by the client, via MIDISend, and the driver is responsible for scheduling events to be played at the right times according to their timestamps.
As of CoreMIDI 1.3, this property may also be set on virtual destinations (but only the creator of the destination should do so).
When a client sends to a virtual destination with an advance schedule time of 0, the virtual destination receives its messages at their scheduled delivery time. If a virtual destination has a non-zero advance schedule time, it receives timestamped messages as soon as they are sent, and must do its own scheduling of the events.

Feedback, Comments & Corrections

MidiObjectMBS.kMIDIPropertyCanRoute as CFStringMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method MIDI MBS MacCF Plugin 3.1 Yes No No Yes, macOS only No
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

Feedback, Comments & Corrections

MidiObjectMBS.kMIDIPropertyConnectionUniqueID as CFStringMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method MIDI MBS MacCF Plugin 3.1 Yes No No Yes, macOS only No
Function: One of the properties for MIDI on Mac OS X.
Notes:
Only available after you called the Init Method.

device/entity/endpoint property, integer or CFDataRef

UniqueID of an external device/entity/endpoint attached to this one (strongly recommended that it be an endpoint). This is for the use of a setup editor UI; not currently used internally. A driver-owned entity or endpoint has this property to refer to an external MIDI device that is connected to it.

The property is non-existant or 0 if there is no connection.

New for CoreMIDI 1.1.

Beginning with CoreMIDI 1.3, this property may be a CFDataRef containing an array of big-endian SInt32's, to allow specifying that a driver object connects to multiple external objects (via MIDI thru-ing or splitting).

This property may also exist for external devices/entities/endpoints, in which case it signifies a MIDI Thru connection to another external device/entity/endpoint (again, strongly recommended that it be an edpoint).

Feedback, Comments & Corrections

MidiObjectMBS.kMIDIPropertyDeviceID as CFStringMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method MIDI MBS MacCF Plugin 3.1 Yes No No Yes, macOS only No
Function: One of the properties for MIDI on Mac OS X.
Notes:
Only available after you called the Init Method.
device/entity property, integer
The entity's system-exclusive ID, in user-visible form
Drivers may set this property on their devices or entities.
Setup editors may allow the user to set this property on external devices.

Feedback, Comments & Corrections

MidiObjectMBS.kMIDIPropertyDriverOwner as CFStringMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method MIDI MBS MacCF Plugin 3.1 Yes No No Yes, macOS only No
Function: One of the properties for MIDI on Mac OS X.
Notes:
Only available after you called the Init Method.

device/entity/endpoint property, string

Name of the driver that owns a device.
Set by the owning driver, on the device; should not be touched by other clients. Property is inherited from the device by its entities and endpoints.

New for CoreMIDI 1.1.

Feedback, Comments & Corrections

MidiObjectMBS.kMIDIPropertyDriverVersion as CFStringMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method MIDI MBS MacCF Plugin 3.1 Yes No No Yes, macOS only No
Function: One of the properties for MIDI on Mac OS X.
Notes:
Only available after you called the Init Method.

device/entity/endpoint property, integer, returns the driver version API of the owning driver (only for driver-owned devices). Drivers need not set this property; applications should not write to it.

New for CoreMIDI 1.3.

Feedback, Comments & Corrections

MidiObjectMBS.kMIDIPropertyFactoryPatchNameFile as CFStringMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method MIDI MBS MacCF Plugin 3.1 Yes No No Yes, macOS only No
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 factory patch name file.

Added in CoreMIDI 1.1. DEPRECATED as of CoreMIDI 1.3.
Use kMIDIPropertyNameConfiguration instead.

Feedback, Comments & Corrections

MidiObjectMBS.kMIDIPropertyImage as CFStringMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method MIDI MBS MacCF Plugin 3.1 Yes No No Yes, macOS only No
Function: One of the properties for MIDI on Mac OS X.
Notes:
Only available after you called the Init Method.

device property, CFStringRef which is a full POSIX path to a device or external device's icon, stored in any standard graphic file format such as JPEG, GIF, PNG and TIFF are all acceptable. (See CFURL for functions to convert between POSIX paths and other ways of specifying files.) The image's maximum size should be 128x128.

Drivers should set the icon on the devices they add.
A studio setup editor should allow the user to choose icons for external devices.

New for CoreMIDI 1.3.

Feedback, Comments & Corrections

MidiObjectMBS.kMIDIPropertyIsBroadcast as CFStringMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method MIDI MBS MacCF Plugin 3.1 Yes No No Yes, macOS only No
Function: One of the properties for MIDI on Mac OS X.
Notes:
Only available after you called the Init Method.
entity/endpoint property, integer
1 if the endpoint broadcasts messages to all of the other endpoints in the device, 0 if not. Set by the owning driver; should not be touched by other clients.
New for CoreMIDI 1.3.

Feedback, Comments & Corrections

MidiObjectMBS.kMIDIPropertyIsDrumMachine as CFStringMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method MIDI MBS MacCF Plugin 3.1 Yes No No Yes, macOS only No
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

Feedback, Comments & Corrections

MidiObjectMBS.kMIDIPropertyIsEffectUnit as CFStringMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method MIDI MBS MacCF Plugin 3.1 Yes No No Yes, macOS only No
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

Feedback, Comments & Corrections

MidiObjectMBS.kMIDIPropertyIsEmbeddedEntity as CFStringMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method MIDI MBS MacCF Plugin 3.1 Yes No No Yes, macOS only No
Function: One of the properties for MIDI on Mac OS X.
Notes:
Only available after you called the Init Method.

entity/endpoint property, integer
0 if there are external MIDI connectors, 1 if not.
New for CoreMIDI 1.1.

Feedback, Comments & Corrections

MidiObjectMBS.kMIDIPropertyIsMixer as CFStringMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method MIDI MBS MacCF Plugin 3.1 Yes No No Yes, macOS only No
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

Feedback, Comments & Corrections

MidiObjectMBS.kMIDIPropertyIsSampler as CFStringMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method MIDI MBS MacCF Plugin 3.1 Yes No No Yes, macOS only No
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

Feedback, Comments & Corrections

MidiObjectMBS.kMIDIPropertyManufacturer as CFStringMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method MIDI MBS MacCF Plugin 3.1 Yes No No Yes, macOS only No
Function: One of the properties for MIDI on Mac OS X.
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:
Only available after you called the Init Method.

device/endpoint property, string
Drivers should set this property on their devices.
Setup editors may allow the user to set this property on external devices.
Creators of virtual endpoints may set this property on their endpoints.

Feedback, Comments & Corrections

MidiObjectMBS.kMIDIPropertyMaxReceiveChannels as CFStringMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method MIDI MBS MacCF Plugin 3.1 Yes No No Yes, macOS only No
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-16

Feedback, Comments & Corrections

MidiObjectMBS.kMIDIPropertyMaxSysExSpeed as CFStringMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method MIDI MBS MacCF Plugin 3.1 Yes No No Yes, macOS only No
Function: One of the properties for MIDI on Mac OS X.
Notes:
Only available after you called the Init Method.
device/entity/endpoint property, integer
Set by the owning driver; should not be touched by other clients.
maximum bytes/second of sysex messages sent to it
(default is 3125, as with MIDI 1.0)

Feedback, Comments & Corrections

MidiObjectMBS.kMIDIPropertyMaxTransmitChannels as CFStringMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method MIDI MBS MacCF Plugin 3.1 Yes No No Yes, macOS only No
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-16

Feedback, Comments & Corrections

MidiObjectMBS.kMIDIPropertyModel as CFStringMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method MIDI MBS MacCF Plugin 3.1 Yes No No Yes, macOS only No
Function: One of the properties for MIDI on Mac OS X.
Notes:
Only available after you called the Init Method.

device/endpoint property, string
Drivers should set this property on their devices.
Setup editors may allow the user to set this property on external devices.
Creators of virtual endpoints may set this property on their endpoints.

Feedback, Comments & Corrections

MidiObjectMBS.kMIDIPropertyName as CFStringMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method MIDI MBS MacCF Plugin 3.1 Yes No No Yes, macOS only No
Function: One of the properties for MIDI on Mac OS X.
Example:
// init midi
dim m as new MidiClientMBS
m.Init NewCFStringMBS("TestApp")

// create a source
dim name as CFStringMBS = NewCFStringMBS("TestSource")
dim source as MidiEndpointMBS = m.CreateSource(name)

// query name property
dim s as CFStringMBS = source.StringProperty(source.kMIDIPropertyName)
MsgBox "Name: "+s.str
Notes:
Only available after you called the Init Method.

device/entity/endpoint property, string
Devices, entities, and endpoints may all have names. The recommended way to display an endpoint's name is to ask for the endpoint name, and display only that name if it is unique. If it is non-unique, prepend the device name.
A setup editor may allow the user to set the names of both driver-owned and external devices.

Feedback, Comments & Corrections

MidiObjectMBS.kMIDIPropertyNameConfiguration as CFStringMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method MIDI MBS MacCF Plugin 3.1 Yes No No Yes, macOS only No
Function: One of the properties for MIDI on Mac OS X.
Notes:
Only available after you called the Init Method.

device/entity/endpoint property, CFDictionary

This specifies the device's current patch, note and control name values using the MIDINameDocument XML format. This specification requires the use of higher-level, OS-specific constructs outside of the specification, to fully define the current names for a device.

The MIDINameConfiguration property is implementated as a CFDictionary:

key "master" maps to a CFDataRef containing an AliasHandle referring to the device's master name document.

key "banks" maps to a CFDictionaryRef. This dictionary's keys are CFStringRef names of patchBank elements in the master document, and its values are each a CFDictionaryRef: key "file" maps to a CFDataRef containing an AliasHandle to a document containing patches that override those in the master document, and key "patchNameList" maps to a CFStringRef which is the name of the patchNameList element in the overriding document.

key "currentModes" maps to a 16-element CFArrayRef, each element of which is a CFStringRef of the name of the current mode for each of the 16 MIDI channels.

Clients setting this property must take particular care to preserve dictionary values other than the ones they are interested in changing, and to properly structure the dictionary.

New for CoreMIDI 1.3.

Feedback, Comments & Corrections

MidiObjectMBS.kMIDIPropertyOffline as CFStringMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method MIDI MBS MacCF Plugin 3.1 Yes No No Yes, macOS only No
Function: One of the properties for MIDI on Mac OS X.
Notes:
Only available after you called the Init Method.

device/entity/endpoint property, integer

1 = device is offline (is temporarily absent), 0 = present
Set by the owning driver, on the device; should not be touched by other clients. Property is inherited from the device by its entities and endpoints.

New for CoreMIDI 1.1.

Feedback, Comments & Corrections

MidiObjectMBS.kMIDIPropertyPanDisruptsStereo as CFStringMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method MIDI MBS MacCF Plugin 3.1 Yes No No Yes, macOS only No
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

Feedback, Comments & Corrections

MidiObjectMBS.kMIDIPropertyPrivate as CFStringMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method MIDI MBS MacCF Plugin 3.1 Yes No No Yes, macOS only No
Function: One of the properties for MIDI on Mac OS X.
Notes:
Only available after you called the Init Method.

device/entity/endpoint property, integer

1 = endpoint is private, hidden from other clients.
May be set on a device or entity, but they will still appear in the API; only
affects whether the owned endpoints are hidden.

New for CoreMIDI 1.3.

Feedback, Comments & Corrections

MidiObjectMBS.kMIDIPropertyReceiveChannels as CFStringMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method MIDI MBS MacCF Plugin 3.1 Yes No No Yes, macOS only No
Function: One of the properties for MIDI on Mac OS X.
Notes:
Only available after you called the Init Method.
endpoint property, integer
The value is a bitmap of channels on which the object receives, (1<<0)=ch 1...(1<<15)=ch 16.
Drivers may set this property on their entities or endpoints.
Setup editors may allow the user to set this property on external endpoints.
Virtual destination may set this property on their endpoints.

Feedback, Comments & Corrections

MidiObjectMBS.kMIDIPropertyReceivesBankSelectLSB as CFStringMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method MIDI MBS MacCF Plugin 3.1 Yes No No Yes, macOS only No
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

Feedback, Comments & Corrections

MidiObjectMBS.kMIDIPropertyReceivesBankSelectMSB as CFStringMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method MIDI MBS MacCF Plugin 3.1 Yes No No Yes, macOS only No
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

Feedback, Comments & Corrections

MidiObjectMBS.kMIDIPropertyReceivesClock as CFStringMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method MIDI MBS MacCF Plugin 3.1 Yes No No Yes, macOS only No
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

Feedback, Comments & Corrections

MidiObjectMBS.kMIDIPropertyReceivesMTC as CFStringMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method MIDI MBS MacCF Plugin 3.1 Yes No No Yes, macOS only No
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

Feedback, Comments & Corrections

Next items

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




Links
MBS Xojo Plugins