com.csipsimple.api

Interface ISipService

All Superinterfaces:

IInterface

All Known Implementing Classes:

ISipService.Stub

public interface ISipService
extends IInterface

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ISipService.Stub Local-side IPC implementation stub class.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAllAccounts() Add all accounts available in database and marked active to running sip stack (loaded previously using sipStart)
void	adjustVolume(SipCallSession callInfo, int direction, int flags)
int	answer(int callId, int status) Answer a call.
void	askThreadedRestart() Restart the sip stack
boolean	canRecord(int callId) Can the call be recorded ?
void	confAdjustRxLevel(int port, float value)
void	confAdjustTxLevel(int port, float value)
long	confGetRxTxLevel(int port) Get Rx and Tx sound level for a given port.
void	forceStopService() Force to stop the sip service (stack + everything that goes arround stack)
SipCallSession	getCallInfo(int callId)
SipCallSession[]	getCalls()
MediaState	getCurrentMediaState()
int	getPresence(long accountId)
String	getPresenceStatus(long accountId)
SipProfileState	getSipProfileState(int accountId) Get registration state for a given account id
int	getVersion() Get the current API version
int	hangup(int callId, int status) Hangup a call.
int	hold(int callId)
void	ignoreNextOutgoingCallFor(String number) Ignore next outgoing call request from tel handler processing
boolean	isRecording(int callId) Is the call being recorded (for at least one way) ?
void	makeCall(String callee, int accountId) Place a call.
void	makeCallWithOptions(String callee, int accountId, Bundle options) Place a call.
void	playWaveFile(String filePath, int callId, int way)
void	reAddAllAccounts() remove and add all accounts available in database and marked active
int	reinvite(int callId, boolean unhold)
void	removeAllAccounts() Remove all accounts from running sip stack (this does nothing in database)
int	sendDtmf(int callId, int keyCode)
void	sendMessage(String msg, String toNumber, long accountId)
void	setAccountRegistration(int accountId, int renew) Change registration for a given account/profile id (id in database)
void	setBluetoothOn(boolean on)
void	setEchoCancellation(boolean on)
void	setMicrophoneMute(boolean on)
void	setPresence(int presence, String statusText, long accountId)
void	setSpeakerphoneOn(boolean on)
String	showCallInfosDialog(int callId)
void	sipStart() Start the sip stack
void	sipStop() Stop the sip stack
int	startLoopbackTest()
void	startRecording(int callId, int way) Start recording of a call to a file.
int	stopLoopbackTest()
void	stopRecording(int callId) Stop recording of a call.
void	switchToAutoAnswer() Switch next incoming request to auto answer
void	updateCallOptions(int callId, Bundle options)
int	xfer(int callId, String callee)
int	xferReplace(int callId, int otherCallId, int options)
void	zrtpSASRevoke(int callId) Revoke a ZRTP SAS
void	zrtpSASVerified(int callId)

Methods inherited from interface android.os.IInterface

asBinder

Method Detail

getVersion

int getVersion()
               throws RemoteException

Get the current API version

Returns:

version number. 1000 x major version + minor version Each major version must be compatible with all versions of the same major version

Throws:

RemoteException

sipStart

void sipStart()
              throws RemoteException

Start the sip stack

Throws:

RemoteException

sipStop

void sipStop()
             throws RemoteException

Stop the sip stack

Throws:

RemoteException

forceStopService

void forceStopService()
                      throws RemoteException

Force to stop the sip service (stack + everything that goes arround stack)

Throws:

RemoteException

askThreadedRestart

void askThreadedRestart()
                        throws RemoteException

Restart the sip stack

Throws:

RemoteException

addAllAccounts

void addAllAccounts()
                    throws RemoteException

Add all accounts available in database and marked active to running sip stack (loaded previously using sipStart)

Throws:

RemoteException

removeAllAccounts

void removeAllAccounts()
                       throws RemoteException

Remove all accounts from running sip stack (this does nothing in database)

Throws:

RemoteException

reAddAllAccounts

void reAddAllAccounts()
                      throws RemoteException

remove and add all accounts available in database and marked active

Throws:

RemoteException

setAccountRegistration

void setAccountRegistration(int accountId,
                          int renew)
                            throws RemoteException

Change registration for a given account/profile id (id in database)

Parameters:

accountId - the account for which we'd like to change the registration state

renew - 0 if we don't want to unregister, 1 to renew registration

Throws:

RemoteException

getSipProfileState

SipProfileState getSipProfileState(int accountId)
                                   throws RemoteException

Get registration state for a given account id

Parameters:

accountId - the account/profile id for which we'd like to get the info (in database)

Returns:

the Profile state

Throws:

RemoteException

switchToAutoAnswer

void switchToAutoAnswer()
                        throws RemoteException

Switch next incoming request to auto answer

Throws:

RemoteException

ignoreNextOutgoingCallFor

void ignoreNextOutgoingCallFor(String number)
                               throws RemoteException

Ignore next outgoing call request from tel handler processing

Throws:

RemoteException

makeCall

void makeCall(String callee,
            int accountId)
              throws RemoteException

Place a call.

Parameters:

callee - The sip uri to call. It can also be a simple number, in which case the app will autocomplete. If you add the scheme, take care to fill completely else it could be considered as a call to a sip IP/domain

accountId - The id of the account to use for this call.

Throws:

RemoteException

makeCallWithOptions

void makeCallWithOptions(String callee,
                       int accountId,
                       Bundle options)
                         throws RemoteException

Place a call.

Parameters:

callee - The sip uri to call. It can also be a simple number, in which case the app will autocomplete. If you add the scheme, take care to fill completely else it could be considered as a call to a sip IP/domain

accountId - The id of the account to use for this call.

options - The options you'd like to apply for this calls SipCallSession.OPT_CALL_VIDEO, SipCallSession.OPT_CALL_EXTRA_HEADERS

Throws:

RemoteException

answer

int answer(int callId,
         int status)
           throws RemoteException

Answer a call.

Parameters:

callId - The id of the call to answer.

status - The sip status code you'd like to answer with. 200 to take the call. 400 <= status < 500 if refusing.

Throws:

RemoteException

hangup

int hangup(int callId,
         int status)
           throws RemoteException

Hangup a call.

Parameters:

callId - The id of the call to hangup.

status - The sip status code you'd like to hangup with.

Throws:

RemoteException

sendDtmf

int sendDtmf(int callId,
           int keyCode)
             throws RemoteException

Throws:

RemoteException

hold

int hold(int callId)
         throws RemoteException

Throws:

RemoteException

reinvite

int reinvite(int callId,
           boolean unhold)
             throws RemoteException

Throws:

RemoteException

xfer

int xfer(int callId,
       String callee)
         throws RemoteException

Throws:

RemoteException

xferReplace

int xferReplace(int callId,
              int otherCallId,
              int options)
                throws RemoteException

Throws:

RemoteException

getCallInfo

SipCallSession getCallInfo(int callId)
                           throws RemoteException

Throws:

RemoteException

getCalls

SipCallSession[] getCalls()
                          throws RemoteException

Throws:

RemoteException

showCallInfosDialog

String showCallInfosDialog(int callId)
                           throws RemoteException

Throws:

RemoteException

setMicrophoneMute

void setMicrophoneMute(boolean on)
                       throws RemoteException

Throws:

RemoteException

setSpeakerphoneOn

void setSpeakerphoneOn(boolean on)
                       throws RemoteException

Throws:

RemoteException

setBluetoothOn

void setBluetoothOn(boolean on)
                    throws RemoteException

Throws:

RemoteException

confAdjustTxLevel

void confAdjustTxLevel(int port,
                     float value)
                       throws RemoteException

Throws:

RemoteException

confAdjustRxLevel

void confAdjustRxLevel(int port,
                     float value)
                       throws RemoteException

Throws:

RemoteException

confGetRxTxLevel

long confGetRxTxLevel(int port)
                      throws RemoteException

Get Rx and Tx sound level for a given port.

Parameters:

port - Port id we'd like to have the level

Returns:

The RX and TX (0-255) level encoded as RX << 8 | TX

Throws:

RemoteException

setEchoCancellation

void setEchoCancellation(boolean on)
                         throws RemoteException

Throws:

RemoteException

adjustVolume

void adjustVolume(SipCallSession callInfo,
                int direction,
                int flags)
                  throws RemoteException

Throws:

RemoteException

getCurrentMediaState

MediaState getCurrentMediaState()
                                throws RemoteException

Throws:

RemoteException

startLoopbackTest

int startLoopbackTest()
                      throws RemoteException

Throws:

RemoteException

stopLoopbackTest

int stopLoopbackTest()
                     throws RemoteException

Throws:

RemoteException

startRecording

void startRecording(int callId,
                  int way)
                    throws RemoteException

Start recording of a call to a file.

Parameters:

callId - the call id to start recording of.

way - the way the recording takes SipManager.BITMASK_IN => record remote party (what goes out speaker/earpiece) SipManager.BITMASK_OUT => record self (what comes from micro), If 0 will record all ways.

Throws:

RemoteException

stopRecording

void stopRecording(int callId)
                   throws RemoteException

Stop recording of a call.

Parameters:

callId - the call id to stop recording (of all recording ways)

Throws:

RemoteException

isRecording

boolean isRecording(int callId)
                    throws RemoteException

Is the call being recorded (for at least one way) ?

Parameters:

callId - the call id to get recording status of.

Returns:

true if the call is currently being recorded

Throws:

RemoteException

canRecord

boolean canRecord(int callId)
                  throws RemoteException

Can the call be recorded ?

Parameters:

callId - the call id to get record capability of.

Returns:

true if it's possible to record the call.

Throws:

RemoteException

playWaveFile

void playWaveFile(String filePath,
                int callId,
                int way)
                  throws RemoteException

Parameters:

filePath - filePath the file to play in stream

callId - the call to play to

way - the way the file should be played SipManager.BITMASK_IN => send to user (speaker/earpiece) SipManager.BITMASK_OUT => send to remote party (micro), example : way = 3 : will play sound both ways

Throws:

RemoteException

sendMessage

void sendMessage(String msg,
               String toNumber,
               long accountId)
                 throws RemoteException

Throws:

RemoteException

setPresence

void setPresence(int presence,
               String statusText,
               long accountId)
                 throws RemoteException

Throws:

RemoteException

getPresence

int getPresence(long accountId)
                throws RemoteException

Throws:

RemoteException

getPresenceStatus

String getPresenceStatus(long accountId)
                         throws RemoteException

Throws:

RemoteException

zrtpSASVerified

void zrtpSASVerified(int callId)
                     throws RemoteException

Throws:

RemoteException

updateCallOptions

void updateCallOptions(int callId,
                     Bundle options)
                       throws RemoteException

Throws:

RemoteException

zrtpSASRevoke

void zrtpSASRevoke(int callId)
                   throws RemoteException

Revoke a ZRTP SAS

Throws:

RemoteException