Click or drag to resize

Swamp Class

Base Swamp class containing all the functionality of the Switcher Amplifier Processor

This class will trigger BaseEvent, ZoneChangeEvent and SourcesChangeEvent events.

Inheritance Hierarchy

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

The Swamp type exposes the following members.

Constructors
 NameDescription
Protected methodSwamp Initialize this Swamp object's inputs and outputs.
Top
Properties
 NameDescription
Public propertyAllZonesDoorbellAudioOnFeedback Indicates that the doorbell source is selected for all doorbell enabled zones as long as the property is true. A false indicates that normal source is selected for all doorbell enabled zones

The BaseEvent event will trigger with AllZonesDoorbellAudioOnFeedbackEventId.

Public propertyAllZonesDoorbellSource Property to set the source used when doorbell audio is enabled. Valid ranges are 0 (Disabled) to 24. This is supported in device firmware versions 4.002.278600000 and higher.
Public propertyAllZonesDoorbellSourceSelectedFeedback Property to indicate the source used when doorbell audio is enabled.

The BaseEvent event will trigger with AllZonesDoorbellAudioSourceEventId.

This is supported in device firmware versions 4.002.278600000 and higher.
Public propertyAllZonesOffFeedback Indicates that all zones are off. The output is true for as long as all zones are turned off.

The BaseEvent event will trigger with AllZonesOffFeedbackEventId.

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 propertyDisposed Property to indicate if the device has been disposed.
(Inherited from GenericDevice)
Public propertyExpanders Collection of Expanders for this Swamp Processor.
Public propertyExpanderTypeFeedback Collection of the eExpanderTypes which are plugged into the unit.

The BaseEvent event will trigger with ExpanderTypeFeedbackEventId with Index is set to Number.

Public propertyExtenderDeviceReadyReservedCues Property to access the Device Ready functionality of the Swamp.

This property will trigger DeviceExtenderSigChange event.

Public propertyFrontPanelLockedFeedback Indicates the lock status of the front panel. The output is true for as long as the buttons are locked out; when false, this indicates that the front panel is not locked.

The BaseEvent event will trigger with FrontPanelLockedFeedbackEventId.

Public propertyFrontPanelSwitchOnFeedback Indicates that the amplifier is turned on (front panel power switch is set to the On position).

The BaseEvent event will trigger with FrontPanelSwitchOnFeedbackEventId.

Public propertyID Property to get the ID of the device.
(Inherited from GenericDevice)
Public propertyIsOnline Property to get the current online state of the device.
(Inherited from GenericDevice)
Public propertyMuteAllZonesFeedback Indicates the mute state of all zones from the Swamp and connected Expanders that have sources routed. When true, all zones with sources routed are muted. When false, at least one of the zones with routed sources is not muted, or all zones are off.

The BaseEvent event will trigger with MuteAllZonesFeedbackEventId.

Public propertyName Get the name of this device.
(Inherited from GenericBase)
Public propertyNumberOfExpanders The maximum number of Expanders allowed on this Swamp.
Public propertyNumberOfInputSources The maximum number of Input Sources allowed on this Swamp.
Public propertyNumberOfOutputZones The maximum number of Output AmplifiedZones allowed on this Swamp.
Public propertyNumberOfSpdifOutputs The maximum number of Spdif Outputs allowed on this Swamp.
Public propertyParent The parent that a given object was added to.
(Inherited from GenericBase)
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)
Public propertySignalPresent Indicates whether a signal is present at the input specified by SignalPresentSource.

The BaseEvent event will trigger with SignalPresentEventId.

Public propertySignalPresentSource Selects the input number that will be monitored by the SignalPresent Output. Valid values: 0 = Disable monitoring, 1 through 16 = Analog 1 through Analog 16, 17 through 24 = SPDIF 17 through SPDIF 24
Public propertySignalPresentSourceFeedback Reports the input number being monitored by the SignalPresentSource.

The BaseEvent event will trigger with SignalPresentSourceFeedbackEventId.

Protected propertySIMPLDeviceImplementation Internal protected member used for actual device control.
(Inherited from GenericDevice)
Public propertySources Collection of Source properties for this Swamp Processor.
Public propertySpdifOuts Collection of Spdifs for this Swamp Processor.
Public propertyTemperatureFeedback When temperature reporting is enabled, this output reports the internal amplifier temperature.

