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

General

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

Changes

Version 1.0

Initial schema definition.

Identifier

The identifier of this schema is com.lawo.emberplus.aes3in.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: Src
   Type: BOOLEAN
   Access: Read Only or Read / Write
   If this parameter is set to true sample rate conversion is performed on the input stream.
   If this parameter is set to false no sample rate conversion is performed on the input stream.

2. Name: Mute
   Type: BOOLEAN
   Access: Read Only or Read / Write
   If this parameter is set to true the input is muted and all incoming audio data is discarded.
   If this parameter is set to false the incoming data must be handled according to the specification and the settings of other parameters described in this schema and supported by the underlying hardware.

In addition an Ember+ node that implements this schema MAY contain a subset of the following parameters, if the underlying hardware supports them:

1. Name: Locked
   Type: BOOLEAN
   Access: Read Only
   If this parameter is set to true this input is locked to an AES3 data stream.
   If this parameter is set to false this input is not locked to an AES3 data stream.

2. Name: Consumer
   Type: BOOLEAN
   Access: Read Only
   If this parameter is set to true the consumer flag is set in the AES3 data stream.
   If this parameter is set to false the consumer flag is not set in the AES3 data stream. Please note that value of this parameter has no meaning, if the Locked parameter is available and it indicates the input is not currently locked to an AES3 data stream.

3. Name: IgnoreValid
   Type: BOOLEAN
   Access: Read / Write
   If this parameter is set to true the validity (V) bit in AES3 subframes is ignored and all data is considered a valid audio stream.
   If this parameter is set to false the validity (V) bit in AES3 subframe must be handled according to the specification.

Notes

If the underlying hardware does not support controlling any of the parameters that must be included according to this schema definition, the corresponding parameter must be declared Read Only and set to the value that corresponds to the behavior of the underlying hardware.