aes70 1.3.8 → 1.4.0

package/src/controller/ControlClasses/OcaMediaTransportNetwork.d.ts

@@ -1,53 +1,52 @@
-import { RemoteDevice } from '../remote_device';
-import { OcaApplicationNetwork } from './OcaApplicationNetwork';
-import { Event } from '../event';
-import { Arguments } from '../arguments';
-
-import { PropertyEvent } from '../property_event';
 import { IOcaMediaCoding } from '../../types/OcaMediaCoding';
 import { IOcaMediaConnection } from '../../types/OcaMediaConnection';
 import { IOcaMediaConnectorCommand } from '../../types/OcaMediaConnectorCommand';
 import { IOcaMediaConnectorState } from '../../types/OcaMediaConnectorState';
-import { IOcaMediaConnectorStatus } from '../../types/OcaMediaConnectorStatus';
-import { IOcaMediaSinkConnector } from '../../types/OcaMediaSinkConnector';
-import { IOcaMediaSourceConnector } from '../../types/OcaMediaSourceConnector';
-import { IOcaPortID } from '../../types/OcaPortID';
-import { OcaMediaConnectorStatus } from '../../types/OcaMediaConnectorStatus';
-import { OcaMediaSinkConnector } from '../../types/OcaMediaSinkConnector';
-import { OcaMediaSourceConnector } from '../../types/OcaMediaSourceConnector';
+import {
+  IOcaMediaConnectorStatus,
+  OcaMediaConnectorStatus,
+} from '../../types/OcaMediaConnectorStatus';
+import {
+  IOcaMediaSinkConnector,
+  OcaMediaSinkConnector,
+} from '../../types/OcaMediaSinkConnector';
+import {
+  IOcaMediaSourceConnector,
+  OcaMediaSourceConnector,
+} from '../../types/OcaMediaSourceConnector';
 import { OcaNetworkMediaProtocol } from '../../types/OcaNetworkMediaProtocol';
 import { OcaPort } from '../../types/OcaPort';
