CallInterface (Kandy Link Android SDK 6.8.0)

All Known Subinterfaces:

IncomingCallInterface, OutgoingCallInterface
```
public interface CallInterface
```
Base interface for all call classes.

Since:

2.0.0

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addPropertyChangeListener(Constants.ChangeListenerKey propertyName, java.beans.PropertyChangeListener listener)` In case of callerAddress or calleeAddress changes this callback will notify the application.
`void`	`bringVideoViewToFront(VideoViewType videoViewType)` Puts Video View of given type in front of any other Video View.
`boolean`	`canReceiveVideo()` Indicates remote side can send video or not.
`boolean`	`canSendVideo()` Indicates remote side can receive video or not.
`void`	`changeVideoResolution(int width, int height)` Changes video resolution as given values.
`void`	`consultativeTransfer(CallInterface call)` Transfers the current call to the transfer target given with another call session in a consultative transfer manner.
`void`	`endCall()` Stops the related call and releases allocated resources.
`void`	`endCall(java.lang.String callEndReason)` Stops the related call with reason and releases allocated resources.
`int`	`getActiveCamera()`
`java.util.List<java.util.Map>`	`getAvailableCodecs(CodecType codecType)` Returns the list of available and supported codecs
`java.lang.String`	`getCalleeAddress()` Returns the callee address information related the call instance
`java.lang.String`	`getCalleeName()` Returns caller name of the related call
`java.lang.String`	`getCallerAddress()` Returns the caller address information related the call instance
`java.lang.String`	`getCallerName()` Returns caller name of the related call
`java.lang.String`	`getCallId()` Returns callId that related with SIP session id For the outgoing call, this value is not set until establish call is succeeded
`CallState`	`getCallState()` Returns the state of the call
`android.hardware.Camera.Size`	`getCameraResolution()`
`java.util.Map<java.lang.String,java.lang.String>`	`getCustomParameters()` Gets custom SIP Headers which are set to the Call as custom parameters to call in order to send them in all mid-call event requests.
`java.lang.String`	`getId()` Returns unique identifier of call object which is generated from SDK Identifier is NOT related with SIP session id
`MediaAttributes`	`getMediaAttributes()` Returns the media attributes of the call
`void`	`getRTPStatistics(RTPStatisticsHandler handler)` Gets RTP/RTP Statistics for related call
`VideoViewType`	`getVideoViewOnFront()` Returns type of the Video View which is on front.
`void`	`holdCall()` Holds the related call.
`boolean`	`isMute()` Returns if call is in mute state
`boolean`	`isVideoEnabled()` Returns if video enabled for this call.
`boolean`	`isVoiceEnabled()` Returns if microphone is muted or not for this call.
`void`	`mute()` Mutes the voice of local user.
`void`	`sendCustomParameters(java.util.Map<java.lang.String,java.lang.String> customParameters)` Sends the given custom SIP headers to SPiDR server.
`boolean`	`sendDTMF(char tone)` Inserts Dual Tone Multi Frequency Signal to sending queue and returns the success
`void`	`setCallerName(java.lang.String callerName)` This method sets the caller name of origin.
`void`	`setCaptureDevice(int position, android.hardware.Camera.Size videoResolution, ProcessListener processListener)` Sets device capture and video resolution to specified position and resolution of the related call
`void`	`setCaptureDevice(android.content.Intent mediaProjectionPermissionResultData, ProcessListener processListener)` Sets device capture to image source for the related call
`void`	`setCustomParameters(java.util.Map<java.lang.String,java.lang.String> customParameters)` Sets given custom SIP Headers as custom parameters to call in order to send them in all mid-call event requests.
`void`	`setLocalVideoView(VideoView localVideoView)` Sets GUI View for video of local user
`void`	`setRemoteVideoView(VideoView remoteVideoView)` Sets GUI View for video of remote peer
`void`	`setVideoEnabled(boolean videoEnabled)` Sets video enabled or not for this call.
`void`	`setVoiceEnabled(boolean voiceEnabled)` Sets microphone muted or not for this call.
`void`	`takeLocalVideoSnapshot(Snapshot.TakeSnapshotCallback callback)` Takes still image of the active local video stream
`void`	`transferCall(java.lang.String newAddress)` Transfers the call to the given address.
`void`	`unHoldCall()` Unholds the related call.
`void`	`unMute()` Opens the voice of local user.
`void`	`videoMute()`
`void`	`videoStart()` Starts video of local user.
`void`	`videoStop()` Stops the video of local user.
`void`	`videoUnMute()`

- Method Detail
  - endCall
```
void endCall()
      throws MobileException
