Control Panel — API documentation

About access types

Access types define how a object parameter can be interacted with. This includes whether they can be written, modified, or if they are ephemeral.

Normal

Normal parameters may be set during object creation and modified.

Immutable

Immutable parameters may be set during object creation. They cannot be modified once the object is created.

Attempting to modify a immutable parameter during an update will cause an ACCESS_VIOLATION error.

Autogenerated

Autogenerated parameters are set by the system and may not be configured during object creation. They may not be modified.

Attempting to set an autogenerated parameter during a create or update will cause an ACCESS_VIOLATION error.

Synthetic

Synthetic parameters are not stored, and may not be set at creation or modified. They are auto-generated on each read of the object.

Attempting to set an syntetic parameter during a create or update will cause an ACCESS_VIOLATION error.

Other

Properties with the type of other do not fit into any of the above catagories. Please read the parameter's documentation for information on their behaviour.

Write-only

Write-only properties can be set at create or update time, but cannot be read back. Usually this represents a piece of information that cannot be read back, like the frame size for BIFs. They will be returned only if provided.