SipCallSession

java.lang.Object
- com.csipsimple.api.SipCallSession

All Implemented Interfaces:

Parcelable
```
public class SipCallSession
extends Object
implements Parcelable
```
Represents state of a call session
This class helps to serialize/deserialize the state of the media layer
Changing these fields has no effect on the sip call session : it's only a structured holder for datas

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SipCallSession.InvState` Describe the control state of a call Pjsip documentation
`static class`	`SipCallSession.MediaState` Describe the media state of the call Pjsip documentation
`static class`	`SipCallSession.StatusCode` Status code of the sip call dialog Actually just shortcuts to SIP codes Pjsip documentation

Nested classes/interfaces inherited from interface android.os.Parcelable
Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Field Summary

Fields
Modifier and Type	Field and Description
`static Parcelable.Creator<SipCallSession>`	`CREATOR` Parcelable creator.
`static int`	`INVALID_CALL_ID` Id of an invalid or not existant call
`static String`	`OPT_CALL_EXTRA_HEADERS` Option key to add custom headers (with X- prefix).
`static String`	`OPT_CALL_VIDEO` Option key to flag video use for the call.
`int`	`primaryKey` Primary key for the parcelable object
`static int`	`TRANSPORT_SECURE_FULL` The call signaling is supposed to be secured end to end.
`static int`	`TRANSPORT_SECURE_NONE` The call signaling is not secure
`static int`	`TRANSPORT_SECURE_TO_SERVER` The call signaling is secure until it arrives on server.

Fields inherited from interface android.os.Parcelable
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors
Constructor and Description
`SipCallSession()` Constructor for a sip call session state object It will contains default values for all flags This class as no setter/getter for members flags It's aim is to allow to serialize/deserialize easily the state of a sip call, not to modify it
`SipCallSession(SipCallSession callInfo)` Constructor by copy

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`canRecord()` Get the capability to record the call to a file.
`int`	`describeContents()`
`boolean`	`equals(Object o)` A sip call session is equal to another if both means the same callId
`long`	`getAccId()` Get the identifier of the account corresponding to this call This identifier is the one you have in `SipProfile.id` It may return `SipProfile.INVALID_ID` if no account detected for this call.
`int`	`getCallId()` Get the call id of this call info
`long`	`getCallStart()` Get the start time of the call.
`int`	`getCallState()` Get the call state of this call info
`int`	`getConfPort()` Get the sounds conference board port Pjsip documentation
`long`	`getConnectStart()` Get the start time of the connection of the call
`boolean`	`getHasZrtp()`
`int`	`getLastStatusCode()` Get the latest status code of the sip dialog corresponding to this call call
`String`	`getLastStatusComment()` Get the last status comment of the sip dialog corresponding to this call
`String`	`getMediaSecureInfo()` Get the information about the media security of this call
`int`	`getMediaStatus()`
`String`	`getRemoteContact()` Get the remote Contact for this call info
`int`	`getTransportSecureLevel()` Get the secure level of the signaling of the call.
`boolean`	`isActive()` Check if the call state indicates that it is an active call in progress.
`boolean`	`isAfterEnded()` Check if the specific call info indicates that it is a call that has been ended In other worlds if the call is in state, disconnected, invalid or null
`boolean`	`isBeforeConfirmed()` Check if the specific call info indicates that it is a call that has not yet been confirmed by both ends.
`boolean`	`isIncoming()` Get the call way
`boolean`	`isLocalHeld()` Get the information about local held state of this call
`boolean`	`isMediaSecure()` Get the secure level of the media of the call
`boolean`	`isOngoing()` Chef if the call state indicates that it's an ongoing call.
`boolean`	`isRecording()` Get the current call recording status for this call.
`boolean`	`isRemoteHeld()` Get the information about remote held state of this call
`boolean`	`isZrtpSASVerified()`
`boolean`	`mediaHasVideo()` Get whether the call has a video media stream connected
`void`	`writeToParcel(Parcel dest, int flags)`

Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - OPT_CALL_VIDEO
```
public static final String OPT_CALL_VIDEO
```
    Option key to flag video use for the call.
    The value must be a boolean.
    
    See Also:
    Boolean, Constant Field Values
  - OPT_CALL_EXTRA_HEADERS
```
public static final String OPT_CALL_EXTRA_HEADERS
```
    Option key to add custom headers (with X- prefix).
    The value must be a bundle with key representing header name, and value representing header value.
    
    See Also:
    Bundle, Constant Field Values
  - TRANSPORT_SECURE_NONE
```
public static int TRANSPORT_SECURE_NONE
```
    The call signaling is not secure
  - TRANSPORT_SECURE_TO_SERVER
```
public static int TRANSPORT_SECURE_TO_SERVER
```
    The call signaling is secure until it arrives on server. After, nothing ensures how it goes.
  - TRANSPORT_SECURE_FULL
```
public static int TRANSPORT_SECURE_FULL
```
    The call signaling is supposed to be secured end to end.
  - INVALID_CALL_ID
```
public static final int INVALID_CALL_ID
```
    Id of an invalid or not existant call
    
    See Also:
    Constant Field Values
  - primaryKey
```
public int primaryKey
```
    Primary key for the parcelable object
  - CREATOR
```
public static final Parcelable.Creator<SipCallSession> CREATOR
```
    Parcelable creator. So that it can be passed as an argument of the aidl interface
- Constructor Detail
  - SipCallSession
```
public SipCallSession()
```
    Constructor for a sip call session state object
    It will contains default values for all flags This class as no setter/getter for members flags
    It's aim is to allow to serialize/deserialize easily the state of a sip call, not to modify it
  - SipCallSession
```
public SipCallSession(SipCallSession callInfo)
```
    Constructor by copy
    
    Parameters:
    callInfo -
- Method Detail
  - describeContents
```
public int describeContents()
```
    Specified by:
    
    describeContents in interface Parcelable
    
    See Also:
    Parcelable.describeContents()
  - writeToParcel
```
public void writeToParcel(Parcel dest,
                 int flags)
