LINECONNECTEDMODE (Compact 2013)

3/26/2014

These bit-flag constants describe different substates of a connected call. A mode is available as call status to the application after the call state transitions to connected, and within the LINE_CALLSTATE message indicating the call is in LINECALLSTATE_CONNECTED. These values are used when the call is on an address that is shared (bridged) with other stations primarily electronic key systems.

The following table shows the LINECONNECTEDMODE constants.

Value	Description
LINECONNECTEDMODE_ACTIVE = 0x00000001	Indicates that the call is connected at the current station (the current station is a participant in the call). If the call state mode is zero (0), the application should assume that the value is "active" This would be the situation on a non-bridged address. The mode can switch between ACTIVE and INACTIVE during a call if the user joins and leaves the call through manual action. In such a bridged situation, a lineDrop or lineHold function call may possibly not actually drop the call or place it on hold, because the status of other stations on the call may govern. For example, attempting to "hold" a call when other stations are participating won't be possible. Instead, the call may simply be changed to the INACTIVE mode if it remains CONNECTED at other stations.
LINECONNECTEDMODE_ACTIVEHELD = 0x00000004	Indicates that the station is an active participant in the call, but that the remote party has placed the call on hold. The other party considers the call to be in the onhold state. Normally, such information is available only when both endpoints of the call fall within the same switching domain. This flag is exposed only to applications that negotiate a TAPI version of 2.0 or later.
LINECONNECTEDMODE_CONFIRMED = 0x00000010	Indicates that the service provider received affirmative notification that the call has entered the connected state. For example, the notification was received through answer supervision or similar mechanisms. This flag is exposed only to applications that negotiate a TAPI version of 2.0 or later.
LINECONNECTEDMODE_INACTIVE = 0x00000002	Indicates that the call is active at one or more other stations, but the current station is not a participant in the call. If the call state mode is ZERO, the application should assume that the value is "active". This would be the situation on a non-bridged address. A call in the INACTIVE state can be joined using lineAnswer. Many operations that are valid in calls in the CONNECTED state can be impossible in the INACTIVE mode, such as monitoring for tones and digits, because the station is not actually participating in the call; monitoring is usually suspended, although not canceled, while the call is in the INACTIVE mode.
LINECONNECTEDMODE_INACTIVEHELD = 0x00000008	Indicates that the station is not an active participant in the call, and that the remote party has placed the call on hold.

Remarks

These constants cannot be extended. All 32 bits are reserved.

For backward compatibility, it is the responsibility of the service provider to examine the negotiated API version on the line, and to not use those LINECONNECTEDMODE_ values that are not supported on the negotiated version. Applications that are not cognizant of LINECONNECTEDMODE_ will most likely assume that a call that is in LINECALLSTATE_CONNECTED is in LINECONNECTEDMODE_ACTIVE.

The LINECONNECTEDMODE_ACTIVE and LINECONNECTEDMODE_INACTIVE values are used when the call is on an address that is shared with other stations. For more information about shared addresses, see LINEADDRESSSHARING, primarily electronic key systems. If the connected call state mode is "active," it means that the call is connected at the current station. That is, the current station is a participant in the call. If the call state mode is "inactive," the call is active at one or more other stations, but the current station is not a participant in the call. If the call state mode is ZERO, the application should assume that the value is "active". This would be the situation on a non-bridged address. The mode can switch between ACTIVE and INACTIVE during a call if the user joins and leaves the call through manual action.

In such a bridged situation, a lineDrop or lineHold function call may possibly not actually drop the call or place it on hold, because the status of other stations on the call may govern. For example, attempting to "hold" a call when other stations are participating will not be possible. Instead, the call can simply be changed to the INACTIVE mode if it remains connected at other stations. A call in the INACTIVE state can be joined using the lineAnswer function.

Many operations that are valid in calls in the connected state can be impossible in the INACTIVE mode, such as monitoring for tones and digits, because the station is not actually participating in the call; monitoring is usually suspended, although not canceled, while the call is in the INACTIVE mode.

Requirements

Header

tapi.h

See Also

Reference

TAPI Constants
lineAnswer
lineDrop
lineHold
LINE_CALLSTATE (TAPI)