Swamp Class |
This class will trigger BaseEvent, ZoneChangeEvent and SourcesChangeEvent events.
public class Swamp : GenericDevice
The Swamp type exposes the following members.
| Name | Description | |
|---|---|---|
| AllZonesDoorbellAudioOnFeedback |
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. | |
| AllZonesDoorbellSource | 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. | |
| AllZonesDoorbellSourceSelectedFeedback |
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. | |
| AllZonesOffFeedback |
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. | |
| ConnectedIpList |
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) | |
| Description |
Get/Set the description of this device.
(Inherited from GenericBase) | |
| Disposed |
Property to indicate if the device has been disposed.
(Inherited from GenericDevice) | |
| Expanders | Collection of Expanders for this Swamp Processor. | |
| ExpanderTypeFeedback |
Collection of the eExpanderTypes which are plugged into the unit.
The BaseEvent event will trigger with ExpanderTypeFeedbackEventId with Index is set to Number. | |
| ExtenderDeviceReadyReservedCues |
Property to access the Device Ready functionality of the Swamp.
This property will trigger DeviceExtenderSigChange event. | |
| FrontPanelLockedFeedback |
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. | |
| FrontPanelSwitchOnFeedback |
Indicates that the amplifier is turned on (front panel power switch is set to the On position).
The BaseEvent event will trigger with FrontPanelSwitchOnFeedbackEventId. | |
| ID |
Property to get the ID of the device.
(Inherited from GenericDevice) | |
| IsOnline |
Property to get the current online state of the device.
(Inherited from GenericDevice) | |
| MuteAllZonesFeedback |
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. | |
| Name |
Get the name of this device.
(Inherited from GenericBase) | |
| NumberOfExpanders | The maximum number of Expanders allowed on this Swamp. | |
| NumberOfInputSources | The maximum number of Input Sources allowed on this Swamp. | |
| NumberOfOutputZones | The maximum number of Output AmplifiedZones allowed on this Swamp. | |
| NumberOfSpdifOutputs | The maximum number of Spdif Outputs allowed on this Swamp. | |
| Parent |
The parent that a given object was added to.
(Inherited from GenericBase) | |
| Registerable |
Property to indicate that this device can be registered.
(Inherited from GenericDevice) | |
| Registered |
Property to get the current registration state of the device.
(Inherited from GenericDevice) | |
| RegistrationFailureReason |
Property to get the Registration Failure Reason, this will match the return value from the call to register.
(Inherited from GenericDevice) | |
| SignalPresent |
Indicates whether a signal is present at the input specified by SignalPresentSource.
The BaseEvent event will trigger with SignalPresentEventId. | |
| SignalPresentSource | 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 | |
| SignalPresentSourceFeedback |
Reports the input number being monitored by the SignalPresentSource.
The BaseEvent event will trigger with SignalPresentSourceFeedbackEventId. | |
| SIMPLDeviceImplementation |
Internal protected member used for actual device control.
(Inherited from GenericDevice) | |
| Sources | Collection of Source properties for this Swamp Processor. | |
| SpdifOuts | Collection of Spdifs for this Swamp Processor. | |
| TemperatureFeedback |
When temperature reporting is enabled, this output reports the internal amplifier temperature.
The BaseEvent event will trigger with TemperatureFeedbackEventId. | |
| TemperatureFormat | Sets the format for internal amp temperature reporting. When false, the format is set to Fahrenheit; when true, Celsius. | |
| TemperatureFormatFeedback |
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. | |
| TemperatureHighFeedback |
Indicates a temperature fault in the amp.
The BaseEvent event will trigger with TemperatureHighFeedbackEventId. | |
| TemperatureReportingEnabledFeedback |
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. | |
| Type |
Property to determine to type of device this is.
(Inherited from GenericDevice) | |
| UnRegistrationFailureReason |
Property to get the Unregistration Failure Reason, this will match the return value from the call to unregister.
(Inherited from GenericDevice) | |
| UserSpecifiedObject |
Can be assigned anything that user wants.
(Inherited from GenericBase) | |
| XioEndpointStubSIMPLDevice |
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) | |
| Zones | Collection of AmplifiedZones for this Swamp Processor. |
| Name | Description | |
|---|---|---|
| AllZonesOff | Turns off all zones. This shuts off all audio and sets all sources to zero. | |
| AllZonesSelectDoorbellAudio | Method to select doorbell source for all doorbell enabled zones. This is supported in device firmware versions 4.002.278600000 and higher. | |
| AllZonesSelectNormalAudio | Method to select normal source for all doorbell enabled zones. This is supported in device firmware versions 4.002.278600000 and higher. | |
| Dispose |
Clean up of resources.
(Inherited from GenericBase) | |
| Dispose(Boolean) |
Method to perform the actual disposing of the device.
(Inherited from GenericDevice) | |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) | |
| Finalize |
Destructor of the device.
(Inherited from GenericDevice) | |
| GetHashCode | Serves as the default hash function. (Inherited from Object) | |
| GetType | Gets the Type of the current instance. (Inherited from Object) | |
| LockFrontPanel | Locks the front panel. When locked the front panel buttons have no effect. | |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) | |
| MuteAllZones | Mutes audio to all zones with sources routed (Sources 1-24). | |
| OnBaseEvent(Int32) |
Protected member used to fire the BaseEvent with the default extended information.
(Inherited from GenericBase) | |
| OnBaseEvent(Int32, UInt16) |
Protected member used to fine the BaseEvent with extended event information.
(Inherited from GenericBase) | |
| OnSourcesChange | 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. | |
| OnZoneChange | Method to fire the ZoneChangeEvent event. This event is fired whenever any change happens for the Feedbacks on the Zones. | |
| Register |
Register this device with the system.
(Inherited from GenericDevice) | |
| TemperatureReportingDisable | Disables the Temperature output to report the internal amplifier temperature. | |
| TemperatureReportingEnable | Enables the Temperature output to report the internal amplifier temperature. | |
| ToString |
Return the name of the device.
(Inherited from GenericDevice) | |
| UnLockFrontPanel | Unlocks the front panel. | |
| UnMuteAllZones | Unmutes audio to all zones with sources routed (Sources 1-24). | |
| UnRegister |
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) |
| Name | Description | |
|---|---|---|
| BaseEvent |
Generic base event, triggered when the there are no other handlers available
for a specific EventID.
(Inherited from GenericBase) | |
| IpInformationChange |
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) | |
| OnlineStatusChange |
Event triggered when the Online status of the device changes.
(Inherited from GenericDevice) | |
| SourcesChangeEvent |
Event triggered when the Source Feedback changes are reported to the Control System.
Valid event IDs are available in SourceEventIds | |
| ZoneChangeEvent |
Event triggered when the Zone Feedback changes are reported to the Control System.
Valid event IDs are available in ZoneEventIds |
| Name | Description | |
|---|---|---|
| AllZonesDoorbellAudioOnFeedbackEventId |
The value of AllZonesDoorbellAudioOnFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| AllZonesDoorbellAudioSourceEventId |
The value of AllZonesDoorbellSourceSelectedFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| AllZonesOffFeedbackEventId |
The value of AllZonesOffFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| AudioLinkStatusFeedbackEventId |
The value of OnlineAudioLinkStatusFeedback has changed. Check the Number to get the Expander Number.
The BaseEvent event will trigger for this event id. | |
| ExpanderTypeFeedbackEventId |
The value of ExpanderTypeFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| FrontPanelLockedFeedbackEventId |
The value of FrontPanelLockedFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| FrontPanelSwitchOnFeedbackEventId |
The value of FrontPanelSwitchOnFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| MuteAllZonesFeedbackEventId |
The value of MuteAllZonesFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| OnlineFeedbackEventId |
The value of OnlineFeedback has changed. Check the Number to get the Expander Number.
The BaseEvent event will trigger for this event id. | |
| SignalPresentEventId |
The value of SignalPresent has changed.
The BaseEvent event will trigger for this event id. | |
| SignalPresentSourceFeedbackEventId |
The value of SignalPresentSourceFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| SPDIFOut10SourceFeedbackEventId |
The value of SPDIFOutSourceFeedback for output 10 has changed.
The BaseEvent event will trigger for this event id. | |
| SPDIFOut9SourceFeedbackEventId |
The value of SPDIFOutSourceFeedback for output 9 has changed.
The BaseEvent event will trigger for this event id. | |
| TemperatureFeedbackEventId |
The value of TemperatureFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| TemperatureFormatFeedbackEventId |
The value of TemperatureFormatFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| TemperatureHighFeedbackEventId |
The value of TemperatureHighFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| TemperatureReportingEnabledFeedbackEventId |
The value of TemperatureReportingEnabledFeedback has changed.
The BaseEvent event will trigger for this event id. |