Call functions

Functions
(long)	- PortSIPSDK::call:sendSdp:videoCall:
	Make a call. More...
(int)	- PortSIPSDK::rejectCall:code:
	rejectCall Reject the incoming call. More...
(int)	- PortSIPSDK::hangUp:
	hangUp Hang up the call. More...
(int)	- PortSIPSDK::answerCall:videoCall:
	answerCall Answer the incoming call. More...
(int)	- PortSIPSDK::updateCall:enableAudio:enableVideo:
	Use the re-INVITE to update the established call. More...
(int)	- PortSIPSDK::hold:
	Place a call on hold. More...
(int)	- PortSIPSDK::unHold:
	Take off hold. More...
(int)	- PortSIPSDK::muteSession:muteIncomingAudio:muteOutgoingAudio:muteIncomingVideo:muteOutgoingVideo:
	Mute the specified session audio or video. More...
(int)	- PortSIPSDK::forwardCall:forwardTo:
	Forward the call to another user once received an incoming call. More...
(long)	- PortSIPSDK::pickupBLFCall:videoCall:
	This function will be used for picking up a call based on the BLF (Busy Lamp Field) status. More...
(int)	- PortSIPSDK::sendDtmf:dtmfMethod:code:dtmfDration:playDtmfTone:
	Send DTMF tone. More...

Detailed Description

Function Documentation

call:sendSdp:videoCall:()

- (long) call:		(NSString *)	callee
sendSdp:		(BOOL)	sendSdp
videoCall:		(BOOL)	videoCall

Make a call.

Parameters

callee	The callee. It can be a name only 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 set to false, the outgoing call will not include the SDP in INVITE message.
videoCall	If set to true and at least one video codec was 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, which 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, and you need to detect the final state of calling in onInviteTrying, onInviteRinging, onInviteFailure callback events.

rejectCall:code:()

- (int) rejectCall:		(long)	sessionId
code:		(int)	code

rejectCall Reject the incoming call.

Parameters

sessionId	The session ID of the call.
code	Reject code. For example, 486 and 480.

Returns

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

hangUp:()

- (int) hangUp:

(long)

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:videoCall:()

- (int) answerCall:		(long)	sessionId
videoCall:		(BOOL)	videoCall

answerCall Answer the incoming call.

Parameters

sessionId	The session ID of the 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 set to false, the answer 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:enableAudio:enableVideo:()

- (int) updateCall:		(long)	sessionId
enableAudio:		(BOOL)	enableAudio
enableVideo:		(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 a specific error code.

Remarks

Example usage:

Example 1: A called B with the audio only, and B answered A, then there would be an audio conversation between A and B. Now if A wants to see B visually, A could use these functions to fulfill it.

[myVoIPSdk clearVideoCodec];
[myVoIPSdk addVideoCodec:VIDEOCODEC_H264];
[myVoIPSdk updateCall:sessionId enableAudio:true enableVideo:true];

Example 2: Remove video stream from current conversation.

[myVoIPSdk updateCall:sessionId enableAudio:true enableVideo:false];

hold:()

- (int) hold:

(long)

sessionId

Place a call on hold.

Parameters

sessionId

The 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.

unHold:()

- (int) unHold:

(long)

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:muteIncomingAudio:muteOutgoingAudio:muteIncomingVideo:muteOutgoingVideo:()

- (int) muteSession:		(long)	sessionId
muteIncomingAudio:		(BOOL)	muteIncomingAudio
muteOutgoingAudio:		(BOOL)	muteOutgoingAudio
muteIncomingVideo:		(BOOL)	muteIncomingVideo
muteOutgoingVideo:		(BOOL)	muteOutgoingVideo

Mute the specified session audio or video.

Parameters

sessionId	The session ID of the call.
muteIncomingAudio	Set it true to mute incoming audio stream, and user cannot hear from remote side audio.
muteOutgoingAudio	Set it true to mute outgoing audio stream, and the remote side cannot hear the audio.
muteIncomingVideo	Set it true to mute incoming video stream, and user cannot see remote side video.
muteOutgoingVideo	Set it true to mute outgoing video stream, and the remote side cannot see video.

Returns

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

forwardCall:forwardTo:()

- (int) forwardCall:		(long)	sessionId
forwardTo:		(NSString *)	forwardTo

Forward the call to another user once received an incoming call.

Parameters

sessionId	The session ID of the call.
forwardTo	Target of the call 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 a specific error code.

pickupBLFCall:videoCall:()

- (long) pickupBLFCall:		(const char *)	replaceDialogId
videoCall:		(BOOL)	videoCall

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

Parameters

replaceDialogId	The ID of the call to be picked up. It comes with onDialogStateUpdated callback.
videoCall	Indicates if it is video call or audio call to be picked up.

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:dtmfMethod:code:dtmfDration:playDtmfTone:()

- (int) sendDtmf:		(long)	sessionId
dtmfMethod:		(DTMF_METHOD)	dtmfMethod
code:		(int)	code
dtmfDration:		(int)	dtmfDuration
playDtmfTone:		(BOOL)	playDtmfTone

Send DTMF tone.

Parameters

sessionId	The session ID of the call.
dtmfMethod	Support sending DTMF tone with two methods: DTMF_RFC2833 and DTMF_INFO. The DTMF_RFC2833 is recommended.
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	By setting 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.