Click or drag to resize

Dvphd Class

Ethernet based Multi-window video processor that displays high-res computer and high-definition video signals with HDCP, provides a fully-customizable HD graphical environment, and enables real-time annotation and touch screen control — all in a modular, scalable hardware platform.

This class will trigger SigChange, ControlChange, AttributeChange 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 Dvphd : BasicTriList

The Dvphd type exposes the following members.

Constructors
 NameDescription
Public methodDvphd Instantiates instance of DVPHD class on Ethernet.
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 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 propertyExtenderAnnotation2ReservedSigs Annotation2 reserved sigs extender.
Public propertyExtenderAnnotationReservedSigs Annotation reserved sigs extender.
Public propertyExtenderEthernetReservedSigs Ethernet reserved sigs extender.
Public propertyExtenderInputCardReservedSigs Input Card reserved sigs extender.
Public propertyExtenderOotbfCurrentOverlayReservedSigs OOTBF Current Overlay reserved sigs extender.
Public propertyExtenderOotbfCurrentPadAreaReservedSigs OOTBF Current Pad Area reserved sigs extender.
Public propertyExtenderOotbfCurrentReservedSigs OOTBF Current reserved sigs extender.
Public propertyExtenderOotbfCustomOverlayReservedSigs OOTBF Custom Overlay reserved sigs extender.
Public propertyExtenderOotbfCustomPadAreaReservedSigs OOTBF Custom Pad Area reserved sigs extender.
Public propertyExtenderOotbfCustomReservedSigs OOTBF Custom reserved sigs extender.
Public propertyExtenderOotbfDefaultSettingsReservedSigs OOTBF Default Settings reserved sigs extender.
Public propertyExtenderOotbfPresetReservedSigs OOTBF Preset reserved sigs extender.
Public propertyExtenderOotbfReservedSigs OOTBF reserved sigs extender.
Public propertyExtenderOotbfStaticNoVideoSettingsReservedSigs OOTBF Static No Video Settings reserved sigs extender.
Public propertyExtenderOotbfStaticOverlayReservedSigs OOTBF Static Overlay reserved sigs extender.
Public propertyExtenderOotbfStaticPadAreaReservedSigs OOTBF Static Pad Area reserved sigs extender.
Public propertyExtenderOotbfStaticReservedSigs OOTBF Static reserved sigs extender.
Public propertyExtenderOutputCardReservedSigs Output Card reserved sigs extender.
Public propertyExtenderQmSourceCompensationReservedSigs Collection of QM Source Compensation reserved sigs extenders.
Public propertyExtenderSmartTechnologiesStatusReservedSigs SMART Technologies Status reserved sigs extender.
Public propertyExtenderSourceControlReservedSigs Collection of Source Control reserved sigs extenders.
Public propertyExtenderSystem2ReservedSigs System2 reserved sigs extender.
Public propertyExtenderSystem3ReservedSigs System3 reserved sigs extender.
Public propertyExtenderSystemReservedSigs System reserved sigs extender.
Public propertyExtenderVideoControlReservedSigs Video Control reserved sigs extender.
Public propertyExtenderVpgInterfaceReservedSigs VPG Interface reserved sigs extender.
Public propertyID Property to get the ID of the device.
(Inherited from GenericDevice)
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 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 propertySleepWakeManager Sleep wake manager.
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 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)
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 Dvphd _dvphd;

   public ControlSystemDvphd()
   {
       //Register console commands
       CrestronConsole.AddNewConsoleCommand(BacklightOnCmd, "BackLightOn", "This is a DVPHD BackLightOn command", ConsoleAccessLevelEnum.AccessOperator);
       CrestronConsole.AddNewConsoleCommand(BacklightOffCmd, "BackLightOff", "This is a DVPHD BackLightOff command", ConsoleAccessLevelEnum.AccessOperator);
       CrestronConsole.AddNewConsoleCommand(AnnotationEffectDelayCmd, "AnnotationEffectDelay", "This is a DVPHD AnnotationEffectDelay command", ConsoleAccessLevelEnum.AccessOperator);
       CrestronConsole.AddNewConsoleCommand(CreateDeviceCmd, "CreateDevice", "This is a DVPHD CreateDevice command", ConsoleAccessLevelEnum.AccessOperator);
       CrestronConsole.AddNewConsoleCommand(VpgTouchCalibStartCmd, "VpgTouchCalibStart", "This is a DVPHD VpgTouchCalibStart command", ConsoleAccessLevelEnum.AccessOperator);
   }

   //This method is to create the DVPHD device and register with control system
   public void CreateDeviceCmd(String args)
   {
       //Initialize the DVPHD device
       _dvphd = new Dvphd(0x16, this);

       for (uint i = 1; i <= 8; i++)
       {
           _dvphd.ExtenderSourceControlReservedSigs[i].Use();
       }

       _dvphd.ExtenderSmartTechnologiesStatusReservedSigs.Use();
       _dvphd.ExtenderVpgInterfaceReservedSigs.Use();
       _dvphd.ExtenderAnnotation2ReservedSigs.Use();

       //Register the DVPHD with the Control system
       //This will enable the gateway connection ("127.0.0.1") in the system at the 
       //ID specified above that the DVPHD will connect to.
       _dvphd.Register();

       CrestronConsole.PrintLine("{0} is registered successfully", _dvphd.ToString());

       _dvphd.SigChange += DvphdSigChange;

       //Reserved sig handler initialization
       for (uint i = 1; i <= 8; i++)
       {
           _dvphd.ExtenderSourceControlReservedSigs[i].VideoAttributes.AttributeChange +=
               ExtenderSourceControlVideoAttributes_DeviceExtenderSigChange;
           _dvphd.ExtenderSourceControlReservedSigs[i].VideoControls.ControlChange +=
               ExtenderSourceControlVideoControls_DeviceExtenderSigChange;
           _dvphd.ExtenderSourceControlReservedSigs[i].DeviceExtenderSigChange +=
               ExtenderSourceControlReservedSigs_DeviceExtenderSigChange;
       }
       _dvphd.ExtenderSmartTechnologiesStatusReservedSigs.DeviceExtenderSigChange += ExtenderSmartTechnologiesStatusReservedSigs_DeviceExtenderSigChange;
       _dvphd.ExtenderVpgInterfaceReservedSigs.DeviceExtenderSigChange += ExtenderVpgInterfaceReservedSigs_DeviceExtenderSigChange;
       _dvphd.ExtenderAnnotation2ReservedSigs.DeviceExtenderSigChange += ExtenderAnnotation2ReservedSigs_DeviceExtenderSigChange;
   }

   //This method is to trigger the VPG touch calibration
   static void VpgTouchCalibStartCmd(string cmdparameters)
   {
       _dvphd.ExtenderVpgInterfaceReservedSigs.VPGTouchCalibrationStart();
   }

   //This method is to set the delay, in seconds, for the annotation effect to occur after the annotation has been drawn.
   static void AnnotationEffectDelayCmd(string cmdparameters)
   {
       _dvphd.ExtenderAnnotation2ReservedSigs.AnnotationEffectDelay.UShortValue = 50;
   }

   //This method is to set the Backlight On for DVPHD
   public void BacklightOnCmd(String args)
   {
       CrestronConsole.ConsoleCommandResponse("Switch On Backlight\r\n");
       _dvphd.ExtenderSystemReservedSigs.BacklightOn();
   }

   //This method is to set the Backlight Off for DVPHD
   public void BacklightOffCmd(String args)
   {
       CrestronConsole.ConsoleCommandResponse("Switch Off Backlight\r\n");
       _dvphd.ExtenderSystemReservedSigs.BacklightOff();
   }


