The SetRingbackType function allows the VOIP application to control the generation of the outgoing call ring back tone. The media engine supports the ability to sound the outgoing call ring back tone immediately after the transmission of the first INVITE request for the call or not until the reception of a "180 Ringing" SIP message. By default, the media engine will sound the ring back tone for an outgoing call immediately after the first INVITE request is transmitted.

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


public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetRingbackType(
	bool RingbackImmediate
Visual Basic (Declaration)
Public Function SetRingbackType ( _
	RingbackImmediate As Boolean _
Visual C++
VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetRingbackType(
	bool RingbackImmediate
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetRingbackType(
	boolean RingbackImmediate


Type: System..::.Boolean
If this parameter is set to non zero, the media engine will generate the ring back sound for the outgoing call as soon as the first SIP INVITE requests is transmitted. If this parameter is zero, the media engine will generate the ring back sound for the outgoing call only after receiving the fist "180 Ringing" SIP message provisional response.

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
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)

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)



See Also