ControlOut

The ControlOut audio object is a framework level object, that ties directly with the framework’s control system. The purpose is to take control values from an xAF instance (AudioProcessingBase) and make them available externally.

The ControlOut audio object accepts any combination of controls – single or block.

Use Case: This object can be deployed whenever the framework wants to access any control value of a signal flow. The platform may want to access these values from the framework.

ControlOut Properties

Below table provides the details about ControlOut object properties and functionality.

Properties Description
Number of Control Input The number of control Input signals is configurable.

  • Range: 1 to 225
  • By default, the number of control input signals is set to 1.
Display Name Display the name of the ControlOut object in the signal flow design. It can be changed based on the intended usage of the object.

Mode

There are no modes available for the ControlOut object.

Additional Parameters

Parameters Description
Group Sizes This is an additional parameter which is an array with a length equal to NumElements

Each value in this array is the size of the corresponding control.

Example: [1,2] would mean the first control input is a single control, but the second is a block control of size 2.

Graphical user interface, application, Teams Description automatically generated

Tuning Parameters

There are no tuning parameters available for the ControlOut object.

Control Interface

There are no control parameters available to control the functioning of this object.

Native Panel

ControlOut audio object does not support the native panel.