Click or drag to resize

AirMediaGeneralDisplay Class

Contains AirMedia general display functions for OSD slot.
Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpProAirMediaGeneralDisplay

Namespace: Crestron.SimplSharpPro
Assembly: SimplSharpPro (in SimplSharpPro.dll) Version: 2.21.121
Syntax
C#
public class AirMediaGeneralDisplay

The AirMediaGeneralDisplay type exposes the following members.

Properties
 NameDescription
Public propertyAddressDisplayDisableFeedback Reports if hostname and domain name display is disabled.

For the "Am100" and "Am101" device, this will fire the "BaseEvent" with event Id "Am100.DisplayAddressDisabledEventId"

This property is not supported on "AM-200", "AM-300" and DMPS3-4K-350-C/250-C product.

Public propertyAddressDisplayEnableFeedback Reports if hostname and domain name display is enabled.

For the "Am100" and "Am101" device, this will fire the "BaseEvent" with event Id "Am100.DisplayAddressEnabledEventId"

This property is not supported on "AM-200", "AM-300" and DMPS3-4K-350-C/250-C product.

Public propertyAirMediaConnectionOverlayDisabledFeedback Reports if the AirMedia connection information is not overlayed when AirMedia Canvas is enabled and multiple users are present.

Only supported for AM-200/AM-300 devices.

This property is not supported on DMPS3-4K-350-C/250-C product.

The "AirMediaInputSlot.AirMediaChange" will trigger with "AirMediaInputSlot.AirMediaConnectionOverlayDisabledFeedbackEventId" when the state of this field changes.

Public propertyAirMediaConnectionOverlayEnabledFeedback Reports if the AirMedia connection information is overlayed when AirMedia Canvas is enabled and multiple users are present.

Only supported for AM-200/AM-300 devices.

This property is not supported on DMPS3-4K-350-C/250-C product.

The "AirMediaInputSlot.AirMediaChange" will trigger with "AirMediaInputSlot.AirMediaConnectionOverlayEnabledFeedbackEventId" when the state of this field changes.

Public propertyCustomURL Set the URL for Custom URL on the ODS for the AirMedia connection.
Public propertyCustomURLFeedback Reports the URL for the Custom URL on the OSD for the AirMedia connection.

For AM-200 and AM-300, the "AirMediaInputSlot.AirMediaChange" will trigger with "AirMediaInputSlot.CustomURLFeedbackEventId".

Public propertyDisplayConnectionOption Sets the display connection option.

For AM-200 and AM-300, the "AirMediaInputSlot.AirMediaChange" will trigger with "AirMediaInputSlot.DisplayConnectionOptionEventId".

This property is only supported on "AM-200", "AM-300" and DMPS3-4K-350-C/250-C product.

Public propertyDisplayConnectionOptionDisabledFeedback Reports if display connection option is disabled.

For AM-200 and AM-300, the "AirMediaInputSlot.AirMediaChange" will trigger with "AirMediaInputSlot.AirMediaDisplayConnectionOptionDisabledEventId".

For Dmps3AirMediaInput card,theDMInputChangewill trigger with AirMediaDisplayConnectionOptionDisabledEventId.

This property is only supported on "AM-200", "AM-300" and DMPS3-4K-350-C/250-C product.

Public propertyDisplayConnectionOptionEnabledFeedback Reports if display connection option is enabled.

For AM-200 and AM-300, the "AirMediaInputSlot.AirMediaChange" will trigger with "AirMediaInputSlot.AirMediaDisplayConnectionOptionEnabledEventId".

For Dmps3AirMediaInput card,theDMInputChangewill trigger with AirMediaDisplayConnectionOptionEnabledEventId.

This property is only supported on "AM-200", "AM-300" and DMPS3-4K-350-C/250-C product.

Public propertyDisplayConnectionOptionFeedback Reports the current display connection option.

For Dmps3AirMediaInput card, the DMInputChangewill trigger with AirMediaDisplayConnectionOptionEventId.

For AM-200 and AM-300, the "AirMediaInputSlot.AirMediaChange" will trigger with "AirMediaInputSlot.AirMediaDisplayConnectionOptionEventId".

This property is only supported on "AM-200", "AM-300" and DMPS3-4K-350-C/250-C product.

Public propertyDisplayCustomUrlDisabledFeedback Reports if display custom URL is disabled.

When this signal is used on a switch based control system, the DMInputChange event will trigger with AirMediaDisplayCustomUrlDisabledEventId.

This property is not supported on "AM-200", "AM-300" and DMPS3-4K-350-C/250-C product.

Public propertyDisplayCustomUrlEnabledFeedback Reports if display custom URL is enabled.

When this signal is used on a switch based control system, the DMInputChange event will trigger with AirMediaDisplayCustomUrlEnabledEventId.

