Click or drag to resize

Tpmc8XGAVOIPReservedSigs Class

Extender class to provide access to the VOIP Reserved Sigs feature of the TPMC-8X-GA Touch Screen.
Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpProDeviceExtender
    Crestron.SimplSharpPro.UITpmc8XGAVOIPReservedSigs

Namespace: Crestron.SimplSharpPro.UI
Assembly: Crestron.SimplSharpPro.UI (in Crestron.SimplSharpPro.UI.dll) Version: 2.21.121
Syntax
C#
public sealed class Tpmc8XGAVOIPReservedSigs : DeviceExtender

The Tpmc8XGAVOIPReservedSigs 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)
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 propertyVOIPBusyFeedback Indicates that the line being called is busy.

The output remains true until another call is placed or received.

Public propertyVOIPCallActiveFeedback Indicates that the outgoing call has connected and is active.

The output remains true for the duration of the call. The output goes false when the call is terminated.

Public propertyVOIPCallTerminatedFeedback Indicates that a call has been terminated for any reason.

The output will pulse when a call is terminated.

Public propertyVOIPConnectedtoServerFeedback Indicates that the touch screen is connected as an SIP client to the SIP server. The output remains true for as long as a valid connection to the server exists.
Public propertyVOIPDialingFeedback Indicates that the SIP call is currently dialing, or connecting.

The output remains true for as long as the call is connecting. The output goes false when the call connects or is terminated.

Public propertyVOIPDoNotDisturbFeedback Indicates the status of Do Not Disturb.

When the output is true, this signifies that Do Not Disturb is On; when false, Do Not Disturb is Off.

Public propertyVOIPHoldFeedback Indicates that the current call is on hold.
Public propertyVOIPIncomingCallFeedback Indicates that an incoming call has arrived.

The output goes false when the call is answered, declined or terminated.

Public propertyVOIPInit The SIP configuration parameters.

Each field must be separated by the & symbol, with no spaces between fields.

Public propertyVOIPInUIDFeedback The UID of the incoming call, in the format:

sip:101@192.168.70.200:5060

Public propertyVOIPLocalExtensionFeedback The local extension of the touch screen.
Public propertyVOIPMyUIDFeedback The UID of the touch screen, which allows direct connection to a CEN-NVS200 or other device, in the format:

sip:101@192.168.70.200:5060

Public propertyVOIPPTTFeedback Indicates that PTT transmission is active, whether triggered by the program or locally from the touch screen.

The output remains true for as long as PTT transmission is active.

Public propertyVOIPPTTModeFeedback Indicates that the target device is PTT. The output remains true for as long as PTT mode is enabled.

When the output is false, this indicates a full-duplex device.

Public propertyVOIPRingbackFeedback Indicates that the touch screen is waiting for a response to an SIP invitation from the target device.

The output pulses every 2 seconds while waiting for the remote party to answer.

Public propertyVOIPRingingFeedback Indicates that an incoming call is waiting to be answered or declined.

The output pulses every 2 seconds while the incoming call is ringing. The output goes false when the call is answered, declined or terminated.

Public propertyVOIPStringtodial The SIP extension, group page or URI to dial.
Public propertyVOIPVideoURLFeedback The URL of the video stream.
Top
Methods
 NameDescription
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 8XGA VOIP 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 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 methodVOIPAnswer When pulsed, an incoming call is answered so voice communications can start.
Public methodVOIPDial When pulsed, dials the number. The string is sent to the SIP client to make a call.
Public methodVOIPDial0 Pulsed to dial digit 0.

The dialed digit is stored in the serial join VOIPDIALBUFFER and appended to the end of the string.

Public methodVOIPDial1 Pulsed to dial digit 1.

The dialed digit is stored in the serial join VOIPDIALBUFFER and appended to the end of the string.

Public methodVOIPDial2 Pulsed to dial digit 2.

The dialed digit is stored in the serial join VOIPDIALBUFFER and appended to the end of the string.

Public methodVOIPDial3 Pulsed to dial digit 3.

The dialed digit is stored in the serial join VOIPDIALBUFFER and appended to the end of the string.

Public methodVOIPDial4 Pulsed to dial digit 4.

The dialed digit is stored in the serial join VOIPDIALBUFFER and appended to the end of the string.

Public methodVOIPDial5 Pulsed to dial digit 5.

The dialed digit is stored in the serial join VOIPDIALBUFFER and appended to the end of the string.

Public methodVOIPDial6 Pulsed to dial digit 6.

The dialed digit is stored in the serial join VOIPDIALBUFFER and appended to the end of the string.

Public methodVOIPDial7 Pulsed to dial digit 7.

The dialed digit is stored in the serial join VOIPDIALBUFFER and appended to the end of the string.

Public methodVOIPDial8 Pulsed to dial digit 8.

The dialed digit is stored in the serial join VOIPDIALBUFFER and appended to the end of the string.

Public methodVOIPDial9 Pulsed to dial digit 9.

The dialed digit is stored in the serial join VOIPDIALBUFFER and appended to the end of the string.

Public methodVOIPDialBackspace When pulsed, the last character in the dial string is removed.
Public methodVOIPDialClear When pulsed, the entire dial string is cleared.
Public methodVOIPDialPound Pulsed to dial #.

The dialed digit is stored in the serial join VOIPDIALBUFFER and appended to the end of the string.

Public methodVOIPDialStar Pulsed to dial *.

The dialed digit is stored in the serial join VOIPDIALBUFFER and appended to the end of the string.

Public methodVOIPDisplayVideo Display video stream on touch screen.
Public methodVOIPDoNotDisturb Toggles the Do Not Disturb setting on and off with each rising edge of the input.

When Do Not Disturb is on, the touch screen will auto-decline all incoming calls.

Public methodVOIPFuncDoorRelease Pulsing this join will send a message to open the exterior door associated with the currently connected BPT door station.
Public methodVOIPFuncPreview Pulsing this join will open a SIP connection to the first BPT door station in the system. Pulsing the join again while the current door station is connected will auto connect to the next door station in the system.

The connection will loop back around to the first station once the last has been contacted.

Public methodVOIPHangup When pulsed, any current call it terminated and any incoming call is rejected without answering.
Public methodVOIPPageAll Page all groups.
Public methodVOIPPTT Indicates that PTT transmission is active, whether triggered by the program or locally from the touch screen.

The output remains true for as long as PTT transmission is active.

Public methodVOIPReject When pulsed, any current call it terminated and any incoming call is rejected without answering.
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