com.ca.wrapper

Class CSCall

java.lang.Object

com.ca.wrapper.CSCall

public class CSCall
extends java.lang.Object

This class contains all Calls related apis. App will be notified by LocalBroadcastManager for asynchronous results of apis.

See Also:

CSEvents

Constructor Summary

Constructors

Constructor and Description
CSCall()

Method Summary

Modifier and Type	Method and Description
void	answerPstnCall(java.lang.String remoteid, java.lang.String callid, java.lang.String callcontextmessage, CSLocation location) answers an incoming pstn call.
void	answerVideoCall(java.lang.String remoteid, java.lang.String callid, CSSurfaceViewRenderer localRender, CSSurfaceViewRenderer remoteRender, java.lang.String callcontextmessage, CSLocation location) answers an incoming video call.
void	answerVoiceCall(java.lang.String remoteid, java.lang.String callid, java.lang.String callcontextmessage, CSLocation location) answers an incoming audio call.
boolean	enableCallStats(boolean enable) enableCallStats.
boolean	enableDefaultlocalVideoPreviewUX(boolean enable) enableDefaultlocalVideoPreviewUX.Set to true or false to enable or disable local preview dragging around the screen,to toggle Local and remote video between Renderer Layouts and to set layout params dynamically in video call
boolean	enableSpeaker(java.lang.String callid, boolean enablespeaker) enable Or Disable Speaker In a Call.
void	endPstnCall(java.lang.String number, java.lang.String callid) ends pstn call.
void	endVideoCall(java.lang.String remoteid, java.lang.String callid, int endStatus, java.lang.String endReason) ends video call.
void	endVoiceCall(java.lang.String remoteid, java.lang.String callid, int endStatus, java.lang.String endReason) ends audio call.
boolean	holdAVCall(java.lang.String remoteid, java.lang.String callid, boolean toggle) hold or unhold either audio call or video call.On success response audio/video gets muted at both caller and calle hence UI for mute functionality should be shown accordingly.Also there are no restrictions on functionality of muteAudio muteVideo when call is on hold,Also after unhold, the previous state of mute in the call will be recovered.
boolean	holdPstnCall(java.lang.String callid, boolean toggle) hold or unhold pstn call.
static boolean	isCallAnswerable(java.lang.String callid) gets Incoming Call Status i.e whether its answerable or not.
boolean	isCallStatsEnabled() isCallStatsEnabled.
boolean	muteAudio(java.lang.String callid, boolean mute) mute or unmute Audio in a call
boolean	muteVideo(java.lang.String callid, boolean mute) mute or unmute video in video call.
boolean	recordCall(java.lang.String callid) Record the call.
boolean	sendDtmfInPstnCall(java.lang.String digit, java.lang.String callid) send Dtmf In Pstn Call
boolean	sendVideoCallRinging(java.lang.String remoteid, java.lang.String callid, boolean iscallwaiting) send call Ringing for Video Call
boolean	sendVoiceCallRinging(java.lang.String remoteid, java.lang.String callid, boolean iscallwaiting) send call Ringing for Voice Call
boolean	setIceTransportsType(CSConstants.IceTransportsType type) setIceTransportsType
boolean	setPreferredAudioCodec(CSConstants.PreferredAudioCodec audioCodec) setPreferredAudioCodec.
boolean	setPreferredVideoCodec(CSConstants.PreferredVideoCodec videocodec) setPreferredVideoCodec.
java.lang.String	startPstnCall(java.lang.String number, java.lang.String fromNumber, java.lang.String callcontextmessage, CSLocation location) initiates an pstn call.
java.lang.String	startVideoCall(java.lang.String remoteid, CSSurfaceViewRenderer localRender, CSSurfaceViewRenderer remoteRender, CSConstants.CALLRECORD callrecord, java.lang.String callcontextmessage, CSLocation location) initiates an outgoing video call.
java.lang.String	startVoiceCall(java.lang.String remoteid, CSConstants.CALLRECORD callrecord, java.lang.String callcontextmessage, CSLocation location) initiates an outgoing audio call.
boolean	toggleCamera(java.lang.String callid) toggle Camera In a Call
boolean	toggleVideocallViews(java.lang.String callid) toggleVideocallViews.toggle Local and remote video between Renderer Layouts.If call is in holded state this api do nothing and returns false

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CSCall

public CSCall()

