Click or drag to resize

CrestronControlSystem Class

Base class for the CrestronControlSystem The Customer application is derived over this class
Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpProCrestronControlSystem

Namespace: Crestron.SimplSharpPro
Assembly: SimplSharpPro (in SimplSharpPro.dll) Version: 2.21.121
Syntax
C#
public class CrestronControlSystem : IComPorts, 
	IRelayPorts, IIROutputPorts, IIOPorts, IDigitalInputPorts, IIRInputPort

The CrestronControlSystem type exposes the following members.

Constructors
 NameDescription
Public methodCrestronControlSystem Base constructor for the CrestronControlSystem class.
Top
Properties
 NameDescription
Public propertyAppInSuspendedState Indicates that the program is in the suspended state
Public propertyComPorts Collection of serial COM ports on the control system.
Public propertyControllerAudioDevice Returns the inbuilt system audio device for this controller
Public propertyControllerBACnetDevice Returns the BACnet object on the controller.
Public propertyControllerBluetoothDevice Returns the BluetoothBle object on the controller.
Public propertyControllerERRadioDevice Returns the inbuilt ER Radio Slot Device
Public propertyControllerFrontPanelSlotDevice Returns the inbuilt Front Panel for this controller
Public propertyControllerIROutputSlot Controller's Built In IR Output Slot
Public propertyControllerPrompt Returns the controller prompt
Public propertyControllerRFGatewayDevice Return the inbuild RF gateway device for this controller
Public propertyControllerTouchScreenSlotDevice Returns the inbuilt Touch Screen for this controller
Public propertyControllerXioCloudRoomSlotDevice Returns the XIO Cloud Room Slot object on the controller.
Public propertyDefaultStringEncoding Set the default String Encoding
Public propertyDigitalInputPorts Collection of digital input ports on the control system.
Public propertyDisplayTypeSupported Returns the type of display supported.
Public propertyEthernetLinkUp Return the current state of the Ethernet Link. True - Link Up -- False - Link Down
Public propertyFliptopTouchscreenSlot If this control system is Fliptop type, this slot will return the FTTouchscreen device. This property will be 'null' otherwise.
Public propertyIRInputPort IR input port on the device. For the MC3, PMC3, and the PMC3-XP valid IR IDs range from 0x00 to 0x1F.
Public propertyIROutputPorts Collection of IR output ports on the control system.
Public propertyIsSystemProdigy Returns true if this is a prodigy system
Public propertyMaximumSupportedConnectItDeviceID Get the maximum supported device ID of ConnectIt devices.
Public propertyStatic memberMaxNumberOfEventsInQueue Returns the max number of events which can be in the device queue at any given time.
Public propertyMicrophones For a control system that has microphones, this will be a collection that contains a collection the MicrophoneBase base class. The user can then cast accordingly to a different microphone type using the MicrophoneType property. Triggered events for microphones can be monitored by subscribing to the MicrophoneChange event handler.

See the definition of IMicrophone interface for more information and an example usage.

