Source: linphonecall.js

/* Wrapper generated by lp-gen-wrappers, do not edit*/

/**
 * The LinphoneCall object represents a call issued or received by the LinphoneCore 
 * @external LinphoneCall
**/
/**
 * Access last known statistics for audio stream, for a given call. 
 * @member {external:LinphoneCallStats} external:LinphoneCall#audioStats
 * @readonly
**/
/**
 * 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. 
 * @member {boolean} external:LinphoneCall#authenticationTokenVerified
**/
/**
 * Returns call quality averaged over all the duration of the call.
 * @member {number} external:LinphoneCall#averageQuality
 * @readonly
**/
/**
 * Returns the call log associated to this call. 
 * @member {external:LinphoneCallLog} external:LinphoneCall#callLog
 * @readonly
**/
/**
 * Indicate whether camera input should be sent to remote end. 
 * @member {boolean} external:LinphoneCall#cameraEnabled
**/
/**
 * Returns current parameters associated to the call. 
 * @member {external:LinphoneCallParams} external:LinphoneCall#currentParams
 * @readonly
**/
/**
 * Obtain real-time quality rating of the call
 * @member {number} external:LinphoneCall#currentQuality
 * @readonly
**/
/**
 * Returns direction of the call (incoming or outgoing). 
 * @member {linphone.CallDir} external:LinphoneCall#dir
 * @readonly
**/
/**
 * Returns call's duration in seconds. 
 * @member {number} external:LinphoneCall#duration
 * @readonly
**/
/**
 * Enables or disable echo cancellation for this call 
 * @member {boolean} external:LinphoneCall#echoCancellationEnabled
**/
/**
 * Enables or disable echo limiter for this call 
 * @member {boolean} external:LinphoneCall#echoLimiterEnabled
**/
/**
 * Returns full details about call errors or termination reasons. 
 * @member {external:LinphoneErrorInfo} external:LinphoneCall#errorInfo
 * @readonly
**/
/**
 * Returns the measured sound volume played locally (received from remote). It is expressed in dbm0. 
 * @member {number} external:LinphoneCall#playVolume
 * @readonly
**/
/**
 * Returns the reason for a call termination (either error or normal termination) 
 * @member {linphone.Reason} external:LinphoneCall#reason
 * @readonly
**/
/**
 * Returns the measured sound volume recorded locally (sent to remote). It is expressed in dbm0. 
 * @member {number} external:LinphoneCall#recordVolume
 * @readonly
**/
/**
 * Returns the refer-to uri (if the call was transfered). 
 * @member {string} external:LinphoneCall#referTo
 * @readonly
**/
/**
 * Returns the remote address associated to this call 
 * @member {external:LinphoneAddress} external:LinphoneCall#remoteAddress
 * @readonly
**/
/**
 * Returns the remote address associated to this call as a string.
 * @member {string} external:LinphoneCall#remoteAddressAsString
 * @readonly
**/
/**
 * Returns the far end's sip contact as a string, if available. 
 * @member {string} external:LinphoneCall#remoteContact
 * @readonly
**/
/**
 * Returns call parameters proposed by remote.
 * @member {external:LinphoneCallParams} external:LinphoneCall#remoteParams
 * @readonly
**/
/**
 * Returns the far end's user agent description string, if available. 
 * @member {string} external:LinphoneCall#remoteUserAgent
 * @readonly
**/
/**
 * 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. 
 * @member {external:LinphoneCall} external:LinphoneCall#replacedCall
 * @readonly
**/
/**
 * Retrieves the call's current state. 
 * @member {linphone.CallState} external:LinphoneCall#state
 * @readonly
**/
/**
 * When this call has received a transfer request, returns the new call that was automatically created as
 * a result of the transfer. 
 * @member {external:LinphoneCall} external:LinphoneCall#transferTargetCall
 * @readonly
**/
/**
 * 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. 
 * @member {external:LinphoneCall} external:LinphoneCall#transfererCall
 * @readonly
**/
/**
 * Access last known statistics for video stream, for a given call. 
 * @member {external:LinphoneCallStats} external:LinphoneCall#videoStats
 * @readonly
**/

/**
 * 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. 
 * @function external:LinphoneCall#hasTransferPending
 * @returns {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. 
 * @function external:LinphoneCall#mediaInProgress
 * @returns {boolean} 
**/

/**
 * Request remote side to send us a Video Fast Update. 
 * @function external:LinphoneCall#sendVfuRequest
 * @returns {void} 
**/

/**
 * Start call recording. The output file where audio is recorded must be previously specified with 
 * @function external:LinphoneCall#startRecording
 * @returns {void} 
**/

/**
 * Stop call recording. 
 * @function external:LinphoneCall#stopRecording
 * @returns {void} 
**/

/**
 * 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. 
 * @function external:LinphoneCall#takePreviewSnapshot
 * @param {string} file - a path where to write the jpeg content. 
 * @returns {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. 
 * @function external:LinphoneCall#takeVideoSnapshot
 * @param {string} file - a path where to write the jpeg content. 
 * @returns {number} 
**/