aes70/src/controller/ControlClasses/OcaDelay.d.ts

A controller library for the AES70 protocol.

import { Arguments } from '../arguments';
import { PropertyEvent } from '../property_event';
import { RemoteDevice } from '../remote_device';
import { OcaActuator } from './OcaActuator';

/**
 * Signal delay - basic version.
 * @extends OcaActuator
 * @class OcaDelay
 */
export declare class OcaDelay extends OcaActuator {
  /**
   * This event is emitted whenever DelayTime changes.
   */
  OnDelayTimeChanged: PropertyEvent<number>;

  constructor(objectNumber: number, device: RemoteDevice);

  /**
   * Gets the value of the DelayTime property. The return value indicates
   * whether the property was successfully retrieved.
   * The return values of this method are
   *
   * - Time of type ``number``
   * - minTime of type ``number``
   * - maxTime of type ``number``
   *
   * @method OcaDelay#GetDelayTime
   * @returns {Promise<Arguments<number,number,number>>}
   */
  GetDelayTime(): Promise<Arguments<[number, number, number]>>;

  /**
   * Sets the value of the DelayTime property. The return value indicates
   * whether the property was successfully set.
   *
   * @method OcaDelay#SetDelayTime
   * @param {number} delayTime
   *
   * @returns {Promise<void>}
   */
  SetDelayTime(delayTime: number): Promise<void>;
}