aes70/src/controller/ControlClasses/OcaGain.js

A controller library for the AES70 protocol.

import { OcaFloat32 } from '../../OCP1/OcaFloat32.js';
import { make_control_class } from '../make_control_class.js';
import { OcaActuator } from './OcaActuator.js';

/**
 * Gain (or attenuation) element.
 * @extends OcaActuator
 * @class OcaGain
 */
export const OcaGain = make_control_class(
  'OcaGain',
  4,
  '\u0001\u0001\u0001\u0005',
  3,
  OcaActuator,
  [
    ['GetGain', 4, 1, [], [OcaFloat32, OcaFloat32, OcaFloat32]],
    ['SetGain', 4, 2, [OcaFloat32], []],
  ],
  [['Gain', [OcaFloat32], 4, 1, false, false, null]],
  []
);

/**
 * Gets the value and limits of the **Gain** property.
 * The return values of this method are
 *
 * - Gain of type ``number``
 * - minGain of type ``number``
 * - maxGain of type ``number``
 *
 * @method OcaGain#GetGain
 * @returns {Promise<Arguments<number,number,number>>}
 */
/**
 * Sets the value of the **Gain** property.
 *
 * @method OcaGain#SetGain
 * @param {number} Gain
 *
 * @returns {Promise<void>}
 */
/**
 * This event is emitted when the property ``Gain`` changes in the remote object.
 * The property ``Gain`` is described in the AES70 standard as follows.
 * Gain in dB.
 *
 * @member {PropertyEvent<number>} OcaGain#OnGainChanged
 */