Public propertyMPC3x101TouchscreenSlot If this control system is MPC3-101 type, this slot will return the MPC4x201Touchscreen device. This property will be 'null' otherwise.
Public propertyMPC3x102TouchscreenSlot If this control system is MPC3-102 type, this slot will return the MPC3x102Touchscreen device. This property will be 'null' otherwise.
Public propertyMPC3x201TouchscreenSlot If this control system is MPC3-201 type, this slot will return the MPC3x201Touchscreen device. This property will be 'null' otherwise.
Public propertyMPC3x30xTouchscreenSlot If this control system is MPC3-301 or MPC3-302 type, this slot will return the MPC3x30xTouchscreen device. This property will be 'null' otherwise.
Public propertyMPC4x102TouchscreenSlot If this control system is MPC4-102 type, this slot will return the MPC4x102Touchscreen device. This property will be 'null' otherwise.
Public propertyMPC4x201TouchscreenSlot If this control system is MPC4-201 type, this slot will return the MPC4x201Touchscreen device. This property will be 'null' otherwise.
Public propertyNumberOfComPorts Number of serial COM ports this controller supports.
Public propertyNumberOfDigitalInputPorts Number of digital input ports this device supports.
Public propertyNumberOfEthernetAdapters Returns number of ethernet adapters in the system
Public propertyNumberOfIROutputPorts Number of IR output ports this device supports.
Public propertyNumberOfMicrophones Property to retrieve how many microphones are supported by the control system.
Public propertyNumberOfRelayPorts Number of relay ports this controller supports.
Public propertyNumberOfSwitcherInputs Property to access the number of inputs on a control system that acts like a switcher (i.e. DMPS3)
Public propertyNumberOfSwitcherOutputs Property to access the number of outputs on a control system that acts like a switcher (i.e. DMPS3)
Public propertyNumberOfUsbHids Number of USB HIDs supported by this control system.
Public propertyNumberOfVersiPorts Number of versiports this device supports.
Public propertyNumProgramsSupported Returns the number of programs supported by this controller
Public propertyProgramNumber Returns the current program number
Public propertyRelayPorts Collection of relay ports on the control system.
Public propertyStatic memberSigGroups Collection of SigGroups for this control system.
Public propertySupportsAudio Returns true if the controller supports internal Audio Slot.
Public propertySupportsBACNet Returns true if the controller supports internal BACnet slot.
Public propertySupportsBluetooth Returns true if the controller supports internal Bluetooth slot.
Public propertySupportsChangingVideoResolution Indicates whether we support changing the video resolution
Public propertySupportsComPort Returns true if the controller supports internal COM Ports
Public propertySupportsConnectItDevices Indicates if the controller support ConnectIt devices.
Public propertySupportsCresnet Returns true if the controller supports cresnet.
Public propertySupportsDigitalInput Returns true if the controller supports internal Digital Inputs
Public propertySupportsDisplaySlot Returns true if the controller supports a Display Slot.
Public propertySupportsERRadio Returns true if the controller supports internal ER Radio slot.
Public propertySupportsEthernet Returns true if the controller supports Ethernet.
Public propertySupportsFlashProjects Indicates whether the display supports Flash Projects
Public propertySupportsInternalAirMedia Property that indicates if the control system supports AirMedia usage.
Public propertySupportsInternalRFGateway Returns true if the controller supports an internal Gateway.
Public propertySupportsInternalStreaming Property that indicates if the control system supports streaming.
Public propertySupportsIRIn Returns true if the controller supports internal IR Inputs
Public propertySupportsIROut Returns true if the controller supports internal IR Output
Public propertySupportsMicrophones Property that indicates if the control system supports microphone usage.
Public propertySupportsRelay Returns true if the controller supports internal Relays.
Public propertySupportsSNMP Returns true if the controller supports internal SNMP slot.
Public propertySupportsSwitcherInputs Property to determine if the control system supports switcher inputs.
Public propertySupportsSwitcherOutputs Property to determine if the control system supports switcher outputs.
Public propertySupportsSystemMonitor Returns true if the controller supports internal System Monitor Slot.
Public propertySupportsThreeSeriesPlugInCards Indicate if three series cards can be attached to the control system.
Public propertySupportsUsbHid Returns true if the controller supports USB HID.
Public propertySupportsVersiport Returns true if the controller supports internal Versiport slot.
Public propertySupportsXioCloudRoom Returns true if the controller supports the XIO Cloud Room Slot.
Public propertyCode exampleSwitcherInputs For control systems that have built in switchers (for example, DMPS3), this collection will contain the inputs of the switcher. Since it is a collection of the interface, the programmer will need to read the CardInputOutputType property to know what the base class of the input is, cast it to that, and then work with it from there. The SwitcherInputs collection will be null for devices that do not have switchers. The index into the SwitcherInputs can also be referenced by the following enums:

CrestronControlSystemeDmps3200cInputs for DMPS-200-C

CrestronControlSystemeDmps3300c300cAecInputs for DMPS-300-C and DMPS-300-C-AEC

CrestronControlSystemeDmps34K150CInputs for DMPS3-4K-150-C

CrestronControlSystemeDmps34K100CInputs for DMPS3-4K-100-C

CrestronControlSystemeDmps34K50Inputs for DMPS3-4K-50

CrestronControlSystemeDmps34K300CInputs for DMPS3-4K-300-C

CrestronControlSystemeDmps34K200CInputs for DMPS3-4K-200-C

CrestronControlSystemeDmps34K350CInputs for DMPS3-4K-350-C

CrestronControlSystemeDmps34K250CInputs for DMPS3-4K-250-C

