Click or drag to resize

MPC3Basic Class

MPC3 Touchscreen Basic Device. It is also the base class of MPC3-201, MPC3-101, MPC3-102, MPC3-301 or MPC3-302 Touchscreen Device.

This class will trigger ButtonStateChange and PanelStateChange events.

Inheritance Hierarchy

Namespace: Crestron.SimplSharpPro
Assembly: SimplSharpPro (in SimplSharpPro.dll) Version: 2.21.121
Syntax
C#
public class MPC3Basic : ThreeSeriesTouchScreen, IButton, 
	IFeedback

The MPC3Basic type exposes the following members.

Properties
 NameDescription
Public propertyActiveBrightness Specifies LED brightness level in active state. Valid values range from 0 (0%) to 65535 (100%). This property is not supported by MPC3x30xTouchscreen.
Public propertyActiveBrightnessFeedBack Indicates the LED brightness level in Active State, Valid values range from 0 (0%) to 65535 (100%).

The PanelStateChange event will trigger with ActiveBrightnessEventId.

This property is not supported by MPC3x30xTouchscreen.
Public propertyActiveModeAutoBrightnessHighLevel Specifies active mode auto brightness high level in lux unit. Valid values range from 0 (0%) to 65535 (100%). This property is not supported by MPC3x30xTouchscreen.
Public propertyActiveModeAutoBrightnessHighLevelFeedBack Reports the current active mode auto brightness high level in lux unit. Valid values range from 0 (0%) to 65535 (100%).

The PanelStateChange event will trigger with ActiveModeAutoBrightnessHighLevelEventId.

This property is not supported by MPC3x30xTouchscreen.
Public propertyActiveModeAutoBrightnessLowLevel Specifies active mode auto brightness low level in lux unit. Valid values range from 0 (0%) to 65535 (100%). This property is not supported by MPC3x30xTouchscreen.
Public propertyActiveModeAutoBrightnessLowLevelFeedBack Reports the current active mode auto brightness low level in lux unit. Valid values range from 0 (0%) to 65535 (100%).

The PanelStateChange event will trigger with ActiveModeAutoBrightnessLowLevelEventId.

This property is not supported by MPC3x30xTouchscreen.
Public propertyActiveTimeout Specifies the Active State timeout value in minutes. Value 0: the timeout is disabled. This property is not supported by MPC3x30xTouchscreen.
Public propertyActiveTimeoutFeedBack Indicates Active State timeout value in minutes.

The PanelStateChange event will trigger with ActiveTimeoutEventId.

This property is not supported by MPC3x30xTouchscreen.
Public propertyAmbientLightLevelFeedBack Reports the current ambient light level in lux unit for selecting high LED level vs low LED level. 100-400: normal office, 600: bright lab, 10000+: direct sunlight.

The PanelStateChange event will trigger with AmbientLightLevelEventId.

Public propertyAmbientLightThresholdForAutoBrightnessAdjustment Specifies ambient light level in lux unit for selecting high LED level vs low LED level. This property is only valid when the AutoBrightnessEnabled property is set to true.
Public propertyAmbientLightThresholdForAutoBrightnessAdjustmentFeedBack Reports the current ambient light threshold level in lux unit. This property is only valid when the AutoBrightnessEnabled property is set to true.

The PanelStateChange event will trigger with AmbientLightThresholdForAutoBrightnessAdjustmentEventId.

Public propertyAutoBrightnessDisabled Disable automatic LED brightness adjustment based ambient light while the property is true. Setting the property to false will enable it. This property is currently supported by "MPB4-101" and "MPB4-201" front panel devices.
Public propertyAutoBrightnessDisabledFeedBack When true, indicates automatic LED brightness adjustment based ambient light is disabled on this device.

When False, indicates automatic LED brightness adjustment based ambient light is enabled on this device.

The PanelStateChange event will trigger with AutoBrightnessDisabledEventId.

This property is currently supported by "MPB4-101" and "MPB4-201" front panel devices.

Public propertyAutoBrightnessEnabled Enable automatic LED brightness adjustment based ambient light while the property is true. Setting the property to false will disable it.
Public propertyAutoBrightnessEnabledFeedBack When true, indicates automatic LED brightness adjustment based ambient light is enabled on this device.

When False, indicates automatic LED brightness adjustment based ambient light is disabled on this device.

The PanelStateChange event will trigger with AutoBrightnessEnabledEventId.

