org.linphone.core

Interface LinphoneCall

public interface LinphoneCall

Object representing a call. Calls are created using LinphoneCore.invite(LinphoneAddress) or passed to the application by listener LinphoneCoreListener.callState(org.linphone.core.LinphoneCore, org.linphone.core.LinphoneCall, org.linphone.core.LinphoneCall.State, java.lang.String)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	LinphoneCall.LinphoneCallListener LinphoneCall listener
static class	LinphoneCall.State Linphone call states

Method Summary

Methods

Modifier and Type	Method and Description
boolean	cameraEnabled()
void	enableCamera(boolean enabled)
void	enableEchoCancellation(boolean enable) Enables or disable echo cancellation.
void	enableEchoLimiter(boolean enable) Enables or disable echo limiter cancellation.
LinphoneCallStats	getAudioStats() Get the audio statistics associated with this call.
String	getAuthenticationToken() Used by ZRTP encryption mechanism.
float	getAverageQuality() Returns call quality averaged over all the duration of the call.
LinphoneCallLog	getCallLog() get the call log associated to this call.
LinphoneChatRoom	getChatRoom() Create a new chat room for messaging from a call if not already existing, else return existing one
LinphoneConference	getConference() Get the conference instance which the call is part of.
LinphoneCallParams	getCurrentParamsCopy()
float	getCurrentQuality() Obtain real-time quality rating of the call Based on local RTP statistics and RTCP feedback, a quality rating is computed and updated during all the duration of the call.
CallDirection	getDirection() get direction of the call (incoming or outgoing).
LinphoneAddress	getDiversionAddress() Returns the diversion address associated to this call if one exists.
int	getDuration()
ErrorInfo	getErrorInfo() Returns last error reported for the call.
LinphonePlayer	getPlayer() Get a call player Call player enable to stream a media file through a call
float	getPlayVolume()
Reason	getReason()
LinphoneAddress	getRemoteAddress() Returns the remote address associated to this call
String	getRemoteContact() Obtain the remote sip contact string.
LinphoneCallParams	getRemoteParams() Get call's remote parameters, as proposed by far end.
String	getRemoteUserAgent() Obtain the remote user agent string.
LinphoneCall	getReplacedCall() Returns the object associated to a call this one is replacing.
LinphoneCall.State	getState() Retrieves the call's current state.
LinphoneCall	getTransfererCall() Returns the transferer if this call was started automatically as a result of an incoming transfer request.
LinphoneCall.State	getTransferState() If a call transfer has been initiated for this call, returns the call state of the new call performed at the remote end as a result of the transfer request.
LinphoneCall	getTransferTargetCall() When this call has received a transfer request, returns the new call that was automatically created as a result of the transfer.
Object	getUserData() Returns user data from a call. return null if any
LinphoneCallStats	getVideoStats() Get the video statistics associated with this call.
boolean	isAuthenticationTokenVerified() Used by ZRTP encryption mechanism.
boolean	isEchoCancellationEnabled() get EC status
boolean	isEchoLimiterEnabled() get EL status
boolean	isInConference() Checks wether the call is part of a conferece.
boolean	mediaInProgress() Indicates whether an operation is in progress at the media side.
void	sendInfoMessage(LinphoneInfoMessage msg) Send an info message to remote peer.
void	setAuthenticationTokenVerified(boolean verified) Used by ZRTP encryption mechanism.
void	setListener(LinphoneCall.LinphoneCallListener listener) Set the callbacks associated with the LinphoneCall.
void	setUserData(Object obj) attached a user data to a call
void	startRecording() Start call recording.
void	stopRecording() Stop call recording.
void	takeSnapshot(String path) Take a photo of currently received video and write it into a jpeg file.
void	zoomVideo(float factor, float cx, float cy) Scale the video by factor, and center it using cx,cy point

Method Detail

getState

LinphoneCall.State getState()

Retrieves the call's current state.

getRemoteAddress

LinphoneAddress getRemoteAddress()

Returns the remote address associated to this call

getDirection

CallDirection getDirection()

get direction of the call (incoming or outgoing).

Returns:

CallDirection

getCallLog

LinphoneCallLog getCallLog()

get the call log associated to this call.

Returns:

LinphoneCallLog

getDiversionAddress

LinphoneAddress getDiversionAddress()

Returns the diversion address associated to this call if one exists.

getAudioStats

LinphoneCallStats getAudioStats()

Get the audio statistics associated with this call.

Returns:

LinphoneCallStats

getVideoStats

LinphoneCallStats getVideoStats()

Get the video statistics associated with this call.

Returns:

LinphoneCallStats

getRemoteParams

LinphoneCallParams getRemoteParams()

Get call's remote parameters, as proposed by far end. This is useful for example to know if far end supports video or encryption.

getCurrentParamsCopy

LinphoneCallParams getCurrentParamsCopy()

enableCamera

void enableCamera(boolean enabled)

cameraEnabled

