Click or drag to resize

Tpmc9xAudioReservedSigs Class

Extender class to provide access to the Audio Reserved Sigs feature of the TPMC-9 and TPMC-9L Touch Screens.
Inheritance Hierarchy

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

The Tpmc9xAudioReservedSigs type exposes the following members.

Properties
 NameDescription
Public propertyAllAudioOffFeedback Property to indicate the speaker audio is disabled.

The DeviceExtenderSigChange event will trigger with BoolChange and AllAudioOffFeedback.


(Inherited from TsxCcsUcCodec100AudioReservedSigs)
Public propertyAllAudioOnFeedback Property to indicate the speaker audio is enabled.

The DeviceExtenderSigChange event will trigger with BoolChange and AllAudioOnFeedback.


(Inherited from TsxCcsUcCodec100AudioReservedSigs)
Public propertyAllAudioVolume Property to set the speaker volume level.
(Inherited from TsxCcsUcCodec100AudioReservedSigs)
Public propertyAllAudioVolumeDown Property to lower the speaker volume by 1%. This property has no effect once the volume reaches 0%. If the property remains true the volume will auto-decrement until the property is set to false or until the volume reaches 0%.
(Inherited from TsxCcsUcCodec100AudioReservedSigs)
Public propertyAllAudioVolumeFeedback Property to report the speaker volume level.

The DeviceExtenderSigChange event will trigger with UShortChange and AllAudioVolumeFeedback.


(Inherited from TsxCcsUcCodec100AudioReservedSigs)
Public propertyAllAudioVolumeUp Property to raise the speaker volume by 1% if input is true. This property has no effect once the volume reaches 100%. If the property remains true the volume will auto-increment until the property is set to false or until the maximum volume is reached.
(Inherited from TsxCcsUcCodec100AudioReservedSigs)
Protected propertyBooleanInput Bool Inputs on the device extender.
(Inherited from DeviceExtender)
Protected propertyBooleanOutput Bool Outputs on the device extender.
(Inherited from DeviceExtender)
Public propertyIntercomOffFeedback Property to indicate that the intercom audio is off.
Public propertyIntercomOnFeedback Property to indicate that the intercom audio is on.
Public propertyIntercomVolume Property to set the Intercom audio volume level.
Public propertyIntercomVolumeDown Property to lower the Intercom audio volume by 1%.
Public propertyIntercomVolumeFeedback Property to report the Intercom audio volume level.
Public propertyIntercomVolumeUp Property to raise the Intercom audio volume by 1%.
Public propertyKeyClickOffFeedback Property to indicate the key click is disabled.

The DeviceExtenderSigChange event will trigger with BoolChange and KeyClickOffFeedback.

This property is not supported on TST-1080.
(Inherited from TsxCcsUcCodec100AudioReservedSigs)
Public propertyKeyClickOnFeedback Property to indicate the key click on is enabled.

The DeviceExtenderSigChange event will trigger with BoolChange and KeyClickOnFeedback.

This property is not supported on TST-1080.
(Inherited from TsxCcsUcCodec100AudioReservedSigs)
Public propertyKeyClickVolume Property to set the key click volume level for on-screen buttons. Valid values range from 0% (mute ) to 100% (maximum volume). Please use the "SimplSharpDeviceHelper.PercentToUshort" to convert the ushort value to percentage. This property is not supported on TST-1080.
(Inherited from TsxCcsUcCodec100AudioReservedSigs)
Public propertyKeyClickVolumeDown Property to lower the key click volume by 1%. This property has no effect once the volume reaches 0%. If the property remains true the volume will auto-decrement until the property is set to false or until the volume reaches 0%. This property is not supported on the FT-TSC, TSCW-730 and TST-1080.
(Inherited from TsxCcsUcCodec100AudioReservedSigs)
Public propertyKeyClickVolumeFeedback Property to report the key click volume level of on-screen buttons.

The DeviceExtenderSigChange event will trigger with UShortChange and KeyClickVolumeFeedback.

Valid values range from 0% (mute ) to 100% (maximum volume). Please use the "SimplSharpDeviceHelper.UshortToPercent" to convert the ushort value to percentage. This property is not supported on TST-1080.
(Inherited from TsxCcsUcCodec100AudioReservedSigs)
Public propertyKeyClickVolumeUp Property to raise the key click volume by 1% if input is true. This property has no effect once the volume reaches 100%. If the property remains true the volume will auto-increment until the property is set to false or until the maximum volume is reached. This property is not supported on the FT-TSC, TSCW-730 and TST-1080.
(Inherited from TsxCcsUcCodec100AudioReservedSigs)
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 propertyWavOffFeedback Property to indicate that the WAV audio is off.

The DeviceExtenderSigChange event will trigger with BoolChange and WavOffFeedback.


(Inherited from Mtx3AudioReservedSigs)
Public propertyWavOnFeedback Property to indicate that the WAV audio is on.

The DeviceExtenderSigChange event will trigger with BoolChange and WavOnFeedback.


(Inherited from Mtx3AudioReservedSigs)
Public propertyWavVolume Property to set the WAV volume level.
(Inherited from Mtx3AudioReservedSigs)
Public propertyWavVolumeDown Property to lower the WAV volume by 1%.
(Inherited from Mtx3AudioReservedSigs)
Public propertyWavVolumeFeedback Property to report the current volume level of WAV.

The DeviceExtenderSigChange event will trigger with UShortChange and WavVolumeFeedback.


(Inherited from Mtx3AudioReservedSigs)
Public propertyWavVolumeUp Property to raise the WAV volume by 1%.
(Inherited from Mtx3AudioReservedSigs)
Top
Methods
 NameDescription
Public methodAllAudioOff Method to turn off the speakers.
(Inherited from TsxCcsUcCodec100AudioReservedSigs)
Public methodAllAudioOn Method to turn on the speakers.
(Inherited from TsxCcsUcCodec100AudioReservedSigs)
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 Audio extender
(Overrides Mtx3AudioReservedSigsInitializeJoins)
Public methodIntercomOff Method to turn off the intercom audio.
Public methodIntercomOn Method to turn on the intercom audio.
Public methodKeyClickOff Method to turn off the key click audio when master audio is enabled.
(Inherited from Mtx3AudioReservedSigs)
Public methodKeyClickOn Method to turn on the key click audio when master audio is enabled.
(Inherited from Mtx3AudioReservedSigs)
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)
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 Method to turn off the WAV audio when master audio is enabled.
(Inherited from Mtx3AudioReservedSigs)
Public methodWavOn Method to turn on the WAV audio when master audio is enabled.
(Inherited from Mtx3AudioReservedSigs)
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