```
    Stops the related call and releases allocated resources.
    
    Throws:
    
    MobileException
    
    Since:
    
    2.0.0
  - endCall
```
void endCall(java.lang.String callEndReason)
      throws MobileException
```
    Stops the related call with reason and releases allocated resources. If reason string char length is more than 600 char, first 600 char will send to remote.
    
    Parameters:
    
    callEndReason - String end call reason (Limit is 600 character)
    
    Throws:
    
    MobileException
    
    Since:
    
    4.4.1
  - videoUnMute
```
void videoUnMute()
```
    Since:
    
    6.6.0
  - videoMute
```
void videoMute()
```
    Since:
    
    6.6.0
  - videoStart
```
void videoStart()
```
    Starts video of local user.
    
    Since:
    
    2.0.0
  - videoStop
```
void videoStop()
```
    Stops the video of local user.
    
    Since:
    
    2.0.0
  - mute
```
void mute()
```
    Mutes the voice of local user.
    
    Since:
    
    2.0.0
  - unMute
```
void unMute()
```
    Opens the voice of local user.
    
    Since:
    
    2.0.0
  - holdCall
```
void holdCall()
```
    Holds the related call.
    
    Since:
    
    2.0.0
  - unHoldCall
```
void unHoldCall()
```
    Unholds the related call.
    
    Since:
    
    2.0.0
  - sendCustomParameters
```
void sendCustomParameters(java.util.Map<java.lang.String,java.lang.String> customParameters)
```
    Sends the given custom SIP headers to SPiDR server.
    
    Parameters:
    
    customParameters - key-value pairs of custom SIP headers to send
    
    Since:
    
    4.5.0
  - setCustomParameters
```
void setCustomParameters(java.util.Map<java.lang.String,java.lang.String> customParameters)
```
    Sets given custom SIP Headers as custom parameters to call in order to send them in all mid-call event requests.
    
    Parameters:
    
    customParameters - key-value pairs of custom SIP headers to send
    
    Since:
    
    4.5.0
  - getCustomParameters
```
java.util.Map<java.lang.String,java.lang.String> getCustomParameters()
```
    Gets custom SIP Headers which are set to the Call as custom parameters to call in order to send them in all mid-call event requests.
    
    Returns:
    
    customParameters key-value pairs of custom SIP headers to send
    
    Since:
    
    4.5.0
  - setCaptureDevice
```
void setCaptureDevice(int position,
                      android.hardware.Camera.Size videoResolution,
                      ProcessListener processListener)
```
    Sets device capture and video resolution to specified position and resolution of the related call
    
    Parameters:
    
    position - that intended to setting
    
    videoResolution - that intended to resolution
    
    processListener - that returns setting device capture result
    
    Since:
    
    3.0.0
  - setCaptureDevice
```
void setCaptureDevice(android.content.Intent mediaProjectionPermissionResultData,
                      ProcessListener processListener)
```
    Sets device capture to image source for the related call
    
    Parameters:
    
    mediaProjectionPermissionResultData -
    
    processListener - that returns setting device capture result
    
    Since:
    
    3.1.4
  - changeVideoResolution
```
void changeVideoResolution(int width,
                           int height)
