Room Class |
public class Room
The Room type exposes the following members.
| Name | Description | |
|---|---|---|
| Balance | 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. | |
| BalanceFeedback | Reports the audio balance. EventIds: BalanceFeedbackEventId will trigger to indicate change. | |
| Bass | Sets the bass level.Valid values range from -120 (-12dB) to +120 (+12dB), where 1 = 0.1dB. | |
| BassFeedback | Tracks the value of the corresponding bass. EventIds: BassFeedbackEventId will trigger to indicate change. | |
| DcFaultFeedback | 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. | |
| IsAmplifiedRoom | IsAmplifiedRoom indicates that Room is Amplified or not. | |
| LoudnessOnFeedback | 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. | |
| MaximumVolume | Defines the maximum volume. This allows endpoints to be set for volume control. | |
| MaximumVolumeFeedback | Reports the Max volume. EventIds: MaximumVolumeFeedbackEventId will trigger to indicate change. | |
| MinimumVolume | Defines the minimum volume. This allows endpoints to be set for volume control. | |
| MinimumVolumeFeedback | Reports the Min volume. EventIds: MinimumVolumeFeedbackEventId will trigger to indicate change. | |
| MonoOnFeedback | 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. | |
| MuteOnFeedback | 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. | |
| Name | Sets the Room name. The string can consist of alphanumeric characters (20 characters max). | |
| NameFeedback | Reports the Room name. The string can consist of alphanumeric characters (20 characters max). EventIds: NameFeedbackEventId will trigger to indicate change. | |
| Number | The Room number associated with this Room Object | |
| OnFeedback | 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. | |
| OverCurrentFaultFeedback | 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. | |
| Source | Select the source to switch to a particular Room, where 1 to 12 are valid. | |
| SourceFeedback | Reports the currently active source. EventIds: SourceFeedbackEventId will trigger to indicate change. | |
| StartupVolume | 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). | |
| StartupVolumeFeedback | Reports the start up volume. EventIds: StartupVolumeFeedbackEventId will trigger to indicate change. | |
| Treble | Sets the treble level.Valid values range from -120 (-12dB) to +120 (+12dB), where 1 = 0.1dB. | |
| TrebleFeedback | Tracks the value of the treble. EventIds: TrebleFeedbackEventId will trigger to indicate change. | |
| Volume | Sets the Room volume level. | |
| VolumeDbFeedback | 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. | |
| VolumeFeedback | Reports the volume level. EventIds: VolumeFeedbackEventId will trigger to indicate change. |
| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) | |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) | |
| GetHashCode | Serves as the default hash function. (Inherited from Object) | |
| GetType | Gets the Type of the current instance. (Inherited from Object) | |
| LoudnessOff | Method to disable the Room's loudness function. | |
| LoudnessOn | Method to enable Room's loudness function.When loudness is active, this adds a bass gain of +10dB and a treble gain of +5dB. | |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) | |
| MonoOff | Method to set Room's audio to stereo. | |
| MonoOn | Method to set the Room's audio to mono. | |
| MuteOff | Method to unmute the Room's audio. | |
| MuteOn | Method to mute the Room's audio. | |
| Off | Method to Switch Off the Room.This is valid only for Amplified Rooms. | |
| On | Method to switch On Room. This is valid only for Amplified Rooms. | |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| Name | Description | |
|---|---|---|
| BalanceFeedbackEventId | Event ID to indicate that BalanceFeedback has changed. | |
| BassFeedbackEventId | Event ID to indicate that BassFeedback has changed. | |
| DcFaultFeedbackEventId | Event ID to indicate that DcFaultFeedback has changed. | |
| LoudnessOnFeedbackEventId | Event ID to indicate that LoudnessOnFeedback has changed. | |
| MaximumVolumeFeedbackEventId | Event ID to indicate that MaximumVolumeFeedback has changed. | |
| MinimumVolumeFeedbackEventId | Event ID to indicate that MinimumVolumeFeedback has changed. | |
| MonoOnFeedbackEventId | Event ID to indicate that MonoOnFeedback has changed. | |
| MuteOnFeedbackEventId | Event ID to indicate that MuteOnFeedback has changed. | |
| NameFeedbackEventId | Event ID to indicate that NameFeedback has changed. | |
| OnFeedbackEventId | Event ID to indicate that OnFeedback has changed. | |
| OverCurrentFaultFeedbackEventId | Event ID to indicate that OverCurrentFaultFeedback has changed. | |
| SourceFeedbackEventId | Event ID to indicate that SourceFeedback has changed. | |
| StartupVolumeFeedbackEventId | Event ID to indicate that StartupVolumeFeedback has changed. | |
| TrebleFeedbackEventId | Event ID to indicate that TrebleFeedback has changed. | |
| VolumeDbFeedbackEventId | Event ID to indicate that VolumeDbFeedback has changed. | |
| VolumeFeedbackEventId | Event ID to indicate that VolumeFeedback has changed. |