Click or drag to resize

Am100 Class

The AM-100 (AirMedia™) Presentation Gateway is a wireless presentation product for small conference rooms and classrooms. Using AirMedia, the presenter/user connects a laptop or mobile device over the local Wi-Fi network to begin displaying the user’s content through the room display. Firmware version 1.1.0.8 or newer is required.

This class will trigger "OnBaseEvent" event with event Id's defined under Am100.

Inheritance Hierarchy

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

The Am100 type exposes the following members.

Constructors
 NameDescription
Public methodAm100 Constructor to generate a new Am100.
Top
Properties
 NameDescription
Public propertyAccessCode The access code for the device. Access code mode must be set to Fixed in order to change the access code. Once the access code is changed the device must be rebooted for the change to take effect.
Public propertyAccessCodeFeedback Returns the access code.
Public propertyAccessCodeModeFeedback Reports the current access code mode.
Public propertyApplyLayoutControlWebpagePasswordFeedbackObsolete.
Applies ModeratorPassword for the web pages.
Public propertyConnectedDeviceFeedback Indicates if a Crestron Connected project is connected. Device's IP must be defined in Crestron Connected setup and the connection must be successful.
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 propertyDisplayControl Property to get the AirMedia Display Control AirMediaGeneralDisplay.
Public propertyDisposed Property to indicate if the device has been disposed.
(Inherited from GenericDevice)
Public propertyErrorFeedback Should always be 0. If the value of this field is not 0 see ErrorTextFeedback for more details.
Public propertyErrorTextFeedback Displays error messages (up to 200 characters) from the device. For example: 'No error'.
Public propertyHostnameFeedback Reports the host name of the device.
Public propertyID Property to get the ID of the device.
(Inherited from GenericDevice)
Public propertyIPAddressFeedback Returns the IP address of the device.
Public propertyIsOnline Property to get the current online state of the device.
(Inherited from GenericDevice)
Public propertyLayoutControlPassword Sets the layout control password. When equal to "" layout control password on the web pages is disabled.
Public propertyLayoutControlPasswordFeedback Reports the layout control password.
Public propertyLayoutControlWebpageDisableFeedback Indicates that the web interface for moderation control is disabled.
Public propertyLayoutControlWebpageEnableFeedback Indicates that the web interface for moderation control is enabled.
Public propertyModeratorDisableFeedback Indicates the CIP interface is disabled as the moderator for Layout Controls of the AM-100.
Public propertyModeratorEnableFeedback Indicates that CIP interface is enabled as the moderator for Layout Controls of the AM-100.
Public propertyName Get the name of this device.
(Inherited from GenericBase)
Public propertyNumberOfUsersConnectedFeedback Indicates the number of users currently connected.
Public propertyOutputResolutionFeedback Indicates the output resolution.
Public propertyOutputTimeout Property to set the amount of time in minutes before the device turns off its output. Valid range is 0-300 minutes. 0 = infinite.
Public propertyOutputTimeoutFeedback Indicates the timeout in minutes after which the device will turn off its output. This will fire the "BaseEvent" with OutputTimeoutFeedbackEventId.
Public propertyParent The parent that a given object was added to.
(Inherited from GenericBase)
Public propertyRebootRequiredFeedback Indicates that reboot is required because there has been a change in a setting.
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 propertySourceSelection Selects the source on the Crestron connected display. Valid values range from 0d to 10d depending on the source. For example, if the source has only 4 inputs, valid values will range from 0d to 4d.
Public propertySourceSelectionFeedback Indicates the source of the Crestron connected display.
Public propertyStatusFeedback Reports the status of the device.
Public propertyStatusTextFeedback Returns the status of the device in text form.
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 propertyUserVideoControls User video controls. User number is index into collection. If a feedback changes on one of these controls the base event will return the EventId from AirMediaUserVideoControl as well as the index of the control.
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 methodAccessCodeMode Configures the access code mode of the device. The Access Code Setup as shown in the administration pages of the web page, determines the access code which should be entered to present display content.
Public methodApplyLayoutControlWebpagePassword Applies ModeratorPassword for the web pages.
Public methodDisableService Disables device services.
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 methodEnableService Enables device services.
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)
Public methodLayoutControlWebpageDisable Disables the web interface for moderation control.
Public methodLayoutControlWebpageEnable Enables the web interface for moderation control.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodModeratorDisable Disables the CIP interface as the moderator for Layout Controls of the AM-100. In this mode, changes to the moderation can be done only by using CIP.
Public methodModeratorEnable Enables the CIP interface as the moderator for Layout Controls of the AM-100. In this mode, changes to the moderation can be done only by using CIP.
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 methodOutputResolution Selects the resolution for both HDMI and VGA.
Public methodReboot Reboots the device on the rising edge of the signal. Typically done when there has been a change in a setting. For example, the device may need to be rebooted if the resolution setting is changed to one different than the current resolution.
Public methodRegister Register this device with the system.
(Inherited from GenericDevice)
Public methodResetConnections Disconnects all apps/users.
Public methodServiceStatus Indicates whether a device service is enabled or disabled.
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 eventAirMediaServiceStatusChange This event will fire when an Am-100 service's status changes.
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)
Top
Fields
 NameDescription
