static
readonly
OcaClassID ClassID
= 1.2.10
Level: 1 Index: 1
This property is an override of the OcaRoot property.
Level: 1 Index: 2
This property is an override of the OcaRoot property.
Level: 3 Index: 3
Type of control protocol used by the network (OCAnn) or NONE if this network is not used for control.
OcaNetworkNodeID
IDAdvertised
Level: 3 Index: 2
ID by which this device is known on the network, i.e. the host name or GUID that this device publishes in the network's directory/discovery system.
Level: 3 Index: 1
Network link type - e.g. wired Ethernet, USB, ... See the OcaNetworkType enum for details. This is a read-only property whose value is fixed to the class that is inherited from OcaNetwork to implement each specific type of network.
Level: 3 Index: 4
Type of media transport protocol used by the network, or NONE if this network is not used for media transport.
Level: 3 Index: 10
List of object numbers of sink OcaNetworkSignalChannel objects collected by this network.
Level: 3 Index: 9
List of object numbers of source OcaNetworkSignalChannel objects collected by this network.
OcaNetworkStatistics
Statistics
Level: 3 Index: 11
Error statistics for this network
OcaNetworkStatus
Status
Level: 3 Index: 5
Operational status of the network.
Level: 3 Index: 8
List of object numbers of sink OcaStreamConnector objects collected by this network.
Level: 3 Index: 7
List of object numbers of source OcaStreamConnector objects collected by this network.
OcaList<OcaNetworkSystemInterfaceID
> SystemInterfaces
Level: 3 Index: 6
Collection of identifiers of system interface(s) used by the network. A "system interface" is the system service through which network traffic passes into and out of the device -- e.g. a socket. The identifier format is system and network dependent; for OCA purposes, it is maintained as a variable-length blob which the protocol does not inspect.
Properties inherited from OcaAgent
Properties inherited from OcaRoot
OcaStreamNetwork::GetLinkType (
)
→ (
OcaNetworkLinkType Type)
Level: 3 Index: 1
Gets the network's link type (wired Ethernet, USB, etc.). Return status indicates whether the operation was successful.
OcaStreamNetwork::GetIDAdvertised (
)
→ (
OcaNetworkNodeID
Name)
Level: 3 Index: 2
Gets the network's IDAdvertised. Return status indicates whether the operation was successful.
OcaStreamNetwork::SetIDAdvertised (
OcaNetworkNodeID
Name )
Level: 3 Index: 3
Sets the network's IDAdvertised. Return status indicates whether the operation was successful.
OcaStreamNetwork::GetControlProtocol (
)
→ (
OcaNetworkControlProtocol Protocol)
Level: 3 Index: 4
Gets the network's ControlProtocol property. Return status indicates whether the operation was successful.
OcaStreamNetwork::GetMediaProtocol (
)
→ (
OcaNetworkMediaProtocol Protocol)
Level: 3 Index: 5
Gets the network's MediaProtocol property. Return status indicates whether the operation was successful.
OcaStreamNetwork::GetStatus (
)
→ (
OcaNetworkStatus
Status)
Level: 3 Index: 6
Retrieves the network's status. Return status indicates whether the status was successfully retrieved.
OcaStreamNetwork::GetStatistics (
)
→ (
OcaNetworkStatistics
Status)
Level: 3 Index: 7
Retrieves network error statistics counter values. Return status indicates whether the values were successfully retrieved.
OcaStreamNetwork::ResetStatistics (
)
Level: 3 Index: 8
Resets network error statistics counters. Return status indicates whether the counters were successfully reset.
OcaStreamNetwork::GetSystemInterfaces (
)
→ (
OcaList<OcaNetworkSystemInterfaceID
> Interfaces)
Level: 3 Index: 9
Gets the list of system interface IDs that this network is using. Return status indicates success of the operation.
OcaStreamNetwork::SetSystemInterfaces (
OcaList<OcaNetworkSystemInterfaceID
> Interfaces )
Level: 3 Index: 10
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.
OcaStreamNetwork::GetStreamConnectorsSource (
)
→ (
OcaList<OcaONo> StreamConnectors)
Level: 3 Index: 11
Gets the list of object numbers of Source OcaStreamConnector objects owned by this network. Return status indicates success of the operation. If the value of the network's MediaProtocol property is NONE, this method will return the status value InvalidRequest.
Members are added to and deleted from this list when OcaStreamConnector objects' Owner properties are updated, or when OcaStreamConnector objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.
OcaStreamNetwork::SetStreamConnectorsSource (
OcaList<OcaONo> StreamConnectors )
Level: 3 Index: 12
Sets the list of object numbers of Source OcaStreamConnector objects owned by this network. Return status indicates success of the operation. If the value of the network's MediaProtocol property is NONE, this method will return the status value InvalidRequest.
Members are added to and deleted from this list when OcaStreamConnector objects' Owner properties are updated, or when OcaStreamConnector objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.
OcaStreamNetwork::GetStreamConnectorsSink (
)
→ (
OcaList<OcaONo> StreamConnectors)
Level: 3 Index: 13
Gets the list of object numbers of Sink OcaStreamConnector objects owned by this network. Return status indicates success of the operation. If the value of the network's MediaProtocol property is NONE, this method will return the status value InvalidRequest.
Members are added to and deleted from this list when OcaStreamConnector objects' Owner properties are updated, or when OcaStreamConnector objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.
OcaStreamNetwork::SetStreamConnectorsSink (
OcaList<OcaONo> StreamConnectors )
Level: 3 Index: 14
Sets the list of object numbers of Sink OcaStreamConnector objects owned by this network. Return status indicates success of the operation. If the value of the network's MediaProtocol property is NONE, this method will return the status value InvalidRequest.
Members are added to and deleted from this list when OcaStreamConnector objects' Owner properties are updated, or when OcaStreamConnector objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.
OcaStreamNetwork::GetSignalChannelsSource (
)
→ (
OcaList<OcaONo> SignalChannels)
Level: 3 Index: 15
Gets the list of object numbers of Source OcaNetworkSignalChannel objects owned by this network. Return status indicates success of the operation. If the value of the network's MediaProtocol property is NONE, this method will return the status value InvalidRequest.
Members are added to and deleted from this list when OcaNetworkSignalChannel objects' Owner properties are updated, or when OcaNetworkSignalChannel objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.
OcaStreamNetwork::SetSignalChannelsSource (
OcaList<OcaONo> SignalChannels )
Level: 3 Index: 16
Sets the list of object numbers of Source OcaNetworkSignalChannel objects owned by this network. Return status indicates success of the operation. If the value of the network's MediaProtocol property is NONE, this method will return the status value InvalidRequest.
Members are added to and deleted from this list when OcaNetworkSignalChannel objects' Owner properties are updated, or when OcaNetworkSignalChannel objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.
OcaStreamNetwork::GetSignalChannelsSink (
)
→ (
OcaList<OcaONo> SignalChannels)
Level: 3 Index: 17
Gets the list of object numbers of Sink OcaNetworkSignalChannel objects owned by this network. Return status indicates success of the operation. If the value of the network's MediaProtocol property is NONE, this method will return the status value InvalidRequest.
Members are added to and deleted from this list when OcaNetworkSignalChannel objects' Owner properties are updated, or when OcaNetworkSignalChannel objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.
OcaStreamNetwork::SetSignalChannelsSink (
OcaList<OcaONo> SignalChannels )
Level: 3 Index: 18
Sets the list of object numbers of Sink OcaNetworkSignalChannel objects owned by this network. Return status indicates success of the operation. If the value of the network's MediaProtocol property is NONE, this method will return the status value InvalidRequest.
Members are added to and deleted from this list when OcaNetworkSignalChannel objects' Owner properties are updated, or when OcaNetworkSignalChannel objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.
OcaStreamNetwork::Startup (
)
Level: 3 Index: 19
Start up this network.
OcaStreamNetwork::Shutdown (
)
Level: 3 Index: 20
Shut down this network.