Public propertyBooleanInput Collection of Boolean Inputs sent to the device.
(Inherited from BasicTriList)
Public propertyBooleanOutput Collection of Boolean Outputs received from the device.
(Inherited from BasicTriList)
Public propertyButton Get the collection of the Button objects for this device. For MPC3-XXX devices, buttons 2 and 3 are only applicable for the MPC3-201/101/102
Public propertyButton1 Get the Button object corresponding to the Button1 button for this device.

Depreciated for MPC4x102Touchscreen and similar devices. Please use the Button collection instead.

Public propertyButton2 Get the Button object corresponding to the Button2 button for this device.

Depreciated for MPC4x102Touchscreen and similar devices. Please use the Button collection instead.

Public propertyButton3 Get the Button object corresponding to the Button3 button for this device.

Depreciated for MPC4x102Touchscreen and similar devices. Please use the Button collection instead.

Public propertyButton4 Get the Button object corresponding to the Button4 button for this device.

Depreciated for MPC4x102Touchscreen and similar devices. Please use the Button collection instead.

Public propertyButton5 Get the Button object corresponding to the Button5 button for this device.

Depreciated for MPC4x102Touchscreen and similar devices. Please use the Button collection instead.

Public propertyButton6 Get the Button object corresponding to the Button6 button for this device.

Depreciated for MPC4x102Touchscreen and similar devices. Please use the Button collection instead.

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 propertyExtenderSystemReservedSigs Extender that contains basic display settings.
(Inherited from ThreeSeriesTouchScreen)
Public propertyFeedback1 Get the Feedback object corresponding to Button1 for this MPC3Basic device.

Depreciated for MPC4x102Touchscreen and similar devices. Please use the Feedbacks collection instead.

Public propertyFeedback2 Get the Feedback object corresponding to Button2 for this MPC3Basic device.

Depreciated for MPC4x102Touchscreen and similar devices. Please use the Feedbacks collection instead.

Public propertyFeedback3 Get the Feedback object corresponding to Button3 for this MPC3Basic device.

Depreciated for MPC4x102Touchscreen and similar devices. Please use the Feedbacks collection instead.

Public propertyFeedback4 Get the Feedback object corresponding to Button4 for this MPC3Basic device.

Depreciated for MPC4x102Touchscreen and similar devices. Please use the Feedbacks collection instead.

Public propertyFeedback5 Get the Feedback object corresponding to Button5 for this MPC3Basic device.

Depreciated for MPC4x102Touchscreen and similar devices. Please use the Feedbacks collection instead.

Public propertyFeedback6 Get the Feedback object corresponding to Button6 for this MPC3Basic device.

Depreciated for MPC4x102Touchscreen and similar devices. Please use the Feedbacks collection instead.

Public propertyFeedbackMute Get the Feedback object corresponding to Mute for this MPC3Basic device.
Public propertyFeedbackPower Get the Feedback object corresponding to Power for this MPC3Basic device.
Public propertyFeedbacks Returns the Feedbacks collection
Public propertyID Property to get the ID of the device.
(Inherited from GenericDevice)
Public propertyIsOnline Property to get the current online state of the device.
(Inherited from GenericDevice)
Public propertyLEDBrightness Specifies the button LED brightness level. Valid values range from 0 (0%) to 65535 (100%).
Public propertyLEDBrightnessFeedBack Indicates the button LED brightness level. Valid values range from 0 (0%) to 65535 (100%).

The PanelStateChange event will trigger with LEDBrightnessEventId.

Public propertyMute Get the Button object corresponding to the Mute button for this device.
Public propertyMuteButtonDisabledFeedBack Property that returns true when the mute button is disabled on this device, false otherwise.

The PanelStateChange event will trigger with MuteButtonDisabledEventId.

Public propertyMuteButtonEnabledFeedBack Property that returns true when the mute button is enabled on this device, false otherwise.

The PanelStateChange event will trigger with MuteButtonEnabledEventId.

Public propertyName Get the name of this device.
(Inherited from GenericBase)
Public propertyNumericalButtonDisabledFeedBack Property to indicate if a numerical button is disabled for a button number on this device.

The PanelStateChange event will trigger with NumericalButtonDisabledEventId.

Public propertyNumericalButtonEnabledFeedBack Property to indicate if a numerical button is enabled for a button number on this device.

The PanelStateChange event will trigger with NumericalButtonEnabledEventId.

Public propertyParent The parent that a given object was added to.
(Inherited from GenericBase)
Public propertyPower Get the Button object corresponding to the Power button for this device.
Public propertyPowerButtonDisabledFeedBack Property that returns true when the power button is disabled on this device, false otherwise.

