Skip to content

Schema Definition: com.lawo.emberplus.microphone.preamp (Version 1)

Kimon Hoffmann edited this page Oct 15, 2018 · 4 revisions

General

This schema is intended to provide a standard way for an Ember+ provider to publish data for microphone preamps.

Changes

Version 1.1

More closely specified the exact meaning of the Gain parameter and added the new parameter EffectiveGain to compensate the newly restricted scope of Gain.

Version 1.0

Initial schema definition.

Identifier

The identifier of this schema is com.lawo.emberplus.microphone.preamp.v<VERSIONMAJOR>.<VERSIONMINOR>
The current major version is: 1
The current minor version is: 1

A consumer implementing this schema may expect that future versions of this schema are backwards compatible to the one it implements if the major version number is unchanged and the minor version number is greater than the one it implements. Changes to the major version number must be considered breaking changes.

Scope

This schema defines the layout of an Ember+ node, defining the parameters it must contain as direct children.

Rules

An Ember+ node that implements this schema MUST contain the following parameters:

  1. Name: Gain
    Type: INTEGER
    Access: Read / Write
    The actual preamp gain without any offsets caused by padding or other factors. If the integral value given here is not a dB representation, the Formula attribute must be specified and contain the formula required to transform the integral value into dB. For easier use by clients it is strongly advised to also specify the Minimum and Maximum attributes.

An Ember+ node that implements this schema MAY contain the following parameters:

  1. Name: Pad
    Type: BOOLEAN
    Access: Read / Write
    Switch to enable or disable padding.

  2. Name: PhantomPower
    Type: BOOLEAN
    Access: Read / Write
    Switch to enable or disable phantom power supply.

  3. Name: LowCutFrequency
    Type: ENUMERATION
    Access: Read / Write
    Description for a choice of low cut filters that can be applied to the microphone preamp. The special enumeration value 0 is reserved for switching off the low cut filter. The actual low cut frequencies are implementation specific and should be provided as a part of the enumeration string names.

  4. Name: EffectiveGain
    Type: INTEGER
    Access: Read Only
    The effective gain currently applied by this preamp including offsets caused by padding or other factors. If the integral value given here is not a dB representation, the Formula attribute must be specified and contain the formula required to transform the integral value into dB.