import { OcaNetworkControlProtocol } from '../../types/OcaNetworkControlProtocol.js'; import { OcaNetworkLinkType } from '../../types/OcaNetworkLinkType.js'; import { OcaNetworkMediaProtocol } from '../../types/OcaNetworkMediaProtocol.js'; import { OcaNetworkStatistics } from '../../types/OcaNetworkStatistics.js'; import { OcaNetworkStatus } from '../../types/OcaNetworkStatus.js'; import { IOcaNetworkSystemInterfaceID, OcaNetworkSystemInterfaceID, } from '../../types/OcaNetworkSystemInterfaceID.js'; import { PropertyEvent } from '../property_event.js'; import { RemoteDevice } from '../remote_device.js'; import { OcaAgent } from './OcaAgent.js'; /** * **DEPRECATED CLASS** *Replaced by class* **OcaControlNetwork ***in version 3 * of Connection Management (CM3)* Abstract base class for defining network * classes to which this device belongs. This class is to be used for control * and monitoring networks only. For media transport networks, and for networks * that combine media transport and control, the **OcaStreamNetwork** class * should be used instead. * @extends OcaAgent * @class OcaNetwork */ export declare class OcaNetwork extends OcaAgent { /** * This event is emitted whenever IDAdvertised changes. */ OnIDAdvertisedChanged: PropertyEvent; /** * This event is emitted whenever ControlProtocol changes. */ OnControlProtocolChanged: PropertyEvent; /** * This event is emitted whenever MediaProtocol changes. */ OnMediaProtocolChanged: PropertyEvent; /** * This event is emitted whenever Status changes. */ OnStatusChanged: PropertyEvent; /** * This event is emitted whenever SystemInterfaces changes. */ OnSystemInterfacesChanged: PropertyEvent; /** * This event is emitted whenever MediaPorts changes. */ OnMediaPortsChanged: PropertyEvent; /** * This event is emitted whenever Statistics changes. */ OnStatisticsChanged: PropertyEvent; constructor(objectNumber: number, device: RemoteDevice); /** * Gets the network's link type (wired Ethernet, USB, etc.). Return status * indicates whether the operation was successful. * * @method OcaNetwork#GetLinkType * @returns {Promise} * A promise which resolves to a single value of type :class:`OcaNetworkLinkType`. */ GetLinkType(): Promise; /** * Gets the network's IDAdvertised. Return status indicates whether the * operation was successful. * * @method OcaNetwork#GetIDAdvertised * @returns {Promise} * A promise which resolves to a single value of type ``Uint8Array``. */ GetIDAdvertised(): Promise; /** * Sets the network's IDAdvertised. Return status indicates whether the * operation was successful. * * @method OcaNetwork#SetIDAdvertised * @param {Uint8Array} Name * * @returns {Promise} */ SetIDAdvertised(Name: Uint8Array): Promise; /** * Gets the network's ControlProtocol property. Return status indicates * whether the operation was successful. * * @method OcaNetwork#GetControlProtocol * @returns {Promise} * A promise which resolves to a single value of type :class:`OcaNetworkControlProtocol`. */ GetControlProtocol(): Promise; /** * Gets the network's MediaProtocol property. This is a deprecated method that * always returns the value NONE. * * @method OcaNetwork#GetMediaProtocol * @returns {Promise} * A promise which resolves to a single value of type :class:`OcaNetworkMediaProtocol`. */ GetMediaProtocol(): Promise; /** * Retrieves the network's status. Return status indicates whether the status * was successfully retrieved. * * @method OcaNetwork#GetStatus * @returns {Promise} * A promise which resolves to a single value of type :class:`OcaNetworkStatus`. */ GetStatus(): Promise; /** * Retrieves network error statistics counter values. Return status indicates * whether the values were successfully retrieved. * * @method OcaNetwork#GetStatistics * @returns {Promise} * A promise which resolves to a single value of type :class:`OcaNetworkStatistics`. */ GetStatistics(): Promise; /** * Resets network error statistics counters. Return status indicates whether * the counters were successfully reset. * * @method OcaNetwork#ResetStatistics * @returns {Promise} */ ResetStatistics(): Promise; /** * Gets the list of system interface IDs that this network is using. Return * status indicates success of the operation. * * @method OcaNetwork#GetSystemInterfaces * @returns {Promise} * A promise which resolves to a single value of type :class:`OcaNetworkSystemInterfaceID[]`. */ GetSystemInterfaces(): Promise; /** * Sets the list of system interface IDs that this network will use. Return * status indicates success of the operation. This method is not implemented * by all network implementations. * * @method OcaNetwork#SetSystemInterfaces * @param {IOcaNetworkSystemInterfaceID[]} Interfaces * * @returns {Promise} */ SetSystemInterfaces( Interfaces: IOcaNetworkSystemInterfaceID[] ): Promise; /** * Deprecated method. Always returns status INVALID_REQUEST. Media transport * is now managed by the class **OcaStreamNetwork.** * * @method OcaNetwork#GetMediaPorts * @returns {Promise} * A promise which resolves to a single value of type ``number[]``. */ GetMediaPorts(): Promise; /** * Start up this network. * * @method OcaNetwork#Startup * @returns {Promise} */ Startup(): Promise; /** * Shut down this network. * * @method OcaNetwork#Shutdown * @returns {Promise} */ Shutdown(): Promise; }