Click or drag to resize

Tpmc8XAudioReservedSigs Class

Extender class to provide access to the Audio Reserved Sigs feature of the TPMC-8X Touch Screen.
Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpProDeviceExtender
    Crestron.SimplSharpPro.UITpmc8BaseAudioReservedSigs
      Crestron.SimplSharpPro.UITpmc8XAudioReservedSigs

Namespace: Crestron.SimplSharpPro.UI
Assembly: Crestron.SimplSharpPro.UI (in Crestron.SimplSharpPro.UI.dll) Version: 2.21.121
Syntax
C#
public class Tpmc8XAudioReservedSigs : Tpmc8BaseAudioReservedSigs

The Tpmc8XAudioReservedSigs type exposes the following members.

Properties
 NameDescription
Public propertyAllAudioBalance Sets the speaker balance.

Valid values range from -32768d (full left) to +32767d (full right).


(Inherited from Tpmc8BaseAudioReservedSigs)
Public propertyAllAudioBalanceFeedback Reports the speaker balance.
(Inherited from Tpmc8BaseAudioReservedSigs)
Public propertyAllAudioBalanceLeft Adjusts the speaker balance to the left by 1 each time the input is true. The input has no effect once the balance reaches -32768d (full left).

If the input remains true for 0.5 seconds, then the balance will continue to adjust every 25ms until the input goes false or until the limit is reached.


(Inherited from Tpmc8BaseAudioReservedSigs)
Public propertyAllAudioBalanceRight Adjusts the speaker balance to the right by 1 each time the input is true. The input has no effect once the balance reaches +32767d (full right).

If the input remains true for 0.5 seconds, then the balance will continue to adjust every 25ms until the input goes false or until the limit is reached.


(Inherited from Tpmc8BaseAudioReservedSigs)
Public propertyAllAudioOffFeedback Indicates that the speakers are off. The feedback remains true for as long as the speakers are off.
(Inherited from Tpmc8BaseAudioReservedSigs)
Public propertyAllAudioOnFeedback Indicates that the speakers are on. The feedback remains true for as long as the speakers are on.
(Inherited from Tpmc8BaseAudioReservedSigs)
Public propertyAllAudioVolume Sets the speaker volume level.

Valid values range from 0% (mute all audio) to 100% (maximum volume).

Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.
(Inherited from Tpmc8BaseAudioReservedSigs)
Public propertyAllAudioVolumeDown Lowers the speaker volume by 1% each time the input is true. The input has no effect once the volume reaches 0%.

If the input remains true for 0.5 seconds, then the volume will continue to decrement every 25ms until the input goes false or until the volume reaches 0%.


(Inherited from Tpmc8BaseAudioReservedSigs)
Public propertyAllAudioVolumeFeedback Reports the speaker volume level.
(Inherited from Tpmc8BaseAudioReservedSigs)
Public propertyAllAudioVolumeUp Raises the speaker volume by 1% each time the input is true. The input has no effect once the volume reaches 100%.

If the input remains true for 0.5 seconds, then the volume will continue to increment every 25ms until the input goes false or until the maximum volume is reached.


(Inherited from Tpmc8BaseAudioReservedSigs)
Public propertyAudioDeviceInternalFeedback Indicates the speaker status. When true, this indicates that the internal speakers are active; when false, the external speakers are active.
Public propertyAutoSwitchAudioDeviceWhenDockedFeedback Indicates the status of the auto switch feature. When true, this indicates that auto switching is On; when false, auto switching is Off.
Protected propertyBooleanInput Bool Inputs on the device extender.
(Inherited from DeviceExtender)
Protected propertyBooleanOutput Bool Outputs on the device extender.
(Inherited from DeviceExtender)
Public propertyMicBoostOffFeedback Indicates that the mic boost setting is off. The output remains true for as long as the mic boost is off.
(Inherited from Tpmc8BaseAudioReservedSigs)
Public propertyMicBoostOnFeedback Indicates that the mic boost setting is on. The output remains true for as long as the mic boost is being applied.
(Inherited from Tpmc8BaseAudioReservedSigs)
Public propertyMicOffFeedback Indicates that mic audio is off. The feedback remains true for as long as line audio is off.
(Inherited from Tpmc8BaseAudioReservedSigs)
Public propertyMicOnFeedback Indicates that mic audio is on. The feedback remains true for as long as mic audio is on.
(Inherited from Tpmc8BaseAudioReservedSigs)
Public propertyMicVolume Sets the mic volume level.

