ThbTapiLine.Status
Unit: hbTapi
 

This property describes the current status of the line device. It encapsulates the TAPI LINEDEVSTATUS structure. The property consist of several sub-properties.

Availability

Design-Time: None / Run-Time: Read

Declaration

property Status: ThbTapiLineStatus;

Description

ThbTapiLine.LINEDEVSTATUS


NumOpens (DWord)

The number of active opens on the line device.

OpenMediaModes (DWord)

This member is a bit array that indicates for which media types the line device is currently open. This member uses one or more of the LINEMEDIAMODE_ Constants:

Constant

Description

LINEMEDIAMODE_AUTOMATEDVOICE

Voice energy was detected on the call, and the voice is locally handled by an automated application such as with an answering machine application. When a service provider cannot distinguish between interactive and automated voice on an incoming call, it will report the call as interactive voice.

LINEMEDIAMODE_DATAMODEM

A data modem session on the call.

LINEMEDIAMODE_ADSI

An ADSI (Analog Display Services Interface) session on the call. ADSI enhances voice calls with alphanumeric information downloaded to the phone and the use of soft buttons on the phone.

LINEMEDIAMODE_DIGITALDATA

A digital data stream of unspecified format.

LINEMEDIAMODE_G3FAX

A group 3 fax is being sent or received over the call.

LINEMEDIAMODE_G4FAX

A group 4 fax is being sent or received over the call.

LINEMEDIAMODE_INTERACTIVEVOICE

Voice energy was detected on the call, and the call is handled as an interactive voice call with humans on both ends.

LINEMEDIAMODE_MIXED

A mixed session on the call. Mixed is one of the ISDN telematic services.

LINEMEDIAMODE_TDD

A TDD (Telephony Devices for the Deaf) session on the call.

LINEMEDIAMODE_TELETEX

A teletex session on the call. Teletex is one of the telematic services.

LINEMEDIAMODE_TELEX

A telex session on the call. Telex is one of the telematic services.

LINEMEDIAMODE_VIDEO

The media type of the call is video. (TAPI versions 2.1 and later)

LINEMEDIAMODE_VIDEOTEX

A videotex session on the call. Videotex is one the telematic services.

LINEMEDIAMODE_VOICEVIEW

The media type of the call is VoiceView. (TAPI versions 1.4 and later)

LINEMEDIAMODE_UNKNOWN

A media stream exists but its mode is not currently known and may become known later. This would correspond to a call with an unclassified media type. In typical analog telephony environments, an incoming call's media type may be unknown until after the call has been answered and the media stream has been filtered to make a determination.
If the unknown media-mode flag is set, other media flags can also be set. This is used to signify that the media is unknown but that it is likely to be one of the other selected media types.


NumActiveCalls (DWord)

The number of calls on the line in call states other than idle, onhold, onholdpendingtransfer, and onholdpendingconference.

NumOnHoldCalls (DWord)

The number of calls on the line in the onhold state.

NumOnHoldPendCalls (DWord)

The number of calls on the line in the onhold state.

LineFeatures (DWord)

Specifies the line-related API functions that are currently available on this line. This member uses one or more of the LINEFEATURE_ Constants.

NumCallCompletions (DWord)

The number of outstanding call completion requests on the line.

RingMode (DWord)

The current ring mode on the line device.

SignalLevel (DWord)

The current signal level of the connection on the line.

BatteryLevel (DWord)

The current battery level of the line device hardware.

RoamMode (DWord)

The current roam mode of the line device. This member uses one of the LINEROAMMODE_ Constants.

DevStatusFlags (DWord)

The status flags indicate information such as whether the device is locked. It consists of one or more members of LINEDEVSTATUSFLAGS_ Constants:

Constant

Meaning

LINEDEVSTATUSFLAGS_CONNECTED

Specifies whether the line is connected to TAPI. If TRUE, the line is connected and TAPI is able to operate on the line device. If FALSE, the line is disconnected and the application is unable to control the line device through TAPI.

LINEDEVSTATUSFLAGS_INSERVICE

Indicates whether the line is in service. If TRUE, the line is in service; if FALSE, the line is out of service.

LINEDEVSTATUSFLAGS_LOCKED

Indicates whether the line is locked or unlocked. This bit is most often used with line devices associated with cellular phones. Many cellular phones have a security mechanism that requires the entry of a password to enable the phone to place calls. This bit can be used to indicate to applications that the phone is locked and cannot place calls until the password is entered on the user interface of the phone so that the application can present an appropriate alert to the user.

LINEDEVSTATUSFLAGS_MSGWAIT

Indicates whether the line has a message waiting. If TRUE, a message is waiting; if FALSE, no message is waiting.

AvailableMediaModes (DWord)

Indicates the media types that can be invoked on new calls created on this line device, when the LineFeatures member indicates that new calls are possible. If this member is zero, it indicates that the service provider either does not know or cannot indicate which media types are available, in which case any or all of the media types indicated in the MediaModes member in ThbTapiLine.Caps may be available.