The SetInCallProcessPriority can be called by application software to modify the current operating system process priority of the telephony engine and the end user's application. The following process priorities can be specified:

PriorityNormal
PriorityHigh
PriorityRealtime


For further information regarding process priorities, see data type VoipMediaEngine..::.IN_CALL_PROCESS_PRIORITY.

Depending on operating system loading, the end user application may want to increase the process priority when it is known that telephony functions will be used in a high demand system. By default, the telephony engine operates under "priority normal" for all conditions unless you call this API procedure.

If no phone calls are active, the telephony engine maintains the "priority normal" state. As soon as an out going or incoming phone call is active, the telephony engine will shift to the process priority specified by the InCallProcessPriority parameter.

When all phone calls terminate, the telephony engine will again enter the "priority normal" state.

Caution:
If you use this telephony API procedure, it is recommended that you do not use the WIN32 API procedure SetPriorityClass in your application.

Namespace:  LanScape
Assembly:  LMEVoipManaged (in LMEVoipManaged.dll) Version: 6.0.5226.26700

Syntax

C#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetInCallProcessPriority(
	VoipMediaEngine..::.IN_CALL_PROCESS_PRIORITY InCallProcessPriority
)
Visual Basic (Declaration)
Public Function SetInCallProcessPriority ( _
	InCallProcessPriority As VoipMediaEngine..::.IN_CALL_PROCESS_PRIORITY _
) As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE
Visual C++
public:
VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetInCallProcessPriority(
	VoipMediaEngine..::.IN_CALL_PROCESS_PRIORITY InCallProcessPriority
)
J#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetInCallProcessPriority(
	VoipMediaEngine..::.IN_CALL_PROCESS_PRIORITY InCallProcessPriority
)

Parameters

InCallProcessPriority
Type: LanScape..::.VoipMediaEngine..::.IN_CALL_PROCESS_PRIORITY
The process priority to apply when phone calls are active.

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 VoipMediaEngine..::.TELEPHONY_RETURN_VALUE data type.

Return ValueDescription
SipCallFailure
This value is returned by telephony API procedures to indicate general API failure. This error value is used as a "catch all error". If you receive this error, check to make sure that all parameters specified in the API procedure call are correct. Particularly, verify that pointers to memory regions are valid. This error return value is only used if a mapping to another specific error value does not exist.

(API return value)

SipInvalidHandle
Application software specified an invalid telephony handle in one of the API procedures. This usually indicates memory corruption on the part of application software.

(API return value)

Remarks

None.

See Also