Valid values range from 0% (mute mic input) to 100% (maximum mic volume).

Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.
(Inherited from Tpmc8BaseAudioReservedSigs)
Public propertyMicVolumeDown Lowers mic audio volume by 1% each time the input is true. The input has no effect once the volume reaches 0%.

If the input remains true for 0.5 seconds, then the volume will continue to decrement every 25ms until the input goes false or until the volume reaches 0%.


(Inherited from Tpmc8BaseAudioReservedSigs)
Public propertyMicVolumeFeedback Reports the mic volume level.

The reported level is the value that is set via the mic volume analog input, or adjusted via the mic volume up/down digital inputs.


(Inherited from Tpmc8BaseAudioReservedSigs)
Public propertyMicVolumeUp Raises mic audio volume by 1% each time the input is true. The input has no effect once the volume reaches 100%.

If the input remains true for 0.5 seconds, then the volume will continue to increment every 25ms until the input goes false or until the maximum volume is reached.


(Inherited from Tpmc8BaseAudioReservedSigs)
Protected propertyStringInput String Inputs on the device extender.
(Inherited from DeviceExtender)
Protected propertyStringOutput String Outputs on the device extender.
(Inherited from DeviceExtender)
Protected propertyUShortInput UShort Inputs on the device extender.
(Inherited from DeviceExtender)
Protected propertyUShortOutput UShort Outputs on the device extender.
(Inherited from DeviceExtender)
Public propertyWAVBalance Sets the WAV audio balance.

Valid values range from -32768d (full left) to +32767d (full right).


(Inherited from Tpmc8BaseAudioReservedSigs)
Public propertyWAVBalanceFeedback Reports the WAV audio balance.

The reported level is the value that is set via the WAV balance analog input, or adjusted via the WAV balance left/right digital inputs.


(Inherited from Tpmc8BaseAudioReservedSigs)
Public propertyWAVBalanceLeft Adjusts the WAV audio balance to the left by 1 each time the input is true. The input has no effect once the WAVBalanceFeedback reaches +32767d (full right).

If the input remains true for 0.5 seconds, then the balance will continue to adjust every 25ms until the input goes low or until the limit is reached.


(Inherited from Tpmc8BaseAudioReservedSigs)
Public propertyWAVBalanceRight Adjusts the WAV audio balance to the right by 1 each time the input is true. The input has no effect once the WAVBalanceFeedback reaches +32767d (full right).

If the input remains true for 0.5 seconds, then the balance will continue to adjust every 25ms until the input goes false or until the limit is reached.


(Inherited from Tpmc8BaseAudioReservedSigs)
Public propertyWAVOffFeedback Indicates that WAV audio is off. The feedback remains true for as long as WAV audio is off.
(Inherited from Tpmc8BaseAudioReservedSigs)
Public propertyWAVOnFeedback Indicates that WAV audio is on. The feedback remains true for as long as WAV audio is on.
(Inherited from Tpmc8BaseAudioReservedSigs)
Public propertyWAVVolume Sets the WAV volume level.

Valid values range from 0% (mute WAV audio) to 100% (maximum WAV volume).

Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.
(Inherited from Tpmc8BaseAudioReservedSigs)
Public propertyWAVVolumeDown Lowers WAV audio volume by 1% each time the input is true. The input has no effect once the WAVVolumeFeedback reaches 0%.

If the input remains true for 0.5 seconds, then the volume will continue to increment every 25ms until the input goes low or until the volume reaches 0%.


