Click or drag to resize

Am101 Class

The AM-101 (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. The Am101 device adds support for DeviceMirroring.

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 sealed class Am101 : Am100

The Am101 type exposes the following members.

Constructors
 NameDescription
Public methodAm101 Constructor to generate a new Am101.
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.
(Inherited from Am100)
Public propertyAccessCodeFeedback Returns the access code.
(Inherited from Am100)
Public propertyAccessCodeModeFeedback Reports the current access code mode.
(Inherited from Am100)
Public propertyApplyLayoutControlWebpagePasswordFeedbackObsolete.
Applies ModeratorPassword for the web pages.
(Inherited from Am100)
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.
(Inherited from Am100)
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.
(Inherited from Am100)
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.
(Inherited from Am100)
Public propertyErrorTextFeedback Displays error messages (up to 200 characters) from the device. For example: 'No error'.
(Inherited from Am100)
Public propertyHostnameFeedback Reports the host name of the device.
(Inherited from Am100)
Public propertyID Property to get the ID of the device.
(Inherited from GenericDevice)
Public propertyIPAddressFeedback Returns the IP address of the device.
(Inherited from Am100)
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.
(Inherited from Am100)
Public propertyLayoutControlPasswordFeedback Reports the layout control password.
(Inherited from Am100)
Public propertyLayoutControlWebpageDisableFeedback Indicates that the web interface for moderation control is disabled.
(Inherited from Am100)
Public propertyLayoutControlWebpageEnableFeedback Indicates that the web interface for moderation control is enabled.
(Inherited from Am100)
Public propertyModeratorDisableFeedback Indicates the CIP interface is disabled as the moderator for Layout Controls of the AM-100.
(Inherited from Am100)
Public propertyModeratorEnableFeedback Indicates that CIP interface is enabled as the moderator for Layout Controls of the AM-100.
(Inherited from Am100)
Public propertyName Get the name of this device.
(Inherited from GenericBase)
Public propertyNumberOfUsersConnectedFeedback Indicates the number of users currently connected.
(Inherited from Am100)
Public propertyOutputResolutionFeedback Indicates the output resolution.
(Inherited from Am100)
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.
(Inherited from Am100)
Public propertyOutputTimeoutFeedback Indicates the timeout in minutes after which the device will turn off its output. This will fire the "BaseEvent" with OutputTimeoutFeedbackEventId.
(Inherited from Am100)
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.
(Inherited from Am100)
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.
(Inherited from Am100)
Public propertySourceSelectionFeedback Indicates the source of the Crestron connected display.
(Inherited from Am100)
Public propertyStatusFeedback Reports the status of the device.
(Inherited from Am100)
Public propertyStatusTextFeedback Returns the status of the device in text form.
(Inherited from Am100)
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.
(Inherited from Am100)
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.
(Inherited from Am100)
Public methodApplyLayoutControlWebpagePassword Applies ModeratorPassword for the web pages.
(Inherited from Am100)
Public methodDisableService Disables device services.
(Inherited from Am100)
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.
(Inherited from Am100)
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.
(Inherited from Am100)
Public methodLayoutControlWebpageEnable Enables the web interface for moderation control.
(Inherited from Am100)
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.
(Inherited from Am100)
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.
(Inherited from Am100)
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.
(Inherited from Am100)
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.
(Inherited from Am100)
Public methodRegister Register this device with the system.
(Inherited from GenericDevice)
Public methodResetConnections Disconnects all apps/users.
(Inherited from Am100)
Public methodServiceStatus Indicates whether a device service is enabled or disabled.
(Inherited from Am100)
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.
(Inherited from Am100)
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

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also