Method Detail

startVoiceCall

public java.lang.String startVoiceCall(java.lang.String remoteid,
                                       CSConstants.CALLRECORD callrecord,
                                       java.lang.String callcontextmessage,
                                       CSLocation location)

initiates an outgoing audio call.

Parameters:

remoteid - of calle

callrecord - whether to record call or not or record as per settings.

callcontextmessage - Call context message

location - Location of the call

Returns:

returns callid

Events:

Below are the events that can be notified by LocalBroadcastManager
CSCALL_CALLANSWERED CSCALL_CALLENDED CSCALL_NOANSWER CSCALL_NOMEDIA CSCALL_RINGING CSCALL_MEDIACONNECTED CSCALL_MEDIADISCONNECTED CSCALL_CALLTERMINATED CSCLIENT_NETWORKERROR CSCLIENT_GSM_CALL_INPROGRESS CSCLIENT_PERMISSION_NEEDED CSCALL_RECORDING_STATUS

answerVoiceCall

public void answerVoiceCall(java.lang.String remoteid,
                            java.lang.String callid,
                            java.lang.String callcontextmessage,
                            CSLocation location)

answers an incoming audio call.

Parameters:

remoteid - of calle

callid - incoming call callid

callcontextmessage - Call context message

location - Location of the call

See Also:

CSCallReceiver

Events:

Below are the events that can be notified by LocalBroadcastManager
CSCALL_CALLENDED CSCALL_NOANSWER CSCALL_NOMEDIA CSCALL_RINGING CSCALL_MEDIACONNECTED CSCALL_MEDIADISCONNECTED CSCALL_CALLTERMINATED CSCLIENT_NETWORKERROR CSCLIENT_GSM_CALL_INPROGRESS CSCLIENT_PERMISSION_NEEDED CSCALL_RECORDING_STATUS

endVoiceCall

public void endVoiceCall(java.lang.String remoteid,
                         java.lang.String callid,
                         int endStatus,
                         java.lang.String endReason)

ends audio call.

Parameters:

remoteid - of calle whose call is active

callid - callid

endStatus - user defined endStatus code

endReason - user defined endReason

Events:

Below are the events that can be notified by LocalBroadcastManager
CSCALL_CALLTERMINATED CSCLIENT_NETWORKERROR

sendVoiceCallRinging

public boolean sendVoiceCallRinging(java.lang.String remoteid,
                                    java.lang.String callid,
                                    boolean iscallwaiting)

send call Ringing for Voice Call

Parameters:

remoteid - of calle

callid - callid

iscallwaiting - callwaiting indication

Events:

Below are the events that can be notified by LocalBroadcastManager
CSCALL_AUDIOVIDEOCALLRINGING_RESPONSE CSCLIENT_NETWORKERROR

sendVideoCallRinging

public boolean sendVideoCallRinging(java.lang.String remoteid,
                                    java.lang.String callid,
                                    boolean iscallwaiting)

send call Ringing for Video Call

Parameters:

remoteid - of calle

callid - callid

iscallwaiting - callwaiting indication

Events:

Below are the events that can be notified by LocalBroadcastManager
CSCALL_AUDIOVIDEOCALLRINGING_RESPONSE CSCLIENT_NETWORKERROR

startVideoCall

public java.lang.String startVideoCall(java.lang.String remoteid,
                                       CSSurfaceViewRenderer localRender,
                                       CSSurfaceViewRenderer remoteRender,
                                       CSConstants.CALLRECORD callrecord,
                                       java.lang.String callcontextmessage,
                                       CSLocation location)

initiates an outgoing video call.

Parameters:

remoteid - of calle

localRender - localRender of type CSSurfaceViewRenderer

remoteRender - remoteRender of type CSSurfaceViewRenderer

callrecord - whether to record call or not or record as per settings.

callcontextmessage - Call context message

location - Location of the call

Returns:

returns callid

Events:

Below are the events that can be notified by LocalBroadcastManager
CSCALL_CALLANSWERED CSCALL_CALLENDED CSCALL_NOANSWER CSCALL_NOMEDIA CSCALL_RINGING CSCALL_MEDIACONNECTED CSCALL_MEDIADISCONNECTED CSCALL_CALLTERMINATED CSCLIENT_NETWORKERROR CSCLIENT_GSM_CALL_INPROGRESS CSCLIENT_PERMISSION_NEEDED CSCALL_RECORDING_STATUS

