Click or drag to resize

Zone Class

The general Sonnex Zone class.

This class will trigger ZoneChangeEvent when a part of a Expander or ZoneChangeEvent when a part of a Swamp.

Inheritance Hierarchy

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

The Zone type exposes the following members.

Properties
 NameDescription
Public propertyBalance Sets the audio balance. Valid values range from -50% to +50%. A value of 0% signifies an even balance between left and right.
Public propertyBalanceFeedback Reports the audio balance.

The ZoneChangeEvent event will trigger with BalanceFeedbackEventId when this Zone is a part of a Expander.

The ZoneChangeEvent event will trigger with BalanceFeedbackEventId when this Zone is a part of a Swamp.

Public propertyBass Sets the bass level. Valid values range from -120 (-12dB) to +120 (+12dB), where 1 = 0.1dB.
Public propertyBassFeedback Tracks the value of the corresponding bass integer input.

The ZoneChangeEvent event will trigger with BassFeedbackEventId when this Zone is a part of a Expander.

The ZoneChangeEvent event will trigger with BassFeedbackEventId when this Zone is a part of a Swamp.

Public propertyCrestronDrcOnFeedback Indicates the DRC status. The output is true when DRC is enabled. When false, this indicates that the feature is turned off.

The ZoneChangeEvent event will trigger with CrestronDRCOnFeedbackEventId when this Zone is a part of a Expander.

The ZoneChangeEvent event will trigger with CrestronDRCOnFeedbackEventId when this Zone is a part of a Swamp.

Public propertyDoorbellFeedback Indicates the Doorbell mode for this zone. The output is true when doorbell mode is enabled. When false, this indicates that the feature is turned off.

The ZoneChangeEvent event will trigger with DoorbellEnableFeedbackEventId when this Zone is a part of a Expander.

The ZoneChangeEvent event will trigger with DoorbellEnableFeedbackEventId when this Zone is a part of a Swamp.

Public propertyDoorbellVolume Sets the doorbell volume level. Use "SimplSharpDeviceHelper.PercentToUshort" to convert the percentage to a ushort value or "SimplSharpDeviceHelper.UshortToPercent" to convert the ushort value to percentage. This is supported in device firmware versions 4.002.278600000 and higher.
Public propertyDoorbellVolumeFeedback Reports the doorbell volume level. Use "SimplSharpDeviceHelper.PercentToUshort" to convert the percentage to a ushort value or "SimplSharpDeviceHelper.UshortToPercent" to convert the ushort value to percentage. This is supported in device firmware versions 4.002.278600000 and higher.

The ZoneChangeEvent event will trigger with DoorbellVolumeFeedbackEventId when this Zone is a part of a Expander.

The ZoneChangeEvent event will trigger with DoorbellVolumeFeedbackEventId when this Zone is a part of a Swamp.

Public propertyEQSelection Sets the tone profile, which sets the bass and treble to pre-defined levels.
Public propertyEqSelectionFeedback Reports the currently active tone profile with a return type of eEQSelection.

The ZoneChangeEvent event will trigger with EqSelectionFeedbackEventId when this Zone is a part of a Expander.

The ZoneChangeEvent event will trigger with EqSelectionFeedbackEventId when this Zone is a part of a Swamp.

Public propertyIsAmplified Indicates if the Zone is Amplified or not.
Public propertyLoudnessOnFeedback Indicates the status of the loudness function. The output is true when loudness is on. When false, this indicates that loudness is off.

The ZoneChangeEvent event will trigger with LoudnessOnFeedbackEventId when this Zone is a part of a Expander.

The ZoneChangeEvent event will trigger with LoudnessOnFeedbackEventId when this Zone is a part of a Swamp.

Public propertyMaxVolume Defines the maximum volume. This allows endpoints to be set for volume control.
Public propertyMaxVolumeFeedback Reports the Max volume.

The ZoneChangeEvent event will trigger with MaxVolumeFeedbackEventId when this Zone is a part of a Expander.

The ZoneChangeEvent event will trigger with MaxVolumeFeedbackEventId when this Zone is a part of a Swamp.

Public propertyMinVolume Defines the minimum volume. This allows endpoints to be set for volume control.
Public propertyMinVolumeFeedback Reports the Min volume.

The ZoneChangeEvent event will trigger with MinVolumeFeedbackEventId when this Zone is a part of a Expander.

The ZoneChangeEvent event will trigger with MinVolumeFeedbackEventId when this Zone is a part of a Swamp.

Public propertyMonoOnFeedback Indicates the mono status of the zone. The output is true when zone audio is set to mono. When false, this indicates stereo audio.

The ZoneChangeEvent event will trigger with MonoOnFeedbackEventId when this Zone is a part of a Expander.

The ZoneChangeEvent event will trigger with MonoOnFeedbackEventId when this Zone is a part of a Swamp.

Public propertyMuteOnFeedback Indicates the current mute status. The output is true when mute is active. When false, this indicates audio has resumed.

