The LinphoneCall object represents a call issued or received by the LinphoneCore
- Source:
Members
-
<readonly> audioStats :external:LinphoneCallStats
-
Access last known statistics for audio stream, for a given call.
Type:
- Source:
-
authenticationTokenVerified :boolean
-
Set the result of ZRTP short code verification by user. If remote party also does the same, it will update the ZRTP cache so that user's verification will not be required for the two users.
Type:
- boolean
- Source:
-
<readonly> averageQuality :number
-
Returns call quality averaged over all the duration of the call.
Type:
- number
- Source:
-
<readonly> callLog :external:LinphoneCallLog
-
Returns the call log associated to this call.
Type:
- Source:
-
cameraEnabled :boolean
-
Indicate whether camera input should be sent to remote end.
Type:
- boolean
- Source:
-
<readonly> currentParams :external:LinphoneCallParams
-
Returns current parameters associated to the call.
Type:
- Source:
-
<readonly> currentQuality :number
-
Obtain real-time quality rating of the call
Type:
- number
- Source:
-
<readonly> dir :linphone.CallDir
-
Returns direction of the call (incoming or outgoing).
Type:
- Source:
-
<readonly> duration :number
-
Returns call's duration in seconds.
Type:
- number
- Source:
-
echoCancellationEnabled :boolean
-
Enables or disable echo cancellation for this call
Type:
- boolean
- Source:
-
echoLimiterEnabled :boolean
-
Enables or disable echo limiter for this call
Type:
- boolean
- Source:
-
<readonly> errorInfo :external:LinphoneErrorInfo
-
Returns full details about call errors or termination reasons.
Type:
- Source:
-
<readonly> playVolume :number
-
Returns the measured sound volume played locally (received from remote). It is expressed in dbm0.
Type:
- number
- Source:
-
<readonly> reason :linphone.Reason
-
Returns the reason for a call termination (either error or normal termination)
Type:
- Source:
-
<readonly> recordVolume :number
-
Returns the measured sound volume recorded locally (sent to remote). It is expressed in dbm0.
Type:
- number
- Source:
-
<readonly> referTo :string
-
Returns the refer-to uri (if the call was transfered).
Type:
- string
- Source:
-
<readonly> remoteAddress :external:LinphoneAddress
-
Returns the remote address associated to this call
Type:
- Source:
-
<readonly> remoteAddressAsString :string
-
Returns the remote address associated to this call as a string.
Type:
- string
- Source:
-
<readonly> remoteContact :string
-
Returns the far end's sip contact as a string, if available.
Type:
- string
- Source:
-
<readonly> remoteParams :external:LinphoneCallParams
-
Returns call parameters proposed by remote.
Type:
- Source:
-
<readonly> remoteUserAgent :string
-
Returns the far end's user agent description string, if available.
Type:
- string
- Source:
-
<readonly> replacedCall :external:LinphoneCall
-
Returns the call object this call is replacing, if any. Call replacement can occur during call transfers. By default, the core automatically terminates the replaced call and accept the new one. This function allows the application to know whether a new incoming call is a one that replaces another one.
Type:
- Source:
-
<readonly> state :linphone.CallState
-
Retrieves the call's current state.
Type:
- Source:
-
<readonly> transfererCall :external:LinphoneCall
-
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.
Type:
- Source:
-
<readonly> transferTargetCall :external:LinphoneCall
-
When this call has received a transfer request, returns the new call that was automatically created as a result of the transfer.
Type:
- Source:
-
<readonly> videoStats :external:LinphoneCallStats
-
Access last known statistics for video stream, for a given call.
Type:
- Source:
Methods
-
hasTransferPending() → {boolean}
-
Returns true if this calls has received a transfer that has not been executed yet. Pending transfers are executed when this call is being paused or closed, locally or by remote endpoint. If the call is already paused while receiving the transfer request, the transfer immediately occurs.
- Source:
Returns:
- Type
- boolean
-
mediaInProgress() → {boolean}
-
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.
- Source:
Returns:
- Type
- boolean
-
sendVfuRequest() → {void}
-
Request remote side to send us a Video Fast Update.
- Source:
Returns:
- Type
- void
-
startRecording() → {void}
-
Start call recording. The output file where audio is recorded must be previously specified with
- Source:
Returns:
- Type
- void
-
stopRecording() → {void}
-
Stop call recording.
- Source:
Returns:
- Type
- void
-
takePreviewSnapshot(file) → {number}
-
Take a photo of currently captured video and write it into a jpeg file. Note that the snapshot is asynchronous, an application shall not assume that the file is created when the function returns.
Parameters:
Name Type Description file
string a path where to write the jpeg content. - Source:
Returns:
- Type
- number
-
takeVideoSnapshot(file) → {number}
-
Take a photo of currently received video and write it into a jpeg file. Note that the snapshot is asynchronous, an application shall not assume that the file is created when the function returns.
Parameters:
Name Type Description file
string a path where to write the jpeg content. - Source:
Returns:
- Type
- number