Click or drag to resize

Switch Class

Generic switch base
Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpProGenericBase
    Crestron.SimplSharpProGenericDevice
      Crestron.SimplSharpPro.DMSwitch
        More

Namespace: Crestron.SimplSharpPro.DM
Assembly: SimplSharpPro (in SimplSharpPro.dll) Version: 2.21.121
Syntax
C#
public class Switch : GenericDevice

The Switch type exposes the following members.

Constructors
 NameDescription
Protected methodSwitch This is the base switch. Has everything you need to control routing.
Top
Properties
 NameDescription
Public propertyConnectedIpList A property containing the list of the ConnectedIpInformation objects which contain information about the devices that are connected to this IP ID. This property is only valid for an ethernet device. If this is not an ethernet device, then this property will return null. If this is an ethernet device, the list will be non-null. It will be empty if no devices are connected. The order of items in this list is not guaranteed.
(Inherited from GenericDevice)
Public propertyCode exampleDescription Get/Set the description of this device.
(Inherited from GenericBase)
Public propertyDisposed Property to indicate if the device has been disposed.
(Inherited from GenericDevice)
Public propertyEnableUSBBreakaway Enables USB breakaway for as long as the input is 'true'. This allows USB to be routed independently from video. If USB breakaway is not enabled, the USB routes will follow the selected video routes, and the "USBOut#" inputs will have no effect. 'true' (level-sensitive) = Enable USB breakaway; 'false' = Disable USB breakaway This property is not supported by HD-RX-4K-X01 switches
Public propertyEnableUSBBreakawayFeedback Indicates that USB breakaway is enabled. The output remains high for as long as USB breakaway is enabled. 'true' = USB breakaway enabled; 'false' = USB breakaway disabled This property is not supported by HD-RX-4K-X01 switches

The DMSystemChange event will trigger with the USBBreakawayEventId if the switcher is a device.

Public propertyID Property to get the ID of the device.
(Inherited from GenericDevice)
Public propertyInputs Get Collection of inputs for this switch
Public propertyIsOnline Property to get the current online state of the device.
(Inherited from GenericDevice)
Public propertyName Get the name of this device.
(Inherited from GenericBase)
Public propertyNumberOfInputs Number of Input Channels on this switch
Public propertyNumberOfOutputs Number of Output Channels on this switch
Public propertyOutputs Get Collection of outputs for this switch
Public propertyParent The parent that a given object was added to.
(Inherited from GenericBase)
Public propertyRegisterable Property to indicate that this device can be registered.
(Inherited from GenericDevice)
Public propertyRegistered Property to get the current registration state of the device.
(Inherited from GenericDevice)
Public propertyRegistrationFailureReason Property to get the Registration Failure Reason, this will match the return value from the call to register.
(Inherited from GenericDevice)
Protected propertySIMPLDeviceImplementation Internal protected member used for actual device control.
(Inherited from GenericDevice)
Public propertySwitchType The type of DM switcher
Public propertyType Property to determine to type of device this is.
(Inherited from GenericDevice)
Public propertyUnRegistrationFailureReason Property to get the Unregistration Failure Reason, this will match the return value from the call to unregister.
(Inherited from GenericDevice)
Public propertyUSBEnter Enables the "Output#_USBRoutedTo" or "Input#_USBRoutedTo" source selection analogs for as long as the input is 'true'. When the input is 'false', the analogs have no effect. 'true' (level-sensitive) = Enable USB; 'false' = Disable USB This property is not supported by HD-RX-4K-X01 switches
Public propertyUserSpecifiedObject Can be assigned anything that user wants.
(Inherited from GenericBase)
Public propertyVideoEnter Enables the "VideoOut#" video source selection analogs for as long as the input is 'true'. When the input is 'false', the analogs have no effect. 'true' (level-sensitive) = Enable video; 'false' = Disable video This property is not supported by HD-RX-4K-X01 switches
Protected propertyXioEndpointStubSIMPLDevice The SIMPL "stub" Device that the XiO Director creates for an endpoint to send the 1C/0E to the correct place in hierarchy.
(Inherited from GenericDevice)
Top
Methods
 NameDescription
Public methodDispose Clean up of resources.
(Inherited from GenericBase)
Protected methodDispose(Boolean) Method to perform the actual disposing of the device.
(Inherited from GenericDevice)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalize Destructor of the device.
(Inherited from GenericDevice)
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)
Protected methodOnBaseEvent(Int32) Protected member used to fire the BaseEvent with the default extended information.
(Inherited from GenericBase)
Protected methodOnBaseEvent(Int32, UInt16) Protected member used to fine the BaseEvent with extended event information.
(Inherited from GenericBase)
Public methodRegister Register this device with the system.
(Inherited from GenericDevice)
Public methodToString Return the name of the device.
(Inherited from GenericDevice)
Public methodUnRegister Unregister this device with the system. This function can not be called from the device's own SigChange event handler.

On successful unregistration, if this device supports the OnlineStatusChange event, it will trigger indicating the device when offline.


(Inherited from GenericDevice)
Top
Events
 NameDescription
Public eventBaseEvent Generic base event, triggered when the there are no other handlers available for a specific EventID.
(Inherited from GenericBase)
Public eventDMInputChange Handle DM Input Events EventIds for this event are located in the DMInputEventIds class.
Public eventDMOutputChange Handle DM Output Events EventIds for this event are located in the DMOutputEventIds class.
Public eventDMSystemChange Event to handle general switch events EventIds for this event are located in the DMSystemEventIds class.
Public eventIpInformationChange Event that tells what IP Address is connected/disconnected from an IP ID for a non-UDP device. This is only valid for an Ethernet device. An exception will be thrown if it is not.
(Inherited from GenericDevice)
Public eventOnlineStatusChange Event triggered when the Online status of the device changes.
(Inherited from GenericDevice)
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also
Inheritance Hierarchy