Click or drag to resize

HdXspOutput Class

HD-XSP Output control class.

This class will trigger the StateChange event.

Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpPro.MediaHdXspOutput
    Crestron.SimplSharpPro.MediaHdXspAmplifiedOutput

Namespace: Crestron.SimplSharpPro.Media
Assembly: Crestron.SimplSharpPro.Media (in Crestron.SimplSharpPro.Media.dll) Version: 2.21.121
Syntax
C#
public class HdXspOutput : IParentInformation

The HdXspOutput type exposes the following members.

Properties
 NameDescription
Public propertyBalance Sets the Balance between the left and right channels. Only supported for Downmix outputs.

Valid values range from -50% (Full Left) to +50% (Full Right). A value of 0% (Default) signifies an even balance between the left and right channels

Public propertyBalanceFeedback Reports the Balance level between the left and right channels.

The StateChange event will trigger with BalanceFeedbackEventId.

Public propertyBass Set the bass levels in decibels.

Valid values range from -120 (-12dB) to 120 (12dB) adjustable in increments of 0.1dB (1 = 0.1dB).

Public propertyBassFeedback Reports the bass level. Valid values range from -120 (-12dB) to +120 (+12dB), where 1 = 0.1dB.

The StateChange event will trigger with BassFeedbackEventId.

Public propertyEQ Sets the Equalization selection for this output.

This is only supported when Type is Main.

Public propertyEQFeedback Reports the the Equalization selection of this output.

The StateChange event will trigger with EQFeedbackEventId.

Public propertyLoudnessOnFeedback Reports if Loudness controls are turned on. 'true' = loudness controls are on; 'false' = loudness controls are off.

The StateChange event will trigger with LoudnessOnFeedbackEventId.

Public propertyMaximumVolume Defines the maximum volume (the volume the output will be set to when the HD-XSP powers on) in percent. Valid values are from 70% to 100%.

Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.

Public propertyMaximumVolumeFeedback Reports the maximum volume in percent.

Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.

The StateChange event will trigger with MaximumVolumeFeedbackEventId.

Public propertyMinimumVolume Defines the minimum volume (the volume the output will be set to when the HD-XSP powers on) in percent. Valid values are from 0% to 50%.

Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.

Public propertyMinimumVolumeFeedback Reports the minimum volume in percent.

Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.

The StateChange event will trigger with MinimumVolumeFeedbackEventId.

Public propertyMuteOnFeedback Property to indicate if the output is muted.

'true' output is muted; 'false' output is not muted.

The StateChange event will trigger with MuteOnFeedbackEventId.

Public propertyOutputMode Sets the output to be treated as Stereo or as Mono. This is only valid for Downmix outputs.
Public propertyOutputModeFeedback Reports how the output is treated as. This only works for Downmix outputs.

The StateChange event will trigger with OutputModeFeedbackEventId.

Public propertyParent The parent that a given object was added to.
Public propertyStartupVolume Defines the startup volume (the volume the output will be set to when the HD-XSP powers on) in percent. Valid values are from 0% to 50%.

Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.

Public propertyStartupVolumeFeedback Reports the startup volume in percent.

Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.

The StateChange event will trigger with StartupVolumeFeedbackEventId.

Public propertyTreble Set the treble levels in decibels.

Valid values range from -120 (-12dB) to 120 (12dB) adjustable in increments of 0.1dB (1 = 0.1dB).

Public propertyTrebleFeedback Reports the treble level. Valid values range from -120 (-12dB) to +120 (+12dB), where 1 = 0.1dB.

The StateChange event will trigger with TrebleFeedbackEventId.

Public propertyType Get the type of output this class represents.
Public propertyUserSpecifiedObject Can be assigned anything that user wants.
Public propertyVolume Property to adjust the volume level of this output.

Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.

Public propertyVolumeFeedback Property to report the current volume level of this output, in percent.

Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.

The StateChange event will trigger with VolumeFeedbackEventId.

Public propertyVolumeInDbFeedback Property to report the true volume level of this output, in decibels (1 = 0.1dB).

The StateChange event will trigger with VolumeInDbFeedbackEventId.

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 Turns off loudness function.
Public methodLoudnessOn Turns on loudness function.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodMuteOff Un-mute this output.
Public methodMuteOn Mute this output.
Public methodToString Return a string representing this HdXspOutput.
(Overrides ObjectToString)
Top
Events
 NameDescription
Public eventStateChange Event triggered when a change is detected from the HD-XSP output this object represents.

Valid event IDs are available in HdXspOutputEventIds

Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also