boolean cameraEnabled()

enableEchoCancellation

void enableEchoCancellation(boolean enable)

Enables or disable echo cancellation.

Parameters:

enable -

isEchoCancellationEnabled

boolean isEchoCancellationEnabled()

get EC status

Returns:

true if echo cancellation is enabled.

enableEchoLimiter

void enableEchoLimiter(boolean enable)

Enables or disable echo limiter cancellation.

Parameters:

enable -

isEchoLimiterEnabled

boolean isEchoLimiterEnabled()

get EL status

Returns:

true if echo limiter is enabled.

getReplacedCall

LinphoneCall getReplacedCall()

Returns the object associated to a call this one is replacing. Call replacement can occur during transfer scenarios.

getDuration

int getDuration()

Returns:

call duration computed from media start

getCurrentQuality

float getCurrentQuality()

Obtain real-time quality rating of the call Based on local RTP statistics and RTCP feedback, a quality rating is computed and updated during all the duration of the call. This function returns its value at the time of the function call. It is expected that the rating is updated at least every 5 seconds or so. The rating is a floating point number comprised between 0 and 5. 4-5 = good quality
3-4 = average quality
2-3 = poor quality
1-2 = very poor quality
0-1 = can't be worse, mostly unusable

Returns:

The function returns -1 if no quality measurement is available, for example if no active audio stream exist. Otherwise it returns the quality rating.

getAverageQuality

float getAverageQuality()

Returns call quality averaged over all the duration of the call. See getCurrentQuality() for more details about quality measurement.

getAuthenticationToken

String getAuthenticationToken()

Used by ZRTP encryption mechanism.

Returns:

SAS associated to the main stream [voice]

isAuthenticationTokenVerified

boolean isAuthenticationTokenVerified()

Used by ZRTP encryption mechanism. SAS can be verified manually by the user or automatically using a previously shared secret.

Returns:

true if the main stream [voice ]SAS was verified.

setAuthenticationTokenVerified

void setAuthenticationTokenVerified(boolean verified)

Used by ZRTP encryption mechanism.

Parameters:

verified - true when displayed SAS is correct

isInConference

boolean isInConference()

Checks wether the call is part of a conferece.

Returns:

A boolean

getConference

LinphoneConference getConference()

Get the conference instance which the call is part of.

Returns:

An instance of #LinphoneConference if the call is part of a conference. null instead.

mediaInProgress

boolean mediaInProgress()

Indicates whether an operation is in progress at the media side. It can a bad idea to initiate signaling operations (adding video, pausing the call, removing video, changing video parameters) while the media is busy in establishing the connection (typically ICE connectivity checks). It can result in failures generating loss of time in future operations in the call. Applications are invited to check this function after each call state change to decide whether certain operations are permitted or not.

Returns:

TRUE if media is busy in establishing the connection, FALSE otherwise.

getPlayVolume

float getPlayVolume()

getRemoteUserAgent

String getRemoteUserAgent()

Obtain the remote user agent string.

getRemoteContact

String getRemoteContact()

Obtain the remote sip contact string.

takeSnapshot

void takeSnapshot(String path)

Take a photo of currently received video and write it into a jpeg file.

zoomVideo

void zoomVideo(float factor,
             float cx,
             float cy)

Scale the video by factor, and center it using cx,cy point

startRecording

void startRecording()

Start call recording. A file path must be provided with LinphoneCallParams.setRecordFile() at call establishement for this method to work.

stopRecording

void stopRecording()

Stop call recording.

getTransferState

LinphoneCall.State getTransferState()

If a call transfer has been initiated for this call, returns the call state of the new call performed at the remote end as a result of the transfer request.

Returns:

the call state of the new call performed by the referee to the refer target.

sendInfoMessage

void sendInfoMessage(LinphoneInfoMessage msg)

Send an info message to remote peer.

getTransfererCall

LinphoneCall getTransfererCall()

Returns the transferer if this call was started automatically as a result of an incoming transfer request. The call in which the transfer request was received is returned in this case.

getTransferTargetCall

LinphoneCall getTransferTargetCall()

When this call has received a transfer request, returns the new call that was automatically created as a result of the transfer.

getReason

Reason getReason()

getErrorInfo

ErrorInfo getErrorInfo()

Returns last error reported for the call.

Returns:

an ErrorInfo.

setUserData

void setUserData(Object obj)

attached a user data to a call

getUserData

Object getUserData()

Returns user data from a call. return null if any

Returns:

an Object.

getPlayer

LinphonePlayer getPlayer()

Get a call player Call player enable to stream a media file through a call

Returns:

A player

getChatRoom

LinphoneChatRoom getChatRoom()

Create a new chat room for messaging from a call if not already existing, else return existing one

Returns:

LinphoneChatRoom where messaging can take place.

setListener

void setListener(LinphoneCall.LinphoneCallListener listener)

Set the callbacks associated with the LinphoneCall.