2.2.6.20 LINECALLPARAMS
The LINECALLPARAMS packet describes parameters supplied when making calls using the MakeCall packet. The LINECALLPARAMS packet is also used as a parameter in other operations, such as line Open.
|
|
|
|
|
|
|
|
|
|
1 |
|
|
|
|
|
|
|
|
|
2 |
|
|
|
|
|
|
|
|
|
3 |
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
dwTotalSize |
|||||||||||||||||||||||||||||||
|
dwBearerMode |
|||||||||||||||||||||||||||||||
|
dwMinRate |
|||||||||||||||||||||||||||||||
|
dwMaxRate |
|||||||||||||||||||||||||||||||
|
dwMediaMode |
|||||||||||||||||||||||||||||||
|
dwCallParamFlags |
|||||||||||||||||||||||||||||||
|
dwAddressMode |
|||||||||||||||||||||||||||||||
|
dwAddressID |
|||||||||||||||||||||||||||||||
|
DialParams (16 bytes) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
dwOrigAddressSize |
|||||||||||||||||||||||||||||||
|
dwOrigAddressOffset |
|||||||||||||||||||||||||||||||
|
dwDisplayableAddressSize |
|||||||||||||||||||||||||||||||
|
dwDisplayableAddressOffset |
|||||||||||||||||||||||||||||||
|
dwCalledPartySize |
|||||||||||||||||||||||||||||||
|
dwCalledPartyOffset |
|||||||||||||||||||||||||||||||
|
dwCommentSize |
|||||||||||||||||||||||||||||||
|
dwCommentOffset |
|||||||||||||||||||||||||||||||
|
dwUserUserInfoSize |
|||||||||||||||||||||||||||||||
|
dwUserUserInfoOffset |
|||||||||||||||||||||||||||||||
|
dwHighLevelCompSize |
|||||||||||||||||||||||||||||||
|
dwHighLevelCompOffset |
|||||||||||||||||||||||||||||||
|
dwLowLevelCompSize |
|||||||||||||||||||||||||||||||
|
dwLowLevelCompOffset |
|||||||||||||||||||||||||||||||
|
dwDevSpecificSize |
|||||||||||||||||||||||||||||||
|
dwDevSpecificOffset |
|||||||||||||||||||||||||||||||
|
dwPredictiveAutoTransferStates |
|||||||||||||||||||||||||||||||
|
dwTargetAddressSize |
|||||||||||||||||||||||||||||||
|
dwTargetAddressOffset |
|||||||||||||||||||||||||||||||
|
dwSendingFlowspecSize |
|||||||||||||||||||||||||||||||
|
dwSendingFlowspecOffset |
|||||||||||||||||||||||||||||||
|
dwReceivingFlowspecSize |
|||||||||||||||||||||||||||||||
|
dwReceivingFlowspecOffset |
|||||||||||||||||||||||||||||||
|
dwDeviceClassSize |
|||||||||||||||||||||||||||||||
|
dwDeviceClassOffset |
|||||||||||||||||||||||||||||||
|
dwDeviceConfigSize |
|||||||||||||||||||||||||||||||
|
dwDeviceConfigOffset |
|||||||||||||||||||||||||||||||
|
dwCallDataSize |
|||||||||||||||||||||||||||||||
|
dwCallDataOffset |
|||||||||||||||||||||||||||||||
|
dwNoAnswerTimeout |
|||||||||||||||||||||||||||||||
|
dwCallingPartyIDSize |
|||||||||||||||||||||||||||||||
|
dwCallingPartyIDOffset |
|||||||||||||||||||||||||||||||
|
dwAddressType (optional) |
|||||||||||||||||||||||||||||||
|
VarData (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
dwTotalSize (4 bytes): An unsigned 32-bit integer. The total size, in bytes, allocated to this packet. This size SHOULD be large enough to hold all the fixed and variably sized portions of this packet.
dwBearerMode (4 bytes): An unsigned 32-bit integer. The value that specifies the bearer mode for the call. If dwBearerMode is set to any value except LINEBEARERMODE_PASSTHROUGH, the call will attempt to complete if that bearer mode is supported on the line being accessed. This member MUST use one or more of the LINEBEARERMODE_Constants.
If dwBearerMode is 0, the default value is LINEBEARERMODE_VOICE.
dwMinRate (4 bytes): An unsigned 32-bit integer. The minimum data rate requested for the call's data stream, in bits per second. When making a call, the service provider attempts to provide the highest available rate in the requested range. If a specific data rate is required, both dwMinRate and dwMaxRate SHOULD be set to that value. If an application works best with one rate but is able to degrade to lower rates, the application SHOULD specify these as the maximum and minimum rates, respectively.
dwMaxRate (4 bytes): An unsigned 32-bit integer. The value that specifies the data rate range requested for the call's data stream in bits per second. When making a call, the service provider attempts to provide the highest available rate in the requested range. If a specific data rate is required, both dwMinRate and dwMaxRate SHOULD be set to that value. If an application works best with one rate but is able to degrade to lower rates, the application SHOULD specify these as the maximum and minimum rates, respectively. If dwMaxRate is 0, the default value is as specified by the dwMaxRate member of the LINEDEVCAPS packet. This is the maximum rate supported by the device.
dwMediaMode (4 bytes): An unsigned 32-bit integer. The value that specifies the expected media mode of the call. This member MUST use one or more of the LINEMEDIAMODE_Constants. If dwMediaMode is 0, the default value is LINEMEDIAMODE_INTERACTIVEVOICE.
dwCallParamFlags (4 bytes): An unsigned 32-bit integer. The value that specifies a collection of Boolean call-setup parameters. This member MUST use one or more of the LINECALLPARAMFLAGS_Constants.
dwAddressMode (4 bytes): An unsigned 32-bit integer. The value that specifies the mode by which the originating address is specified. The dwAddressMode member cannot be LINEADDRESSMODE_ADDRESSID for the Open packet. This member MUST use one or more of the LINEADDRESSMODE_Constants.
dwAddressID (4 bytes): An unsigned 32-bit integer. The address identifier of the originating address if dwAddressMode is set to LINEADDRESSMODE_ADDRESSID.
DialParams (16 bytes): A LINEDIALPARAMS. When a value of 0 is specified for this field, the default value for the field is used as indicated in the DefaultDialParams member of the LINEDEVCAPS packet. If a nonzero value is specified for a field that is outside the range specified by the corresponding fields in MinDialParams and MaxDialParams in the LINEDEVCAPS packet, the nearest value within the valid range is used instead.
dwOrigAddressSize (4 bytes): An unsigned 32-bit integer. The size, in bytes, of the field holding the originating address.
dwOrigAddressOffset (4 bytes): An unsigned 32-bit integer. The offset, in bytes, from the beginning of this packet. The format of this address is dependent on the dwAddressMode member.
dwDisplayableAddressSize (4 bytes): An unsigned 32-bit integer. The size, in bytes, of the displayable string including the null terminator.
dwDisplayableAddressOffset (4 bytes): An unsigned 32-bit integer. The offset, in bytes, from the beginning of this packet that specifies the displayable string that is used for logging purposes. The content of this string is recorded in the dwDisplayableAddressOffset and dwDisplayableAddressSize fields of the call's LINECALLINFO packet.
dwCalledPartySize (4 bytes): An unsigned 32-bit integer. The size, in bytes, of the field that holds called-party data.
dwCalledPartyOffset (4 bytes): An unsigned 32-bit integer. The offset, in bytes, from the beginning of this packet. This data can be specified by the client that makes the call and is made available in the call's packet for logging purposes. The format of this field is that of dwStringFormat, as specified in LINEDEVCAPS.
dwCommentSize (4 bytes): An unsigned 32-bit integer. The size, in bytes, of the field that holds comments about the call.
dwCommentOffset (4 bytes): An unsigned 32-bit integer. The offset, in bytes, from the beginning of this packet. This data can be specified by the client that makes the call and is made available in the call's packet for logging purposes. The format of this field is that of dwStringFormat, as specified in LINEDEVCAPS.
dwUserUserInfoSize (4 bytes): An unsigned 32-bit integer. The size, in bytes, of the field that holds user-user data.
dwUserUserInfoOffset (4 bytes): An unsigned 32-bit integer. The offset, in bytes, from the beginning of this packet. The protocol discriminator field for the user-user data, if required, SHOULD appear as the first byte of the data pointed to by dwUserUserInfoOffset and MUST be accounted for in dwUserUserInfoSize.
dwHighLevelCompSize (4 bytes): An unsigned 32-bit integer. The size, in bytes, of the field that holds high-level compatibility data.
dwHighLevelCompOffset (4 bytes): An unsigned 32-bit integer. The offset, in bytes, from the beginning of this packet for the HighLevelCompOffset.
dwLowLevelCompSize (4 bytes): An unsigned 32-bit integer. The size, in bytes, of the field that holds low-level compatibility data.
dwLowLevelCompOffset (4 bytes): An unsigned 32-bit integer. The offset, in bytes, from the beginning of this packet for the LowLevelCompOffset.
dwDevSpecificSize (4 bytes): An unsigned 32-bit integer. The size, in bytes, of the field that holds device-specific data.
dwDevSpecificOffset (4 bytes): An unsigned 32-bit integer. The offset, in bytes, from the beginning of this packet for the DevSpecificOffset.
dwPredictiveAutoTransferStates (4 bytes): An unsigned 32-bit integer. The LINECALLSTATE_Constants, entry into which cause the call to be blind-transferred to the specified target address. Set to 0 if automatic transfer is not desired.
dwTargetAddressSize (4 bytes): An unsigned 32-bit integer. The size, in bytes, of a string specifying the target address that can be dialed not using dwAddressID. Used in the case of certain automatic actions. In the case of predictive dialing, specifies the address to which the call SHOULD be automatically transferred. Set to 0 if automatic transfer is not desired. In the case of a No Hold Conference, specifies the address that SHOULD be added to the call. In the case of a One Step Transfer, specifies the address to dial on the consultation call.
dwTargetAddressOffset (4 bytes): An unsigned 32-bit integer. The offset from the beginning of LINECALLPARAMS of a string specifying the target-dialable address not using dwAddressID. Used in the case of certain automatic actions. In the case of predictive dialing, specifies the address to which the call SHOULD be automatically transferred. Set to 0 if automatic transfer is not desired. In the case of a No Hold Conference, specifies the address that SHOULD be added to the call. In the case of a One Step Transfer, specifies the address to dial on the consultation call.
dwSendingFlowspecSize (4 bytes): An unsigned 32-bit integer. The total size, in bytes, of a Winsock2 FLOWSPEC packet followed by Winsock2 provider-specific data.
dwSendingFlowspecOffset (4 bytes): An unsigned 32-bit integer. The offset from the beginning of LINECALLPARAMS of a Winsock2 FLOWSPEC packet followed by Winsock2 provider-specific data.
dwReceivingFlowspecSize (4 bytes): An unsigned 32-bit integer. The total size, in bytes, of a Winsock2 FLOWSPEC packet.
dwReceivingFlowspecOffset (4 bytes): An unsigned 32-bit integer. The offset from the beginning of LINECALLPARAMS of a Winsock2 FLOWSPEC packet.
dwDeviceClassSize (4 bytes): An unsigned 32-bit integer. The size, in bytes, of a null-terminated ASCII string (the size includes the NULL) that indicates the device class of the device whose configuration is specified in DeviceConfig. Valid device class strings are the same as those specified for the GetID packet.
dwDeviceClassOffset (4 bytes): An unsigned 32-bit integer. The offset from the beginning of LINECALLPARAMS of a null-terminated ASCII string (the size includes the NULL) that indicates the device class of the device whose configuration is specified in DeviceConfig.
dwDeviceConfigSize (4 bytes): An unsigned 32-bit integer. The size, in bytes, of the opaque configuration packet pointed to by dwDevConfigOffset. This value is returned in the dwStringSize member in the VARSTRING packet returned by the GetDevConfig packet. If the size is 0, the default device configuration is used. This enables the application to set the device configuration before the call is initiated.
dwDeviceConfigOffset (4 bytes): An unsigned 32-bit integer. The offset from the beginning of LINECALLPARAMS to the opaque configuration packet. This value is returned in the dwStringSize field in the VARSTRING packet returned by GetDevConfig. If the size is 0, the default device configuration is used. This allows the application to set the device configuration before the call is initiated.
dwCallDataSize (4 bytes): An unsigned 32-bit integer. The size, in bytes, of the call data set by the application to be initially attached to the call.
dwCallDataOffset (4 bytes): An unsigned 32-bit integer. The offset from the beginning of LINECALLPARAMS of the call data set by the application to be initially attached to the call.
dwNoAnswerTimeout (4 bytes): An unsigned 32-bit integer. The number of seconds, after the completion of dialing, that the call SHOULD wait in the proceeding or ring-back state before it is abandoned by the service provider with a LINECALLSTATE_DISCONNECTED and LINEDISCONNECTMODE_NOANSWER. A value of 0 indicates that automatic call abandonment is not used.
dwCallingPartyIDSize (4 bytes): An unsigned 32-bit integer. The size, in bytes, of a null-terminated ASCII string (the size includes the NULL) that specifies the identity of the party placing the call.
dwCallingPartyIDOffset (4 bytes): An unsigned 32-bit integer. The offset from the beginning of LINECALLPARAMS of a null-terminated ASCII string (the size includes the NULL) that specifies the identity of the party placing the call. If the content of the identifier is acceptable and a path is available, the service provider passes the identifier to the called party to indicate the identity of the calling party.
dwAddressType (4 bytes): An unsigned 32-bit integer. The address type used for the call. This member is available only if the negotiated TAPI version is 3.0 or 3.1.
VarData (variable): MUST contain:
Originating address, as specified by dwOrigAddressOffset.
Displayable string that is used for logging purposes, as specified by dwDisplayableAddressOffset.
Called-party data, as specified by dwCalledPartyOffset.
Comments about the call, as specified by dwCommentOffset.
User-user data, as specified by dwUserUserInfoOffset.
High-level compatibility data, as specified by dwHighLevelCompOffset.
Low-level compatibility data, as specified by dwLowLevelCompOffset.
Device-specific information, as specified by dwDevSpecificOffset.
Target-dialable address, as specified by dwTargetAddressOffset.
A FLOWSPEC packet, as specified by dwSendingFlowspecOffset and dwReceivingFlowspecOffset.
Device class of the device, as specified by dwDeviceClassOffset.
Opaque configuration packet, as specified by dwDeviceConfigOffset.
Call data set by the application to be initially attached to the call, as specified by dwCallDataOffset.
Identity of the party placing the call, as specified by dwCallingPartyIDOffset.
Device-specific extensions SHOULD use the dwDevSpecificSize and dwDevSpecificOffset members of this packet.
This packet is used as a parameter to the MakeCall packet when setting up a call. Its fields enable the application to specify a variety of ISDN call-setup parameters. If no LINECALLPARAMS packet is supplied to MakeCall, a default POTS voice-grade call is requested with the default values listed above.
Note The members dwOrigAddressSize through dwDevSpecificOffset are ignored when an lpCallParams parameter is specified with the Open function.