The PanelStateChange event will trigger with PowerButtonDisabledEventId.

Public propertyPowerButtonEnabledFeedBack Property that returns true when the power button is enabled on this device, false otherwise.

The PanelStateChange event will trigger with PowerButtonEnabledEventId.

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 propertySmartObjects Collection containing the loaded SmartObjects of this device.
(Inherited from BasicTriListWithSmartObject)
Public propertyStandbyBrightness Specifies LED brightness level in standby state. Valid values range from 0 (0%) to 65535 (100%). This property is not supported by MPC3x30xTouchscreen.
Public propertyStandbyBrightnessFeedBack Indicates the LED brightness level in Standby State. Valid values range from 0 (0%) to 65535 (100%).

The PanelStateChange event will trigger with StandbyBrightnessEventId.

This property is not supported by MPC3x30xTouchscreen.
Public propertyStandbyModeAutoBrightnessHighLevel Specifies standby mode auto brightness high level in lux unit. Valid values range from 0 (0%) to 65535 (100%). This property is not supported by MPC3x30xTouchscreen.
Public propertyStandbyModeAutoBrightnessHighLevelFeedBack Reports the current standby mode auto brightness high level in lux unit. Valid values range from 0 (0%) to 65535 (100%).

The PanelStateChange event will trigger with StandbyModeAutoBrightnessHighLevelEventId.

This property is not supported by MPC3x30xTouchscreen.
Public propertyStandbyModeAutoBrightnessLowLevel Specifies standby mode auto brightness low level in lux unit. Valid values range from 0 (0%) to 65535 (100%). This property is not supported by MPC3x30xTouchscreen.
Public propertyStandbyModeAutoBrightnessLowLevelFeedBack Reports the current standby mode auto brightness low level in lux unit. Valid values range from 0 (0%) to 65535 (100%).

The PanelStateChange event will trigger with StandbyModeAutoBrightnessLowLevelEventId.

This property is not supported by MPC3x30xTouchscreen.
Public propertyStandbyTimeout Specifies the Standby State timeout value in minutes. Value 0: the timeout is disabled. This property is not supported by MPC3x30xTouchscreen.
Public propertyStandbyTimeoutFeedBack Indicates Standby State timeout value in minutes.

The PanelStateChange event will trigger with StandbyTimeoutEventId.

This property is not supported by MPC3x30xTouchscreen.
Public propertyStringInput Collection of String Inputs sent to the device.
(Inherited from BasicTriList)
Public propertyStringOutput Collection of String Outputs received from the device.
(Inherited from BasicTriList)
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 propertyUserSpecifiedObject Can be assigned anything that user wants.
(Inherited from GenericBase)
Public propertyUShortInput Collection of Integer Inputs sent to the device.
(Inherited from BasicTriList)
Public propertyUShortOutput Collection of Integer Outputs received from the device.
(Inherited from BasicTriList)
Public propertyVolumeBargraph Property to set volume bargraph level on this device. Valid values range from 0 (0%) to 65535 (100%). This property is not supported by MPC3x30xTouchscreen.
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 methodDisableMuteButton Disable the mute button on this device.
Public methodDisableNumericalButton Disable a given numerical button on this device.
Public methodDisablePowerButton Disable the power button on this device.
Public methodDisableVolumeDownButton Disable the volume down button on this device.
Public methodDisableVolumeUpButton Disable the volume up button on this device.
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 methodEnableMuteButton Enable the mute button on this device.
Public methodEnableNumericalButton Enable a given numerical button on this device.
Public methodEnablePowerButton Enable the power button on this device.
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)
Public methodCode exampleLoadSmartObjects(ISmartObject) Load the smart objects to this device that are already loaded for the specified device.
(Inherited from BasicTriListWithSmartObject)
Public methodCode exampleLoadSmartObjects(Stream) Load a smart object given a reference to a stream for the SGD file.
(Inherited from BasicTriListWithSmartObject)
Public methodCode exampleLoadSmartObjects(String) Load a smart object given a SGD Filename with an absolute path.
(Inherited from BasicTriListWithSmartObject)
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 eventButtonStateChange Event fired when a button state change was received from the device.
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)
Public eventPanelStateChange Event fired when a panel state change was received from the device.
Public eventSigChange Event triggered when cue information is received from a device. When processing this event, it will hold off other cues from being received from the device. If one desires to continue processing the data and receive more information, launch a new thread and allow this event to exit.
(Inherited from BasicTriList)
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also