Click or drag to resize

OutputBackgroundImage Class

Background Image class.

This class will trigger BackgroundImagePropertyChange, ImageFromLocalDrivePropertyChange and ImageFromRemoteDrivePropertyChange events.

Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpPro.DMOutputBackgroundImage

Namespace: Crestron.SimplSharpPro.DM
Assembly: SimplSharpPro (in SimplSharpPro.dll) Version: 2.21.121
Syntax
C#
public sealed class OutputBackgroundImage : IParentInformation

The OutputBackgroundImage type exposes the following members.

Properties
 NameDescription
Public propertyDisabledFeedback Property to indicate if the background image is disabled.

The BackgroundImagePropertyChange event will trigger with BackgroundImageDisabledEventId.

Public propertyEnabledFeedback Property to indicate if the background image is enabled.

The BackgroundImagePropertyChange event will trigger with BackgroundImageEnabledEventId.

Public propertyImageDisplayMode Property to set/get the image display mode. This property is currently not supported by "HdPs401", "HdPs402", "HdPs442", "HdPs621" and "HdPs622" devices and returns OneToOne when queried and sets are ignored.
Public propertyImageDisplayModeFeedback Property to report the image display mode for displaying background image, after no video is detected. This property is currently not supported by "HdPs401", "HdPs402", "HdPs442", "HdPs621" and "HdPs622" devices and returns OneToOne when queried.

The BackgroundImagePropertyChange event will trigger with NoVideoTimeoutFeedbackEventId.

Public propertyLocalDriveImage Property to access local drive image object.

The ImageFromLocalDrivePropertyChange event will trigger with DMOutputEventIds.

Public propertyNoVideoTimeout Property to set/get the time out, to confirm no video on output. The minimum timeout is 5 seconds and maximum timeout is 65535 seconds. Default timeout is 5 seconds. After this time out the background image will be displayed.
Public propertyNoVideoTimeoutFeedback Property to indicate timeout, to display background image after no video is detected.

The BackgroundImagePropertyChange event will trigger with NoVideoTimeoutFeedbackEventId.

Public propertyOwner Reference back to the device that this video attribute is on.
Public propertyParent The parent that this object was added to.
Public propertyRemoteDriveImage Property to access remote drive image object.

The ImageFromRemoteDrivePropertyChange event will trigger with DMOutputEventIds.

Public propertyRetrievalMode Property to set/get the image source.
Public propertyRetrievalModeFeedback Property to indicate the image location for retieval.

The BackgroundImagePropertyChange event will trigger with RetrievalModeFeedbackEventId.

Public propertyUserSpecifiedObject Can be assigned anything that user wants.
Top
Methods
 NameDescription
Public methodDisable Method to disable the display of background image. After executing, no image will be displayed or existing image will be cleared from display.
Public methodEnable Method to enable the display of background image. Background image will be fetched based on the RetrievalMode property.
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 eventBackgroundImagePropertyChange Event triggered when a feedback has changed for this OutputBackgroundImage.
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also