(Inherited from Tpmc8BaseAudioReservedSigs)
Public propertyWAVVolumeFeedback Reports the current WAV volume level.
(Inherited from Tpmc8BaseAudioReservedSigs)
Public propertyWAVVolumeUp Raises WAV audio volume by 1% each time the input is true. The input has no effect once the WAVVolumeFeedback reaches 100%.

If the input remains true for 0.5 seconds, then the volume will continue to increment every 25ms until the input goes false or until the maximum volume is reached.


(Inherited from Tpmc8BaseAudioReservedSigs)
Top
Methods
 NameDescription
Public methodAllAudioOff Turns off the speakers.
(Inherited from Tpmc8BaseAudioReservedSigs)
Public methodAllAudioOn Turns on the speakers.
(Inherited from Tpmc8BaseAudioReservedSigs)
Public methodAudioDeviceInternal When the panel is docked (as reported by the WiFi Reserved extender), each rising edge of the input toggles between the internal and external speakers.

The input will toggle the speakers regardless of the auto switch status.

The input has no effect when the panel is undocked.

Public methodAutoSwitchAudioDeviceWhenDocked Toggles the auto switch feature on and off with each rising edge of the input.

When auto switching is on, the panel switches automatically from the internal speakers to the external speakers of the wallmount docking station whenever the panel is docked.

When auto switching is off, the panel will remain on internal speakers regardless of the docking status. The speakers can still be switched manually through the panel's Setup pages, or via the AudioDeviceInternal input.

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)
Protected methodInitializeJoins Method to initialize the sigs of the 8X Audio extender
(Overrides Tpmc8BaseAudioReservedSigsInitializeJoins)
Protected methodMapAnalogInputJoins Protected function to map joins to the join collection on the parent device.
(Inherited from DeviceExtender)
Protected methodMapAnalogOutputJoins Protected function to map joins to the join collection on the parent device.
(Inherited from DeviceExtender)
Protected methodMapDigitalInputJoins Protected function to map joins to the join collection on the parent device.
(Inherited from DeviceExtender)
Protected methodMapDigitalOutputJoins Protected function to map joins to the join collection on the parent device.
(Inherited from DeviceExtender)
Protected methodMapSerialInputJoins Protected function to map joins to the join collection on the parent device.
(Inherited from DeviceExtender)
Protected methodMapSerialOutputJoins Protected function to map joins to the join collection on the parent device.
(Inherited from DeviceExtender)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodMicBoostOff Turns off mic boost.
(Inherited from Tpmc8BaseAudioReservedSigs)
Public methodMicBoostOn Applies a 20dB boost to the mic signal.
(Inherited from Tpmc8BaseAudioReservedSigs)
Public methodMicOff Turns off mic audio.
(Inherited from Tpmc8BaseAudioReservedSigs)
Public methodMicOn Turns on mic audio.
(Inherited from Tpmc8BaseAudioReservedSigs)
Protected methodSendCueEventDataForDeviceExtender Function to trigger the DeviceExtender Sig Change event
(Inherited from DeviceExtender)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodUse Set the extender as usable on the device. Call this method before registration of the device.
(Inherited from DeviceExtender)
Public methodWAVOff Turns off WAV audio.
(Inherited from Tpmc8BaseAudioReservedSigs)
Public methodWAVOn Turns on WAV audio.

WAV audio includes any sound that is generated by the PC, including Windows Media Player audio and Web sounds.


(Inherited from Tpmc8BaseAudioReservedSigs)
Top
Events
 NameDescription
Public eventDeviceExtenderSigChange Event to receive sig information intended for a device extender. When processing this event, it will hold off other sigs from being received from the device. If one desires to continue processing the data and receive more information, launch a new thread and allow this event to exit.
(Inherited from DeviceExtender)
Top
Fields
 NameDescription
Protected field_InUse Bool to determine if the extended is in use by the user.
(Inherited from DeviceExtender)
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also