// Sig callback used to read information received from the _dvphd.
   static void DvphdSigChange(GenericBase currentDevice, SigEventArgs args)
   {
       if (args.Event == eSigEvent.BoolChange)
       {
           var tempBooleanSig = args.Sig as BoolOutputSig;

           if (tempBooleanSig != null)
           {
               if (tempBooleanSig.Number <= 16000)
               {
                   //This means Boolean "sig" changed on the _dvphd
                   //Just print some information for now.
                   CrestronConsole.PrintLine("Boolean Sig {0}'s state {1}", tempBooleanSig.Number, tempBooleanSig.BoolValue);

                   _dvphd.BooleanInput[50].BoolValue = true;
               }
               else
               {
                   CrestronConsole.PrintLine("Boolean Sig {0} is not processed", tempBooleanSig.Number);
               }
           }
       }
       else if (args.Event == eSigEvent.UShortChange)
       {
           var tempIntegerSig = args.Sig as UShortOutputSig;

           if (tempIntegerSig != null)
           {
               if (tempIntegerSig.Number <= 16000)
               {
                   //This means Integer "cue" changed on the _dvphd
                   //Just print some information for now.
                   CrestronConsole.PrintLine("Integer Sig {0}'s state {1}", tempIntegerSig.Number, tempIntegerSig.UShortValue);

                   _dvphd.UShortInput[tempIntegerSig.Number].UShortValue = tempIntegerSig.UShortValue;
               }
               else
               {
                   CrestronConsole.PrintLine("Integer Sig {0} is not processed", tempIntegerSig.Number);
                }
           }
       }
       else if (args.Event == eSigEvent.StringChange)
       {
           var tempStringSig = args.Sig as StringOutputSig;

           if (tempStringSig != null)
           {
               if (tempStringSig.Number <= 16000)
               {
                   //This means String "cue" changed on the _dvphd
                   //Just print some information for now.
                   CrestronConsole.PrintLine("String Sig {0}'s state {1}", tempStringSig.Number, tempStringSig.StringValue);

                   _dvphd.StringInput[tempStringSig.Number].StringValue = tempStringSig.StringValue;
               }
               else
               {
                   CrestronConsole.PrintLine("String Sig {0} is not processed", tempStringSig.Number);
                }
           }
       }
   }

   //This method is to handle the Source Control Reserved Sig Events
   static void ExtenderSourceControlReservedSigs_DeviceExtenderSigChange(DeviceExtender extender, SigEventArgs args)
   {
       CrestronConsole.PrintLine("Source Control Reserved Sig {0}", args.Sig.Number);

       for (uint i = 1; i <= 8; i++)
       {
           //Sig change for the extender
           if (args.Sig == _dvphd.ExtenderSourceControlReservedSigs[i].NoVideoFeedback)
           {
               CrestronConsole.PrintLine("NoVideoFeedback: {0}", args.Sig.BoolValue);
               break;
           }
           if (args.Sig == _dvphd.ExtenderSourceControlReservedSigs[i].NoiseReductionFeedback)
           {
               CrestronConsole.PrintLine("NoiseReductionFeedback: {0}", args.Sig.UShortValue);
               break;
           }
       }
   }

   //This method is to handle the Video Controls Sig events of Source Control Extender
   static void ExtenderSourceControlVideoControls_DeviceExtenderSigChange(object sender, GenericEventArgs args)
   {
       if (args.EventId == VideoControlsEventIds.BlueFeedbackEventId)
       {
           CrestronConsole.Print("BlueFeedback Event received, BlueFeedback sig value is {0}\r\n", ((VideoControlsEnhanced)sender).BlueFeedback.UShortValue);
       }
   }

   //This method is to handle the Video Attributes Sig events of Source Control Extender
   static void ExtenderSourceControlVideoAttributes_DeviceExtenderSigChange(object sender, GenericEventArgs args)
   {
       if (args.EventId == VideoAttributeEventIds.HdcpActiveFeedbackEventId)
       {
           CrestronConsole.Print("HdcpActiveFeedback Event received, and HdcpActiveFeedback sig state is  {0}\r\n", ((DvphdVideoAttributes)sender).HdcpActiveFeedback.BoolValue);
       }
   }

   //This method is to handle the Annotation 2 Reserved Sig Events
   static void ExtenderAnnotation2ReservedSigs_DeviceExtenderSigChange(DeviceExtender extender, SigEventArgs args)
   {
       CrestronConsole.PrintLine("Annotation2 Reserved Sig {0}", args.Sig.Number);

       //Sig change for the extender
       if (args.Sig == _dvphd.ExtenderAnnotation2ReservedSigs.AnnotationEffectDelayFeedback)
       {
           CrestronConsole.PrintLine("AnnotationEffectDelayFeedback: {0}", args.Sig.UShortValue);
       }
   }

   //This method is to handle the VPG Interface Reserved Sig Events
   static void ExtenderVpgInterfaceReservedSigs_DeviceExtenderSigChange(DeviceExtender extender, SigEventArgs args)
   {
       CrestronConsole.PrintLine("VPG Interface Reserved Sig {0}", args.Sig.Number);

       //Sig change for the extender
       if (args.Sig == _dvphd.ExtenderVpgInterfaceReservedSigs.VPGTouchCalibrationStartFeedback)
       {
           CrestronConsole.PrintLine("VPGTouchCalibrationStartFeedback: {0}", args.Sig.BoolValue);
       }
   }

   //This method is to handle the SMART Technologies Status Reserved Sig Events
   static void ExtenderSmartTechnologiesStatusReservedSigs_DeviceExtenderSigChange(DeviceExtender extender, SigEventArgs args)
   {
       CrestronConsole.PrintLine("SMART Technologies Status Reserved Sig {0}", args.Sig.Number);

       //Sig change for the extender
       if (args.Sig == _dvphd.ExtenderSmartTechnologiesStatusReservedSigs.SmartBoardActiveFeedback)
       {
           CrestronConsole.PrintLine("SmartBoardActiveFeedback: {0}", args.Sig.BoolValue);
       }
   }

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also