Click or drag to resize

OverlayProperties Class

Base class for Text and Image Overlay Properties.

This class will trigger OverlayPropertiesChange event.

Inheritance Hierarchy

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

The OverlayProperties 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.

Public propertyEnableFeedback Property to report the text/image overlay enabled status.

The OverlayPropertiesChange event will trigger with EnabledEventId.

Public propertyLocation Property to set the location of the overlayed text/image.
Public propertyLocationFeedback Property to report the location of the overlayed text/image.

The OverlayPropertiesChange event will trigger with LocationFeedbackEventId.

Public propertyOwner This represents the owner of this class and needs to be cast accordingly.
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.
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.

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

The OverlayPropertiesChange event will trigger with XPositionFeedbackEventId.

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

The OverlayPropertiesChange event will trigger with YPositionFeedbackEventId.

Top
Methods
 NameDescription
Public methodDisable Method to disable text/image overlay.
Public methodEnable Method to enable text/image overlay.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
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)
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.
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also