```
    Specified by:
    
    writeToParcel in interface Parcelable
    
    See Also:
    Parcelable.writeToParcel(Parcel, int)
  - equals
```
public boolean equals(Object o)
```
    A sip call session is equal to another if both means the same callId
    
    Overrides:
    
    equals in class Object
  - getCallId
```
public int getCallId()
```
    Get the call id of this call info
    
    Returns:
    id of this call
  - getCallState
```
public int getCallState()
```
    Get the call state of this call info
    
    Returns:
    the invitation state
    See Also:
    SipCallSession.InvState
  - getMediaStatus
```
public int getMediaStatus()
```
  - getRemoteContact
```
public String getRemoteContact()
```
    Get the remote Contact for this call info
    
    Returns:
    string representing the remote contact
  - isIncoming
```
public boolean isIncoming()
```
    Get the call way
    
    Returns:
    true if the remote party was the caller
  - getConnectStart
```
public long getConnectStart()
```
    Get the start time of the connection of the call
    
    Returns:
    duration in milliseconds
    See Also:
    SystemClock.elapsedRealtime()
  - isActive
```
public boolean isActive()
```
    Check if the call state indicates that it is an active call in progress. This is equivalent to state incoming or early or calling or confirmed or connecting
    
    Returns:
    true if the call can be considered as in progress/active
  - isOngoing
```
public boolean isOngoing()
```
    Chef if the call state indicates that it's an ongoing call. This is equivalent to state confirmed.
    
    Returns:
    true if the call can be considered as ongoing.
  - getConfPort
```
public int getConfPort()
```
    Get the sounds conference board port
    Pjsip documentation
    
    Returns:
    the conf port of the audio media of this call
  - getAccId
```
public long getAccId()
```
    Get the identifier of the account corresponding to this call
    This identifier is the one you have in SipProfile.id
    It may return SipProfile.INVALID_ID if no account detected for this call. Example, case of peer to peer call
    
    Returns:
    The SipProfile.id of the account use for this call
  - getTransportSecureLevel
```
public int getTransportSecureLevel()
```
    Get the secure level of the signaling of the call.
    
    Returns:
    one of TRANSPORT_SECURE_NONE, TRANSPORT_SECURE_TO_SERVER, TRANSPORT_SECURE_FULL
  - isMediaSecure
```
public boolean isMediaSecure()
```
    Get the secure level of the media of the call
    
    Returns:
    true if the call has a media encrypted
  - getMediaSecureInfo
```
public String getMediaSecureInfo()
```
    Get the information about the media security of this call
    
    Returns:
    the information about the media security
  - isLocalHeld
```
public boolean isLocalHeld()
```
    Get the information about local held state of this call
    
    Returns:
    the information about local held state of media
  - isRemoteHeld
```
public boolean isRemoteHeld()
```
    Get the information about remote held state of this call
    
    Returns:
    the information about remote held state of media
  - isBeforeConfirmed
```
public boolean isBeforeConfirmed()
```
    Check if the specific call info indicates that it is a call that has not yet been confirmed by both ends.
    In other worlds if the call is in state, calling, incoming early or connecting.
    
    Returns:
    true if the call can be considered not yet been confirmed
  - isAfterEnded
```
public boolean isAfterEnded()
```
    Check if the specific call info indicates that it is a call that has been ended
    In other worlds if the call is in state, disconnected, invalid or null
    
    Returns:
    true if the call can be considered as already ended
  - getLastStatusCode
```
public int getLastStatusCode()
```
    Get the latest status code of the sip dialog corresponding to this call call
    
    Returns:
    the status code
    See Also:
    SipCallSession.StatusCode
  - getLastStatusComment
```
public String getLastStatusComment()
```
    Get the last status comment of the sip dialog corresponding to this call
    
    Returns:
    the last status comment string from server
  - mediaHasVideo
```
public boolean mediaHasVideo()
```
    Get whether the call has a video media stream connected
    
    Returns:
    true if the call has a video media stream
  - isRecording
```
public boolean isRecording()
```
    Get the current call recording status for this call.
    
    Returns:
    true if we are currently recording this call to a file
  - canRecord
```
public boolean canRecord()
```
    Get the capability to record the call to a file.
    
    Returns:
    true if it should be possible to record the call to a file
  - isZrtpSASVerified
```
public boolean isZrtpSASVerified()
```
    Returns:
    the zrtpSASVerified
  - getHasZrtp
```
public boolean getHasZrtp()
```
    Returns:
    whether call has Zrtp encryption active
  - getCallStart
```
public long getCallStart()
```
    Get the start time of the call.
    
    Returns:
    the callStart start time of the call.

Class SipCallSession

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Field Summary

Fields inherited from interface android.os.Parcelable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OPT_CALL_VIDEO

OPT_CALL_EXTRA_HEADERS

TRANSPORT_SECURE_NONE

TRANSPORT_SECURE_TO_SERVER

TRANSPORT_SECURE_FULL

INVALID_CALL_ID

primaryKey

CREATOR

Constructor Detail

SipCallSession

SipCallSession

Method Detail

describeContents

writeToParcel

equals

getCallId

getCallState

getMediaStatus

getRemoteContact

isIncoming

getConnectStart

isActive

isOngoing

getConfPort

getAccId

getTransportSecureLevel

isMediaSecure

getMediaSecureInfo

isLocalHeld

isRemoteHeld

isBeforeConfirmed

isAfterEnded

getLastStatusCode

getLastStatusComment

mediaHasVideo

isRecording

canRecord

isZrtpSASVerified

getHasZrtp

getCallStart