Platforms to show: All Mac Windows Linux Cross-Platform
Back to CoreAudioMBS class.
CoreAudioMBS.AudioDeviceGetPropertyCFString(AudioDeviceID as Integer, channel as Integer, isinput as boolean, propertyID as string) as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Audio | MBS MacOSX Plugin | 10.2 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Lasterror is set.
The property you query must be one of the CFString properties.
CoreAudioMBS.AudioDeviceGetPropertyInfo(AudioDeviceID as Integer, channel as Integer, isinput as boolean, propertyID as string, byref size as Integer, byref writeable as boolean)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Audio | MBS MacOSX Plugin | 4.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Lasterror is set.
CoreAudioMBS.AudioDeviceGetPropertyMemory(AudioDeviceID as Integer, channel as Integer, isinput as boolean, propertyID as string) as memoryblock
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Audio | MBS MacOSX Plugin | 4.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Lasterror is set.
Some examples using this method:
CoreAudioMBS.AudioDeviceGetPropertyString(AudioDeviceID as Integer, channel as Integer, isinput as boolean, propertyID as string) as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Audio | MBS MacOSX Plugin | 4.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Lasterror is set.
Some examples using this method:
CoreAudioMBS.AudioDeviceSetPropertyMemory(AudioDeviceID as Integer, when as memoryblock, channel as Integer, isinput as boolean, propertyID as string, data as memoryblock, offset as Integer, length as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Audio | MBS MacOSX Plugin | 4.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Lasterror is set.
CoreAudioMBS.AudioDeviceSetPropertyString(AudioDeviceID as Integer, when as memoryblock, channel as Integer, isinput as boolean, propertyID as string, data as string)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Audio | MBS MacOSX Plugin | 4.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Lasterror is set.
CoreAudioMBS.AudioHardwareGetPropertyCFString(propertyID as string) as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Audio | MBS MacOSX Plugin | 10.2 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Lasterror is set.
The property you query must be one of the CFString properties.
CoreAudioMBS.AudioHardwareGetPropertyInfo(propertyID as string, byref size as Integer, byref writeable as boolean)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Audio | MBS MacOSX Plugin | 4.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Lasterror is set.
Some examples using this method:
CoreAudioMBS.AudioHardwareGetPropertyMemory(propertyID as string) as memoryblock
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Audio | MBS MacOSX Plugin | 4.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Lasterror is set.
Some examples using this method:
CoreAudioMBS.AudioHardwareGetPropertyString(propertyID as string) as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Audio | MBS MacOSX Plugin | 4.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Lasterror is set.
CoreAudioMBS.AudioHardwareSetPropertyMemory(propertyID as string, data as memoryblock, offset as Integer, length as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Audio | MBS MacOSX Plugin | 4.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Lasterror is set.
CoreAudioMBS.AudioHardwareSetPropertyString(propertyID as string, data as string)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Audio | MBS MacOSX Plugin | 4.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Lasterror is set.
CoreAudioMBS.AudioObjectGetPropertyData(inObjectID as Integer, AddressSelector as UInt32, AddressScope as UInt32, AddressElement as UInt32, QualifierData as memoryblock = nil, InputData as Memoryblock = nil) as memoryblock
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Audio | MBS MacOSX Plugin | 14.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
The plugin queries size and creates a buffer for the result.
inObjectID: The AudioObject to query.
AddressSelector, AddressScope or AddressElement: An audio object property address indicating which property is being queried.
QualifierData: A buffer of data to be used in determining the data of the property being queried. Note that not all properties require qualification, in which case this value will be nil.
If InputData is nil, we query size and allocate buffer of required size.
If InputData is not nil, we use this memoryblock with its size. Result is InputData on success.
Lasterror is set.
CoreAudioMBS.AudioObjectGetPropertyDataSize(inObjectID as Integer, AddressSelector as UInt32, AddressScope as UInt32, AddressElement as UInt32, QualifierData as memoryblock = nil) as UInt32
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Audio | MBS MacOSX Plugin | 14.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
inObjectID: The AudioObject to query.
AddressSelector, AddressScope or AddressElement: An audio object property address indicating which property is being queried.
QualifierData: A buffer of data to be used in determining the data of the property being queried. Note that not all properties require qualification, in which case this value will be nil.
Returns an UInt32 indicating how many bytes the data for the given property occupies.
Lasterror is set.
CoreAudioMBS.AudioObjectSetPropertyData(inObjectID as Integer, AddressSelector as UInt32, AddressScope as UInt32, AddressElement as UInt32, Data as Memoryblock, QualifierData as memoryblock = nil)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Audio | MBS MacOSX Plugin | 14.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
inObjectID: The AudioObject to query.
AddressSelector, AddressScope or AddressElement: An audio object property address indicating which property is being queried.
QualifierData: A buffer of data to be used in determining the data of the property being queried. Note that not all properties require qualification, in which case this value will be nil.
Lasterror is set.
CoreAudioMBS.AudioOutputUnitStart(componenthandle as Integer) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Audio | MBS MacOSX Plugin | 4.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Errorcode is returned.
CoreAudioMBS.AudioOutputUnitStop(componenthandle as Integer) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Audio | MBS MacOSX Plugin | 4.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Errorcode is returned.
CoreAudioMBS.AudioStreamGetPropertyCFString(AudioStreamID as Integer, channel as Integer, propertyID as string) as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Audio | MBS MacOSX Plugin | 10.2 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Lasterror is set.
The property you query must be one of the CFString properties.
CoreAudioMBS.AudioStreamGetPropertyInfo(AudioStreamID as Integer, channel as Integer, propertyID as string, byref size as Integer, byref writeable as boolean)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Audio | MBS MacOSX Plugin | 4.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Lasterror is set.
CoreAudioMBS.AudioStreamGetPropertyMemory(AudioStreamID as Integer, channel as Integer, propertyID as string) as memoryblock
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Audio | MBS MacOSX Plugin | 4.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Lasterror is set.
CoreAudioMBS.AudioStreamGetPropertyString(AudioStreamID as Integer, channel as Integer, propertyID as string) as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Audio | MBS MacOSX Plugin | 4.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Lasterror is set.
CoreAudioMBS.AudioStreamSetPropertyMemory(AudioStreamID as Integer, when as memoryblock, channel as Integer, propertyID as string, data as memoryblock, offset as Integer, length as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Audio | MBS MacOSX Plugin | 4.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Lasterror is set.
CoreAudioMBS.AudioStreamSetPropertyString(AudioStreamID as Integer, when as memoryblock, channel as Integer, propertyID as string, data as string)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Audio | MBS MacOSX Plugin | 4.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Lasterror is set.
CoreAudioMBS.AudioUnitGetParameter(AudioUnit as Integer, ParameterID as Integer, AudioUnitScope as Integer, AudioUnitElement as Integer) as single
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Audio | MBS MacOSX Plugin | 4.2 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
CoreAudioMBS.AudioUnitGetPropertyCFString(AudioUnit as Integer, propertyID as Integer, AudioUnitScope as Integer, AudioUnitElement as Integer) as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Audio | MBS MacOSX Plugin | 10.2 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Lasterror is set.
Constants for AudioUnitScope:
kAudioUnitScope_Global | = 0 |
kAudioUnitScope_Input | = 1 |
kAudioUnitScope_Output | = 2 |
kAudioUnitScope_Group | = 3 |
kAudioUnitScope_Part | = 4 |
The property you query must be one of the CFString properties.
CoreAudioMBS.AudioUnitGetPropertyInfo(AudioUnit as Integer, propertyID as Integer, AudioUnitScope as Integer, AudioUnitElement as Integer, byref size as Integer, byref writeable as boolean)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Audio | MBS MacOSX Plugin | 4.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Lasterror is set.
Constants for AudioUnitScope:
kAudioUnitScope_Global | = 0 |
kAudioUnitScope_Input | = 1 |
kAudioUnitScope_Output | = 2 |
kAudioUnitScope_Group | = 3 |
kAudioUnitScope_Part | = 4 |
CoreAudioMBS.AudioUnitGetPropertyMemory(AudioUnit as Integer, propertyID as Integer, AudioUnitScope as Integer, AudioUnitElement as Integer) as memoryblock
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Audio | MBS MacOSX Plugin | 4.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Lasterror is set.
Constants for AudioUnitScope:
kAudioUnitScope_Global | = 0 |
kAudioUnitScope_Input | = 1 |
kAudioUnitScope_Output | = 2 |
kAudioUnitScope_Group | = 3 |
kAudioUnitScope_Part | = 4 |
CoreAudioMBS.AudioUnitGetPropertyString(AudioUnit as Integer, propertyID as Integer, AudioUnitScope as Integer, AudioUnitElement as Integer) as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Audio | MBS MacOSX Plugin | 4.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Lasterror is set.
Constants for AudioUnitScope:
kAudioUnitScope_Global | = 0 |
kAudioUnitScope_Input | = 1 |
kAudioUnitScope_Output | = 2 |
kAudioUnitScope_Group | = 3 |
kAudioUnitScope_Part | = 4 |
CoreAudioMBS.AudioUnitInitialize(componenthandle as Integer) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Audio | MBS MacOSX Plugin | 4.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Errorcode is returned.
CoreAudioMBS.AudioUnitReset(componenthandle as Integer, scope as Integer, element as Integer) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Audio | MBS MacOSX Plugin | 4.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Errorcode is returned.
Useful constants:
kAudioUnitScope_Global | = 0 |
kAudioUnitScope_Input | = 1 |
kAudioUnitScope_Output | = 2 |
kAudioUnitScope_Group | = 3 |
kAudioUnitScope_Part | = 4 |
CoreAudioMBS.AudioUnitSetParameter(AudioUnit as Integer, ParameterID as Integer, AudioUnitScope as Integer, AudioUnitElement as Integer, value as single, BufferOffsetInFrames as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Audio | MBS MacOSX Plugin | 4.2 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
CoreAudioMBS.AudioUnitSetPropertyMemory(AudioUnit as Integer, propertyID as Integer, AudioUnitScope as Integer, AudioUnitElement as Integer, data as memoryblock, offset as Integer, length as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Audio | MBS MacOSX Plugin | 4.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Lasterror is set.
Constants for AudioUnitScope:
kAudioUnitScope_Global | = 0 |
kAudioUnitScope_Input | = 1 |
kAudioUnitScope_Output | = 2 |
kAudioUnitScope_Group | = 3 |
kAudioUnitScope_Part | = 4 |
CoreAudioMBS.AudioUnitSetPropertyString(AudioUnit as Integer, propertyID as Integer, AudioUnitScope as Integer, AudioUnitElement as Integer, data as string)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Audio | MBS MacOSX Plugin | 4.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Lasterror is set.
Constants for AudioUnitScope:
kAudioUnitScope_Global | = 0 |
kAudioUnitScope_Input | = 1 |
kAudioUnitScope_Output | = 2 |
kAudioUnitScope_Group | = 3 |
kAudioUnitScope_Part | = 4 |
CoreAudioMBS.AudioUnitUninitialize(componenthandle as Integer) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Audio | MBS MacOSX Plugin | 4.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Errorcode is returned.
CoreAudioMBS.CloseComponent(componenthandle as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Audio | MBS MacOSX Plugin | 4.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Do not use the componenthandle any more after this call!
CoreAudioMBS.OpenDefaultComponent(type as string, subtype as string) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Audio | MBS MacOSX Plugin | 4.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
You can check the "QT Components list" example project for which components are installed.
Returns 0 on any error.
type and subtype must be 4 letter codes.
useful constans:
kAudioUnitComponentType | = "aunt" |
kAudioUnitSubType_Output | = "out " |
kAudioUnitID_HALOutput | = "ahal" |
kAudioUnitID_DefaultOutput | = "def " |
kAudioUnitID_SystemOutput | = "sys " |
kAudioUnitID_GenericOutput | = "genr" |
kAudioUnitSubType_MusicDevice | = "musd" |
kAudioUnitID_DLSSynth | = "dls " |
kAudioUnitSubType_SampleRateConverter | = "srcv" |
kAudioUnitID_PolyphaseSRC | = "poly" |
kAudioUnitSubType_FormatConverter | = "fmtc" |
kAudioUnitID_Interleaver | = "inlv" |
kAudioUnitID_Deinterleaver | = "dnlv" |
kAudioUnitID_AUConverter | = "conv" |
kAudioUnitSubType_Effect | = "efct" |
kAudioUnitID_MatrixReverb | = "mrev" |
kAudioUnitID_Delay | = "dely" |
kAudioUnitID_LowPassFilter | = "lpas" |
kAudioUnitID_HighPassFilter | = "hpas" |
kAudioUnitID_BandPassFilter | = "bpas" |
kAudioUnitID_PeakLimiter | = "lmtr" |
kAudioUnitID_DynamicsProcessor | = "dcmp" |
kAudioUnitSubType_Mixer | = "mixr" |
kAudioUnitID_StereoMixer | = "smxr" |
kAudioUnitID_3DMixer | = "3dmx" |
The items on this page are in the following plugins: MBS MacOSX Plugin.