Platforms to show: All Mac Windows Linux Cross-Platform

Back to AVAudioEngineMBS class.

AVAudioEngineMBS.autoShutdownEnabled as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundationNode MBS AVFoundation Plugin 18.4 ✅ Yes ❌ No ❌ No ✅ Yes All
When auto shutdown is enabled, the engine can start and stop the audio hardware dynamically, to conserve power. This is the enforced behavior on watchOS and can be optionally enabled on other platforms.

To conserve power, it is advised that the client pause/stop the engine when not in use.
But when auto shutdown is enabled, the engine will stop the audio hardware if it was running idle for a certain duration, and restart it later when required.
Note that, because this operation is dynamic, it may affect the start times of the source nodes (e.g. AVAudioPlayerNodeMBS), if the engine has to resume from its shutdown state.

On watchOS, auto shutdown is always enabled. On other platforms, it is disabled by default, but the client can enable it if needed.

This property is applicable only when the engine is rendering to/from an audio device. If the value is changed when the engine is in manual rendering mode, it will take effect whenever the engine is switched to render to/from the audio device.

Available on MacOS 10.13 or newer.
(Read and Write property)

AVAudioEngineMBS.Handle as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundationNode MBS AVFoundation Plugin 15.3 ✅ Yes ❌ No ❌ No ✅ Yes All
The internal object reference.

(Read and Write property)

AVAudioEngineMBS.InManualRenderingMode as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundationNode MBS AVFoundation Plugin 18.4 ✅ Yes ❌ No ❌ No ✅ Yes All
Whether or not the engine is operating in manual rendering mode, i.e. not connected to an audio device and rendering in response to the requests from the client.

Manual rendering is currently not supported in MBS Plugins.

Available on MacOS 10.13 or newer.
(Read only property)

AVAudioEngineMBS.inputNode as AVAudioInputNodeMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundationNode MBS AVFoundation Plugin 15.3 ✅ Yes ❌ No ❌ No ✅ Yes All
The audio engine’s singleton input audio node.

The audio engine creates a singleton on demand when inputNode is first accessed. To receive input, connect another audio node from the output of the input audio node, or create a recording tap on it.

The AVAudioSesssion instance and/or the availability of hardware features determine whether an app can perform input. Check the input format of input node (specifically, the hardware format) for a non-zero sample rate and channel count to see if input is enabled.
(Read only property)

AVAudioEngineMBS.mainMixerNode as AVAudioMixerNodeMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundationNode MBS AVFoundation Plugin 15.3 ✅ Yes ❌ No ❌ No ✅ Yes All
The audio engine’s optional singleton main mixer node.

When the property is first accessed the audio engine constructs a singleton main mixer and connects it to the outputNode on demand. You can then connect additional audio nodes to the mixer.

By default, the mixer's output format (sample rate and channel count) will track the format of the output node. It is possible to make the connection explicitly with a different format.
(Read only property)

Some examples using this property:

AVAudioEngineMBS.manualRenderingFormat as AVAudioFormatMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundationNode MBS AVFoundation Plugin 21.0 ✅ Yes ❌ No ❌ No ✅ Yes All
The render format of the engine in manual rendering mode.

(Read only property)

Some examples using this property:

AVAudioEngineMBS.manualRenderingMaximumFrameCount as UInt32

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundationNode MBS AVFoundation Plugin 21.0 ✅ Yes ❌ No ❌ No ✅ Yes All
The maximum number of PCM sample frames the engine can produce in any single render call in manual rendering mode.

If you get this property when the engine isn't in manual rendering mode, it returns zero.
(Read only property)

Some examples using this property:

AVAudioEngineMBS.manualRenderingMode as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundationNode MBS AVFoundation Plugin 21.0 ✅ Yes ❌ No ❌ No ✅ Yes All
The manual rendering mode configured on the engine.

Either ManualRenderingModeOffline or ManualRenderingModeRealtime.
(Read only property)

AVAudioEngineMBS.manualRenderingSampleTime as Int64

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundationNode MBS AVFoundation Plugin 21.0 ✅ Yes ❌ No ❌ No ✅ Yes All
An indication of where the engine is on its render timeline in manual rendering mode.

(Read only property)

Some examples using this property:

AVAudioEngineMBS.outputNode as AVAudioOutputNodeMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundationNode MBS AVFoundation Plugin 15.3 ✅ Yes ❌ No ❌ No ✅ Yes All
The audio engine’s singleton output audio node.

When this property is first accessed the audio engine creates a singleton on demand. Connect another audio node to the input of the output audio node, or obtain a mixer that is connected by default, using the mainMixerNode property.

The AVAudioSesssion instance and/or the availability of hardware features determine whether an app can perform output. Check the output format of output node (specifically, the hardware format) for a non-zero sample rate and channel count to see if output is enabled.
(Read only property)

Some examples using this property:

AVAudioEngineMBS.running as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundationNode MBS AVFoundation Plugin 15.3 ✅ Yes ❌ No ❌ No ✅ Yes All
Returns the audio engine’s running state.

The value is true if the audio engine is running, otherwise, false.
(Read only property)

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


The biggest plugin in space...