Click or drag to resize

UcEngineReservedSigs Class

Extender class to provide access to the UC-Engine Reserved Sigs feature of the UC-ENGINE devices.

This class will trigger DeviceExtenderSigChange event.

Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpProDeviceExtender
    Crestron.SimplSharpPro.UCUcEngineReservedSigs
      Crestron.SimplSharpPro.UCUcEngineFlexZoomReservedSigs

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

The UcEngineReservedSigs 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 propertyCameraFirmwareVersionFeedback This property is to report UC-Engine camera firmware version.

The DeviceExtenderSigChange event will trigger with StringChange and CameraFirmwareVersionFeedback.

Public propertyCameraNameFeedback This property is to report UC-Engine camera name.

The DeviceExtenderSigChange event will trigger with StringChange and CameraNameFeedback.

Public propertyHuddlyCameraConnectedFeedback Property to indicate if the Huddly IQ camera is plugged into the system. True = Huddly IQ camera plugged; False = Huddly IQ camera not connected.

The DeviceExtenderSigChange event will trigger with BoolChange and HuddlyCameraConnectedFeedback.

Public propertyHuddlyCameraVersionFeedback Property to return the hardware version number of the Huddly IQ camera, if connected.

The DeviceExtenderSigChange event will trigger with StringChange and HuddlyCameraVersionFeedback.

Public propertyHuddlyRoomOccupantCountFeedback Property to return the number of occupants that the Huddly IQ camera reports in the visible space. This value is only available when the camera is active in a meeting or call, and when Huddly Genius Framing is enabled.

The DeviceExtenderSigChange event will trigger with UShortChange and HuddlyRoomOccupantCountFeedback.

Public propertyHuddlySerialNumberFeedback Property to return the serial number of the Huddly IQ camera if connected.

The DeviceExtenderSigChange event will trigger with StringChange and HuddlySerialNumberFeedback.

Public propertyHuddlySoftwareVersionFeedback Property to return the firmware version number of the Huddly IQ camera, if connected.

The DeviceExtenderSigChange event will trigger with StringChange and HuddlySoftwareVersionFeedback.

Public propertyHuddlyUpgradeStatusFeedback This property is reserved for Future Use.

The DeviceExtenderSigChange event will trigger with StringChange and HuddlyUpgradeStatusFeedback.

Public propertyImageMode Property to set the Image Mode. Note: The system will automatically reboot as soon as this join is sent. For this reason be advised, this is a configuration setting and not meant to be used as an on the fly change. For valid values refer UcEngineReservedSigseImageMode.
Public propertyImageModeFeedback Property to report the current Image Mode. For valid values refer UcEngineReservedSigseImageMode.

The DeviceExtenderSigChange event will trigger with UShortChange and ImageModeFeedback.

Public propertyImageModeZoomFeedback Property to indicate Zoom Image Mode is enabled. Note: The system will automatically reboot as soon as this property value is sent. For this reason be advised, this is a configuration setting and not meant to be used as an on the fly change. true = Zoom Image Mode enabled; false = Zoom Image Mode disabled

The DeviceExtenderSigChange event will trigger with BoolChange and ImageModeZoomFeedback.

Public propertyProvisioningVersionFeedback Property to return the Microsoft Teams image provisioning number.
Public propertySoftwareBuildFeedback Property to return the Microsoft Teams software version number.

The DeviceExtenderSigChange event will trigger with StringChange and SoftwareBuildFeedback.

Protected propertyStringInput String Inputs on the device extender.
(Inherited from DeviceExtender)
Protected propertyStringOutput String Outputs on the device extender.
(Inherited from DeviceExtender)
Public propertyTeamsImageModeEnabledFeedback Property to indicate if the Teams Image Mode is enabled. true = Teams Image Mode enabled; false = Teams Image Mode disabled

The DeviceExtenderSigChange event will trigger with BoolChange and TeamsImageModeEnabledFeedback.

Protected propertyUShortInput UShort Inputs on the device extender.
(Inherited from DeviceExtender)
Protected propertyUShortOutput UShort Outputs on the device extender.
(Inherited from DeviceExtender)
Public propertyWindowsBuildFeedback Property to return the build number of the Windows install on the UC-ENGINE.

The DeviceExtenderSigChange event will trigger with StringChange and WindowsBuildFeedback.

Top
Methods
 NameDescription
Public methodEnableTeamsImageMode Method to enable Teams Image Mode. Note: The system will automatically reboot as soon as the value of this property is sent. For this reason be advised, this is a configuration setting and not meant to be used as an on the fly change.
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 methodImageModeZoom Method to enable Zoom Image Mode.
Protected methodInitializeJoins Method to initialize the Sigs of the UC-Engine extender
(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 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)
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