This property is not supported on "AM-200", "AM-300" and DMPS3-4K-350-C/250-C product.

Public propertyDisplayTimeout Sets the timeout to display the OSD after a user disconnects.
Remarks
The valid value range is 1 to 300. Value 1 means 1 second. Value 0 means infinity.
This property is not supported on all platforms. This property is not supported on "AM-200", "AM-300" and DMPS3-4K-350-C/250-C.
Public propertyDisplayTimeoutFeedback Reports the timeout value for displaying the OSD after a user disconnects.
Remarks
The valid value range is 1 to 300. Value 1 means 1 second. Value 0 means infinity.

This property is not supported on "AM-200", "AM-300" and DMPS3-4K-350-C/250-C.

For the "Am100" and "Am101" device, this will fire the "BaseEvent" with event Id "Am100.OSDTimeoutEventId"

Public propertyDomainNameDisplayDisableFeedback Reports if domain name display is disabled.

For the "Am100" and "Am101" device, this will fire the "BaseEvent" with event Id "Am100.DisplayDomainNameDisabledEventId"

This property is not supported on "AM-200", "AM-300" and DMPS3-4K-350-C/250-C product.

Public propertyDomainNameDisplayEnableFeedback Reports if domain name display is enabled.

For the "Am100" and "Am101" device, this will fire the "BaseEvent" with event Id "Am100.DisplayDomainNameEnabledEventId"

This property is not supported on "AM-200", "AM-300" and DMPS3-4K-350-C/250-C product.

Public propertyImageErrorFeedback Reports an error if there was a problem displaying the image at ImageURL. Value 0 means OK.

For AM-200 and AM-300, the "AirMediaInputSlot.AirMediaChange" will trigger with "AirMediaInputSlot.ImageErrorFeedbackEventId".

For Dmps3AirMediaInput card,theDMInputChangewill trigger with AirMediaImageErrorEventId.

For the "Am100" and "Am101" device, this will fire the "BaseEvent" with event Id "Am100.AirMediaImageErrorEventId"

Public propertyImageURL Sets the URL for the image. Supports HTTP,HTTPS and FTP. This property is not supported by AM-200 and AM-300 devices.
Public propertyImageURLFeedback Reports the URL for the image. Supports HTTP,HTTPS and FTP. This property is not supported by AM-200 and AM-300 devices.

For Dmps3AirMediaInput card,theDMInputChange will trigger with AirMediaImageURLEventId.

For AM-200 and AM-300, the "AirMediaInputSlot.AirMediaChange" will trigger with "AirMediaInputSlot.ImageURLFeedbackEventId".

For the "Am100" and "Am101" device, this will fire the "BaseEvent" with event Id "Am100.AirMediaImageURLEventId"

Public propertyIPAddressDisplayDisableFeedback Reports if IP address display is disabled.

For the "Am100" and "Am101" device, this will fire the "BaseEvent" with event Id "Am100.DisplayIPAddressDisabledEventId"

This property is not supported on "AM-200", "AM-300" and DMPS3-4K-350-C/250-C product.

Public propertyIPAddressDisplayEnableFeedback Reports if IP address display is enabled.

For the "Am100" and "Am101" device, this will fire the "BaseEvent" with event Id "Am100.DisplayIPAddressEnabledEventId"

This property is not supported on "AM-200", "AM-300" and DMPS3-4K-350-C/250-C product.

Public propertyLoginCodeDisplayDisableFeedback Reports if Login Code display is disabled.

For Dmps3AirMediaInput card,theDMInputChangewill trigger with DMInputEventIds.

For AM-200 and AM-300, the "AirMediaInputSlot.AirMediaChange" will trigger with "AirMediaInputSlot.AirMediaDisplayLoginCodeDisabledEventId".

For the "Am100" and "Am101" device, this will fire the "BaseEvent" with event Id "Am100.DisplayLoginCodeDisabledEventId"

Public propertyLoginCodeDisplayEnableFeedback Reports if Login Code display is enabled.

For AM-200 and AM-300, the "AirMediaInputSlot.AirMediaChange" will trigger with "AirMediaInputSlot.AirMediaDisplayLoginCodeEnabledEventId".

For Dmps3AirMediaInput card,theDMInputChange will trigger with AirMediaDisplayLoginCodeEnabledEventId.

For the "Am100" and "Am101" device, this will fire the "BaseEvent" with event Id "Am100.DisplayIPAddressEnabledEventId"

Public propertyShowOSDFeedback Reports if the OSD is being displayed.

This property is not supported on "AM-200", "AM-300" and DMPS3-4K-350-C/250-C product.

For the "Am100" and "Am101" device, this will fire the "BaseEvent" with event Id "Am100.OSDDisplayedFeedbackEventId"

