Enum representing the status of a call.

Enum representing the direction of a call.

LinphoneCallState enum represents the different states a call can reach into.

Undocumented

Undocumented

Returns the ZRTP authentication token to verify.

Returns whether ZRTP authentication token is verified. If not, it must be verified by users as described in ZRTP procedure. Once done, the application must inform of the results with setAuthenticationTokenVerified().

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

Gets the call log associated to this call.

Returns true if camera pictures are allowed to be sent to the remote party.

Create a new chat room for messaging from a call if not already existing, else return existing one. No reference is given to the caller: the chat room will be deleted when the call is ended.

Return the associated conference object.

Get the core that has created the specified call.

Gets the current LinphoneCallCbs. This is meant only to be called from a callback to be able to get the user_data associated with the LinphoneCallCbs that is calling the callback.

Returns current parameters associated to the call.

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 direction of the call (incoming or outgoing).

Returns the diversion address associated to this call.

Returns call’s duration in seconds.

Returns true if echo cancellation is enabled.

Returns true if echo limiter is enabled.

Returns full details about call errors or termination reasons.

Returns whether or not the call is currently being recorded.

Get microphone muted state.

Get microphone volume gain. If the sound backend supports it, the returned gain is equal to the gain set with the system mixer.

Get the native window handle of the video window, casted as an unsigned long.

Returns local parameters associated with the call. This is typically the parameters passed at call initiation to Core.inviteAddressWithParams() or acceptWithParams(), or some default parameters if no CallParams was explicitely passed during call initiation.

Get the mesured playback volume level (received from remote) in dbm0.

Get a player associated with the call to play a local file and stream it to the remote peer.

Returns the reason for a call termination (either error or normal termination)

Get the mesured record volume level (sent to remote) in dbm0.

Gets the refer-to uri (if the call was transfered).

Returns the remote address associated to this call.

Returns the remote address associated to this call as a string. The result string must be freed by user using ms_free().

Returns the far end’s sip contact as a string, if available.

Returns call parameters proposed by remote. This is useful when receiving an incoming call, to know whether the remote party supports video, encryption or whatever.

Returns the far end’s user agent description string, if available.

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.

Get speaker muted state.

Get speaker volume gain. If the sound backend supports it, the returned gain is equal to the gain set with the system mixer.

Retrieves the call’s current state.

Returns the number of stream for the given call. Currently there is only two (Audio, Video), but later there will be more.

Returns the to address with its headers associated to this call.

Returns the current transfer state, if a transfer has been initiated from this call.

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

Gets 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.

Accept an incoming call. Basically the application is notified of incoming calls within the call_state_changed callback of the LinphoneCoreVTable structure, where it will receive a LinphoneCallIncoming event with the associated Call object. The application can later accept the call using this method.

Accept an early media session for an incoming call. This is identical as calling acceptEarlyMediaWithParams() with nil parameters.

When receiving an incoming, accept to start a media session as early-media. This means the call is not accepted but audio & video streams can be established if the remote party supports early media. However, unlike after call acceptance, mic and camera input are not sent during early-media, though received audio & video are played normally. The call can then later be fully accepted using accept() or acceptWithParams().

Accept call modifications initiated by other end. This call may be performed in response to a #LinphoneCallUpdatedByRemote state notification. When such notification arrives, the application can decide to call deferUpdate() so that it can have the time to prompt the user. getRemoteParams() can be used to get information about the call parameters requested by the other party, such as whether a video stream is requested.

When the user accepts or refuse the change, acceptUpdate() can be done to answer to the other party. If params is nil, then the same call parameters established before the update request will continue to be used (no change). If params is not nil, then the update will be accepted according to the parameters passed. Typical example is when a user accepts to start video, then params should indicate that video stream should be used (see CallParams.enableVideo()).

Accept an incoming call, with parameters. Basically the application is notified of incoming calls within the call_state_changed callback of the LinphoneCoreVTable structure, where it will receive a LinphoneCallIncoming event with the associated Call object. The application can later accept the call using this method.

Tell whether a call has been asked to autoanswer.

Stop current DTMF sequence sending. Please note that some DTMF could be already sent, depending on when this function call is delayed from linphone_call_send_dtmfs. This function will be automatically called if call state change to anything but LinphoneCallStreamsRunning.

Decline a pending incoming call, with a reason.

