Call functions

Functions
Int32	PortSIP.PortSIPLib.call (String callee, Boolean sendSdp, Boolean videoCall)
	Make a call. More...
Int32	PortSIP.PortSIPLib.rejectCall (Int32 sessionId, int code)
	rejectCall Reject the incoming call. More...
Int32	PortSIP.PortSIPLib.hangUp (Int32 sessionId)
	hangUp Hang up the call. More...
Int32	PortSIP.PortSIPLib.answerCall (Int32 sessionId, Boolean videoCall)
	answerCall Answer the incoming call. More...
Int32	PortSIP.PortSIPLib.updateCall (Int32 sessionId, bool enableAudio, bool enableVideo)
	Use the re-INVITE to update the established call. More...
Int32	PortSIP.PortSIPLib.hold (Int32 sessionId)
	To place a call on hold. More...
Int32	PortSIP.PortSIPLib.unHold (Int32 sessionId)
	Take off hold. More...
Int32	PortSIP.PortSIPLib.muteSession (Int32 sessionId, Boolean muteIncomingAudio, Boolean muteOutgoingAudio, Boolean muteIncomingVideo, Boolean muteOutgoingVideo)
	Mute the specified session audio or video. More...
Int32	PortSIP.PortSIPLib.forwardCall (Int32 sessionId, String forwardTo)
	Forward call to another one when receiving the incoming call. More...
Int32	PortSIP.PortSIPLib.pickupBLFCall (String replaceDialogId, Boolean videoCall)
	This function will be used for picking up a call based on the BLF (Busy Lamp Field) status. More...
Int32	PortSIP.PortSIPLib.sendDtmf (Int32 sessionId, DTMF_METHOD dtmfMethod, int code, int dtmfDuration, bool playDtmfTone)
	Send DTMF tone. More...

Detailed Description

Function Documentation

call()

Int32 PortSIP.PortSIPLib.call	(	String	callee,
		Boolean	sendSdp,
		Boolean	videoCall
	)

Make a call.

Parameters

callee	The callee. It can be either name or full SIP URI. For example: user001, sip:user0.nosp@m.01@s.nosp@m.ip.ip.nosp@m.tel..nosp@m.org or sip:user0.nosp@m.02@s.nosp@m.ip.yo.nosp@m.urdo.nosp@m.main..nosp@m.com:5068
sendSdp	If it's set to false, the outgoing call doesn't include the SDP in INVITE message.
videoCall	If it's set to true with at least one video codecs added, the outgoing call will include the video codec into SDP.

Returns

If the function succeeds, it will return the session ID of the call that is greater than 0. If the function fails, it will return a specific error code. Note: the function success just means the outgoing call is being processed. You need to detect the call final state in onInviteTrying, onInviteRinging, onInviteFailure callback events.

rejectCall()

Int32 PortSIP.PortSIPLib.rejectCall	(	Int32	sessionId,
		int	code
	)

rejectCall Reject the incoming call.

Parameters

sessionId	The sessionId of the call.
code	Reject code. For example, 486, 480 etc.

Returns

If the function succeeds, it will return value 0. If the function fails, it will return a specific error code.

hangUp()

Int32 PortSIP.PortSIPLib.hangUp

(

Int32

sessionId

)

hangUp Hang up the call.

Parameters

sessionId

Session ID of the call.

Returns

If the function succeeds, it will return value 0. If the function fails, it will return a specific error code.

answerCall()

Int32 PortSIP.PortSIPLib.answerCall	(	Int32	sessionId,
		Boolean	videoCall
	)

answerCall Answer the incoming call.

Parameters

sessionId	The session ID of call.
videoCall	If the incoming call is a video call and the video codec is matched, set it to true to answer the video call. If it's set to false, the answered call will not include video codec answer anyway.

Returns

If the function succeeds, it will return value 0. If the function fails, it will return a specific error code.

updateCall()

Int32 PortSIP.PortSIPLib.updateCall	(	Int32	sessionId,
		bool	enableAudio,
		bool	enableVideo
	)

Use the re-INVITE to update the established call.

Parameters

sessionId	The session ID of call.
enableAudio	Set to true to allow the audio in updated call, or false to disable audio in updated call.
enableVideo	Set to true to allow the video in updated call, or false to disable video in updated call.

Returns

If the function succeeds, it will return value 0. If the function fails, it will return value a specific error code.

