Click or drag to resize

Dge100 Class

Standalone digital graphics engine device similar in nature to the DGE-1 and DVPHD.

This class will trigger BaseEvent, AttributeChange, CecChange, DeviceInformationChange, StreamChange and DeviceExtenderSigChange events.

Inheritance Hierarchy

Namespace: Crestron.SimplSharpPro.UI
Assembly: Crestron.SimplSharpPro.UI (in Crestron.SimplSharpPro.UI.dll) Version: 2.21.121
Syntax
C#
public class Dge100 : BasicTriListWithSmartObject, IIROutputPorts, 
	IComPorts

The Dge100 type exposes the following members.

Constructors
 NameDescription
Public methodDge100 Constructor for Dge100 that uses Ethernet as interface.
Top
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 propertyComPorts Collection of serial COM ports on the Dge100 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 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 propertyExtenderApplicationControlReservedSigs Property to access the Application Control functionality of the Dge100 and DmDge200C.

This property will trigger DeviceExtenderSigChange event.

Public propertyExtenderAudioReservedSigs Property to access the Audio functionality of the Dge100 and DmDge200C.

This property will trigger DeviceExtenderSigChange event.

Public propertyExtenderAuthenticationReservedSigs Property to access the Authentication functionality of the Dge100 and DmDge200C.

This property will trigger DeviceExtenderSigChange event.

Public propertyExtenderAutoUpdateReservedSigs Property to access the Auto Update functionality of the Dge100 and DmDge200C.

This property will trigger DeviceExtenderSigChange event.

Public propertyExtenderDvp4AnnotationReservedSigs Property to access the DVP4 Annotation functionality of the Dge100 and DmDge200C.

This property will trigger DeviceExtenderSigChange event.

Public propertyExtenderEthernetReservedSigs Property to access the Ethernet functionality of the Dge100 and DmDge200C.

This property will trigger DeviceExtenderSigChange event.

Public propertyExtenderPinpointUXReservedSigs Property to access the Pinpoint UX functionality of the DmDge200C.

This property will trigger DeviceExtenderSigChange event.

This is currently supported only on the DmDge200C
Public propertyExtenderScreenSaverReservedSigs Property to access the Screen Saver functionality of the Dge100 and DmDge200C.

This property will trigger DeviceExtenderSigChange event.

Public propertyExtenderSystem3ReservedSigs Property to access the System3 functionality of the Dge100 and DmDge200C.

This property will trigger DeviceExtenderSigChange event.

Public propertyExtenderSystemReservedSigs Property to access the System functionality of the Dge100 and DmDge200C.

This property will trigger DeviceExtenderSigChange event.

Public propertyExtenderTouchDetectionReservedSigs Property to access the Touch Detection functionality of the Dge100 and DmDge200C.

This property will trigger DeviceExtenderSigChange event.

Public propertyHdmiIn HDMI Input present on this Dge100 device

This property will trigger StreamChange with DMInputEventIds, AttributeChange with VideoAttributeEventIds, and CecChange with CecEventIds.

Public propertyHdmiOut HDMI output present on this Dge100 device

This property will trigger StreamChange with DMOutputEventIds, AttributeChange with VideoAttributeEventIds, DeviceInformationChange with ConnectedDeviceEventIds and CecChange with CecEventIds.

Public propertyID Property to get the ID of the device.
(Inherited from GenericDevice)
Public propertyIROutputPorts Collection of IR output ports on the Dge100 device.
Public propertyIsOnline Property to get the current online state of the device.
(Inherited from GenericDevice)
Public propertyName Get the name of this device.
(Inherited from GenericBase)
Public propertyNumberOfComPorts Number of serial COM ports this Dge100 device supports.
Public propertyNumberOfIROutputPorts Number of IR output ports this Dge100 device supports.
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)
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 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 propertyUsbPort Get the UsbHidPort.