Decline a pending incoming call, with a ErrorInfo object.

When receiving a #LinphoneCallUpdatedByRemote state notification, prevent Core from performing an automatic answer. When receiving a #LinphoneCallUpdatedByRemote state notification (ie an incoming reINVITE), the default behaviour of Core is defined by the “defer_update_default” option of the “sip” section of the config. If this option is 0 (the default) then the Core automatically answers the reINIVTE with call parameters unchanged. However when for example when the remote party updated the call to propose a video stream, it can be useful to prompt the user before answering. This can be achieved by calling linphone_core_defer_call_update during the call state notification, to deactivate the automatic answer that would just confirm the audio but reject the video. Then, when the user responds to dialog prompt, it becomes possible to call acceptUpdate() to answer the reINVITE, with eventually video enabled in the CallParams argument.

The #LinphoneCallUpdatedByRemote notification can also arrive when receiving an INVITE without SDP. In such case, an unchanged offer is made in the 200Ok, and when the ACK containing the SDP answer is received,

LinphoneCallUpdatedByRemote is triggered to notify the application of possible

changes in the media session. However in such case defering the update has no meaning since we just generating an offer.

Return a copy of the call statistics for a particular stream type.

Returns the value of the header name.

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.

Indicates whether an operation is in progress at the media side. It can be 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.

Call generic OpenGL render for a given call.

Pauses the call. If a music file has been setup using Core.setPlayFile(), this file will be played to the remote user. The only way to resume a paused call is to call resume().

Redirect the specified call to the given redirect URI.

Request the callback passed to linphone_call_cbs_set_next_video_frame_decoded to be called the next time the video decoder properly decodes a video frame.

Resumes a call. The call needs to have been paused previously with pause().

Send the specified dtmf. The dtmf is automatically played to the user.

Send a list of dtmf. The dtmfs are automatically sent to remote, separated by some needed customizable delay. Sending is canceled if the call state changes to something not LinphoneCallStreamsRunning.

Send a InfoMessage through an established call.

Request remote side to send us a Video Fast Update.

Start call recording. Video record is only available if this function is called in state StreamRunning. The output file where audio is recorded must be previously specified with CallParams.setRecordFile().

Stop call recording.

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.

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.

Terminates a call.

Terminates a call.

Performs a simple call transfer to the specified destination. The remote endpoint is expected to issue a new call to the specified destination. The current call remains active and thus can be later paused or terminated. It is possible to follow the progress of the transfer provided that transferee sends notification about it. In this case, the transfer_state_changed callback of the LinphoneCoreVTable is invoked to notify of the state of the new call at the other party. The notified states are

LinphoneCallOutgoingInit , #LinphoneCallOutgoingProgress,

LinphoneCallOutgoingRinging and #LinphoneCallConnected.

Transfers a call to destination of another running call. This is used for “attended transfer” scenarios. The transfered call is supposed to be in paused state, so that it is able to accept the transfer immediately. The destination call is a call previously established to introduce the transfered person. This method will send a transfer request to the transfered person. The phone of the transfered is then expected to automatically call to the destination of the transfer. The receiver of the transfer will then automatically close the call with us (the ‘dest’ call). It is possible to follow the progress of the transfer provided that transferee sends notification about it. In this case, the transfer_state_changed callback of the LinphoneCoreVTable is invoked to notify of the state of the new call at the other party. The notified states are #LinphoneCallOutgoingInit ,

LinphoneCallOutgoingProgress, #LinphoneCallOutgoingRinging and

LinphoneCallConnected.

Updates a running call according to supplied call parameters or parameters changed in the LinphoneCore. It triggers a SIP reINVITE in order to perform a new offer/answer of media capabilities. Changing the size of the transmitted video after calling linphone_core_set_preferred_video_size can be used by passing nil as params argument. In case no changes are requested through the CallParams argument, then this argument can be omitted and set to nil. WARNING: Updating a call in the #LinphoneCallPaused state will still result in a paused call even if the media directions set in the params are sendrecv. To resume a paused call, you need to call resume().

Perform a zoom of the video displayed during a call. The zoom ensures that all the screen is fullfilled with the video.

Perform a zoom of the video displayed during a call.

• deprecated: use linphone_call_zoom instead cx and cy are updated in return in case their coordinates were too excentrated for the requested zoom factor. The zoom ensures that all the screen is fullfilled with the video.