Public propertyShowWiFiAddressCustom The custom string to appear on the OSD as the WiFi's Address when ShowWiFiAddressOptions is set to Custom.

This property is only supported on "AM-200" and "AM-300" products.

Public propertyShowWiFiAddressCustomFeedback Property to report the custom string that will represent the WiFi's Address when ShowWiFiAddressOptions is set to Custom.

For AM-200 and AM-300, the "AirMediaInputSlot.AirMediaChange" will trigger with "AirMediaInputSlot.ShowWiFiAddressCustomFeedbackEventId".

This property is only supported on "AM-200" and "AM-300" products.

Public propertyShowWiFiAddressDisabledFeedback Reports if the WiFi address information will not be shown on the OSD.

Only supported for AM-200/AM-300 devices.

The "AirMediaInputSlot.AirMediaChange" will trigger with "AirMediaInputSlot.ShowWiFiAddressDisabledFeedbackEventId" when the state of this field changes.

Public propertyShowWiFiAddressEnabledFeedback Reports if the WiFi address information will be shown on the OSD.

Only supported for AM-200/AM-300 devices.

The "AirMediaInputSlot.AirMediaChange" will trigger with "AirMediaInputSlot.ShowWiFiAddressEnabledFeedbackEventId" when the state of this field changes.

Public propertyShowWiFiAddressOptions Sets how the WiFi's Address will be shown on the OSD of this device.

This property is only supported on "AM-200" and "AM-300" products.

Public propertyShowWiFiAddressOptionsFeedback Reports the current option selected for how the WiFi's Address is shown on the OSD.

For AM-200 and AM-300, the "AirMediaInputSlot.AirMediaChange" will trigger with "AirMediaInputSlot.ShowWiFiAddressOptionsFeedbackEventId".

This property is only supported on "AM-200" and "AM-300" products.

Public propertyShowWiFiKeyCustom The custom string to appear on the OSD as the WiFi's Key when ShowWiFiKeyOptions is set to ShowCustomValue.

This property is only supported on "AM-200" and "AM-300" products.

Public propertyShowWiFiKeyCustomFeedback Reports the custom string that will represent the WiFi's key when ShowWiFiKeyOptions is set to ShowCustomValue.

For AM-200 and AM-300, the "AirMediaInputSlot.AirMediaChange" will trigger with "AirMediaInputSlot.ShowWiFiKeyCustomFeedbackEventId".

This property is only supported on "AM-200" and "AM-300" products.

Public propertyShowWiFiKeyDisabledFeedback Reports if the WiFi key information will not be shown on the OSD.

Only supported for AM-200/AM-300 devices.

The "AirMediaInputSlot.AirMediaChange" will trigger with "AirMediaInputSlot.ShowWiFiKeyDisabledFeedbackEventId" when the state of this field changes.

Public propertyShowWiFiKeyEnabledFeedback Reports if the WiFi key information will be shown on the OSD.

Only supported for AM-200/AM-300 devices.

The "AirMediaInputSlot.AirMediaChange" will trigger with "AirMediaInputSlot.ShowWiFiKeyEnabledFeedbackEventId" when the state of this field changes.

Public propertyShowWiFiKeyOptions Sets how the WiFi's Key will be shown on the OSD of this device.

This property is only supported on "AM-200" and "AM-300" products.

Public propertyShowWiFiKeyOptionsFeedback Reports the current option selected for how the WiFi's Key is shown on the OSD.

For AM-200 and AM-300, the "AirMediaInputSlot.AirMediaChange" will trigger with "AirMediaInputSlot.ShowWiFiKeyOptionsFeedbackEventId".

This property is only supported on "AM-200" and "AM-300" products.

Public propertyShowWiFiSsidCustom The custom string to appear on the OSD as the WiFi's SSID when ShowWiFiSsidOptions is set to ShowCustomValue.

This property is only supported on "AM-200" and "AM-300" products.

Public propertyShowWiFiSsidCustomFeedback Report the custom string that will represent the WiFi's SSID when ShowWiFiSsidOptions is set to ShowCustomValue.

For AM-200 and AM-300, the "AirMediaInputSlot.AirMediaChange" will trigger with "AirMediaInputSlot.ShowWiFiSsidCustomFeedbackEventId".

This property is only supported on "AM-200" and "AM-300" products.

Public propertyShowWiFiSsidDisabledFeedback Reports if the WiFi SSID information will not be shown on the OSD.

Only supported for AM-200/AM-300 devices.

The "AirMediaInputSlot.AirMediaChange" will trigger with "AirMediaInputSlot.ShowWiFiSsidDisabledFeedbackEventId" when the state of this field changes.

Public propertyShowWiFiSsidEnabledFeedback Reports if the WiFi SSID information will be shown on the OSD.

