LINECALLPARAMS

The LINECALLPARAMS structure describes parameters supplied when making calls with TSPI_lineMakeCall. The LINECALLPARAMS structure is also used as a parameter in other operations. The comments on the right indicate the default values used when this structure is not provided to TSPI_lineMakeCall.

typedef struct linecallparams_tag {  // Defaults:
    DWORD  dwTotalSize;  // ---------

    DWORD  dwBearerMode;  // voice
    DWORD  dwMinRate;  // (3.1kHz)
    DWORD  dwMaxRate;  // (3.1kHz)
    DWORD  dwMediaMode;  // interactiveVoice

    DWORD  dwCallParamFlags;  // 0
    DWORD  dwAddressMode;  // addressID
    DWORD  dwAddressID  // (any available)

    LINEDIALPARAMS DialParams;  // (0, 0, 0, 0)

    DWORD  dwOrigAddressSize;  // 0
    DWORD  dwOrigAddressOffset;

    DWORD  dwDisplayableAddressSize;  // 0
    DWORD  dwDisplayableAddressOffset;

    DWORD  dwCalledPartySize;  // 0
    DWORD  dwCalledPartyOffset;

    DWORD  dwCommentSize;  // 0
    DWORD  dwCommentOffset;

    DWORD  dwUserUserInfoSize;  // 0
    DWORD  dwUserUserInfoOffset;

    DWORD  dwHighLevelCompSize;  // 0
    DWORD  dwHighLevelCompOffset;

    DWORD  dwLowLevelCompSize;  // 0
    DWORD  dwLowLevelCompOffset;

    DWORD  dwDevSpecificSize;  // 0
    DWORD  dwDevSpecificOffset;
} LINECALLPARAMS, FAR *LPLINECALLPARAMS;

Members

dwTotalSize

The total size in bytes allocated to this data structure. This size should be big enough to hold all the fixed and variably sized portions of this data structure.

dwBearerMode

The bearer mode for the call. This member uses the following LINEBEARERMODE_ constants:

LINEBEARERMODE_VOICE: A regular 3.1kHz analog voice grade bearer service. Bit integrity is not assured. Voice can support fax and modem media modes.
LINEBEARERMODE_SPEECH: Corresponds to G.711 speech transmission on the call. The network can 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: Corresponds to a non-call-associated signaling connection from the application to the service provider or switch (treated as a media stream by the Telephony API).
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.

If dwBearerMode is not set (is 0), the LINEBEARERMODE_VOICE value is assumed.

dwMinRate

dwMaxRate

The data rate range requested for the call's data stream in bps (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 min and max should be set to that value. If an application works best with one rate, but is able the degrade to lower rates, the application specifies these as the max and min rates, respectively.

If dwMaxRate is not set (is 0), the rate is assumed to be the maximum rate supported by device.

dwMediaMode

The expected media mode of the call. This member 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 is answered and the media stream is filtered to make a determination.
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_TDD: A TDD (Telephony Devices for the Deaf) session on the call.
LINEMEDIAMODE_G4FAX: A group 4 fax is being sent or received over 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.

If dwMediaMode is not set (is 0), the LINEMEDIAMODE_INTERACTIVEVOICE value is assumed.

dwCallParamFlags

These flags specify a collection of boolean call setup parameters, of type LINECALLPARAMFLAGS_. Values are:

LINECALLPARAMFLAGS_SECURE: The call is set up as secure.
LINECALLPARAMFLAGS_IDLE: The call gets an idle call appearance.
LINECALLPARAMFLAGS_BLOCKID: The originator identity is concealed (block caller ID).
LINECALLPARAMFLAGS_ORIGOFFHOOK: The originator's phone is automatically taken off hook.
LINECALLPARAMFLAGS_DESTOFFHOOK: The called party's phone is automatically taken off hook.

dwAddressMode

The mode by which the originating address is specified, of type LINEADDRESSMODE_. Values are:

LINEADDRESSMODE_ADDRESSID: The address is specified by means of a small integer in the range from 0 to dwNumAddresses minus one, where dwNumAddresses is the value in the line's device capabilities. The selected address is specified in the dwAddressID member.
LINEADDRESSMODE_DIALABLEADDR: The address is specified with its dialable address. The address is contained in the dwOrigAddressSize, dwOrigAddressOffset variably sized field.

If dwAddressMode is not set (is 0), the LINEADDRESSMODE_ADDRESSID value is assumed.

dwAddressID

The address identifier of the originating address if dwAddressMode is set to LINEADDRESSMODE_ADDRESSID.

DialParams

Dial parameters to be used on this call, of type LINEDIALPARAMS. When any member within this field has a value of 0, the default value for the field is used as specified in DefaultDialParams of the LINEDEVCAPS structure. If a nonzero value is specified for a field but the value is outside the range specified by the corresponding fields in MinDialParams and MaxDialParams in the LINEDEVCAPS structure, the nearest value within the valid range is used instead.

dwOrigAddressSize

dwOrigAddressOffset

The size in bytes and the offset from the beginning of this data structure in bytes of the variably sized field holding the originating address. The format of this address depends on the dwAddressMode member.

dwDisplayableAddressSize

dwDisplayableAddressOffset

The displayable string is used for logging purposes. The content of these fields is recorded in the dwDisplayableAddressSize/Offset member of the call's LINE_CALLINFO message. This information is intended for logging purposes. The TAPI function lineTranslateAddress returns appropriate information to be placed in this field in the dwDisplayableAddressSize/Offset members of the LINETRANSLATEOUTPUT structure.

dwCalledPartySize

dwCalledPartyOffset

The size in bytes and the offset from the beginning of this data structure in bytes of the variably sized field holding called party information. This information can be specified by the application that makes the call and is made available in the call's information structure for logging purposes. The format of this member is that of dwStringFormat, as specified in LINEDEVCAPS.

dwCommentSize

dwCommentOffset

The size in bytes and the offset from the beginning of this data structure in bytes of the variably sized field holding comments about the call. This information can be specified by the application that makes the call and is made available in the call's information structure for logging purposes. The format of this member is that of dwStringFormat, as specified in LINEDEVCAPS.

dwUserUserInfoSize

dwUserUserInfoOffset

The size in bytes and the offset from the beginning of this data structure in bytes of the variably sized field holding user-user information.

dwHighLevelCompSize

dwHighLevelCompOffset

The size in bytes and the offset from the beginning of this data structure in bytes of the variably sized field holding high-level compatibility information.

dwLowLevelCompSize

dwLowLevelCompOffset

The size in bytes and the offset from the beginning of this data structure in bytes of the variably sized field holding low-level compatibility information.

dwDevSpecificSize

dwDevSpecificOffset

The size in bytes and the offset from the beginning of this data structure in bytes of the variably sized field holding device-specific information.

Remarks

Device-specific extensions should use the DevSpecific (dwDevSpecificSize and dwDevSpecificOffset) variably sized area of this data structure.

This structure is used as a parameter for other operations, such as TSPI_lineMakeCall when setting up a call. Its members allow the application to specify the quality of service requested from the network as well as a variety of ISDN call setup parameters. If no LINECALLPARAMS structure is supplied to TSPI_lineMakeCall, a default POTS voice grade call is requested with the default values listed above.

Note that the parameters DialParams through dwDevSpecificOffset are ignored when an lpCallParams parameter is specified with the function TSPI_lineConditionalMediaDetection.

LINECALLPARAMS

Members

Remarks

See Also