answerVideoCall

public void answerVideoCall(java.lang.String remoteid,
                            java.lang.String callid,
                            CSSurfaceViewRenderer localRender,
                            CSSurfaceViewRenderer remoteRender,
                            java.lang.String callcontextmessage,
                            CSLocation location)

answers an incoming video call.

Parameters:

remoteid - of calle

callid - incoming call callid

callcontextmessage - Call context message

location - Location of the call

localRender - localRender of type CSSurfaceViewRenderer

remoteRender - remoteRender of type CSSurfaceViewRenderer

See Also:

CSCallReceiver

Events:

Below are the events that can be notified by LocalBroadcastManager
CSCALL_CALLENDED CSCALL_NOANSWER CSCALL_NOMEDIA CSCALL_RINGING CSCALL_MEDIACONNECTED CSCALL_MEDIADISCONNECTED CSCALL_CALLTERMINATED CSCLIENT_NETWORKERROR CSCLIENT_GSM_CALL_INPROGRESS CSCLIENT_PERMISSION_NEEDED CSCALL_RECORDING_STATUS

endVideoCall

public void endVideoCall(java.lang.String remoteid,
                         java.lang.String callid,
                         int endStatus,
                         java.lang.String endReason)

ends video call.

Parameters:

remoteid - of calle whose call is active

callid - callid

endStatus - user defined endStatus code

endReason - user defined endReason

Events:

Below are the events that can be notified by LocalBroadcastManager
CSCALL_CALLTERMINATED CSCLIENT_NETWORKERROR

enableSpeaker

public boolean enableSpeaker(java.lang.String callid,
                             boolean enablespeaker)

enable Or Disable Speaker In a Call.

Parameters:

enablespeaker - true to enable speaker or false to disable speaker

Returns:

success or failure

muteAudio

public boolean muteAudio(java.lang.String callid,
                         boolean mute)

mute or unmute Audio in a call

Parameters:

mute - true to mute or false to unmute

Returns:

true or false

Events:

Below are the events that can be notified by LocalBroadcastManager
These events will be notified only for active calls
These events will be notified to remote end only when network available and for app to app audio or video calls only
CSCALL_MUTE_OR_UNMUTE CSCALL_MUTE_OR_UNMUTE_ACK

muteVideo

public boolean muteVideo(java.lang.String callid,
                         boolean mute)

mute or unmute video in video call.

Parameters:

mute - true to mute or false to unmute

Returns:

true or false

Events:

Below are the events that can be notified by LocalBroadcastManager
These events will be notified only for active app to app video calls
These events will be notified to remote end only when network available and for app to app video calls only
CSCALL_MUTE_OR_UNMUTE CSCALL_MUTE_OR_UNMUTE_ACK

toggleCamera

public boolean toggleCamera(java.lang.String callid)

toggle Camera In a Call

Parameters:

callid - callid

Returns:

true or false

toggleVideocallViews

public boolean toggleVideocallViews(java.lang.String callid)

toggleVideocallViews.toggle Local and remote video between Renderer Layouts.If call is in holded state this api do nothing and returns false

Parameters:

callid - callid

Returns:

true or false

enableDefaultlocalVideoPreviewUX

public boolean enableDefaultlocalVideoPreviewUX(boolean enable)

enableDefaultlocalVideoPreviewUX.Set to true or false to enable or disable local preview dragging around the screen,to toggle Local and remote video between Renderer Layouts and to set layout params dynamically in video call

Parameters:

enable - true or false

Returns:

true or false

setIceTransportsType

public boolean setIceTransportsType(CSConstants.IceTransportsType type)

setIceTransportsType

Parameters:

type - IceTransportsType

Returns:

true or false

setPreferredAudioCodec

public boolean setPreferredAudioCodec(CSConstants.PreferredAudioCodec audioCodec)

setPreferredAudioCodec. For app to PSTN calling G729 will be preferred codec always.

Parameters:

audioCodec - audioCodec

Returns:

true or false

setPreferredVideoCodec

public boolean setPreferredVideoCodec(CSConstants.PreferredVideoCodec videocodec)

setPreferredVideoCodec. Any codec set must be supported by device. Else this api returns false.

Parameters:

videocodec - videocodec

Returns:

true or false

isCallAnswerable