The BaseEvent event will trigger with TemperatureFeedbackEventId.

Public propertyTemperatureFormat Sets the format for internal amp temperature reporting. When false, the format is set to Fahrenheit; when true, Celsius.
Public propertyTemperatureFormatFeedback Indicates the temperature format. The output is true for as long as the format is set to Celsius. When the output is false, this indicates that the format is set to Fahrenheit.

The BaseEvent event will trigger with TemperatureFormatFeedbackEventId.

Public propertyTemperatureHighFeedback Indicates a temperature fault in the amp.

The BaseEvent event will trigger with TemperatureHighFeedbackEventId.

Public propertyTemperatureReportingEnabledFeedback Indicates the status of temperature reporting. The output is true for as long as temperature reporting is enabled; when false, this indicates that temperature reporting is disabled.

The BaseEvent event will trigger with TemperatureReportingEnabledFeedbackEventId.

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)
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)
Public propertyZones Collection of AmplifiedZones for this Swamp Processor.
Top
Methods
 NameDescription
Public methodAllZonesOff Turns off all zones. This shuts off all audio and sets all sources to zero.
Public methodAllZonesSelectDoorbellAudio Method to select doorbell source for all doorbell enabled zones. This is supported in device firmware versions 4.002.278600000 and higher.
Public methodAllZonesSelectNormalAudio Method to select normal source for all doorbell enabled zones. This is supported in device firmware versions 4.002.278600000 and higher.
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 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 methodLockFrontPanel Locks the front panel. When locked the front panel buttons have no effect.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodMuteAllZones Mutes audio to all zones with sources routed (Sources 1-24).
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)
Protected methodOnSourcesChange Event fired for Feedbacks on the Source Method to fire the SourcesChangeEvent event. This event is fired whenever any change happens for Feedbacks on the Source.
Protected methodOnZoneChange Method to fire the ZoneChangeEvent event. This event is fired whenever any change happens for the Feedbacks on the Zones.
Public methodRegister Register this device with the system.
(Inherited from GenericDevice)
Public methodTemperatureReportingDisable Disables the Temperature output to report the internal amplifier temperature.
Public methodTemperatureReportingEnable Enables the Temperature output to report the internal amplifier temperature.
Public methodToString Return the name of the device.
(Inherited from GenericDevice)
Public methodUnLockFrontPanel Unlocks the front panel.
Public methodUnMuteAllZones Unmutes audio to all zones with sources routed (Sources 1-24).
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 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)
Public eventSourcesChangeEvent Event triggered when the Source Feedback changes are reported to the Control System.

Valid event IDs are available in SourceEventIds

Public eventZoneChangeEvent Event triggered when the Zone Feedback changes are reported to the Control System.

Valid event IDs are available in ZoneEventIds

Top
Fields
 NameDescription
Public fieldStatic memberAllZonesDoorbellAudioOnFeedbackEventId The value of AllZonesDoorbellAudioOnFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberAllZonesDoorbellAudioSourceEventId The value of AllZonesDoorbellSourceSelectedFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberAllZonesOffFeedbackEventId The value of AllZonesOffFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberAudioLinkStatusFeedbackEventId The value of OnlineAudioLinkStatusFeedback has changed. Check the Number to get the Expander Number.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberExpanderTypeFeedbackEventId The value of ExpanderTypeFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberFrontPanelLockedFeedbackEventId The value of FrontPanelLockedFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberFrontPanelSwitchOnFeedbackEventId The value of FrontPanelSwitchOnFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberMuteAllZonesFeedbackEventId The value of MuteAllZonesFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberOnlineFeedbackEventId The value of OnlineFeedback has changed. Check the Number to get the Expander Number.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberSignalPresentEventId The value of SignalPresent has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberSignalPresentSourceFeedbackEventId The value of SignalPresentSourceFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberSPDIFOut10SourceFeedbackEventId The value of SPDIFOutSourceFeedback for output 10 has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberSPDIFOut9SourceFeedbackEventId The value of SPDIFOutSourceFeedback for output 9 has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberTemperatureFeedbackEventId The value of TemperatureFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberTemperatureFormatFeedbackEventId The value of TemperatureFormatFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberTemperatureHighFeedbackEventId The value of TemperatureHighFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberTemperatureReportingEnabledFeedbackEventId The value of TemperatureReportingEnabledFeedback has changed.

The BaseEvent event will trigger for this event id.

Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also