+import { IOcaPortID } from '../../types/OcaPortID';
+import { Arguments } from '../arguments';
+import { Event } from '../event';
+import { PropertyEvent } from '../property_event';
+import { RemoteDevice } from '../remote_device';
+import { OcaApplicationNetwork } from './OcaApplicationNetwork';
 
 /**
- * This was not documented in the OCA standard.
  * @extends OcaApplicationNetwork
  * @class OcaMediaTransportNetwork
  */
 export declare class OcaMediaTransportNetwork extends OcaApplicationNetwork {
   /**
-   * Event indicating that a media source connector has changed. The change type indicates if the connector was added, deleted or changed.
+   * Event indicating that a media source connector has changed. The change type
+   * indicates if the connector was added, deleted or changed.
    * @member OcaMediaTransportNetwork#OnSourceConnectorChanged {Event}
-   * Event indicating that a media source connector has changed. The change
-   * type indicates if the connector was added, deleted or changed.
    */
   OnSourceConnectorChanged: Event;
 
   /**
-   * Event indicating that a media sink connector has changed. The change type indicates if the connector was added, deleted or changed.
+   * Event indicating that a media sink connector has changed. The change type
+   * indicates if the connector was added, deleted or changed.
    * @member OcaMediaTransportNetwork#OnSinkConnectorChanged {Event}
-   * Event indicating that a media sink connector has changed. The change
-   * type indicates if the connector was added, deleted or changed.
    */
   OnSinkConnectorChanged: Event;
 
   /**
    * Event indicating that the status of a source or sink connector has changed.
    * @member OcaMediaTransportNetwork#OnConnectorStatusChanged {Event}
-   * Event indicating that the status of a source or sink connector has
-   * changed.
    */
   OnConnectorStatusChanged: Event;
-
   /**
    * This event is emitted whenever Protocol changes.
    */
@@ -91,7 +90,8 @@ export declare class OcaMediaTransportNetwork extends OcaApplicationNetwork {
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * Gets the network's Protocol property. Return status indicates whether the operation was successful.
+   * Gets the network's Protocol property. Return status indicates whether the
+   * operation was successful.
    *
    * @method OcaMediaTransportNetwork#GetMediaProtocol
    * @returns {Promise<OcaNetworkMediaProtocol>}
@@ -100,19 +100,22 @@ export declare class OcaMediaTransportNetwork extends OcaApplicationNetwork {
   GetMediaProtocol(): Promise<OcaNetworkMediaProtocol>;
 
   /**
-   * Gets the list of ports owned by the MediaTransportNetwork object (representing the source and sink network channels). The return value indicates whether the list was successfully retrieved.
+   * Gets the list of ports owned by the MediaTransportNetwork object
+   * (representing the source and sink network channels). The return value
+   * indicates whether the list was successfully retrieved.
    *
    * @method OcaMediaTransportNetwork#GetPorts
    * @returns {Promise<OcaPort[]>}
-   *   A promise which resolves to a single value of type ``OcaPort[]``.
+   *   A promise which resolves to a single value of type :class:`OcaPort[]`.
    */
   GetPorts(): Promise<OcaPort[]>;
 
   /**
-   * Gets the name of the designated port. The return value indicates whether the name was successfully retrieved.
+   * Gets the name of the designated port. The return value indicates whether
+   * the name was successfully retrieved.
    *
    * @method OcaMediaTransportNetwork#GetPortName
-   * @param {OcaPortID} PortID
+   * @param {IOcaPortID} PortID
    *
    * @returns {Promise<string>}
    *   A promise which resolves to a single value of type ``string``.
@@ -120,11 +123,11 @@ export declare class OcaMediaTransportNetwork extends OcaApplicationNetwork {
   GetPortName(PortID: IOcaPortID): Promise<string>;
 
   /**
-   * Sets the name of the designated port. The return value indicates whether the name was successfully set.
+   * Sets the name of the designated port. The return value indicates whether
+   * the name was successfully set.
    *
    * @method OcaMediaTransportNetwork#SetPortName
-   * @param {OcaPortID} PortID
-   *
+   * @param {IOcaPortID} PortID
    * @param {string} Name
    *
    * @returns {Promise<void>}
@@ -132,7 +135,8 @@ export declare class OcaMediaTransportNetwork extends OcaApplicationNetwork {
   SetPortName(PortID: IOcaPortID, Name: string): Promise<void>;
 
   /**
-   * Gets the maximum number of source connectors this media transport network supports.
+   * Gets the maximum number of source connectors this media transport network
+   * supports.
    *
    * @method OcaMediaTransportNetwork#GetMaxSourceConnectors
    * @returns {Promise<number>}
@@ -141,7 +145,8 @@ export declare class OcaMediaTransportNetwork extends OcaApplicationNetwork {
   GetMaxSourceConnectors(): Promise<number>;
 
   /**
-   * Gets the maximum number of source connectors this media transport network supports.
+   * Gets the maximum number of source connectors this media transport network
+   * supports.
    *
    * @method OcaMediaTransportNetwork#GetMaxSinkConnectors
    * @returns {Promise<number>}
@@ -150,7 +155,8 @@ export declare class OcaMediaTransportNetwork extends OcaApplicationNetwork {
   GetMaxSinkConnectors(): Promise<number>;
 
   /**
-   * Gets the maximum number of ports per pin this media transport network supports.
+   * Gets the maximum number of ports per pin this media transport network
+   * supports.
    *
    * @method OcaMediaTransportNetwork#GetMaxPinsPerConnector
    * @returns {Promise<number>}
@@ -159,7 +165,8 @@ export declare class OcaMediaTransportNetwork extends OcaApplicationNetwork {
   GetMaxPinsPerConnector(): Promise<number>;
 
   /**
-   * Gets the maximum number of pins (channels) per connector this media transport network supports.
+   * Gets the maximum number of pins (channels) per connector this media
+   * transport network supports.
    *
    * @method OcaMediaTransportNetwork#GetMaxPortsPerPin
    * @returns {Promise<number>}
@@ -168,16 +175,18 @@ export declare class OcaMediaTransportNetwork extends OcaApplicationNetwork {
   GetMaxPortsPerPin(): Promise<number>;
 
   /**
-   * Gets the descriptors of all the source (output) connectors collected by this network object. Return status indicates success of the operation.
+   * Gets the descriptors of all the source (output) connectors collected by
+   * this network object. Return status indicates success of the operation.
    *
    * @method OcaMediaTransportNetwork#GetSourceConnectors
    * @returns {Promise<OcaMediaSourceConnector[]>}
-   *   A promise which resolves to a single value of type ``OcaMediaSourceConnector[]``.
+   *   A promise which resolves to a single value of type :class:`OcaMediaSourceConnector[]`.
    */
   GetSourceConnectors(): Promise<OcaMediaSourceConnector[]>;
 
   /**
-   * Retrieves the descriptor of a given source connector. Return status indicates the success of the operation.
+   * Retrieves the descriptor of a given source connector. Return status
+   * indicates the success of the operation.
    *
    * @method OcaMediaTransportNetwork#GetSourceConnector
    * @param {number} ID
@@ -188,16 +197,18 @@ export declare class OcaMediaTransportNetwork extends OcaApplicationNetwork {
   GetSourceConnector(ID: number): Promise<OcaMediaSourceConnector>;
 
   /**
-   * Gets the descriptors of all the sink (output) connectors collected by this network object. Return status indicates success of the operation.
+   * Gets the descriptors of all the sink (output) connectors collected by this
+   * network object. Return status indicates success of the operation.
    *
    * @method OcaMediaTransportNetwork#GetSinkConnectors
    * @returns {Promise<OcaMediaSinkConnector[]>}
-   *   A promise which resolves to a single value of type ``OcaMediaSinkConnector[]``.
+   *   A promise which resolves to a single value of type :class:`OcaMediaSinkConnector[]`.
    */
   GetSinkConnectors(): Promise<OcaMediaSinkConnector[]>;
 
   /**
-   * Retrieves the descriptor of a given sink connector. Return status indicates the success of the operation.
+   * Retrieves the descriptor of a given sink connector. Return status indicates
+   * the success of the operation.
    *
    * @method OcaMediaTransportNetwork#GetSinkConnector
    * @param {number} ID
@@ -208,16 +219,18 @@ export declare class OcaMediaTransportNetwork extends OcaApplicationNetwork {
   GetSinkConnector(ID: number): Promise<OcaMediaSinkConnector>;
 
   /**
-   * Gets the status of all the source and sink connectors collected by this network object. Return status indicates success of the operation.
+   * Gets the status of all the source and sink connectors collected by this
+   * network object. Return status indicates success of the operation.
    *
    * @method OcaMediaTransportNetwork#GetConnectorsStatuses
    * @returns {Promise<OcaMediaConnectorStatus[]>}
-   *   A promise which resolves to a single value of type ``OcaMediaConnectorStatus[]``.
+   *   A promise which resolves to a single value of type :class:`OcaMediaConnectorStatus[]`.
    */
   GetConnectorsStatuses(): Promise<OcaMediaConnectorStatus[]>;
 
   /**
-   * Gets the status of a single connector. Return status indicates success of the operation.
+   * Gets the status of a single connector. Return status indicates success of
+   * the operation.
    *
    * @method OcaMediaTransportNetwork#GetConnectorStatus
    * @param {number} ConnectorID
@@ -228,12 +241,16 @@ export declare class OcaMediaTransportNetwork extends OcaApplicationNetwork {
   GetConnectorStatus(ConnectorID: number): Promise<OcaMediaConnectorStatus>;
 
   /**
-   * Adds a source connector to this network. Parameters of the new connector are given in the Connector parameter; device returns the same parameter with the new connector ID filled in. If the new connector's AlignmentLevel property value is given as NaN, the value of this network's AlignmentLevel property will be used. Return status indicates the success of the operation.
+   * Adds a source connector to this network. Parameters of the new connector
+   * are given in the Connector parameter; device returns the same parameter
+   * with the new connector ID filled in. If the new connector's AlignmentLevel
+   * property value is given as NaN, the value of this network's AlignmentLevel
+   * property will be used. Return status indicates the success of the
+   * operation.
    *
    * @method OcaMediaTransportNetwork#AddSourceConnector
-   * @param {OcaMediaSourceConnector} Connector
-   *
-   * @param {OcaMediaConnectorState} InitialStatus
+   * @param {IOcaMediaSourceConnector} Connector
+   * @param {IOcaMediaConnectorState} InitialStatus
    *
    * @returns {Promise<OcaMediaSourceConnector>}
    *   A promise which resolves to a single value of type :class:`OcaMediaSourceConnector`.
@@ -244,12 +261,17 @@ export declare class OcaMediaTransportNetwork extends OcaApplicationNetwork {
   ): Promise<OcaMediaSourceConnector>;
 
   /**
-   * Adds a sinkconnector to this network. Parameters of the new connector are given in the Connector parameter; device returns the same parameter with the new connector ID filled in. If the new connector's AlignmentLevel property value is given as NaN, the value of this network's AlignmentLevel property will be used. If the new connector's AlignmentGain property value is given as NaN, the value of this network's AlignmentGain property will be used. Return status indicates the success of the operation.
+   * Adds a sinkconnector to this network. Parameters of the new connector are
+   * given in the Connector parameter; device returns the same parameter with
+   * the new connector ID filled in. If the new connector's AlignmentLevel
+   * property value is given as NaN, the value of this network's AlignmentLevel
+   * property will be used. If the new connector's AlignmentGain property value
+   * is given as NaN, the value of this network's AlignmentGain property will be
+   * used. Return status indicates the success of the operation.
    *
    * @method OcaMediaTransportNetwork#AddSinkConnector
-   * @param {OcaMediaConnectorStatus} InitialStatus
-   *
-   * @param {OcaMediaSinkConnector} Connector
+   * @param {IOcaMediaConnectorStatus} InitialStatus
+   * @param {IOcaMediaSinkConnector} Connector
    *
    * @returns {Promise<OcaMediaSinkConnector>}
    *   A promise which resolves to a single value of type :class:`OcaMediaSinkConnector`.
@@ -260,12 +282,12 @@ export declare class OcaMediaTransportNetwork extends OcaApplicationNetwork {
   ): Promise<OcaMediaSinkConnector>;
 
   /**
-   * Change the state of a given connector. Return status indicates the success of the operation.
+   * Change the state of a given connector. Return status indicates the success
+   * of the operation.
    *
    * @method OcaMediaTransportNetwork#ControlConnector
    * @param {number} ConnectorID
-   *
-   * @param {OcaMediaConnectorCommand} Command
+   * @param {IOcaMediaConnectorCommand} Command
    *
    * @returns {Promise<void>}
    */
@@ -275,12 +297,12 @@ export declare class OcaMediaTransportNetwork extends OcaApplicationNetwork {
   ): Promise<void>;
 
   /**
-   * Sets a source connector's channel pin map. Return status indicates the success of the operation.
+   * Sets a source connector's channel pin map. Return status indicates the
+   * success of the operation.
    *
    * @method OcaMediaTransportNetwork#SetSourceConnectorPinMap
    * @param {number} ConnectorID
-   *
-   * @param {Map<number, OcaPortID>} ChannelPinMap
+   * @param {Map<number, IOcaPortID>} ChannelPinMap
    *
    * @returns {Promise<void>}
    */
@@ -290,12 +312,12 @@ export declare class OcaMediaTransportNetwork extends OcaApplicationNetwork {
   ): Promise<void>;
 
   /**
-   * Sets a sink connector's channel pin map. Return status indicates the success of the operation.
+   * Sets a sink connector's channel pin map. Return status indicates the
+   * success of the operation.
    *
    * @method OcaMediaTransportNetwork#SetSinkConnectorPinMap
    * @param {number} ConnectorID
-   *
-   * @param {Map<number, OcaPortID[]>} ChannelPinMap
+   * @param {Map<number, IOcaPortID[]>} ChannelPinMap
    *
    * @returns {Promise<void>}
    */
@@ -305,12 +327,12 @@ export declare class OcaMediaTransportNetwork extends OcaApplicationNetwork {
   ): Promise<void>;
 
   /**
-   * Sets a connector's  **Connection** property. Return status indicates the success of the operation.
+   * Sets a connector's **Connection** property. Return status indicates the
+   * success of the operation.
    *
    * @method OcaMediaTransportNetwork#SetConnectorConnection
    * @param {number} ConnectorID
-   *
-   * @param {OcaMediaConnection} Connection
+   * @param {IOcaMediaConnection} Connection
    *
    * @returns {Promise<void>}
    */
@@ -320,12 +342,12 @@ export declare class OcaMediaTransportNetwork extends OcaApplicationNetwork {
   ): Promise<void>;
 
   /**
-   * Sets the Coding field of the connection descriptor of the referenced connector. Return status indicates the success of the operation.
+   * Sets the Coding field of the connection descriptor of the referenced
+   * connector. Return status indicates the success of the operation.
    *
    * @method OcaMediaTransportNetwork#SetConnectorCoding
    * @param {number} ConnectorID
-   *
-   * @param {OcaMediaCoding} Coding
+   * @param {IOcaMediaCoding} Coding
    *
    * @returns {Promise<void>}
    */
@@ -335,11 +357,13 @@ export declare class OcaMediaTransportNetwork extends OcaApplicationNetwork {
   ): Promise<void>;
 
   /**
-   * Sets the Alignment Level field of a connector. Value must be between the min and max values of the AlignmentLevel property of this network. A value of NaN will cause the current value of this network's AlignmentLevel property to be used. Return status indicates the success of the operation.
+   * Sets the Alignment Level field of a connector. Value must be between the
+   * min and max values of the AlignmentLevel property of this network. A value
+   * of NaN will cause the current value of this network's AlignmentLevel
+   * property to be used. Return status indicates the success of the operation.
    *
    * @method OcaMediaTransportNetwork#SetConnectorAlignmentLevel
    * @param {number} ConnectorID
-   *
    * @param {number} Level
    *
    * @returns {Promise<void>}
@@ -347,11 +371,15 @@ export declare class OcaMediaTransportNetwork extends OcaApplicationNetwork {
   SetConnectorAlignmentLevel(ConnectorID: number, Level: number): Promise<void>;
 
   /**
-   * For OcaMediaSinkConnectors only (not source). Sets the Alignment Gain field of the connection descriptor of the referenced connector. Value must be between the min and max values of the AlignmentGain property of this network. A value of NaN will cause the current value of the network's AlignmentGain property to be used. Return status indicates the success of the operation.
+   * For OcaMediaSinkConnectors only (not source). Sets the Alignment Gain field
+   * of the connection descriptor of the referenced connector. Value must be
+   * between the min and max values of the AlignmentGain property of this
+   * network. A value of NaN will cause the current value of the network's
+   * AlignmentGain property to be used. Return status indicates the success of
+   * the operation.
    *
    * @method OcaMediaTransportNetwork#SetConnectorAlignmentGain
    * @param {number} ConnectorID
-   *
    * @param {number} Gain
    *
    * @returns {Promise<void>}
@@ -359,7 +387,8 @@ export declare class OcaMediaTransportNetwork extends OcaApplicationNetwork {
   SetConnectorAlignmentGain(ConnectorID: number, Gain: number): Promise<void>;
 
   /**
-   * Deletes a connector from this network. Return status indicates the success of the operation.
+   * Deletes a connector from this network. Return status indicates the success
+   * of the operation.
    *
    * @method OcaMediaTransportNetwork#DeleteConnector
    * @param {number} ID
@@ -369,7 +398,9 @@ export declare class OcaMediaTransportNetwork extends OcaApplicationNetwork {
   DeleteConnector(ID: number): Promise<void>;
 
   /**
-   * Gets the default, min, and max alignment levels for OcaMedia{Source|Sink}Connectors attached to this network. Return status indicates success of the operation.
+   * Gets the default, min, and max alignment levels for
+   * OcaMedia{Source|Sink}Connectors attached to this network. Return status
+   * indicates success of the operation.
    * The return values of this method are
    *
    * - Level of type ``number``
@@ -382,7 +413,8 @@ export declare class OcaMediaTransportNetwork extends OcaApplicationNetwork {
   GetAlignmentLevel(): Promise<Arguments<[number, number, number]>>;
 
   /**
-   * Gets the default, min, and max alignment gains for OcaMediaSinkConnectors attached to this network. Return status indicates success of the operation.
+   * Gets the default, min, and max alignment gains for OcaMediaSinkConnectors
+   * attached to this network. Return status indicates success of the operation.
    * The return values of this method are
    *
    * - Gain of type ``number``