To make use of a specific input, you will need to check against the type present in the interface and cast/use it from there.
Public propertyCode exampleSwitcherOutputs For control systems that have built in switchers (for example, DMPS3), this collection will contain the outputs of the switcher. Since it is a collection of the interface, the programmer will need to read the CardInputOutputType property to know what the base class of the output is, cast it to that, and then work with it from there. The SwitcherOutputs collection will be null for devices that do not have switchers. The index into the SwitcherOutputs can also be referenced by the following enums:

CrestronControlSystemeDmps3200cOutputs for DMPS-200-C

CrestronControlSystemeDmps300cOutputs for DMPS-300-C

CrestronControlSystemeDmps3300cAecOutputs for DMPS-300-C-AEC

CrestronControlSystemeDmps34K150COutputs for DMPS3-4K-150-C

CrestronControlSystemeDmps34K100COutputs for DMPS3-4K-100-C

CrestronControlSystemeDmps34K50Outputs for DMPS3-4K-50

CrestronControlSystemeDmps34K300COutputs for DMPS3-4K-300-C

CrestronControlSystemeDmps34K200COutputs for DMPS3-4K-200-C

CrestronControlSystemeDmps34K350COutputs for DMPS3-4K-350-C

CrestronControlSystemeDmps34K250COutputs for DMPS3-4K-250-C

To make use of a specific output, you will need to check against the type present in the interface and cast/use it from there.
Public propertyTouchscreenType Property to return the type of touchscreen this controller supports.
Public propertyTPCSTouchscreenSlot If this control system is a TPCS this slot will return the TPCS Touchscreen device. This property will be 'null' otherwise.
Public propertyTSCW730TouchscreenSlot If this control system is TSCW730 type, this slot will return the TSCW730TouchscreenSlot device. This property will be 'null' otherwise.
Public propertyUsbHids Collection of USB HIDs apart of this control system.
Public propertyVersiPorts Collection of versiports on the control system.
Top
Methods
 NameDescription
Public methodStatic memberClearSigGroups Method to remove all sig groups from the system. This will clear the contents of all sigs.
Public methodStatic memberCreateSigGroup(Int32, BoolInputSig) Method to create a new SigGroup for this system.
Public methodStatic memberCreateSigGroup(Int32, eSigType) Method to create a new SigGroup for this system.
Public methodStatic memberCreateSigGroup(Int32, StringInputSig) Method to create a new SigGroup for this system.
Public methodStatic memberCreateSigGroup(Int32, UShortInputSig) Method to create a new SigGroup for this system.
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)
Public methodInitializeSystem Function for the customer to initialize their devices and other system parameters...
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodStatic memberRemoveSigGroup(Int32) Method to remove a SigGroup from the system. This will also clear the SigGroup of its contents.
Public methodStatic memberRemoveSigGroup(SigGroup) Method to remove a SigGroup from the system. This will also clear the SigGroup of its contents.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Events
 NameDescription
Public eventDMInputChange For a control system with DM controls (such as DMPS3) this will allow subscriptions to the DM Input events.

Valid event IDs are available in DMInputEventIds

Public eventDMOutputChange For a control system with DM controls (such as DMPS3) this will allow subscriptions to the DM Output events.

Valid event IDs are available in DMOutputEventIds and HDScalerScaler

Public eventDMSystemChange For a control system with DM controls (such as DMPS3) this will allow subscriptions to the DM System Change events.

Valid event IDs are available in DMSystemEventIds

Public eventMicrophoneChange The even triggered when a control system with microphones report a change in microphone state.For a control system with microphones, this is the event handler.

Valid event IDs are available in MicrophoneEventIds

Top
Fields
 NameDescription
Public fieldStatic memberNullBoolInputSig Sig used to signify that this cue is not initialized or usable.
Public fieldStatic memberNullBoolOutputSig Sig used to signify that this cue is not initialized or usable.
Public fieldStatic memberNullCue Sig returned when the Sig value should not be used. Check the Event from the SigEventArgs instead.
Public fieldStatic memberNullStringInputSig Sig used to signify that this cue is not initialized or usable.
Public fieldStatic memberNullStringOutputSig Sig used to signify that this cue is not initialized or usable.
Public fieldStatic memberNullUShortInputSig Sig used to signify that this cue is not initialized or usable.
Public fieldStatic memberNullUShortOutputSig Sig used to signify that this cue is not initialized or usable.
Public fieldSystemControl If this device has switcher system control, then this item will be non-null. The SystemControlType in the interface can be used to cast appropriately.

See the definition of ISystemControl for more information an example usage.

Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also