SetCallTerminateTimeout

The SetCallTerminateTimeout function allows an application to specify the number of milliseconds that must pass before a call terminate operation (call hang-up) is considered to be in the time-out state. Generally application software does not need to call this API procedure unless a call endpoint is taking a very long time responding to your applications call termination requests. The internal default value for call termination time-out is 2000 Ms.
 

Parameters:

hStateMachine

[in] The handle to the telephony engine. This is the handle that was returned by a previous call to the StartSipTelephony procedure.

CallTerminateTimeoutMs

[in] The number of milliseconds to use when determining call terminate time-out state. Any value 0 Ms or greater is acceptable.

Note: If you specify a time out value that is smaller than the time it takes the far end of a call to respond to the media engine's BYE requests, you will receive SipCallTimeOut return values from the TerminateCall API procedure. If the media engine has many calls active and you want to terminate the media engine quickly, setting the value for the CallTerminateTimeoutMs parameter to zero and calling this API procedure before terminating the media engine will result in faster shutdown.
 

Return Value:

If the function succeeds, the return value will be SipSuccess.

If the function fails, the return value will be one of the following values as specified by the TELEPHONY_RETURN_VALUE data type.