Click or drag to resize

Room Class

The general room Class.
Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpPro.AudioDistributionRoom

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

The Room 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. Use PercentToUshort(Single) to convert the percentage to a UShort value or UshortToPercent(UInt16) to convert the UShort value to percentage.
Public propertyBalanceFeedback Reports the audio balance. EventIds: BalanceFeedbackEventId will trigger to indicate change.
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. EventIds: BassFeedbackEventId will trigger to indicate change.
Public propertyDcFaultFeedback Indicates the Dc Fault status of the Room. The property value is true when there is DC fault. When false, this indicates no fault. This is valid only for Amplified Rooms. EventIds: DcFaultFeedbackEventId will trigger to indicate change.
Public propertyIsAmplifiedRoom IsAmplifiedRoom indicates that Room is Amplified or not.
Public propertyLoudnessOnFeedback Indicates the status of the loudness function. The property value is true when loudness is on. When false, this indicates that loudness is off. EventIds: LoudnessOnFeedbackEventId will trigger to indicate change.
Public propertyMaximumVolume Defines the maximum volume. This allows endpoints to be set for volume control.
Public propertyMaximumVolumeFeedback Reports the Max volume. EventIds: MaximumVolumeFeedbackEventId will trigger to indicate change.
Public propertyMinimumVolume Defines the minimum volume. This allows endpoints to be set for volume control.
Public propertyMinimumVolumeFeedback Reports the Min volume. EventIds: MinimumVolumeFeedbackEventId will trigger to indicate change.
Public propertyMonoOnFeedback Indicates the mono status of the room. The property value is true when room audio is set to mono. When false, this indicates stereo. EventIds: MonoOnFeedbackEventId will trigger to indicate change.
Public propertyMuteOnFeedback Indicates the current mute status. The property value is true when mute is active. When false, this indicates audio has resumed. EventIds: MuteOnFeedbackEventId will trigger to indicate change.
Public propertyName Sets the Room name. The string can consist of alphanumeric characters (20 characters max).
Public propertyNameFeedback Reports the Room name. The string can consist of alphanumeric characters (20 characters max). EventIds: NameFeedbackEventId will trigger to indicate change.
Public propertyNumber The Room number associated with this Room Object
Public propertyOnFeedback Indicates the current Room Status. The property value is true when room is active. When false, this indicates room is off. This is valid only for Amplified Rooms. EventIds: OnFeedbackEventId will trigger to indicate change.
Public propertyOverCurrentFaultFeedback Indicates the Over Current Fault status of the Room. The property value is true when there is Over Current fault.When false, this indicates no fault. This is valid only for Amplified Rooms. EventIds: OverCurrentFaultFeedbackEventId will trigger to indicate change.
Public propertySource Select the source to switch to a particular Room, where 1 to 12 are valid.
Public propertySourceFeedback Reports the currently active source. EventIds: SourceFeedbackEventId will trigger to indicate change.
Public propertyStartupVolume Sets the start up 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-12).
Public propertyStartupVolumeFeedback Reports the start up volume. EventIds: StartupVolumeFeedbackEventId will trigger to indicate change.
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 treble. EventIds: TrebleFeedbackEventId will trigger to indicate change.
Public propertyVolume Sets the Room volume level.
Public propertyVolumeDbFeedback Reports the actual volume level in decibels. Reported values will range from -800 (-80dB) to +200 (+20dB), where 1 = 0.1dB. EventIds: VolumeDbFeedbackEventId will trigger to indicate change.
Public propertyVolumeFeedback Reports the volume level. EventIds: VolumeFeedbackEventId will trigger to indicate change.
Top
Methods
 NameDescription
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 Room's loudness function.
Public methodLoudnessOn Method to enable Room'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 Room's audio to stereo.
Public methodMonoOn Method to set the Room's audio to mono.
Public methodMuteOff Method to unmute the Room's audio.
Public methodMuteOn Method to mute the Room's audio.
Public methodOff Method to Switch Off the Room.This is valid only for Amplified Rooms.
Public methodOn Method to switch On Room. This is valid only for Amplified Rooms.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Fields
 NameDescription
Public fieldStatic memberBalanceFeedbackEventId Event ID to indicate that BalanceFeedback has changed.
Public fieldStatic memberBassFeedbackEventId Event ID to indicate that BassFeedback has changed.
Public fieldStatic memberDcFaultFeedbackEventId Event ID to indicate that DcFaultFeedback has changed.
Public fieldStatic memberLoudnessOnFeedbackEventId Event ID to indicate that LoudnessOnFeedback has changed.
Public fieldStatic memberMaximumVolumeFeedbackEventId Event ID to indicate that MaximumVolumeFeedback has changed.
Public fieldStatic memberMinimumVolumeFeedbackEventId Event ID to indicate that MinimumVolumeFeedback has changed.
Public fieldStatic memberMonoOnFeedbackEventId Event ID to indicate that MonoOnFeedback has changed.
Public fieldStatic memberMuteOnFeedbackEventId Event ID to indicate that MuteOnFeedback has changed.
Public fieldStatic memberNameFeedbackEventId Event ID to indicate that NameFeedback has changed.
Public fieldStatic memberOnFeedbackEventId Event ID to indicate that OnFeedback has changed.
Public fieldStatic memberOverCurrentFaultFeedbackEventId Event ID to indicate that OverCurrentFaultFeedback has changed.
Public fieldStatic memberSourceFeedbackEventId Event ID to indicate that SourceFeedback has changed.
Public fieldStatic memberStartupVolumeFeedbackEventId Event ID to indicate that StartupVolumeFeedback has changed.
Public fieldStatic memberTrebleFeedbackEventId Event ID to indicate that TrebleFeedback has changed.
Public fieldStatic memberVolumeDbFeedbackEventId Event ID to indicate that VolumeDbFeedback has changed.
Public fieldStatic memberVolumeFeedbackEventId Event ID to indicate that VolumeFeedback has changed.
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also