Click or drag to resize

MpBBase Class

Base class for Media Presentation Button Panels.

This class will trigger ButtonStateChange, ShaftEncoderChange and LightSensorChange events.

Inheritance Hierarchy

Namespace: Crestron.SimplSharpPro.Keypads
Assembly: Crestron.SimplSharpPro.Keypads (in Crestron.SimplSharpPro.Keypads.dll) Version: 2.21.121
Syntax
C#
public class MpBBase : KeypadBase, IIRInputPort, 
	IAmbientLightSensor, IBargraphWithIndicator, IBargraph

The MpBBase type exposes the following members.

Properties
 NameDescription
Public propertyBargraphValue Property to set the value of the 5-segment bargraph, as follows: 0% = No segment illuminated 1% - 20% = Segment 1 ON 21% - 40% = Segments 1 and 2 ON 41% - 60% = Segments 1-3 ON 61% - 80% = Segments 1-4 ON 81% - 100% = Segments 1-5 ON Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.
Public propertyButton Collection of buttons supported by the device.
(Inherited from KeypadBase)
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 propertyFeedbacks Property to get the collection of feedbacks on the device.
(Inherited from KeypadBase)
Public propertyID Property to get the ID of the device.
(Inherited from GenericDevice)
Public propertyIndicatorIntensity Property to set the brightness level of the bargraph. Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.
Public propertyIRInputPort IR input port on the device. Valid IRIDs range from 0x00 to 0x3F.
Public propertyIsOnline Property to get the current online state of the device.
(Inherited from GenericDevice)
Public propertyLightSensorValue Property to report the ambient light level detected by the internal photo sensor.

The LightSensorChange event will trigger with UShort and LightSensorValue.

Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.
Public propertyMpBShaftEncoder Shaft Encoder object for MpBBase.
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 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 propertyRowBacklightBrightness Property to set the backlight brightness level of the corresponding row, where Row 1 is the top row and Row 3 is the bottom row. The backlight illuminates the labels over each button. Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.
Public propertyRowIndicatorBrightness Property to set the brightness level of the corresponding row of LED indicators, where Row 1 is the top row and Row 3 is the bottom row. Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.
Protected propertySIMPLDeviceImplementation Internal protected member used for actual device control.
(Inherited from GenericDevice)
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)
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 fired when a button state change was received from the device.
(Inherited from KeypadBase)
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 eventLightSensorChange Event triggered when the ambient light level as a percentage from 0% to 100% is reported as determined by the internal light sensor.
Public eventOnlineStatusChange Event triggered when the Online status of the device changes.
(Inherited from GenericDevice)
Top
Fields
 NameDescription
Protected field_Buttons Collection that contains button objects.
(Inherited from KeypadBase)
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also