Click or drag to resize

Hr1x0WirelessRemoteBase Class

Base class for HR-1X0 Series Handheld Wireless Remotes.
Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpProGenericBase
    Crestron.SimplSharpProGenericDevice
      Crestron.SimplSharpPro.RemotesHr1x0WirelessRemoteBase
        Crestron.SimplSharpPro.RemotesHr100
        Crestron.SimplSharpPro.RemotesHr150
        Crestron.SimplSharpPro.RemotesHr310

Namespace: Crestron.SimplSharpPro.Remotes
Assembly: Crestron.SimplSharpPro.Remotes (in Crestron.SimplSharpPro.Remotes.dll) Version: 2.21.121
Syntax
C#
public class Hr1x0WirelessRemoteBase : GenericDevice, 
	IHr1x0BatteryInformation, IHR33Button, IButton

The Hr1x0WirelessRemoteBase type exposes the following members.

Constructors
 NameDescription
Protected methodHr1x0WirelessRemoteBase Constructor to generate a new base Crestron HR-1X0 Series Handheld Wireless Remote devices.
Top
Properties
 NameDescription
Public propertyBatteryCriticalFeedback Property to indicate that the battery level (measured as the total voltage across the four disposable AAA batteries) is critical.
Public propertyBatteryLowFeedback Property to indicate that the battery level (measured as the total voltage across the four disposable AAA batteries) is low.
Public propertyBatteryVoltageFeedback Property to report the battery level, in millivolts.
Public propertyBlue Get the Button object corresponding to the Blue button for this device.
Public propertyButton Get the collection of the Button objects for this device.
Public propertyChannelDown Get the Button object corresponding to the ChannelDown button for this device.
Public propertyChannelUp Get the Button object corresponding to the ChannelUp button for this device.
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 propertyCustom1 Get the Button object corresponding to the Custom1 button for this device.
Public propertyCustom2 Get the Button object corresponding to the Custom2 button for this device.
Public propertyCustom3 Get the Button object corresponding to the Custom3 button for this device.
Public propertyCustom4 Get the Button object corresponding to the Custom4 button for this device.
Public propertyCode exampleDescription Get/Set the description of this device.
(Inherited from GenericBase)
Public propertyDialPadDown Get the Button object corresponding to the DialPadDown button for this device.
Public propertyDialPadEnter Get the Button object corresponding to the DialPadEnter button for this device.
Public propertyDialPadLeft Get the Button object corresponding to the DialPadLeft button for this device.
Public propertyDialPadRight Get the Button object corresponding to the DialPadRight button for this device.
Public propertyDialPadUp Get the Button object corresponding to the DialPadUp button for this device.
Public propertyDisposed Property to indicate if the device has been disposed.
(Inherited from GenericDevice)
Public propertyDvr Get the Button object corresponding to the Dvr button for this device.
Public propertyExit Get the Button object corresponding to the Exit button for this device.
Public propertyFastForward Get the Button object corresponding to the FastForward button for this device.
Public propertyGreen Get the Button object corresponding to the Green button for this device.
Public propertyGuide Get the Button object corresponding to the Guide button for this device.
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 device.
Public propertyIsOnline Property to get the current online state of the device.
(Inherited from GenericDevice)
Public propertyLast Get the Button object corresponding to the Last button for this device.
Public propertyMenu Get the Button object corresponding to the Menu button for this device.
Public propertyMute Get the Button object corresponding to the Mute button for this device.
Public propertyName Get the name of this device.
(Inherited from GenericBase)
Public propertyNextTrack Get the Button object corresponding to the NextTrack button for this device.
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 device.
Public propertyPlay Get the Button object corresponding to the Play button for this device.
Public propertyPower Get the Button object corresponding to the Power button for this device.
Public propertyPreviousTrack Get the Button object corresponding to the PreviousTrack button for this device.
Public propertyRecord Get the Button object corresponding to the Record button for this device.
Public propertyRed Get the Button object corresponding to the Red button for this device.
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 device.
Protected propertySIMPLDeviceImplementation Internal protected member used for actual device control.
(Inherited from GenericDevice)
Public propertyStop Get the Button object corresponding to the Stop button for this device.
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 propertyVolumeDown Get the Button object corresponding to the VolumeDown button for this device.
Public propertyVolumeUp Get the Button object corresponding to the VolumeUp button for this device.
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)
Public propertyYellow Get the Button object corresponding to the Yellow button for this device.
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 methodHr1x0SigAndButtonStateChange SigChange method that executes when a remote button event occurs or sig change event occurs for HR-1X0 Remotes. EventIds for this event are located in the Hr1x0EventIds class.
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)
Protected methodOnButtonStateChange Method to fire the button state change event.
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)
Top
Fields
 NameDescription
Protected fieldButtons Collection of button objects.
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also