Click or drag to resize

DmNvxUsbHotKey Class

Usb hot key device class.

This class will trigger UsbHotKeyPropertyChange event with UsbInputEventIds.

.
Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpPro.DM.EndpointsDmNvxUsbHotKey

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

The DmNvxUsbHotKey type exposes the following members.

Properties
 NameDescription
Public propertyCaptureModeFeedback Property to indicate, if capture mode is enabled.

The UsbHotKeyPropertyChange event will trigger with CaptureModeEventId.

Public propertyEnterCaptureModeCustomKey When EnterCaptureModeKey is selected to CustomKeyStroke.

Refer "https://wiki.osdev.org/USB_Human_Interface_Devices" for more information on the Raw USB data for each key press on the key board.

Example key stroke sequence is "{LEFTCTRL}+A". Refer DmNvxUsbHotKeyeKeyUsbScanCodeMap for the valid key strokes. Remove the prefix "Key" from the name of the key and use the remain characters in the enum constant name for each key stroke. e.g. the key stroke name for KeyA will be "A". To specify characters that aren't displayed when you press a key, such as ENTER or TAB, and keys that represent actions rather than characters, use the "Key" removed enum constant names enclosed in braces, e.g. for ENTER key it will be {ENTER}. For keys A-Z, a-z, 0-9 the characters as it is shall be entered. The USB scan codes are same for both capitals as well as small letters. This property is not supported by DMPS-4200 device.
Public propertyEnterCaptureModeCustomKeyFeedback Reports the current custom key stroke set for entry into capture mode. Raw USB data for the entry into capture mode is received to this property from the NVX device. The same is converted to the custom key stroke set and returned to the user. If the raw USB data received is not valid then {INVALID RAW USB DATA FOUND} will be returned.

The custom key is normally set when EnterCaptureModeKey is selected to CustomKeyStroke.

The UsbHotKeyPropertyChange event will trigger with EnterCaptureModeCustomKeyFeedbackEventId.

This property is not supported by DMPS-4200 device.
Public propertyEnterCaptureModeKey Selects the default or custom key strokes for entry into capture mode. Requires the command to be sent (2) two times. Enter capture mode allows the USB route to change from the remote device to the control processor: USB-----NVX----Network----NVX----Control processor (Capture mode on/enter)
Public propertyEnterCaptureModeKeyFeedback Reports the current key stroke selected for entry into capture mode.

The UsbHotKeyPropertyChange event will trigger with EnterCaptureModeKeyFeedbackEventId.

This property is not supported by DMPS-4200 device.
Public propertyExitCaptureModeCustomKey When ExitCaptureModeKey is selected to CustomKeyStroke.

Refer "https://wiki.osdev.org/USB_Human_Interface_Devices" for more information on the Raw USB data for each key press on the key board.

Example key stroke sequence is "{LEFTCTRL}+A". Refer DmNvxUsbHotKeyeKeyUsbScanCodeMap for the valid key strokes. Remove the prefix "Key" from the name of the key and use the remain characters in the enum constant name for each key stroke. e.g. the key stroke name for KeyA will be "A". To specify characters that aren't displayed when you press a key, such as ENTER or TAB, and keys that represent actions rather than characters, use the "Key" removed enum constant names enclosed in braces, e.g. for ENTER key it will be {ENTER}. For keys A-Z, a-z, 0-9 the characters as it is shall be entered. The USB scan codes are same for both capitals as well as small letters. This property is not supported by DMPS-4200 device.
Public propertyExitCaptureModeCustomKeyFeedback Reports the current custom key stroke set for exit from capture mode. Raw USB data for the exit from capture mode is received to this property from the NVX device. The same is converted to the custom key stroke set and returned to the user. If the raw USB data received is not valid then {INVALID RAW USB DATA FOUND} will be returned.

The custom key is normally set when ExitCaptureModeKey is selected to CustomKeyStroke.

The UsbHotKeyPropertyChange event will trigger with ExitCaptureModeCustomKeyFeedbackEventId.

This property is not supported by DMPS-4200 device.
Public propertyExitCaptureModeKey Selects the default or custom key strokes for exit from capture mode. Requires the command to be sent (1) one time. Exit capture mode allows the USB route to change from the control processor to the remote device: USB-----NVX----Network----NVX----USB (Capture mode off/exit)
Public propertyExitCaptureModeKeyFeedback Reports the current key stroke selected for exit from capture mode.

The UsbHotKeyPropertyChange event will trigger with ExitCaptureModeKeyFeedbackEventId.

This property is not supported by DMPS-4200 device.
Public propertyKeyBoardShortcutFeedback Property to return collection of keyboard shortcuts.

The UsbHotKeyPropertyChange event will trigger with KeyBoardShortcutEventId and index into the collection.

Public propertyMessageFeedback Property to indicate the raw serial data from the keyboard.

The UsbHotKeyPropertyChange event will trigger with MessageFeedbackEventId with index into the collection.

Public propertyParent The parent that a given object was added to.
Public propertyUsbHotKeyDisabledFeedback Property to indicate, if usb hot key is disabled.

The UsbHotKeyPropertyChange event will trigger with UsbHotKeyDisabledEventId.

Public propertyUsbHotKeyEnabledFeedback Property to indicate, if usb hot key is enabled.

The UsbHotKeyPropertyChange event will trigger with UsbHotKeyEnabledEventId.

Public propertyUserSpecifiedObject Can be assigned anything that user wants.
Top
Methods
 NameDescription
Public methodDisableHotKey Method to disable usb hot key functionality.
Public methodEnableHotKey Method to enable usb hot key functionality. Enabled by default.
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 eventUsbHotKeyPropertyChange Event triggered when a feedback has changed for this DmNvxUsbHotKey.
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also