Click or drag to resize

DmXioDirectorBaseDmXioGlobalDomain Class

Global Domain class for the XIO Director
Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpPro.DM.StreamingDmXioDirectorBaseDmXioGlobalDomain

Namespace: Crestron.SimplSharpPro.DM.Streaming
Assembly: Crestron.SimplSharpPro.DM (in Crestron.SimplSharpPro.DM.dll) Version: 2.21.121
Syntax
C#
public class DmXioGlobalDomain : IParentInformation

The DmXioDirectorBaseDmXioGlobalDomain type exposes the following members.

Properties
 NameDescription
Public propertyParent The parent that a DmXioDirectorBaseDmXioGlobalDomain object was added to.
Public propertyRouteByName Property to set the current route using the name of the endpoint. Name is what is reported in the "Endpoints" subslot. If the endpoint is found is the current domain, it will to route to that endpoint. Has the following errors: 1. If the endpoint is not found in the entire director the RouteByNameFeedback property value received shall be: EndpointNameNotFound 2. If duplicate names are found: a. If the name is in the current domain, route to that endpoint and return the name. b. If duplicate names are found outside the current domain the RouteByNameFeedback property value shall be in the format "DuplicateEndpointNamesFound: "routingId1", "routingId2", "routingIdN". Example: Domains 3, 5, and 8 all have an input named "Apple TV". The user routes domain 6, output 2 to the input name "Apple TV". The RouteByNameFeedback property value shall be "DuplicateEndpointNamesFound: D3I2, D5I23, D8I5. 3. If an output is attempted to be routed to a device configured as an output, the following shall be received as the RouteByNameFeedback property value "IncompatibleType: D3O2 is configured as an output"
Public propertyRouteByNameFeedback Property to return the the name of the endpoint using which the current route is set or error message may be received in case of an error. The following error values may be received for this property: 1. If the endpoint is not found in the entire director the RouteByNameFeedback property value received shall be: EndpointNameNotFound 2. If duplicate names are found: a. If the name is in the current domain, route to that endpoint and return the name. b. If duplicate names are found outside the current domain the RouteByNameFeedback property value shall be in the format "DuplicateEndpointNamesFound: "routingId1", "routingId2", "routingIdN". Example: Domains 3, 5, and 8 all have an input named "Apple TV". The user routes domain 6, output 2 to the input name "Apple TV". The RouteByNameFeedback property value shall be "DuplicateEndpointNamesFound: D3I2, D5I23, D8I5. 3. If an output is attempted to be routed to a device configured as an output, the following shall be received as the RouteByNameFeedback property value "IncompatibleType: D3O2 is configured as an output"

This property will trigger GlobalDomainChange event with RouteByNameFeedbackEventId and Index gives the index into the RouteByNameFeedback collection.

Public propertyRouteByRoutingId Property to set the current route using the routing ID of the endpoint. Used for inter-domain routing. Serial values shall start with a "D" followed by the domain number you wish to access, followed by an "I", representing the desired input number. Leading zeros are optional and can be accomodated up to ten places (example: D0000000002I0000000006 is the same as D2I6) D5I8 represents Domain 5, Input 8 The start letters shall be case-insensitive, therefore the system shall accept: "D" or "d" for the domain identifier start letter "I" or "i" for the input identifier start letter Note: the routing ID can also be found on the "Endpoints".
Public propertyRouteByRoutingIdFeedback Property to return the routing ID of the endpoint using which te current route is set. Used for inter-domain routing.

This property will trigger GlobalDomainChange event with RouteByRoutingIdFeedbackEventId and Index gives the index into the RouteByRoutingIdFeedback collection.

Public propertyUserSpecifiedObject Can be assigned anything that user wants.
Public propertyVideoOut Property to set the video route to a transmitter. Note, the three properties below should all update when any of them are changed. Example 1: User sets Domain 4 VideoOut3 to 15. Input 15 is named "Roku". [T:VideoOutFeedback[3].UShortValue] = 15 [T:RouteByRoutingIdFeedback[3].StringValue] = D4I15 [T:RouteByNameFeedback[3].StringValue] = "Roku"
Public propertyVideoOutFeedback Property to report the route that is set to the transmitter.

This property will trigger GlobalDomainChange event with VideoOutFeedbackEventId and Index gives the index into the VideoOutFeedback collection.

Top
Methods
 NameDescription
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Events
 NameDescription
Public eventGlobalDomainChange Event triggered when feedback has been received from the DmXioDirectorBase relating to this particular DmXioDirectorBaseDmXioGlobalDomain.
Top
Fields
 NameDescription
Public fieldStatic memberRouteByNameFeedbackEventId The value of RouteByNameFeedback has changed.

The GlobalDomainChange event will trigger for this event id and Index will indicate the index into the RouteByNameFeedback collection.

Public fieldStatic memberRouteByRoutingIdFeedbackEventId The value of RouteByRoutingIdFeedback has changed.

The GlobalDomainChange event will trigger for this event id and Index will indicate the index into the RouteByRoutingIdFeedback collection.

Public fieldStatic memberVideoOutFeedbackEventId The value of VideoOutFeedback has changed.

The GlobalDomainChange event will trigger for this event id and Index will indicate the index into the VideoOutFeedback collection.

Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also