Public fieldStatic memberAccessCodeFeedbackEventId Event ID for AccessCodeFeedback change event.
Public fieldStatic memberAccessCodeModeFeedbackEventId Event ID for AccessCodeModeFeedback change event.
Public fieldStatic memberAirMediaImageErrorEventId

The ImageErrorFeedback has changed.

The "OnBaseEvent" event will trigger for this event id.

Public fieldStatic memberAirMediaImageURLEventId

The ImageURLFeedback has changed.

The "OnBaseEvent" event will trigger for this event id.

Public fieldStatic memberConnectedDeviceFeedbackEventId Event ID for ConnectedDeviceFeedback change event.
Public fieldStatic memberConnectedFeedbackEventId Event ID for ConnectedFeedback change event.
Public fieldStatic memberDisconnectedFeedbackEventId Event ID for DisconnectedFeedback change event.

The "OnBaseEvent" event will trigger for this event id.

This is only valid for the AirPlay user type

Public fieldStatic memberDisplayAddressDisabledEventId

The AddressDisplayDisableFeedback has changed.

The "OnBaseEvent" event will trigger for this event id.

Public fieldStatic memberDisplayAddressEnabledEventId

The AddressDisplayEnableFeedback has changed.

The "OnBaseEvent" event will trigger for this event id.

Public fieldStatic memberDisplayDomainNameDisabledEventId

The DomainNameDisplayDisableFeedback has changed.

The "OnBaseEvent" event will trigger for this event id.

Public fieldStatic memberDisplayDomainNameEnabledEventId

The DomainNameDisplayEnableFeedback has changed.

The "OnBaseEvent" event will trigger for this event id.

Public fieldStatic memberDisplayIPAddressDisabledEventId

The IPAddressDisplayDisableFeedback has changed.

The "OnBaseEvent" event will trigger for this event id.

Public fieldStatic memberDisplayIPAddressEnabledEventId

The IPAddressDisplayEnableFeedback has changed.

The "OnBaseEvent" event will trigger for this event id.

Public fieldStatic memberDisplayLoginCodeDisabledEventId

The LoginCodeDisplayDisableFeedback has changed.

The "OnBaseEvent" event will trigger for this event id.

Public fieldStatic memberDisplayLoginCodeEnabledEventId

The LoginCodeDisplayEnableFeedback has changed.

The "OnBaseEvent" event will trigger for this event id.

Public fieldStatic memberErrorFeedbackEventId Event ID for ErrorFeedback change event.
Public fieldStatic memberErrorTextFeedbackEventId Event ID for ErrorTextFeedback change event.
Public fieldStatic memberHostnameFeedbackEventId Event ID for HostnameFeedback change event.
Public fieldStatic memberIPAddressFeedbackEventId Event ID for IPAddressFeedback change event.
Public fieldStatic memberLayoutControlPasswordFeedbackEventId Event ID for LayoutControlPasswordFeedback change event.
Public fieldStatic memberLayoutControlWebpageDisableFeedbackEventId Event ID for LayoutControlWebpageDisableFeedback change event.
Public fieldStatic memberLayoutControlWebpageEnableFeedbackEventId Event ID for LayoutControlWebpageEnableFeedback change event.
Public fieldStatic memberModeratorDisableFeedbackEventId Event ID for ModeratorDisableFeedback change event.
Public fieldStatic memberModeratorEnableFeedbackEventId Event ID for ModeratorEnableFeedback change event.
Public fieldStatic memberNumberOfUsersConnectedFeedbackEventId Event ID for NumberOfUsersConnectedFeedback change event.
Public fieldStatic memberOSDDisplayedFeedbackEventId

The ShowOSDFeedback has changed.

The "OnBaseEvent" event will trigger for this event id.

Public fieldStatic memberOSDTimeoutEventId

The DisplayTimeoutFeedback has changed.

The "OnBaseEvent" event will trigger for this event id.

Public fieldStatic memberOutputResolutionFeedbackEventId Event ID for OutputResolutionFeedback change event.
Public fieldStatic memberOutputTimeoutFeedbackEventId Event ID for OutputTimeoutFeedback change event.
Public fieldStatic memberRebootRequiredFeedbackEventId Event ID for RebootRequiredFeedback change event.
Public fieldStatic memberSourceSelectionFeedbackEventId Event ID for SourceSelectionFeedback change event.
Public fieldStatic memberStatusFeedbackEventId Event ID for StatusFeedback change event.
Public fieldStatic memberStatusTextFeedbackEventId Event ID for StatusTextFeedback change event.
Public fieldStatic memberUserIPAddressFeedbackEventId Event ID for UserIPAddressFeedback change event.
Public fieldStatic memberUserNameFeedbackEventId Event ID for UserNameFeedback change event.
Public fieldStatic memberWindowPositionFeedbackEventId Event ID for UserWindowPositionFeedback change event.
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also