Only supported for AM-200/AM-300 devices.

The "AirMediaInputSlot.AirMediaChange" will trigger with "AirMediaInputSlot.ShowWiFiSsidEnabledFeedbackEventId" when the state of this field changes.

Public propertyShowWiFiSsidOptions Sets how the WiFi's SSID will be shown on the OSD of this device.

This property is only supported on "AM-200" and "AM-300" products.

Public propertyShowWiFiSsidOptionsFeedback Reports the current option selected for how the WiFi's SSID is shown on the OSD.

For AM-200 and AM-300, the "AirMediaInputSlot.AirMediaChange" will trigger with "AirMediaInputSlot.ShowWiFiSsidOptionsFeedbackEventId".

This property is only supported on "AM-200" and "AM-300" products.

Top
Methods
 NameDescription
Public methodAddressDisplayDisable Hides the AirMedia device hostname and domain name on the OSD.

This property is not supported on "AM-200", "AM-300" and DMPS3-4K-350-C/250-C product.

Public methodAddressDisplayEnable Displays the AirMedia device hostname and domain name (if enabled) on the OSD.

This property is not supported on "AM-200", "AM-300" and DMPS3-4K-350-C/250-C product.

Public methodAirMediaConnectionOverlayDisabled Hide the AirMedia connection information when AirMedia Canvas is enabled and multiple users are presenting.

This property is only supported on "AM-200" and "AM-300" products.

This property is not supported on DMPS3-4K-350-C/250-C product.

Public methodAirMediaConnectionOverlayEnabled Display the AirMedia connection information when AirMedia Canvas is enabled and multiple users are presenting.

This property is only supported on "AM-200" and "AM-300" products.

This property is not supported on DMPS3-4K-350-C/250-C product.

Public methodDisplayConnectionOptionDisable Hide the connection option on the OSD.

This property is only supported on "AM-200", "AM-300" and DMPS3-4K-350-C/250-C product.

Public methodDisplayConnectionOptionEnable Display the connection option on the OSD.

This property is only supported on "AM-200", "AM-300" and DMPS3-4K-350-C/250-C product.

Public methodDisplayCustomUrlDisable Hides the Custom URL on the OSD.

This property is not supported on "AM-200", "AM-300" and DMPS3-4K-350-C/250-C product.

Public methodDisplayCustomUrlEnable Displays the Custom URL on the OSD.

This property is not supported on "AM-200", "AM-300" and DMPS3-4K-350-C/250-C product.

Public methodDomainNameDisplayDisable Hides the AirMedia device domain name on the OSD.

This property is not supported on "AM-200", "AM-300" and DMPS3-4K-350-C/250-C product.

Public methodDomainNameDisplayEnable Displays the AirMedia device domain name on the OSD.

This property is not supported on "AM-200", "AM-300" and DMPS3-4K-350-C/250-C product.

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 methodGetImage Retrieve the image at the URL specified in ImageURL and display it on the OSD. This method is not supported by AM-200 and AM-300 devices.
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodIPAddressDisplayDisable Hides the AirMedia device IP address on the OSD.

This property is not supported on "AM-200", "AM-300" and DMPS3-4K-350-C/250-C product.

Public methodIPAddressDisplayEnable Displays the AirMedia device IP address on the OSD.

This property is not supported on "AM-200", "AM-300" and DMPS3-4K-350-C/250-C product.

Public methodLoginCodeDisplayDisable Hides the Login Code from the OSD.
Public methodLoginCodeDisplayEnable Displays the Login Code on the OSD.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodShowOSD Causes the OSD to redisplayed This method is not supported on all platforms. This method is not supported on "AM-200", "AM-300" and DMPS3-4K-350-C/250-C product.
Public methodShowWiFiAddressDisabled Hid the AirMedia connection information when AirMedia Canvas is enabled and multiple users are presenting.

This property is only supported on "AM-200" and "AM-300" products.

Public methodShowWiFiAddressEnabled Display the AirMedia connection information when AirMedia Canvas is enabled and multiple users are presenting.

This property is only supported on "AM-200" and "AM-300" products.

Public methodShowWiFiKeyDisabled Disables the showing of WiFi Key Connection Information on the OSD of this device.

This property is only supported on "AM-200" and "AM-300" products.

Public methodShowWiFiKeyEnabled Enables the showing of WiFi Key Connection Information on the OSD of this device.

This property is only supported on "AM-200" and "AM-300" products.

Public methodShowWiFiSsidDisabled Disables the showing of WiFi SSID Connection Information on OSD of this device.

This property is only supported on "AM-200" and "AM-300" products.

Public methodShowWiFiSsidEnabled Enables the showing of WiFi SSID Connection Information on the OSD of this device.

This property is only supported on "AM-200" and "AM-300" products.

Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also