Click or drag to resize

UcEngineAudioRsvdSigs Class

Extender class to provide access to the Audio Reserved Sigs feature of the "UcEngine" device.

This class will trigger DeviceExtenderSigChange event.

Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpProDeviceExtender
    Crestron.SimplSharpPro.UCUcEngineAudioRsvdSigs

Namespace: Crestron.SimplSharpPro.UC
Assembly: Crestron.SimplSharpPro.DeviceSupport (in Crestron.SimplSharpPro.DeviceSupport.dll) Version: 2.21.121
Syntax
C#
public sealed class UcEngineAudioRsvdSigs : DeviceExtender

The UcEngineAudioRsvdSigs type exposes the following members.

Properties
 NameDescription
Protected propertyBooleanInput Bool Inputs on the device extender.
(Inherited from DeviceExtender)
Protected propertyBooleanOutput Bool Outputs on the device extender.
(Inherited from DeviceExtender)
Public propertyConferenceMicMuteOffFeedback Property to indicate the conference microphone is turned off.

The DeviceExtenderSigChange event will trigger with BoolChange and ConferenceMicMuteOffFeedback.

Public propertyConferenceMicMuteOnFeedback Property to indicate the conference microphone is turned on.

The DeviceExtenderSigChange event will trigger with BoolChange and ConferenceMicMuteOnFeedback.

Public propertyConferenceMicNameFeedback Property that reports the name of the conference microphone.

The DeviceExtenderSigChange event will trigger with StringChange and ConferenceMicNameFeedback.

Public propertyConferenceMicVolume Property to set conference microphone (mic) audio volume.
Public propertyConferenceMicVolumeDown Property that lowers conference microphone (mic) audio volume by 1%. The input has no effect once the volume reaches 0%.
Public propertyConferenceMicVolumeFeedback Property that reports the conference microphone (mic) audio volume setting.

The DeviceExtenderSigChange event will trigger with UShortChange and ConferenceMicVolumeFeedback.

Public propertyConferenceMicVolumeUp Property to raise conference microphone (mic) audio volume by 1%. The input has no effect once the volume reaches 100%.
Public propertyConferenceSpeakerMuteOffFeedback Property to indicate the conference speakers are unmuted.

The DeviceExtenderSigChange event will trigger with BoolChange and ConferenceSpeakerMuteOffFeedback.

Public propertyConferenceSpeakerMuteOnFeedback Property to indicate the conference speakers are muted.

The DeviceExtenderSigChange event will trigger with BoolChange and ConferenceSpeakerMuteOnFeedback.

Public propertyConferenceSpeakerNameFeedback Property that reports the name of the conference speaker.

The DeviceExtenderSigChange event will trigger with StringChange and ConferenceSpeakerNameFeedback.

Public propertyConferenceSpeakerVolume Property to set conference speaker audio volume.
Public propertyConferenceSpeakerVolumeDown Property to decrease conference speaker volume.
Public propertyConferenceSpeakerVolumeFeedback Property that reports the conference speaker audio volume setting.

The DeviceExtenderSigChange event will trigger with UShortChange and ConferenceSpeakerVolumeFeedback.

Public propertyConferenceSpeakerVolumeUp Property to increase conference speaker volume.
Public propertyDefaultSpeakerMuteOffFeedback Property to indicate default speakers are unmuted.

The DeviceExtenderSigChange event will trigger with BoolChange and DefaultSpeakerMuteOffFeedback.

Public propertyDefaultSpeakerMuteOnFeedback Property to indicate default speakers are muted.

The DeviceExtenderSigChange event will trigger with BoolChange and DefaultSpeakerMuteOnFeedback.

Public propertyDefaultSpeakerNameFeedback Property that reports the name of the default speaker.

The DeviceExtenderSigChange event will trigger with StringChange and DefaultSpeakerNameFeedback.

Public propertyDefaultSpeakerVolume Property to set default speaker audio volume.
Public propertyDefaultSpeakerVolumeDown Property to decrease the audio volume of default speakers.
Public propertyDefaultSpeakerVolumeFeedback Property that reports the default speaker audio volume setting.

The DeviceExtenderSigChange event will trigger with UShortChange and DefaultSpeakerVolumeFeedback.

Public propertyDefaultSpeakerVolumeUp Property to increase the audio volume of default speakers.
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)
Top
Methods
 NameDescription
Public methodConferenceMicMuteOff Method to turn off conference microphone.
Public methodConferenceMicMuteOn Method to turn on conference microphone.
Public methodConferenceSpeakerMuteOff Method that unmute the conference speakers.
Public methodConferenceSpeakerMuteOn Method that mutes the conference speakers.
Public methodDefaultSpeakerMuteOff Method to unmute the default speakers.
Public methodDefaultSpeakerMuteOn Method to mute the default speakers.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(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 extender Audio Reserved Sigs.
(Overrides DeviceExtenderInitializeJoins)
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 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)
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