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

General

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

Changes

Version 1.0

Initial schema definition.

Identifier

The identifier of this schema is com.lawo.emberplus.aes3out.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 as well as parameters it may contain, if the underlying hardware supports them.

Rules

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

1. Name: Mute
   Type: BOOLEAN
   Access: Read / Write
   A switch indicating whether or not the output is muted.

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

1. Name: ChannelStatusMode
   Type: ENUMERATION
   Access: Read / Write
   This parameter may take one of three values that determine how the channel status data should be populated:
   • 0 - Indicate consumer use of channel status block.
   • 1 - Indicate professional use of channel status block.
   • 2 - Keep the channel status block as is. Please see the Notes section below for further details regarding this setting.

Notes

Even though both parameters, whose presence is mandated by this schema must be writable, it is at the discretion of the provider which values it accepts. This can be used to cater to limited support by the underlying hardware.

The special value 2 for the ChannelStatusMode parameter is intended to be able to pass through incoming AES3 data streams unaltered. If the data stream serving this output provides no means to automatically determine a sensible value for the channel status block the value of 2 for this parameter should be treated as if the parameter was set to 1.