```
    Changes video resolution as given values. These values are not saved so they can be thought as temporary
    
    Parameters:
    
    width - width of video
    
    height - height of video
  - transferCall
```
void transferCall(java.lang.String newAddress)
```
    Transfers the call to the given address. Note that, transfer operation cannot be used with Anonymous calls.
    
    Parameters:
    
    newAddress - String user which call will be transferred to
    
    Since:
    
    2.0.0
  - consultativeTransfer
```
void consultativeTransfer(CallInterface call)
```
    Transfers the current call to the transfer target given with another call session in a consultative transfer manner. Note that, consultative transfer operation cannot be used with Anonymous calls.
    
    Parameters:
    
    call - other call session as transfer target
    
    Since:
    
    4.5.1
  - getCallerAddress
```
java.lang.String getCallerAddress()
```
    Returns the caller address information related the call instance
    
    Returns:
    
    String
    
    Since:
    
    2.0.0
  - getCalleeAddress
```
java.lang.String getCalleeAddress()
```
    Returns the callee address information related the call instance
    
    Returns:
    
    String
    
    Since:
    
    2.0.0
  - getId
```
java.lang.String getId()
```
    Returns unique identifier of call object which is generated from SDK Identifier is NOT related with SIP session id
    
    Returns:
    
    String unique identifier of call object
    
    Since:
    
    4.0.2
  - getCallId
```
java.lang.String getCallId()
```
    Returns callId that related with SIP session id For the outgoing call, this value is not set until establish call is succeeded
    
    Returns:
    
    String identifier that related SIP session id
    
    Since:
    
    2.0.0
  - setLocalVideoView
```
void setLocalVideoView(VideoView localVideoView)
```
    Sets GUI View for video of local user
    
    Parameters:
    
    localVideoView - VideoView for local user
    
    Since:
    
    2.0.0
  - setRemoteVideoView
```
void setRemoteVideoView(VideoView remoteVideoView)
```
    Sets GUI View for video of remote peer
    
    Parameters:
    
    remoteVideoView - VideoView for remote peer
    
    Since:
    
    2.0.0
  - bringVideoViewToFront
```
void bringVideoViewToFront(VideoViewType videoViewType)
```
    Puts Video View of given type in front of any other Video View.
    
    Parameters:
    
    videoViewType - type of video view to bring to front
    
    Since:
    
    4.4.4
  - getVideoViewOnFront
```
VideoViewType getVideoViewOnFront()
```
    Returns type of the Video View which is on front.
    
    Returns:
    
    type of the Video View which is on front
    
    Since:
    
    4.4.4
  - getCallState
```
CallState getCallState()
```
    Returns the state of the call
    
    Returns:
    
    com.genband.mobile.impl.services.call.CallState.Type
    
    Since:
    
    2.0.0
  - getMediaAttributes
```
MediaAttributes getMediaAttributes()
```
    Returns the media attributes of the call
    
    Returns:
    
    MediaAttributes
    
    Since:
    
    2.0.0
  - isMute
```
boolean isMute()
```
    Returns if call is in mute state
    
    Returns:
    
    Boolean
    
    Since:
    
    3.0.4
  - isVoiceEnabled
```
boolean isVoiceEnabled()
```
    Returns if microphone is muted or not for this call.
    
    Returns:
    
    Boolean
    
    Since:
    
    2.0.0
  - setVoiceEnabled
```
void setVoiceEnabled(boolean voiceEnabled)
```
    Sets microphone muted or not for this call.
    
    Parameters:
    
    voiceEnabled - Boolean
    
    Since:
    
    2.0.0
  - isVideoEnabled
```
boolean isVideoEnabled()
```
    Returns if video enabled for this call.
    
    Returns:
    
    Boolean
    
    Since:
    
    2.0.0
  - setVideoEnabled
```
void setVideoEnabled(boolean videoEnabled)
```
    Sets video enabled or not for this call.
    
    Parameters:
    
    videoEnabled - Boolean
    
    Since:
    
    2.0.0
  - canReceiveVideo
```
boolean canReceiveVideo()
```
    Indicates remote side can send video or not. Local side can receive video if he wishes. It is determined by Remote Session Description direction as follows
    
    sendrecv sendonly recvonly inactive
    
    Values true true false false
    
    Returns:
    
    boolean
    
    Since:
    
    2.0.0
  - canSendVideo
```
boolean canSendVideo()
```
    Indicates remote side can receive video or not. Local side can send video if he wishes. It is determined by Remote Session Description direction as follows
    
    sendrecv sendonly recvonly inactive
    
    Values true false true false
    
    Returns:
    
    boolean
    
    Since:
    
    2.0.0
  - getActiveCamera
```
int getActiveCamera()
```
    Returns:
    
    int position of the current active camera
    
    Since:
    
    2.0.0
  - getCameraResolution
```
android.hardware.Camera.Size getCameraResolution()
```
    Returns:
    
    Camera.Size camera resolution of the current active camera
    
    Since:
    
    4.0.2
    
    See Also:
    
    Camera.Size
  - setCallerName
```
void setCallerName(java.lang.String callerName)
```
    This method sets the caller name of origin. Especially needed for anonymous calls.
    
    Parameters:
    
    callerName - Name, which will be shown on the screen of terminator.
    
    Since:
    
    2.0.0
  - getCallerName
```
java.lang.String getCallerName()
```
    Returns caller name of the related call
    
    Returns:
    
    String
    
    Since:
    
    2.0.0
  - getCalleeName
```
java.lang.String getCalleeName()
```
    Returns caller name of the related call
    
    Returns:
    
    String
    
    Since:
    
    2.0.0
  - sendDTMF
```
boolean sendDTMF(char tone)
```
    Inserts Dual Tone Multi Frequency Signal to sending queue and returns the success
    
    Parameters:
    
    tone - character value of DTMF tone. Can only be 0,1...,9,*,#,a,b,c,d,A,B,C,D;
    
    Returns:
    
    true if tone can be successfully inserted to queue otherwise false
    
    Since:
    
    3.0.1
  - addPropertyChangeListener
```
void addPropertyChangeListener(Constants.ChangeListenerKey propertyName,
                               java.beans.PropertyChangeListener listener)