The ZoneChangeEvent event will trigger with MuteOnFeedbackEventId when this Zone is a part of a Expander.

The ZoneChangeEvent event will trigger with MuteOnFeedbackEventId when this Zone is a part of a Swamp.

Public propertyName Sets the zone name. The string can consist of alphanumeric characters (20 characters max).
Public propertyNightMode Selects the Night mode for the zone.
Public propertyNightModeFeedback Indicates the current night mode.

This property will trigger OnZoneChange event with NightModeFeedbackEventId.

Public propertyNumber This Number of the Zone.
Public propertyOutputBusVolumeOffset Sets the volume offset. The offset ranges from -120 (-12dB) to +120 (+12dB), where 1 = 0.1dB.
Public propertyOutputBusVolumeOffsetFeedback Reports the output bus volume offset.

The ZoneChangeEvent event will trigger with OutputBusVolumeOffsetFeedbackEventId when this Zone is a part of a Expander.

The ZoneChangeEvent event will trigger with OutputBusVolumeOffsetFeedbackEventId when this Zone is a part of a Swamp.

Public propertySource Select the source to switch to a particular zone, where 1 to 24 are valid for Analog and SPDIF sources.
Public propertySourceFeedback Reports the currently active source.

The ZoneChangeEvent event will trigger with SourceFeedbackEventId when this Zone is a part of a Expander.

The ZoneChangeEvent event will trigger with SourceFeedbackEventId when this Zone is a part of a Swamp.

Public propertyStartupVolume Sets the startup volume. This is the default volume that will be applied as the switcher transitions from no source selected (0) to a source being routed (1-24).
Public propertyStartupVolumeFeedback Reports the startup volume.

The ZoneChangeEvent event will trigger with StartupVolumeFeedbackEventId when this Zone is a part of a Expander.

The ZoneChangeEvent event will trigger with StartupVolumeFeedbackEventId when this Zone is a part of a Swamp.

Public propertyToneProfile Selects the Tone profile for the zone.
Public propertyToneProfileFeedback Indicates the current Tone profile.

This property will trigger OnZoneChange event with ToneProfileFeedbackEventId.

Public propertyTreble Sets the treble level. Valid values range from -120 (-12dB) to +120 (+12dB), where 1 = 0.1dB.
Public propertyTrebleFeedback Tracks the value of the corresponding treble integer input.

The ZoneChangeEvent event will trigger with TrebleFeedbackEventId when this Zone is a part of a Expander.

The ZoneChangeEvent event will trigger with TrebleFeedbackEventId when this Zone is a part of a Swamp.

Public propertyVolume Sets the Zone volume level. Valid values range from 0% to 100%. where 0% = 0 and 100% = 65535. Use "SimplSharpDeviceHelper.PercentToUshort" to convert the percentage to a ushort value or "SimplSharpDeviceHelper.UshortToPercent" to convert the ushort value to percentage.
Public propertyVolumedBFeedback Reports the actual volume level in decibels. Reported values will range from -800 (-80dB) to +200 (+20dB), where 1 = 0.1dB.

The ZoneChangeEvent event will trigger with VolumedBFeedbackEventId when this Zone is a part of a Expander.

The ZoneChangeEvent event will trigger with VolumedBFeedbackEventId when this Zone is a part of a Swamp.

Public propertyVolumeFeedback Reports the volume level. Reported values range from 0 to 100%. where 0% = 0 and 100% = 65535. Use "SimplSharpDeviceHelper.PercentToUshort" to convert the percentage to a ushort value or "SimplSharpDeviceHelper.UshortToPercent" to convert the ushort value to percentage.

The ZoneChangeEvent event will trigger with VolumeFeedbackEventId when this Zone is a part of a Expander.

The ZoneChangeEvent event will trigger with VolumeFeedbackEventId when this Zone is a part of a Swamp.

Top
Methods
 NameDescription
Public methodCrestronDRCOff Disables the Crestron-defined DRC (Dynamic Range Control) algorithm to the zone's audio.
Public methodCrestronDRCOn Applies the Crestron-defined DRC (Dynamic Range Control) algorithm to the zone's audio. Dynamic range control reduces loud peaks in sound while raising the level of quiet sounds.
Public methodDoorbellEnableOff Method to disable the doorbell mode for this zone. This is supported in device firmware versions 4.002.278600000 and higher
Public methodDoorbellEnableOn Method to enable the doorbell mode for this zone. This is supported in device firmware versions 4.002.278600000 and higher
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 methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodLoudnessOff Method to disable the zone's loudness function.
Public methodLoudnessOn Method to enable zone's loudness function. When loudness is active, this adds a bass gain of +10dB and a treble gain of +5dB.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodMonoOff Method to set zone's audio to stereo.
Public methodMonoOn Method to set the zone's audio to mono.
Public methodMuteOff Method to unmute the zone's audio.
Public methodMuteOn Method to mute the zone's audio.
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