Click or drag to resize

ImageOverlayProperties Class

Image Overlay Properties Class.

This class will trigger OverlayPropertiesChange event.

Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpPro.DM.Streaming.OverlayOverlayProperties
    Crestron.SimplSharpPro.DM.Streaming.OverlayImageOverlayProperties

Namespace: Crestron.SimplSharpPro.DM.Streaming.Overlay
Assembly: Crestron.SimplSharpPro.DM (in Crestron.SimplSharpPro.DM.dll) Version: 2.21.121
Syntax
C#
public sealed class ImageOverlayProperties : OverlayProperties

The ImageOverlayProperties type exposes the following members.

Properties
 NameDescription
Public propertyDisableFeedback Property to report the text/image overlay disabled status.

The OverlayPropertiesChange event will trigger with DisabledEventId.


(Inherited from OverlayProperties)
Public propertyEnableFeedback Property to report the text/image overlay enabled status.

The OverlayPropertiesChange event will trigger with EnabledEventId.


(Inherited from OverlayProperties)
Public propertyImageBlendColor Property to set a color that will be made transparent. Takes hex triplet (#1122CC), shorthand (#ccc) or HTML color name. Case insensitive. This property is only supported by HD-WP-4K-401-C device.
Public propertyImageBlendColorDisabledFeedback Property to indicate if the image blend color is disabled. True = blend color disabled; False = blend color enabled. This property is supported by HD-WP-4K-401-C device only.

The OverlayPropertiesChange event will trigger with ImageBlendColorDisabledEventId.

Public propertyImageBlendColorEnabledFeedback Property to indicate if the image blend color is enabled. True = blend color enabled; False = blend color disabled. This property is supported by HD-WP-4K-401-C device only.

The OverlayPropertiesChange event will trigger with ImageBlendColorEnabledEventId.

Public propertyImageBlendColorFeedback Property to return a color that was made transparent. Takes hex triplet (#1122CC), shorthand (#ccc) or HTML color name. Case insensitive. This property is only supported by HD-WP-4K-401-C device.

The OverlayPropertiesChange event will trigger with ImageBlendColorFeedbackEventId and Index gives the index into the ImageBlendColorFeedback collection.

Public propertyLocation Property to set the location of the overlayed text/image.
(Inherited from OverlayProperties)
Public propertyLocationFeedback Property to report the location of the overlayed text/image.

The OverlayPropertiesChange event will trigger with LocationFeedbackEventId.


(Inherited from OverlayProperties)
Public propertyOwner This represents the owner of this class and needs to be cast accordingly.
(Inherited from OverlayProperties)
Public propertyPath Property to set URI to image (should support the schemes, HTTP, HTTPS, file, SMB/CIFS at a minimum).
Public propertyPathFeedback Property to return the URI of the image.

The OverlayPropertiesChange event will trigger with PathFeedbackEventId.

Public propertyTransparency Property to set the transparency of the text/image for DmRmc100Str and HdWp4k401C or DmfXx4kSfp. Property to set the transparency of the text and the background for "DmNvx350", "DmNvx351", "DmNvx350C" or "DmNvx351C". Setting this property sets the "BackgroundTransparency" property of the "DmNvx350", "DmNvx351", "DmNvx350C" or "DmNvx351C". Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.
(Inherited from OverlayProperties)
Public propertyTransparencyFeedback Property to report the current transparency value of the text/image DmRmc100Str and HdWp4k401C. Property to report the current transparency value of the text and the background for "DmNvx350", "DmNvx351", "DmNvx350C" or "DmNvx351C". Reading this property returns the "BackgroundTransparencyFeedback" property of the "DmNvx350", "DmNvx351", "DmNvx350C" or "DmNvx351C". Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.

The OverlayPropertiesChange event will trigger with TransparencyFeedbackEventId.


(Inherited from OverlayProperties)
Public propertyType Type of Overlay Properties class.
(Inherited from OverlayProperties)
Public propertyXPosition Property to set the X position of the text/image overlay (in pixels) based on the value set in Location.
(Inherited from OverlayProperties)
Public propertyXPositionFeedback Property to report the X position of the text/image overlay (in pixels).

The OverlayPropertiesChange event will trigger with XPositionFeedbackEventId.


(Inherited from OverlayProperties)
Public propertyYPosition Property to set the Y the position of the text/image overlay (in lines) based on the value set in Location.
(Inherited from OverlayProperties)
Public propertyYPositionFeedback Property to report the Y position of the text/image overlay (in pixels).

The OverlayPropertiesChange event will trigger with YPositionFeedbackEventId.


(Inherited from OverlayProperties)
Top
Methods
 NameDescription
Public methodDisable Method to disable text/image overlay.
(Inherited from OverlayProperties)
Public methodDisableImageBlendColor Method to disable image blend color. This property is supported by HD-WP-4K-401-C device only.
Public methodEnable Method to enable text/image overlay.
(Inherited from OverlayProperties)
Public methodEnableImageBlendColor Method to enable image blend color. This property is supported by HD-WP-4K-401-C device only.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Events
 NameDescription
Public eventOverlayPropertiesChange Event triggered when TextOverlayProperties or ImageOverlayProperties sig change is received from the device.
(Inherited from OverlayProperties)
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also