This property will trigger UsbHidChange with UsbHidEventIds.

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)
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)
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 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
Example
C#
static Dge100 _dge100;

   public ControlSystemDge100()
   {
       //Register console commands
       CrestronConsole.AddNewConsoleCommand(CreateDeviceCmd, "CreateDevice", "This is a DGE-100 CreateDevice command", ConsoleAccessLevelEnum.AccessOperator);
       CrestronConsole.AddNewConsoleCommand(AllAudioToggleCmd, "AllAudioToggle", "This is a DGE-100 AllAudioToggle command", ConsoleAccessLevelEnum.AccessOperator);
   }

   public void CreateDeviceCmd(String args)
   {
       //Initialize the DGE-100 device for Ethernet Communication.
       _dge100 = new Dge100(0x18, this);

       _dge100.ExtenderAuthenticationReservedSigs.Use();

       _dge100.BaseEvent += Dge100EventHandler;

       _dge100.HdmiIn.VideoAttributes.AttributeChange += Dge100_VideoAttributeEventHandler;
       _dge100.HdmiIn.StreamCec.CecChange += Dge100CecChangeEventHandler;
       _dge100.HdmiIn.StreamChange += Dge100_StreamChangeEventHandler;

       _dge100.HdmiOut.VideoAttributes.AttributeChange += Dge100_VideoAttributeEventHandler;
       _dge100.HdmiOut.StreamCec.CecChange += Dge100CecChangeEventHandler;
       _dge100.HdmiOut.StreamChange += Dge100_StreamChangeEventHandler;
       _dge100.HdmiOut.ConnectedDevice.DeviceInformationChange += Dge100_DeviceInfoChangeEventHandler;

       _dge100.UsbPort.UsbHidChange += Dge100_UsbHidChangeEventHandler;

       //Reserved sig handler initialization
       _dge100.ExtenderAuthenticationReservedSigs.DeviceExtenderSigChange += ExtenderAuthenticationReservedSigs_DeviceExtenderSigChange;

       _dge100.Register();
   }

   // Method to toggle the All Audio Toggle Sig value for DGE-100.
   public void AllAudioToggleCmd(String args)
   {
       if (_dge100.ExtenderAudioReservedSigs.AllAudioOnFeedback.BoolValue)
       {
           CrestronConsole.ConsoleCommandResponse("Disable Audio\r\n");
           _dge100.ExtenderAudioReservedSigs.AllAudioOff();
       }
       else
       {
           CrestronConsole.ConsoleCommandResponse("Enable Audio\r\n");
           _dge100.ExtenderAudioReservedSigs.AllAudioOn();
       }
   }

   // Sig callback used to read Authentication Control Reserved Sig information received from the DGE-100.
   static void ExtenderAuthenticationReservedSigs_DeviceExtenderSigChange(DeviceExtender currentDeviceExtender, SigEventArgs args)
   {
       //Sig change for the extender
       if (args.Sig == _dge100.ExtenderAuthenticationReservedSigs.AuthenticationOnFeedback)
       {
           CrestronConsole.PrintLine("AuthenticationOnFeedback: {0}", args.Sig.BoolValue);
       }
   }

   // Method to handle HDMI Out/In sig change events for DGE-100 Device.
   static void Dge100EventHandler(GenericBase device, BaseEventArgs args)
   {
       if (device.ID == 4)
       {
           CrestronConsole.PrintLine("HdmiIn");
       }
       else if (device.ID == 5)
       {
           CrestronConsole.PrintLine("HdmiOut");
       }

       if (args.EventId == DMInputEventIds.SourceSyncEventId)
       {
           CrestronConsole.PrintLine("Sync detected on DGE-100, SyncDetectedFeedback value is {0}", _dge100.HdmiIn.SyncDetectedFeedback.BoolValue);
       }
       else if (args.EventId == DMOutputEventIds.SyncDetectedEventId)
       {
           CrestronConsole.PrintLine("Sync detected on DGE-100, SyncDetectedFeedback value is {0}", _dge100.HdmiOut.SyncDetectedFeedback.BoolValue);
       }
   }

   // Method to handle USB HID sig change events for DGE-100 Device.
   static void Dge100_UsbHidChangeEventHandler(UsbHidPort port, UsbHidEventArgs args)
   {
       if (args.EventId == UsbHidEventIds.DeviceDetectedEventId)
       {
           CrestronConsole.PrintLine("{0} device Device Detected Feedback Event Occurred\r\n", _dge100.UsbPort.ToString());
       }
   }

   // Method to handle HDMI Out Device Info sig change events for DGE-100 Device.
   static void Dge100_DeviceInfoChangeEventHandler(ConnectedDeviceInformation device, ConnectedDeviceEventArgs args)
   {
       if (args.EventId == ConnectedDeviceEventIds.ManufacturerEventId)
       {
           CrestronConsole.PrintLine("{0} device Manufacturer Name Feedback Event Occurred\r\n", _dge100.HdmiOut.ConnectedDevice.ToString());
       }
   }

   // Method to handle HDMI Out/In Stream sig change events for DGE-100 Device.
   static void Dge100_StreamChangeEventHandler(Stream stream, StreamEventArgs args)
   {
       if (args.EventId == DMInputEventIds.AudioFormatEventId)
       {
           CrestronConsole.PrintLine("{0} device Audio Format Feedback Event Occurred\r\n", stream.ToString());
       }
   }

   // Method to handle HDMI Out/In VideoAttribute sig change events for DGE-100 Device.
   static void Dge100_VideoAttributeEventHandler(object sender, GenericEventArgs args)
   {
       if (args.EventId == VideoAttributeEventIds.HorizontalResolutionFeedbackEventId)
       {
           CrestronConsole.PrintLine("{0} device Horizontal Resolution Feedback Event Occurred\r\n", sender.ToString());
       }
   }

   // Method to handle HDMI Out/In CEC sig change events for DGE-100 Device.
   static void Dge100CecChangeEventHandler(Cec device, CecEventArgs args)
   {
       if (args.EventId == CecEventIds.ErrorFeedbackEventId)
       {
           CrestronConsole.PrintLine(string.Format("Device: {0} - Cec Error Detected Status: {1}", _dge100.ToString(), _dge100.HdmiOut.StreamCec.ErrorFeedback.BoolValue));
       }
   }

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also