LINECALLINFO
The LINECALLINFO
structure contains information about a call. This information remains
relatively fixed for the duration of the call and is obtained with lineGetCallInfo. If a part of the
structure does change, then a LINE_CALLINFO message is sent to the application indicating
which information item has changed. Dynamically changing information about a
call, such as call progress status, is available in the LINECALLSTATUS structure, returned with
the function lineGetCallStatus.
typedef struct linecallinfo_tag {
DWORD dwTotalSize;
DWORD dwNeededSize;
DWORD dwUsedSize;
HLINE hLine;
DWORD dwLineDeviceID;
DWORD dwAddressID;
DWORD dwBearerMode;
DWORD dwRate;
DWORD dwMediaMode;
DWORD dwAppSpecific;
DWORD
dwCallID;
DWORD dwRelatedCallID;
DWORD dwCallParamFlags;
DWORD dwCallStates;
DWORD dwMonitorDigitModes;
DWORD dwMonitorMediaModes;
LINEDIALPARAMS DialParams;
DWORD dwOrigin;
DWORD dwReason;
DWORD dwCompletionID;
DWORD dwNumOwners;
DWORD dwNumMonitors;
DWORD dwCountryCode;
DWORD dwTrunk;
DWORD dwCallerIDFlags;
DWORD dwCallerIDSize;
DWORD dwCallerIDOffset;
DWORD dwCallerIDNameSize;
DWORD dwCallerIDNameOffset;
DWORD dwCalledIDFlags;
DWORD dwCalledIDSize;
DWORD dwCalledIDOffset;
DWORD dwCalledIDNameSize;
DWORD dwCalledIDNameOffset;
DWORD dwConnectedIDFlags;
DWORD dwConnectedIDSize;
DWORD
dwConnectedIDOffset;
DWORD dwConnectedIDNameSize;
DWORD dwConnectedIDNameOffset;
DWORD dwRedirectionIDFlags;
DWORD dwRedirectionIDSize;
DWORD dwRedirectionIDOffset;
DWORD dwRedirectionIDNameSize;
DWORD dwRedirectionIDNameOffset;
DWORD dwRedirectingIDFlags;
DWORD dwRedirectingIDSize;
DWORD dwRedirectingIDOffset;
DWORD dwRedirectingIDNameSize;
DWORD dwRedirectingIDNameOffset;
DWORD dwAppNameSize;
DWORD dwAppNameOffset;
DWORD dwDisplayableAddressSize;
DWORD dwDisplayableAddressOffset;
DWORD dwCalledPartySize;
DWORD dwCalledPartyOffset;
DWORD dwCommentSize;
DWORD dwCommentOffset;
DWORD dwDisplaySize;
DWORD dwDisplayOffset;
DWORD dwUserUserInfoSize;
DWORD dwUserUserInfoOffset;
DWORD dwHighLevelCompSize;
DWORD dwHighLevelCompOffset;
DWORD dwLowLevelCompSize;
DWORD dwLowLevelCompOffset;
DWORD dwChargingInfoSize;
DWORD dwChargingInfoOffset;
DWORD dwTerminalModesSize;
DWORD dwTerminalModesOffset;
DWORD dwDevSpecificSize;
DWORD dwDevSpecificOffset;
DWORD dwCallTreatment;
DWORD dwCallDataSize;
DWORD dwCallDataOffset;
DWORD dwSendingFlowspecSize;
DWORD dwSendingFlowspecOffset;
DWORD dwReceivingFlowspecSize;
DWORD dwReceivingFlowspecOffset;
} LINECALLINFO, FAR *LPLINECALLINFO;
Members
dwTotalSize
The total
size in bytes allocated to this data structure.
dwNeededSize
The size in
bytes for this data structure that is needed to hold all the returned
information.
dwUsedSize
The size in
bytes of the portion of this data structure that contains useful information.
hLine
The handle
for the line device with which this call is associated.
dwLineDeviceID
The device ID
of the line device with which this call is associated.
dwAddressID
The address
ID of the address on the line on which this call exists.
dwBearerMode
The current
bearer mode of the call. This field uses the following LINEBEARERMODE_
constants:
LINEBEARERMODE_VOICE
This is a
regular 3.1 kHz analog voice grade bearer service. Bit integrity is not
assured. Voice can support fax and modem media modes.
LINEBEARERMODE_SPEECH
This
corresponds to G.711 speech transmission on the call. The network may use
processing techniques such as analog transmission, echo cancellation, and
compression/decompression. Bit integrity is not assured. Speech is not intended
to support fax and modem media modes.
LINEBEARERMODE_MULTIUSE
The multiuse
mode defined by ISDN.
LINEBEARERMODE_DATA
The
unrestricted data transfer on the call. The data rate is specified separately.
LINEBEARERMODE_ALTSPEECHDATA
The alternate
transfer of speech or unrestricted data on the same call (ISDN).
LINEBEARERMODE_NONCALLSIGNALING
A
non-call-associated signaling connection from the application to the service
provider or switch (treated as a "media stream" by TAPI).
LINEBEARERMODE_PASSTHROUGH
When a call
is active in LINEBEARERMODE_PASSTHROUGH, the service provider gives direct
access to the attached hardware for control by the application. This mode is
used primarily by applications desiring temporary direct control over
asynchronous modems, accessed through the Win32 comm functions, for the purpose
of configuring or using special features not otherwise supported by the service
provider.
dwRate
The rate of
the call's data stream in bps (bits per second).
dwMediaMode
Specifies the
media mode of the information stream currently on the call. This is the media
mode as determined by the owner of the call, which is not necessarily the same
as that of the last LINE_MONITORMEDIA message. This field is not directly affected by the
LINE_MONITORMEDIA messages. It uses the following LINEMEDIAMODE_ constants:
LINEMEDIAMODE_UNKNOWN
A media
stream exists but its mode is not known. This corresponds to a call with an
unclassified media type. In typical analog telephony environments, an inbound
call's media mode may be unknown until after the call has been answered and the
media stream has been filtered to make a determination.
LINEMEDIAMODE_INTERACTIVEVOICE
The presence
of voice energy is detected on the call and the call is treated as an
interactive call with humans on both ends.
LINEMEDIAMODE_AUTOMATEDVOICE
The presence
of voice energy is detected on the call and the voice is locally handled by an
automated application.
LINEMEDIAMODE_DATAMODEM
A data modem
session is detected on the call.
LINEMEDIAMODE_G3FAX
A group 3 fax
is being sent or received on the call.
LINEMEDIAMODE_G4FAX
A group 4 fax
is being sent or received over the call.
LINEMEDIAMODE_TDD
A TDD
(Telephony Devices for the Deaf) session on the call.
LINEMEDIAMODE_DIGITALDATA
Digital data
being sent or received over the call.
LINEMEDIAMODE_TELETEX
A teletex
session on the call. Teletex is one of the telematic services.
LINEMEDIAMODE_VIDEOTEX
A videotex
session on the call. Videotex is one the telematic services.
LINEMEDIAMODE_TELEX
A telex
session on the call. Telex is one the telematic services.
LINEMEDIAMODE_MIXED
A mixed
session on the call. Mixed is one the ISDN telematic services.
LINEMEDIAMODE_ADSI
An ADSI
(Analog Display Services Interface) session on the call.
LINEMEDIAMODE_VOICEVIEW
The media
mode of the call is VoiceView.
dwAppSpecific
This field is
uninterpreted by the API implementation and service provider. It can be set by
any owner application of this call with the operation lineSetAppSpecific.
dwCallID
In some
telephony environments, the switch or service provider may assign a unique
identifier to each call. This allows the call to be tracked across transfers,
forwards, or other events. The domain of these call IDs and their scope is
service-provider defined. The dwCallID field makes this unique
identifier available to the applications.
dwRelatedCallID
Telephony
environments that use the call ID often may find it necessary to relate one
call to another. The dwRelatedCallID field may be used by the service
provider for this purpose.
dwCallParamFlags
A collection
of call-related parameters when the call is outbound. These are same call
parameters specified in lineMakeCall, of type LINECALLPARAMFLAGS_. Values are:
LINECALLPARAMFLAGS_SECURE
The call is
currently secure. This flag is also updated if the call is later secured
through lineSecureCall.
LINECALLPARAMFLAGS_IDLE
The call
started out using an idle call.
LINECALLPARAMFLAGS_BLOCKID
The
originator identity was concealed (block caller ID presentation to the remote
party).
LINECALLPARAMFLAGS_ORIGOFFHOOK
The
originator's phone was automatically taken offhook.
LINECALLPARAMFLAGS_DESTOFFHOOK
The called
party's phone was automatically taken offhook.
dwCallStates
The call
states for which the application may be notified on this call, of type
LINECALLSTATE_. The dwCallStates member is constant in LINECALLINFO
and does not change depending on the call state. Values are:
LINECALLSTATE_IDLE
The call is
idle no call exists.
LINECALLSTATE_OFFERING
The call is
being offered to the station signaling the arrival of a new call. In some
environments, a call in the offering state does not automatically alert the
user; alerting is done by the switch instructing the line to ring. It does not
affect any call states.
LINECALLSTATE_ACCEPTED
The call was
offering and has been accepted. This indicates to other (monitoring)
applications that the current owner application has claimed responsibility for
answering the call. In ISDN, this also initiates alerting to both parties.
LINECALLSTATE_DIALTONE
The call is
receiving a dial tone from the switch, which means that the switch is ready to
receive a dialed number.
LINECALLSTATE_DIALING
Destination
address information (a phone number) is being sent to the switch over the call.
Note that the operation lineGenerateDigits does not place the line into the dialing
state.
LINECALLSTATE_RINGBACK
The call is
receiving ringback from the called address. Ringback indicates that the other
station has been reached and is being alerted.
LINECALLSTATE_BUSY
The call is
receiving a busy tone. Busy tone indicates that the call cannot be completed either a circuit (trunk) or the remote party's station
are in use.
LINECALLSTATE_SPECIALINFO
Special
information is sent by the network. Special information is typically sent when
the destination cannot be reached.
LINECALLSTATE_CONNECTED
The call has
been established, the connection is made. Information is able to flow over the
call between the originating address and the destination address.
LINECALLSTATE_PROCEEDING
Dialing has
completed and the call is proceeding through the switch or telephone network.
LINECALLSTATE_ONHOLD
The call is
on hold by the switch.
LINECALLSTATE_CONFERENCED
The call is
currently a member of a multiparty conference call.
LINECALLSTATE_ONHOLDPENDCONF
The call is
currently on hold while it is being added to a conference.
LINECALLSTATE_ONHOLDPENDTRANSF
The call is
currently on hold awaiting transfer to another number.
LINECALLSTATE_DISCONNECTED
The remote
party has disconnected from the call.
LINECALLSTATE_UNKNOWN
The state of
the call is not known. This may be due to limitations of the call progress
detection implementation.
dwMonitorDigitsModes
The various
digit modes for which monitoring is currently enabled, of type LINEDIGITMODE_.
Values are:
LINEDIGITMODE_PULSE
Uses
pulse/rotary for digit signaling.
LINEDIGITMODE_DTMF
Uses DTMF
tones for digit signaling.
LINEDIGITMODE_DTMFEND
Uses DTMF
tones for digit detection, and also detects the down edges.
dwMonitorMediaModes
The various
media modes for which monitoring is currently enabled, of type LINEMEDIAMODE_.
Values are:
LINEMEDIAMODE_INTERACTIVEVOICE
The presence
of voice energy on the call and the call is treated as an interactive call with
humans on both ends.
LINEMEDIAMODE_AUTOMATEDVOICE
The presence
of voice energy on the call and the voice is locally handled by an automated
application.
LINEMEDIAMODE_DATAMODEM
A data modem
session on the call.
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_TDD
A TDD
(Telephony Devices for the Deaf) session on the call.
LINEMEDIAMODE_DIGITALDATA
Digital data
is being sent or received over the call.
LINEMEDIAMODE_TELETEX
A teletex
session on the call. Teletex is one of the telematic services.
LINEMEDIAMODE_VIDEOTEX
A videotex
session on the call. Videotex is one the telematic services.
LINEMEDIAMODE_TELEX
A telex
session on the call. Telex is one the telematic services.
LINEMEDIAMODE_MIXED
A mixed
session on the call. Mixed is one the ISDN telematic services.
LINEMEDIAMODE_ADSI
An ADSI
(Analog Display Services Interface) session on the call.
LINEMEDIAMODE_VOICEVIEW
The media
mode of the call is VoiceView.
DialParams
The dialing
parameters currently in effect on the call, of type LINEDIALPARAMS. Unless these parameters
are set by either lineMakeCall or lineSetCallParams, their values will be the same as the defaults
used in the LINEDEVCAPS.
dwOrigin
Identifies
where the call originated from. This field uses the following LINECALLORIGIN_
constants:
LINECALLORIGIN_OUTBOUND
The call is
an outbound call.
LINECALLORIGIN_INTERNAL
The call is
inbound and originated internally (on the same PBX, for example).
LINECALLORIGIN_EXTERNAL
The call is
inbound and originated externally.
LINECALLORIGIN_UNKNOWN
The call is
an inbound call and its origin is currently unknown but may become known later.
LINECALLORIGIN_UNAVAIL
The call is
an inbound call. Its origin is not available and will never become known for
this call.
LINECALLORIGIN_CONFERENCE
The call
handle is for a conference call, that is, the application's connection to the
conference bridge in the switch.
dwReason
The reason
why the call occurred. This field uses the following LINECALLREASON_ constants:
LINECALLREASON_DIRECT
This is a
direct call.
LINECALLREASON_FWDBUSY
This call was
forwarded from another extension that was busy at the time of the call.
LINECALLREASON_FWDNOANSWER
The call was
forwarded from another extension that didn't answer the call after some number
of rings.
LINECALLREASON_FWDUNCOND
The call was
forwarded unconditionally from another number.
LINECALLREASON_PICKUP
The call was
picked up from another extension.
LINECALLREASON_UNPARK
The call was
retrieved as a parked call.
LINECALLREASON_REDIRECT
The call was
redirected to this station.
LINECALLREASON_CALLCOMPLETION
The call was
the result of a call completion request.
LINECALLREASON_TRANSFER
The call has
been transferred from another number. Party ID information may indicate who the
caller is and where the call was transferred from.
LINECALLREASON_REMINDER
The call is a
reminder (or "recall") that the user has a call parked or on hold for
potentially a long time.
LINECALLREASON_UNKNOWN
The reason
for the call is currently unknown but may become known later.
LINECALLREASON_UNAVAIL
The reason
for the call is unavailable and will not become known later.
dwCompletionID
The
completion ID for the incoming call if it is the result of a completion request
that terminates. This ID is meaningful only if dwReason is
LINECALLREASON_CALLCOMPLETION.
dwNumOwners
The number of
application modules with different call handles with owner privilege for the
call.
dwNumMonitors
The number of
application modules with different call handles with monitor privilege for the
call.
dwCountryCode
The country
code of the destination party. Zero if unknown.
dwTrunk
The number of
the trunk over which the call is routed. This field is used for both inbound
and outgoing calls. The dwTrunk field should be set to 0xFFFFFFFF if it
is unknown.
dwCallerIDFlags
Determines
the validity and content of the caller party ID information. The caller is the
originator of the call. This field uses the following LINECALLPARTYID_
constants:
LINECALLPARTYID_BLOCKED
Caller ID
information for the call has been blocked by the caller but would otherwise
have been available.
LINECALLPARTYID_OUTOFAREA
Caller ID
information for the call is not available because it is not propagated all the
way by the network.
LINECALLPARTYID_NAME
The caller ID
information for the call is the caller's name (from a table maintained inside
the switch). It is provided in the caller ID name variably sized field.
LINECALLPARTYID_ADDRESS
The caller ID
information for the call is the caller's number and is provided in the caller
ID variably sized field.
LINECALLPARTYID_PARTIAL
Caller ID
information for the call is valid but is limited to partial number information.
LINECALLPARTYID_UNKNOWN
Caller ID
information is currently unknown but it may become known later.
LINECALLPARTYID_UNAVAIL
Caller ID
information is unavailable and will not become known later.
dwCallerIDSize
dwCallerIDOffset
The size in
bytes of the variably sized field containing the caller party ID number
information, and the offset in bytes from the beginning of this data structure.
dwCallerIDNameSize
dwCallerIDNameOffset
The size in
bytes of the variably sized field containing the caller party ID name
information, and the offset in bytes from the beginning of this data structure.
dwCalledIDFlags
Determines
the validity and content of the called-party ID information. The called party
corresponds to the originally addressed party. This field uses the following
LINECALLPARTYID_ constants:
LINECALLPARTYID_BLOCKED
Called ID
information for the call has been blocked by the caller but would otherwise
have been available.
LINECALLPARTYID_OUTOFAREA
Caller ID
information for the call is not available because it is not propagated all the
way by the network.
LINECALLPARTYID_NAME
The called ID
information for the call is the caller's name (from a table maintained inside
the switch). It is provided in the called ID name variably sized field.
LINECALLPARTYID_ADDRESS
The called ID
information for the call is the caller's number and is provided in the called
ID variably sized field.
LINECALLPARTYID_PARTIAL
Called ID
information for the call is valid but is limited to partial number information.
LINECALLPARTYID_UNKNOWN
Called ID
information is currently unknown but it may become known later.
LINECALLPARTYID_UNAVAIL
Called ID
information is unavailable and will not become known later.
dwCalledIDSize
dwCalledIDOffset
The size in
bytes of the variably sized field containing the called-party ID number
information, and the offset in bytes from the beginning of this data structure.
dwCalledIDNameSize
dwCalledIDNameOffset
The size in
bytes of the variably sized field containing the called-party ID name information,
and the offset in bytes from the beginning of this data structure.
dwConnectedFlags
Determines
the validity and content of the connected party ID information. The connected
party is the party that was actually connected to. This may be different from
the called-party ID if the call was diverted. This field uses the following
LINECALLPARTYID_ constants:
LINECALLPARTYID_BLOCKED
Connected
party ID information for the call has been blocked by the caller but would
otherwise have been available.
LINECALLPARTYID_OUTOFAREA
Connected ID
information for the call is not available as it is not propagated all the way
by the network.
LINECALLPARTYID_NAME
The connected
party ID information for the call is the caller's name (from a table maintained
inside the switch). It is provided in the connected ID name variably sized
field.
LINECALLPARTYID_ADDRESS
The connected
party ID information for the call is the caller's number and is provided in the
connected ID variably sized field.
LINECALLPARTYID_PARTIAL
Connected
party ID information for the call is valid but is limited to partial number
information.
LINECALLPARTYID_UNKNOWN
Connected
party ID information is currently unknown but it may become known later.
LINECALLPARTYID_UNAVAIL
Connected
party ID information is unavailable and will not become known later.
dwConnectedIDSize
dwConnectedIDOffset
The size in
bytes of the variably sized field containing the connected party ID number
information, and the offset in bytes from the beginning of this data structure.
dwConnectedIDNameSize
dwConnectedIDNameOffset
The size in
bytes of the variably sized field containing the connected party ID name
information, and the offset in bytes from the beginning of this data structure.
dwRedirectionIDFlags
Determines the
validity and content of the redirection party ID information. The redirection
party identifies to the calling user the number towards which diversion was
invoked. This field uses the following LINECALLPARTYID_ constants:
LINECALLPARTYID_BLOCKED
Redirection
party ID information for the call has been blocked by the caller but would
otherwise have been available.
LINECALLPARTYID_OUTOFAREA
Redirection
ID information for the call is not available because it is not propagated all
the way by the network.
LINECALLPARTYID_NAME
The
redirection party ID information for the call is the caller's name (from a
table maintained inside the switch). It is provided in the redirection ID name
variably sized field.
LINECALLPARTYID_ADDRESS
The
redirection party ID information for the call is the caller's number and is
provided in the redirection ID variably sized field.
LINECALLPARTYID_PARTIAL
Redirection
party ID information for the call is valid but is limited to partial number
information.
LINECALLPARTYID_UNKNOWN
Redirection
ID information is currently unknown but it may become known later.
LINECALLPARTYID_UNAVAIL
Redirection
ID information is unavailable and will not become known later.
dwRedirectionIDSize
dwRedirectionIDOffset
The size in
bytes of the variably sized field containing the redirection party ID number
information, and the offset in bytes from the beginning of this data structure.
dwRedirectionIDNameSize
dwRedirectionIDNameOffset
The size in
bytes of the variably sized field containing the redirection party ID name
information, and the offset in bytes from the beginning of this data structure.
dwRedirectingIDFlags
Determines
the validity and content of the redirecting party ID information. The
redirecting party identifies to the diverted-to user the party from which
diversion was invoked. This field uses the following LINECALLPARTYID_
constants:
LINECALLPARTYID_BLOCKED
Redirecting
party ID information for the call has been blocked by the caller but would
otherwise have been available.
LINECALLPARTYID_OUTOFAREA
Redirecting
ID information for the call is not available because it is not propagated all
the way by the network.
LINECALLPARTYID_NAME
The
redirecting party ID information for the call is the caller's name (from a
table maintained inside the switch). It is provided in the redirecting ID name
variably sized field.
LINECALLPARTYID_ADDRESS
The
redirecting party ID information for the call is the caller's number and is provided
in the redirecting ID variably sized field.
LINECALLPARTYID_PARTIAL
Redirecting
party ID information for the call is valid but is limited to partial number
information.
LINECALLPARTYID_UNKNOWN
Redirecting
ID information is currently unknown but it may become known later.
LINECALLPARTYID_UNAVAIL
Redirecting ID
information is unavailable and will not become known later.
dwRedirectingIDSize
dwRedirectingIDOffset
The size in
bytes of the variably sized field containing the redirecting party ID number
information, and the offset in bytes from the beginning of this data structure.
dwRedirectingIDNameSize
dwRedirectingIDNameOffset
The size in
bytes of the variably sized field containing the redirecting party ID name
information, and the offset in bytes from the beginning of this data structure.
dwAppNameSize
dwAppNameOffset
The size in
bytes and the offset in bytes from the beginning of this data structure of the
variably sized field holding the user-friendly application name of the
application that first originated, accepted, or answered the call. This is the
name that an application can specify in lineInitializeEx. If the application
specifies no such name, then the application's module file name is used
instead.
dwDisplayableAddressSize
dwDisplayableAddressOffset
The
displayable string is used for logging purposes. The information is obtained
from LINECALLPARAMS
for functions that initiate calls. The function lineTranslateAddress returns appropriate
information to be placed in this field in the dwDisplayableAddressSize
and dwDisplayableAddressOffset fields of the LINETRANSLATEOUTPUT structure.
dwCalledPartySize
dwCalledPartyOffset
The size in
bytes of the variably sized field holding a user-friendly description of the
called party, and the offset in bytes from the beginning of this data
structure. This information can be specified on lineMakeCall and can be optionally
specified in the lpCallParams whenever a new call is established. It is
useful for call logging purposes.
dwCommentSize
dwCommentOffset
The size in
bytes of the variably sized field holding a comment about the call provided by
the application that originated the call using lineMakeCall, and the
offset in bytes from the beginning of this data structure. This information can
be optionally specified in the lpCallParams whenever a new call is
established.
dwDisplaySize
dwDisplayOffset
The size in
bytes of the variably sized field holding raw display information, and the
offset in bytes from the beginning of this data structure. Depending on the
telephony environment, a service provider may extract functional information
from this for presentation in a more functional way.
dwUserUserInfoSize
dwUserUserInfoOffset
The size in
bytes of the variably sized field holding user-to-user information, and the
offset in bytes from the beginning of this data structure The protocol
discriminator field for the user-to-user information, if used, appears as the
first byte of the data pointed to by dwUserUserInfoOffset, and is
accounted for in dwUserUserInfoSize.
dwHighLevelCompSize
dwHighLevelCompOffset
The size in
bytes of the variably sized field holding high-level compatibility information,
and the offset in bytes from the beginning of this data structure. The format
of this information is specified by other standards (ISDN Q.931).
dwLowLevelCompSize
dwLowLevelCompOffset
The size in
bytes of the variably sized field holding low-level compatibility information,
and the offset in bytes from the beginning of this data structure The format of
this information is specified by other standards (ISDN Q.931).
dwChargingInfoSize
dwChargingInfoOffset
The size in
bytes of the variably sized field holding charging information, and the offset
in bytes from the beginning of this data structure The format of this
information is specified by other standards (ISDN Q.931).
dwTerminalModesSize
dwTerminalModesOffset
The size in
bytes of the variably sized device field containing an array with DWORD-sized
entries, and the offset in bytes from the beginning of this data structure. The
set of LINETERMMODE_ constants is indexed by terminal IDs, in the range from
zero to one less than dwNumTerminals. Each entry in the array specifies
the current terminal modes for the corresponding terminal set with the lineSetTerminal operation for this call's
media stream. Values are:
LINETERMMODE_LAMPS
Lamp events
sent from the line to the terminal.
LINETERMMODE_BUTTONS
Button-press
events sent from the terminal to the line.
LINETERMMODE_DISPLAY
Display
information sent from the line to the terminal.
LINETERMMODE_RINGER
Ringer-control
information sent from the switch to the terminal.
LINETERMMODE_HOOKSWITCH
Hookswitch
event sent between the terminal and the line.
LINETERMMODE_MEDIATOLINE
The
unidirectional media stream from the terminal to the line associated with a
call on the line. Use this value when the routing of both unidirectional
channels of a call's media stream can be controlled independently.
LINETERMMODE_MEDIAFROMLINE
The unidirectional
media stream from the line to the terminal associated with a call on the line.
Use this value when the routing of both unidirectional channels of a call's
media stream can be controlled independently.
LINETERMMODE_MEDIABIDIRECT
The
bidirectional media stream associated with a call on the line and the terminal.
Use this value when the routing of both the unidirectional channels of a call's
media stream cannot be controlled independently.
dwDevSpecificSize
dwDevSpecificOffset
The size in
bytes of the variably sized field holding device-specific information., and the
offset in bytes from the beginning of this data structure.
dwCallTreatment
The call
treatment currently being applied on the call or that will be applied when the
call enters the next applicable state. May be 0 if call treatments are not
supported.
dwCallDataSize
dwCallDataOffset
The size in
bytes and offset from the beginning of LINECALLINFO of the
application-settable call data.
dwSendingFlowspecSize
dwSendingFlowspecOffset
The total
size in bytes and offset from the beginning of LINECALLINFO of a
WinSock2 FLOWSPEC structure followed by WinSock2 provider-specific data,
equivalent to what would have been stored in SendingFlowspec.len in a WinSock2 QOS
structure. Specifies the quality of service current in effect in the sending
direction on the call. The provider-specific portion following the FLOWSPEC
structure must not contain pointers to other blocks of memory, because TAPI
will not know how to marshal the data pointed to by the private pointer(s) and
convey it through interprocess communication to the application.
dwReceivingFlowspecSize
dwReceivingFlowspecOffset
The total
size in bytes and offset from the beginning of LINECALLINFO of a
WinSock2 FLOWSPEC structure followed by WinSock2 provider-specific data,
equivalent to what would have been stored in ReceivingFlowspec.len in a
WinSock2 QOS structure. Specifies the quality of service current in
effect in the receiving direction on the call. The provider-specific portion
following the FLOWSPEC structure must not contain pointers to other
blocks of memory, because TAPI will not know how to marshal the data pointed to
by the private pointer(s) and convey it through interprocess communication to
the application.
Remarks
Device-specific
extensions should use the DevSpecific (dwDevSpecificSize and dwDevSpecificOffset)
variably sized area of this data structure.
The LINECALLINFO
data structure contains relatively fixed information about a call. This
structure is returned with lineGetCallInfo. When information items in
this data structure have changed, a LINE_CALLINFO message is sent to the
application. A parameter to this message is the information item or field that
changed.
The dwAppSpecific
field can be used by applications to tag calls by using lineSetAppSpecific.
This field is uninterpreted by TAPI or service providers. It is initially set
to zero.
The members dwCallTreatment
through dwReceivingFlowspecOffset are available only to applications
that open the line device with an API version of 0x00020000 or greater.
Note The preferred
format for specification of the contents of the callerID field and the
other five similar fields is the TAPI canonical number format. For
example, a ICLID of "2068828080" received from the switch should be
converted to "+1 (206) 8828080" before being placed in the LINECALLINFO
structure. This standardized format facilitates searching of databases and
callback functions implemented in applications.
See Also