Skip to content

Schema Definition: com.lawo.emberplus.micline (Version 1)

Kimon Hoffmann edited this page Oct 27, 2015 · 2 revisions

General

This schema is intended to provide a standard way for an Ember+ provider to publish data for analog inputs to which both microphones or line level equipment may be connected.

Changes

Version 1.0

Initial schema definition.

Identifier

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

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 two subnodes:

  1. Name: Microphone
    Schema: com.lawo.emberplus.microphone.preamp
    Major Version: Equal to 1
    Minor Version: Greater than or equal to 1

  2. Name: Line
    Schema: com.lawo.emberplus.linein
    Major Version: Equal to 1
    Minor Version: Greater than or equal to 0

In addition, an Ember+ node that implements this schema MUST contain the following parameters:

  1. Name: LineMode
    Type: BOOLEAN
    Access: Read / Write
    A switch indicating whether this Mic/Line node is currently in line mode (TRUE) or in microphone mode (FALSE).

Notes

The Microphone and Line nodes must be considered separate datasets that will be applied to the hardware according to the current setting of the LineMode parameter. This means that

  • toggling the LineMode parameter must not change any of the (schema defined) parameters in the Microphone or Line nodes.
  • changing any of the (schema defined) parameters in the Microphone or Line nodes, must not cause a change of any of the (schema defined) parameters of the Line or Microphone node respectively.

Effectively this renders toggling the LineMode parameter twice in succession an identity transformation with regard to the initial and resulting Ember+ tree as well as the initial and the resulting state of the hardware.