2.2.4.1.3.66 SetCallParams
The SetCallParams packet is transmitted from a TAPI client to a TAPI server in a remote procedure call. Sending this packet allows an application to change the bearer mode, rate parameters, and dial parameters of an existing call.
|
|
|
|
|
|
|
|
|
|
1 |
|
|
|
|
|
|
|
|
|
2 |
|
|
|
|
|
|
|
|
|
3 |
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Req_Func |
|||||||||||||||||||||||||||||||
|
Reserved1 |
|||||||||||||||||||||||||||||||
|
dwRequestID |
|||||||||||||||||||||||||||||||
|
hCall |
|||||||||||||||||||||||||||||||
|
dwBearerMode |
|||||||||||||||||||||||||||||||
|
dwMinRate |
|||||||||||||||||||||||||||||||
|
dwMaxRate |
|||||||||||||||||||||||||||||||
|
lpDialParams |
|||||||||||||||||||||||||||||||
|
dwSize |
|||||||||||||||||||||||||||||||
|
Reserved2 |
|||||||||||||||||||||||||||||||
|
Reserved3 |
|||||||||||||||||||||||||||||||
|
Reserved4 |
|||||||||||||||||||||||||||||||
|
Reserved5 |
|||||||||||||||||||||||||||||||
|
Reserved6 |
|||||||||||||||||||||||||||||||
|
Reserved7 |
|||||||||||||||||||||||||||||||
|
VarData (16 bytes, optional) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
Req_Func (4 bytes): An unsigned 32-bit integer. The identifier of the function that will be invoked on the remote server. This value MUST be set to 72.
-
Return Values
-
On completion of ClientRequest, this field contains the result of the encapsulated telephony request. A nonzero request ID value indicates that the request is in progress and will complete asynchronously, and a LINEERR_Constants value indicates synchronous failure.
-
Returns a positive request identifier if the function will be completed asynchronously or a negative error number if an error occurs. The dwParam2 parameter of the corresponding LINE_REPLY packet is zero if the function succeeds, or it is a negative error number if an error occurs. If the client specified a nonzero value in the dwRequestID field of the packet, the same value MUST be used for the returned positive request identifier. The following table shows the return values for this function.
-
Value
Meaning
LINEERR_BEARERMODEUNAVAIL
0x80000003
The bearer mode member in the LINECALLPARAMS packet is invalid, the bearer mode that is specified in LINECALLPARAMS is not available, or the bearer mode of the call cannot be changed to the specified bearer mode.
LINEERR_NOTOWNER
0x80000046
The application is not the owner of the call.
LINEERR_INVALBEARERMODE
0x80000016
The bearer mode is invalid.
LINEERR_OPERATIONUNAVAIL
0x80000049
The operation is invalid.
LINEERR_INVALCALLHANDLE
0x80000018
The call handle is invalid.
LINEERR_RATEUNAVAIL
0x8000004A
The rate is unavailable.
LINEERR_INVALRATE
0x80000037
The rate is invalid.
LINEERR_NOMEM
0x80000044
Not enough memory is available.
LINEERR_OPERATIONFAILED
0x80000048
The operation failed.
LINEERR_RESOURCEUNAVAIL
0x8000004B
The resource is unavailable.
LINEERR_UNINITIALIZED
0x80000050
The parameter is uninitialized.
LINEERR_INVALCALLSTATE
0x8000001C
The call state is invalid.
LINEERR_INVALPOINTER
0x80000035
The pointer is invalid.
Reserved1 (4 bytes): An unsigned 32-bit integer. MUST be set to zero when sent and MUST be ignored on receipt.
dwRequestID (4 bytes): An unsigned 32-bit integer. The identifier of the asynchronous request.
-
Value
Meaning
0x00000000
The server MUST generate a unique positive request ID to return as the Ack_ReturnValue.
0x00000001 — 0x7FFFFFFF
The server MUST use this value instead of generating a unique positive request ID.
hCall (4 bytes): An HCALL. The handle to the call whose parameters are to be changed. One way of obtaining a valid hCall is by sending the MakeCall packet. Also a valid hCall can be obtained from LINE_CALLSTATE packet sent by the remote server. The application MUST be an owner of the call. The call state of hCall can be any state except idle or disconnected.
dwBearerMode (4 bytes): An unsigned 32-bit integer. The new bearer mode for the call. This field MUST use one of the LINEBEARERMODE_Constants.
dwMinRate (4 bytes): An unsigned 32-bit integer. The lower bound for the new data rate of the call.
dwMaxRate (4 bytes): An unsigned 32-bit integer. The upper bound for the new data rate of the call.
lpDialParams (4 bytes): An unsigned 32-bit integer. The offset, in bytes, in the VarData field of a LINEDIALPARAMS packet that contains the new dial parameters of the call. If this field is -1 (0xFFFFFFFF), no call parameter is sent.
dwSize (4 bytes): An unsigned 32-bit integer. The size, in bytes, of the packet that is indicated in the lpDialParams field.
Reserved2 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.
Reserved3 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.
Reserved4 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.
Reserved5 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.
Reserved6 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.
Reserved7 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.
VarData (16 bytes): Contains the LINEDIALPARAMS packet that specifies a collection of dialing-related fields.