Click or drag to resize

Mtx3Base Class

Base class for TouchScreens: MTX3 Wireless Touch Screen

This class will trigger SigChange, ButtonStateChange and DeviceExtenderSigChange events.

Inheritance Hierarchy

Namespace: Crestron.SimplSharpPro.DeviceSupport
Assembly: Crestron.SimplSharpPro.DeviceSupport (in Crestron.SimplSharpPro.DeviceSupport.dll) Version: 2.21.121
Syntax
C#
public class Mtx3Base : BasicTriList, ITP29Button, 
	IButton

The Mtx3Base type exposes the following members.

Properties
 NameDescription
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 Mtx3Base device.

This property will trigger ButtonStateChange event with eButtonState.

Public propertyChannelDown Get the Button object corresponding to the ChannelDown button for this Mtx3Base device.

The ButtonStateChange event will trigger with ChannelDown and eButtonState.

Public propertyChannelUp Get the Button object corresponding to the ChannelUp button for this Mtx3Base device.

The ButtonStateChange event will trigger with ChannelUp and eButtonState.

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 propertyDown Get the Button object corresponding to the Down button for this Mtx3Base device.

The ButtonStateChange event will trigger with Down and eButtonState.

Public propertyEnter Get the Button object corresponding to the Enter button for this Mtx3Base device.

The ButtonStateChange event will trigger with Enter and eButtonState.

Public propertyExit Get the Button object corresponding to the Exit button for this Mtx3Base device.

The ButtonStateChange event will trigger with Exit and eButtonState.

Public propertyExtenderAudioReservedSigs Property to access the Audio functionality of the Mtx3Base Wireless Touch Screen.

This property will trigger DeviceExtenderSigChange event.

Public propertyExtenderRfReservedSigs Property to access the RF functionality of the Mtx3Base Wireless Touch Screen.

This property will trigger DeviceExtenderSigChange event.

Public propertyExtenderSystem2ReservedSigs Property to access the System2 functionality of the Mtx3Base Wireless Touch Screen.

This property will trigger DeviceExtenderSigChange event.

Public propertyExtenderSystem3ReservedSigs Property to access the System3 functionality of the Mtx3Base Wireless Touch Screen.

This property will trigger DeviceExtenderSigChange event.

Public propertyExtenderSystemReservedSigs Property to access the System functionality of the Mtx3Base Wireless Touch Screen.

This property will trigger DeviceExtenderSigChange event.

Public propertyFastForward Get the Button object corresponding to the FastForward button for this Mtx3Base device.

The ButtonStateChange event will trigger with FastForward and eButtonState.

Public propertyGuide Get the Button object corresponding to the Guide button for this Mtx3Base device.

The ButtonStateChange event will trigger with Guide and eButtonState.

Public propertyHome Get the Button object corresponding to the Home button for this Mtx3Base device.

The ButtonStateChange event will trigger with Home and eButtonState.

Public propertyID Property to get the ID of the device.
(Inherited from GenericDevice)
Public propertyInformation Get the Button object corresponding to the Information button for this Mtx3Base device.

The ButtonStateChange event will trigger with Information and eButtonState.

Public propertyIsOnline Property to get the current online state of the device.
(Inherited from GenericDevice)
Public propertyKeypad Get the Button object corresponding to the Keypad button for this Mtx3Base device.

The ButtonStateChange event will trigger with Keypad and eButtonState.

Public propertyLast Get the Button object corresponding to the Last button for this Mtx3Base device.

The ButtonStateChange event will trigger with Last and eButtonState.

Public propertyLeft Get the Button object corresponding to the Left button for this Mtx3Base device.

The ButtonStateChange event will trigger with Left and eButtonState.

Public propertyList Get the Button object corresponding to the List button for this Mtx3Base device.

The ButtonStateChange event will trigger with List and eButtonState.

Public propertyMenu Get the Button object corresponding to the Menu button for this Mtx3Base device.

The ButtonStateChange event will trigger with Menu and eButtonState.

Public propertyMute Get the Button object corresponding to the Mute button for this Mtx3Base device.

The ButtonStateChange event will trigger with Mute and eButtonState.

Public propertyName Get the name of this device.
(Inherited from GenericBase)
Public propertyParent The parent that a given object was added to.
(Inherited from GenericBase)
Public propertyPause Get the Button object corresponding to the Pause button for this Mtx3Base device.

The ButtonStateChange event will trigger with Pause and eButtonState.

Public propertyPlay Get the Button object corresponding to the Play button for this Mtx3Base device.

The ButtonStateChange event will trigger with Play and eButtonState.

Public propertyPower Get the Button object corresponding to the Power button for this Mtx3Base device.

The ButtonStateChange event will trigger with Power and eButtonState.

Public propertyRecord Get the Button object corresponding to the Record button for this Mtx3Base device.

The ButtonStateChange event will trigger with Record and eButtonState.

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)
Public propertyRewind Get the Button object corresponding to the Rewind button for this Mtx3Base device.

The ButtonStateChange event will trigger with Rewind and eButtonState.

Public propertyRight Get the Button object corresponding to the Right button for this Mtx3Base device.

The ButtonStateChange event will trigger with Right and eButtonState.

Public propertySideTrigger Get the Button object corresponding to the SideTrigger button for this Mtx3Base device.

The ButtonStateChange event will trigger with SideTrigger and eButtonState.

Protected propertySIMPLDeviceImplementation Internal protected member used for actual device control.
(Inherited from GenericDevice)
Public propertySoftkey1 Get the Button object corresponding to the Softkey1 button for this Mtx3Base device.

The ButtonStateChange event will trigger with Softkey1 and eButtonState.

Public propertySoftkey2 Get the Button object corresponding to the Softkey2 button for this Mtx3Base device.

The ButtonStateChange event will trigger with Softkey2 and eButtonState.

Public propertySoftkey3 Get the Button object corresponding to the Softkey3 button for this Mtx3Base device.

The ButtonStateChange event will trigger with Softkey3 and eButtonState.

Public propertyStop Get the Button object corresponding to the Stop button for this Mtx3Base device.

The ButtonStateChange event will trigger with Stop and eButtonState.

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 propertyUp Get the Button object corresponding to the Up button for this Mtx3Base device.

The ButtonStateChange event will trigger with Up and eButtonState.

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 propertyVolumeDown Get the Button object corresponding to the VolumeDown button for this Mtx3Base device.

The ButtonStateChange event will trigger with VolumeDown and eButtonState.

Public propertyVolumeUp Get the Button object corresponding to the VolumeUp button for this Mtx3Base device.

The ButtonStateChange event will trigger with VolumeUp and eButtonState.

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 eventButtonStateChange Event triggered when a Button reports information to the Control System.

Button states are available in eButtonState.

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 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