```
    In case of callerAddress or calleeAddress changes this callback will notify the application.
    
    Parameters:
    
    propertyName - parameter for which object should listen
    
    listener - listener object
  - getRTPStatistics
```
void getRTPStatistics(RTPStatisticsHandler handler)
```
    Gets RTP/RTP Statistics for related call
    
    Parameters:
    
    handler - Handler Interface to get RTP statistics
    
    Since:
    
    3.1.4
  - takeLocalVideoSnapshot
```
void takeLocalVideoSnapshot(Snapshot.TakeSnapshotCallback callback)
```
    Takes still image of the active local video stream
    
    Parameters:
    
    callback - to capture result of the operation
    
    Since:
    
    4.5.2
  - getAvailableCodecs
```
java.util.List<java.util.Map> getAvailableCodecs(CodecType codecType)
```
    Returns the list of available and supported codecs
    
    Parameters:
    
    codecType - the type of the codecs
    
    Returns:
    
    the codec list

	sendrecv	sendonly	recvonly	inactive
Values	true	true	false	false

	sendrecv	sendonly	recvonly	inactive
Values	true	false	true	false

Interface CallInterface

Method Summary

Method Detail

endCall

endCall

videoUnMute

videoMute

videoStart

videoStop

mute

unMute

holdCall

unHoldCall

sendCustomParameters

setCustomParameters

getCustomParameters

setCaptureDevice

setCaptureDevice

changeVideoResolution

transferCall

consultativeTransfer

getCallerAddress

getCalleeAddress

getId

getCallId

setLocalVideoView

setRemoteVideoView

bringVideoViewToFront

getVideoViewOnFront

getCallState

getMediaAttributes

isMute

isVoiceEnabled

setVoiceEnabled

isVideoEnabled

setVideoEnabled

canReceiveVideo

canSendVideo

getActiveCamera

getCameraResolution

setCallerName

getCallerName

getCalleeName

sendDTMF

addPropertyChangeListener

getRTPStatistics

takeLocalVideoSnapshot

getAvailableCodecs