public static boolean isCallAnswerable(java.lang.String callid)

gets Incoming Call Status i.e whether its answerable or not.

Parameters:

callid - callid

Returns:

returns true if call exists or returns false if call already ended by caller or on invalid callid

startPstnCall

public java.lang.String startPstnCall(java.lang.String number,
                                      java.lang.String fromNumber,
                                      java.lang.String callcontextmessage,
                                      CSLocation location)

initiates an pstn call.

Parameters:

number - of calle

fromNumber - fromNumber. It can be a Caller id that can be choosen from user's available DID numbers.

callcontextmessage - Call context message

location - Location of the call

Returns:

returns callid

Events:

Below are the events that can be notified by LocalBroadcastManager
CSCALL_CALLANSWERED CSCALL_CALLENDED CSCALL_NOANSWER CSCALL_NOMEDIA CSCALL_RINGING CSCALL_SESSION_IN_PROGRESS CSCALL_MEDIACONNECTED CSCALL_MEDIADISCONNECTED CSCALL_CALLTERMINATED CSCLIENT_NETWORKERROR CSCLIENT_GSM_CALL_INPROGRESS CSCLIENT_PERMISSION_NEEDED CSCALL_RECORDING_AT_SERVER

answerPstnCall

public void answerPstnCall(java.lang.String remoteid,
                           java.lang.String callid,
                           java.lang.String callcontextmessage,
                           CSLocation location)

answers an incoming pstn call.

Parameters:

remoteid - of calle

callid - incoming call callid

callcontextmessage - Call context message

location - Location of the call

See Also:

CSCallReceiver

Events:

Below are the events that can be notified by LocalBroadcastManager
CSCALL_CALLENDED CSCALL_NOANSWER CSCALL_NOMEDIA CSCALL_RINGING CSCALL_MEDIACONNECTED CSCALL_MEDIADISCONNECTED CSCALL_CALLTERMINATED CSCLIENT_NETWORKERROR CSCLIENT_GSM_CALL_INPROGRESS CSCLIENT_PERMISSION_NEEDED CSCALL_RECORDING_AT_SERVER

endPstnCall

public void endPstnCall(java.lang.String number,
                        java.lang.String callid)

ends pstn call.

Parameters:

number - of calle whose call is active

callid - callid

Events:

Below are the events that can be notified by LocalBroadcastManager
CSCALL_CALLTERMINATED CSCLIENT_NETWORKERROR

holdPstnCall

public boolean holdPstnCall(java.lang.String callid,
                            boolean toggle)

hold or unhold pstn call.

Parameters:

callid - callid

toggle - true to hold the call.false to unhold the call.

Events:

Below are the events that can be notified by LocalBroadcastManager
CSCALL_HOLD_UNHOLD_RESPONSE CSCLIENT_NETWORKERROR

sendDtmfInPstnCall

public boolean sendDtmfInPstnCall(java.lang.String digit,
                                  java.lang.String callid)

send Dtmf In Pstn Call

Parameters:

callid - callid

digit - digit

Events:

Below are the events that can be notified by LocalBroadcastManager
CSCALL_SEND_DTMF_TONE_RESPONSE CSCLIENT_NETWORKERROR

holdAVCall

public boolean holdAVCall(java.lang.String remoteid,
                          java.lang.String callid,
                          boolean toggle)

hold or unhold either audio call or video call.On success response audio/video gets muted at both caller and calle hence UI for mute functionality should be shown accordingly.Also there are no restrictions on functionality of muteAudio muteVideo when call is on hold,Also after unhold, the previous state of mute in the call will be recovered.

Parameters:

remoteid - of calle whose call is active

callid - callid

toggle - true to hold the call.false to unhold the call.

Events:

Below are the events that can be notified by LocalBroadcastManager
CSCALL_HOLD_UNHOLD_RESPONSE CSCLIENT_NETWORKERROR

recordCall

public boolean recordCall(java.lang.String callid)

Record the call. This api should be called only after CSCALL_MEDIACONNECTED event.

Returns:

true or false

isCallStatsEnabled

public boolean isCallStatsEnabled()

isCallStatsEnabled. gets call stats are enabled or not.

Returns:

true or false.

enableCallStats

public boolean enableCallStats(boolean enable)

enableCallStats. Specify call stats should be enabled or not.This api should be called after initialization

Parameters:

enable - true or false

Returns:

true or false