Remarks

Example usage:
Example 1: A called B with the audio only, B answered A, there has an audio conversation between A, B. Now A wants to see B visually, A could use these functions to do it.

clearVideoCodec();  
addVideoCodec(VIDEOCODEC_H264);
updateCall(sessionId, true, true);

Example 2: Remove video stream from current conversation.

updateCall(sessionId, true, false);

hold()

Int32 PortSIP.PortSIPLib.hold

(

Int32

sessionId

)

To place a call on hold.

Parameters

sessionId

The session ID of call.

Returns

If the function succeeds, it will return value 0. If the function fails, it will return a specific error code.

unHold()

Int32 PortSIP.PortSIPLib.unHold

(

Int32

sessionId

)

Take off hold.

Parameters

sessionId

The session ID of call.

Returns

If the function succeeds, it will return value 0. If the function fails, it will return a specific error code.

muteSession()

Int32 PortSIP.PortSIPLib.muteSession	(	Int32	sessionId,
		Boolean	muteIncomingAudio,
		Boolean	muteOutgoingAudio,
		Boolean	muteIncomingVideo,
		Boolean	muteOutgoingVideo
	)

Mute the specified session audio or video.

Parameters

sessionId	The session ID of the call.
muteIncomingAudio	Set it to true to mute incoming audio stream, and remote side audio cannot be heard.
muteOutgoingAudio	Set it to true to mute outgoing audio stream, and the remote side can't hear the audio.
muteIncomingVideo	Set it to true to mute incoming video stream, and the remote side video will be invisible.
muteOutgoingVideo	Set it to true to mute outgoing video stream, and the remote side can't see the video.

Returns

If the function succeeds, it will return value 0. If the function fails, it will return a specific error code.

forwardCall()

Int32 PortSIP.PortSIPLib.forwardCall	(	Int32	sessionId,
		String	forwardTo
	)

Forward call to another one when receiving the incoming call.

Parameters

sessionId	The session ID of the call.
forwardTo	Target of the forwarding. It can be "sip:number@sipserver.com" or "number" only.

Returns

If the function succeeds, it will return value 0. If the function fails, it will return value a specific error code.

pickupBLFCall()

Int32 PortSIP.PortSIPLib.pickupBLFCall	(	String	replaceDialogId,
		Boolean	videoCall
	)

This function will be used for picking up a call based on the BLF (Busy Lamp Field) status.

Parameters

replaceDialogId	The session ID of the call.
videoCall	Target of the forwarding. It can be "sip:number@sipserver.com" or "number" only.

Returns

If the function succeeds, it will return a session ID that is greater than 0 to the new call, otherwise returns a specific error code that is less than 0.

Remarks

The scenario is:

1. User 101 subscribed the user 100's call status: sendSubscription(mSipLib, "100", "dialog");
2. When 100 hold a call or 100 is ringing, onDialogStateUpdated callback will be triggered, and 101 will receive this callback. Now 101 can use pickupBLFCall function to pick the call rather than 100 to talk with caller.

sendDtmf()

Int32 PortSIP.PortSIPLib.sendDtmf	(	Int32	sessionId,
		DTMF_METHOD	dtmfMethod,
		int	code,
		int	dtmfDuration,
		bool	playDtmfTone
	)

Send DTMF tone.

Parameters

sessionId	The session ID of the call.
dtmfMethod	DTMF tone could be sent with two methods: DTMF_RFC2833 and DTMF_INFO, of which DTMF_RFC2833 is recommend.
code	The DTMF tone (0-16).

code	Description
0	The DTMF tone 0.
1	The DTMF tone 1.
2	The DTMF tone 2.
3	The DTMF tone 3.
4	The DTMF tone 4.
5	The DTMF tone 5.
6	The DTMF tone 6.
7	The DTMF tone 7.
8	The DTMF tone 8.
9	The DTMF tone 9.
10	The DTMF tone *.
11	The DTMF tone #.
12	The DTMF tone A.
13	The DTMF tone B.
14	The DTMF tone C.
15	The DTMF tone D.
16	The DTMF tone FLASH.

Parameters

dtmfDuration	The DTMF tone samples. Recommended value 160.
playDtmfTone	If it is set to true, the SDK plays local DTMF tone sound when sending DTMF.

Returns

If the function succeeds, it will return value 0. If the function fails, it will return a specific error code.