|
Liblinphone
5.4.0
|
Placing and receiving calls. More...
Typedefs | |
| typedef void(* | LinphonePlayerCbsEofReachedCb) (LinphonePlayer *player) |
| Callback for notifying end of play (file). More... | |
| typedef enum _LinphoneRecorderState | LinphoneRecorderState |
| Enum representing the state of a recording. | |
| typedef enum _LinphoneVideoSourceType | LinphoneVideoSourceType |
| Enum representing the type of a video source. | |
| typedef enum _LinphoneVideoSourceScreenSharingType | LinphoneVideoSourceScreenSharingType |
| Enum representing the sub type of the screen sharing. | |
| typedef enum _LinphoneMediaDirection | LinphoneMediaDirection |
| Indicates for a given media the stream direction. | |
| typedef struct _LinphonePlayer | LinphonePlayer |
| Player interface. | |
| typedef struct _LinphonePlayerCbs | LinphonePlayerCbs |
| An object to handle the callbacks for the handling a LinphonePlayer objects. | |
| typedef enum LinphonePlayerState | LinphonePlayerState |
| The state of a LinphonePlayer. | |
| typedef enum _LinphonePrivacy | LinphonePrivacy |
| Defines privacy policy to apply as described by rfc3323. | |
| typedef unsigned int | LinphonePrivacyMask |
| A mask of LinphonePrivacy values. | |
| typedef enum _LinphoneBaudotMode | LinphoneBaudotMode |
| LinphoneBaudotMode enum represents the Baudot mode to use for the call. | |
| typedef enum _LinphoneBaudotStandard | LinphoneBaudotStandard |
| LinphoneBaudotStandard enum represents the Baudot standard to use to send Baudot tones in the call. | |
| typedef void(* | LinphoneCallCbsDtmfReceivedCb) (LinphoneCall *call, int dtmf) |
| Callback for being notified of received DTMFs. More... | |
| typedef void(* | LinphoneCallCbsGoClearAckSentCb) (LinphoneCall *call) |
| GoClear ACK sent callback. More... | |
| typedef void(* | LinphoneCallCbsSecurityLevelDowngradedCb) (LinphoneCall *call) |
| Call security level downgraded callback. More... | |
| typedef void(* | LinphoneCallCbsEncryptionChangedCb) (LinphoneCall *call, bool_t on, const char *authentication_token) |
| Call encryption changed callback. More... | |
| typedef void(* | LinphoneCallCbsAuthenticationTokenVerifiedCb) (LinphoneCall *call, bool_t verified) |
| Call authentication token verified callback. More... | |
| typedef void(* | LinphoneCallCbsSendMasterKeyChangedCb) (LinphoneCall *call, const char *send_master_key) |
| Call send master key changed callback. More... | |
| typedef void(* | LinphoneCallCbsReceiveMasterKeyChangedCb) (LinphoneCall *call, const char *receive_master_key) |
| Call receive master key changed callback. More... | |
| typedef void(* | LinphoneCallCbsInfoMessageReceivedCb) (LinphoneCall *call, const LinphoneInfoMessage *message) |
| Callback for receiving info messages. More... | |
| typedef void(* | LinphoneCallCbsStateChangedCb) (LinphoneCall *call, LinphoneCallState state, const char *message) |
| Call state notification callback. More... | |
| typedef void(* | LinphoneCallCbsStatsUpdatedCb) (LinphoneCall *call, const LinphoneCallStats *stats) |
| Callback for receiving quality statistics for calls. More... | |
| typedef void(* | LinphoneCallCbsTransferStateChangedCb) (LinphoneCall *call, LinphoneCallState state) |
| Callback for notifying progresses of transfers. More... | |
| typedef void(* | LinphoneCallCbsReferRequestedCb) (LinphoneCall *call, const LinphoneAddress *refer_to) |
| Callback for notifying when a call transfer (refer) is requested. More... | |
| typedef void(* | LinphoneCallCbsAckProcessingCb) (LinphoneCall *call, LinphoneHeaders *ack, bool_t is_received) |
| Callback for notifying the processing SIP ACK messages. More... | |
| typedef void(* | LinphoneCallCbsTmmbrReceivedCb) (LinphoneCall *call, int stream_index, int tmmbr) |
| Callback for notifying a received TMMBR. More... | |
| typedef void(* | LinphoneCallCbsSnapshotTakenCb) (LinphoneCall *call, const char *file_path) |
| Callback for notifying a snapshot taken. More... | |
| typedef void(* | LinphoneCallCbsNextVideoFrameDecodedCb) (LinphoneCall *call) |
| Callback to notify a next video frame has been decoded. More... | |
| typedef void(* | LinphoneCallCbsCameraNotWorkingCb) (LinphoneCall *call, const char *camera_name) |
| Callback to notify that the camera is not working and has been changed to "No Webcam". More... | |
| typedef void(* | LinphoneCallCbsVideoDisplayErrorOccurredCb) (LinphoneCall *call, int error_code) |
| Callback to notify that there are errors from the video rendering. More... | |
| typedef void(* | LinphoneCallCbsAudioDeviceChangedCb) (LinphoneCall *call, LinphoneAudioDevice *audio_device) |
| Callback to notify that the audio device has been changed. More... | |
| typedef void(* | LinphoneCallCbsRemoteRecordingCb) (LinphoneCall *call, bool_t recording) |
| Callback to notify that the call is being recorded by the remote. More... | |
| typedef void(* | LinphoneCallCbsBaudotDetectedCb) (LinphoneCall *call, LinphoneBaudotStandard standard) |
| Callback to notify that Baudot tones have been detected in the audio received from the remote. More... | |
| typedef struct _LinphoneCall | LinphoneCall |
| This object represents a call issued or received by the LinphoneCore. More... | |
| typedef struct _LinphoneCallCbs | LinphoneCallCbs |
| That class holds all the callbacks which are called by LinphoneCall objects. More... | |
| typedef struct _LinphoneCallParams | LinphoneCallParams |
| An object containing various parameters of a LinphoneCall. More... | |
| typedef struct _LinphoneRecorder | LinphoneRecorder |
| Interface used to record audio and video into files. More... | |
| typedef struct _LinphoneRecorderParams | LinphoneRecorderParams |
| Object containing various parameters of a LinphoneRecorder. More... | |
| typedef struct _LinphoneVideoSourceDescriptor | LinphoneVideoSourceDescriptor |
| Object that is used to describe a video source. | |
| typedef enum _LinphoneMediaFileFormat | LinphoneMediaFileFormat |
| Enum representing the file format of a recording. | |
| typedef enum _LinphoneCallState | LinphoneCallState |
| LinphoneCallState enum represents the different states a call can reach into. More... | |
Placing and receiving calls.
The LinphoneCall object represents an incoming or outgoing call managed by the LinphoneCore.
| typedef struct _LinphoneCall LinphoneCall |
This object represents a call issued or received by the LinphoneCore.
Linphone only allows at most one active call at any given time and it will be in LinphoneCallStateStreamsRunning. However, if the core is locally hosting a LinphoneConference, you may have some or all the calls in the conference in LinphoneCallStateStreamsRunning as well as an additional active call outside of the conference in LinphoneCallStateStreamsRunning if the local participant of the LinphoneConference is not part of it.
You can get the LinphoneCallState of the call using linphone_call_get_state(), it's current LinphoneCallParams with linphone_call_get_current_params() and the latest statistics by calling linphone_call_get_audio_stats() or linphone_call_get_video_stats().
The application can receive the various kind of events occuring in a call through the LinphoneCallCbs interface, see also linphone_call_add_callbacks().
| typedef struct _LinphoneCallCbs LinphoneCallCbs |
That class holds all the callbacks which are called by LinphoneCall objects.
Use linphone_factory_create_call_cbs() to create an instance. Then, call the callback setters on the events you need to monitor and pass the object to a LinphoneCall instance through linphone_call_add_callbacks().
| typedef void(* LinphoneCallCbsAckProcessingCb) (LinphoneCall *call, LinphoneHeaders *ack, bool_t is_received) |
Callback for notifying the processing SIP ACK messages.
| call | LinphoneCall for which an ACK is being received or sent |
| ack | the ACK LinphoneHeaders |
| is_received | if TRUE this ACK is an incoming one, otherwise it is an ACK about to be sent. |
| typedef void(* LinphoneCallCbsAudioDeviceChangedCb) (LinphoneCall *call, LinphoneAudioDevice *audio_device) |
Callback to notify that the audio device has been changed.
| call | LinphoneCall for which the audio device has changed |
| audio_device | the new audio device used for this call |
| typedef void(* LinphoneCallCbsAuthenticationTokenVerifiedCb) (LinphoneCall *call, bool_t verified) |
Call authentication token verified callback.
| call | LinphoneCall object whose authentication is verified. |
| verified | Whether encryption is verified. |
| typedef void(* LinphoneCallCbsBaudotDetectedCb) (LinphoneCall *call, LinphoneBaudotStandard standard) |
Callback to notify that Baudot tones have been detected in the audio received from the remote.
| call | LinphoneCall where Baudot tones have been detected |
| standard | The Baudot standard of the detected tones. |
| typedef void(* LinphoneCallCbsCameraNotWorkingCb) (LinphoneCall *call, const char *camera_name) |
Callback to notify that the camera is not working and has been changed to "No Webcam".
A camera is detected as mis-functionning as soon as it outputs no frames at all during a period of 5 seconds. This check is only performed on desktop platforms, in the purpose of notifying camera failures, for example if when a usb cable gets disconnected.
| call | LinphoneCall for which the next video frame has been decoded |
| camera_name | the name of the non-working camera |
| typedef void(* LinphoneCallCbsDtmfReceivedCb) (LinphoneCall *call, int dtmf) |
Callback for being notified of received DTMFs.
| call | LinphoneCall object that received the dtmf |
| dtmf | The ascii code of the dtmf |
| typedef void(* LinphoneCallCbsEncryptionChangedCb) (LinphoneCall *call, bool_t on, const char *authentication_token) |
Call encryption changed callback.
| call | LinphoneCall object whose encryption is changed. |
| on | Whether encryption is activated. |
| authentication_token | An authentication_token, currently set for ZRTP kind of encryption only. |
| typedef void(* LinphoneCallCbsGoClearAckSentCb) (LinphoneCall *call) |
GoClear ACK sent callback.
| call | the LinphoneCall on which the GoClear ACK was sent. |
| typedef void(* LinphoneCallCbsInfoMessageReceivedCb) (LinphoneCall *call, const LinphoneInfoMessage *message) |
Callback for receiving info messages.
| call | LinphoneCall whose info message belongs to. |
| message | LinphoneInfoMessage object. |
| typedef void(* LinphoneCallCbsNextVideoFrameDecodedCb) (LinphoneCall *call) |
Callback to notify a next video frame has been decoded.
| call | LinphoneCall for which the next video frame has been decoded |
| typedef void(* LinphoneCallCbsReceiveMasterKeyChangedCb) (LinphoneCall *call, const char *receive_master_key) |
Call receive master key changed callback.
| call | LinphoneCall object whose encryption is changed. |
| receive_master_key | The receive master key of the SRTP session. |
| typedef void(* LinphoneCallCbsReferRequestedCb) (LinphoneCall *call, const LinphoneAddress *refer_to) |
Callback for notifying when a call transfer (refer) is requested.
| call | LinphoneCall associated with the transfer request. |
| refer_to | The target LinphoneAddress to which the call is being transferred. |
| typedef void(* LinphoneCallCbsRemoteRecordingCb) (LinphoneCall *call, bool_t recording) |
Callback to notify that the call is being recorded by the remote.
| call | LinphoneCall for which the audio is recorded |
| recording | TRUE if the call is being recorded by the remote, FALSE otherwise |
| typedef void(* LinphoneCallCbsSecurityLevelDowngradedCb) (LinphoneCall *call) |
Call security level downgraded callback.
| call | LinphoneCall object whose security level is downgraded. |
| typedef void(* LinphoneCallCbsSendMasterKeyChangedCb) (LinphoneCall *call, const char *send_master_key) |
Call send master key changed callback.
| call | LinphoneCall object whose encryption is changed. |
| send_master_key | The send master key of the SRTP session. |
| typedef void(* LinphoneCallCbsSnapshotTakenCb) (LinphoneCall *call, const char *file_path) |
Callback for notifying a snapshot taken.
| call | LinphoneCall for which the snapshot was taken |
| file_path | the name of the saved file |
| typedef void(* LinphoneCallCbsStateChangedCb) (LinphoneCall *call, LinphoneCallState state, const char *message) |
Call state notification callback.
| call | LinphoneCall whose state is changed. |
| state | The new LinphoneCallState of the call |
| message | An informational message about the state. |
| typedef void(* LinphoneCallCbsStatsUpdatedCb) (LinphoneCall *call, const LinphoneCallStats *stats) |
Callback for receiving quality statistics for calls.
| call | LinphoneCall object whose statistics are notified |
| stats | LinphoneCallStats object |
| typedef void(* LinphoneCallCbsTmmbrReceivedCb) (LinphoneCall *call, int stream_index, int tmmbr) |
Callback for notifying a received TMMBR.
| call | LinphoneCall for which the TMMBR has changed |
| stream_index | the index of the current stream |
| tmmbr | the value of the received TMMBR |
| typedef void(* LinphoneCallCbsTransferStateChangedCb) (LinphoneCall *call, LinphoneCallState state) |
Callback for notifying progresses of transfers.
| call | LinphoneCall that was transferred |
| state | The LinphoneCallState of the call to transfer target at the far end. |
| typedef void(* LinphoneCallCbsVideoDisplayErrorOccurredCb) (LinphoneCall *call, int error_code) |
Callback to notify that there are errors from the video rendering.
The error code depends of the implementation.
EGL_CONTEXT_LOST, it is recommanded to restart the Window ID with **_create_native_**_video_window_id() and **_set_native_**_video_window_id() functions.| call | LinphoneCall |
| error_code | error code from render. It depends of the renderer. |
| typedef struct _LinphoneCallParams LinphoneCallParams |
An object containing various parameters of a LinphoneCall.
You can specify your params while answering an incoming call using linphone_call_accept_with_params() or while initiating an outgoing call with linphone_core_invite_address_with_params().
This object can be created using linphone_core_create_call_params(), using NULL for the call pointer if you plan to use it for an outgoing call.
For each call, three LinphoneCallParams are available: yours, your correspondent's and the one that describe the current state of the call that is the result of the negociation between the previous two. For example, you might enable a certain feature in your call param but this feature can be denied in the remote's configuration, hence the difference.
| typedef enum _LinphoneCallState LinphoneCallState |
LinphoneCallState enum represents the different states a call can reach into.
The application is notified of a state change through the LinphoneCoreVTable::call_state_changed callback.
| typedef void(* LinphonePlayerCbsEofReachedCb) (LinphonePlayer *player) |
Callback for notifying end of play (file).
| player | The LinphonePlayer object |
| typedef struct _LinphoneRecorder LinphoneRecorder |
Interface used to record audio and video into files.
| typedef struct _LinphoneRecorderParams LinphoneRecorderParams |
Object containing various parameters of a LinphoneRecorder.
| enum _LinphoneBaudotMode |
LinphoneBaudotMode enum represents the Baudot mode to use for the call.
LinphoneBaudotStandard enum represents the Baudot standard to use to send Baudot tones in the call.
| Enumerator | |
|---|---|
| LinphoneBaudotStandardUs | Send 45.45 baud US Baudot tones. |
| LinphoneBaudotStandardEurope | Send 50 baud European Baudot tones. |
| enum _LinphoneCallState |
LinphoneCallState enum represents the different states a call can reach into.
The application is notified of a state change through the LinphoneCoreVTable::call_state_changed callback.
Indicates for a given media the stream direction.
Enum representing the file format of a recording.
| enum _LinphonePrivacy |
Defines privacy policy to apply as described by rfc3323.
| Enumerator | |
|---|---|
| LinphonePrivacyNone | Privacy services must not perform any privacy function. |
| LinphonePrivacyUser | Request that privacy services provide a user-level privacy function. With this mode, "from" header is hidden, usually replaced by From: "Anonymous" <sip:anonymous@anonymous.invalid> |
| LinphonePrivacyHeader | Request that privacy services modify headers that cannot be set arbitrarily by the user (Contact/Via). |
| LinphonePrivacySession | Request that privacy services provide privacy for session media. |
| LinphonePrivacyId | rfc3325 The presence of this privacy type in a Privacy header field indicates that the user would like the Network Asserted Identity to be kept private with respect to SIP entities outside the Trust Domain with which the user authenticated. Note that a user requesting multiple types of privacy MUST include all of the requested privacy types in its Privacy header field value |
| LinphonePrivacyCritical | Privacy service must perform the specified services or fail the request. |
| LinphonePrivacyDefault | Special keyword to use privacy as defined either globally or by proxy using linphone_proxy_config_set_privacy() |
Enum representing the sub type of the screen sharing.
| enum LinphonePlayerState |
The state of a LinphonePlayer.
| Enumerator | |
|---|---|
| LinphonePlayerClosed | No file is opened for playing. |
| LinphonePlayerPaused | The player is paused. |
| LinphonePlayerPlaying | The player is playing. |
| LinphoneStatus linphone_call_accept | ( | LinphoneCall * | call | ) |
Accepts 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 #LinphoneCallStateIncoming event with the associated LinphoneCall object. The application can later accept the call using this method.
| call | The LinphoneCall object |
| LinphoneStatus linphone_call_accept_early_media | ( | LinphoneCall * | call | ) |
Accepts an early media session for an incoming call.
This is identical as calling linphone_call_accept_early_media_with_params() with NULL parameters.
| call | A LinphoneCall object |
| LinphoneStatus linphone_call_accept_early_media_with_params | ( | LinphoneCall * | call, |
| const LinphoneCallParams * | params | ||
| ) |
When receiving an incoming, accepts 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 linphone_call_accept() or linphone_call_accept_with_params().
| call | A LinphoneCall object |
| params | The call parameters to use (can be NULL). |
| LinphoneStatus linphone_call_accept_update | ( | LinphoneCall * | call, |
| const LinphoneCallParams * | params | ||
| ) |
Accepts call modifications initiated by other end through an incoming reINVITE or UPDATE request.
linphone_call_accept_update() is typically used in response to a LinphoneCallStateUpdatedByRemote state notification. When such notification arrives, the application has several choices:
An application may use linphone_call_get_remote_params() to get information about the call parameters proposed by the other party (for example when he wants to add a video stream), in order to decide what to do, like for example requesting the end-user approval.
The params argument must be constructed with linphone_core_create_call_params(). linphone_core_create_call_params() will initialize the returned LinphoneCallParams according to the offered parameters, previously used local parameters and local policies. For example, if the remote user-agent wants to add a video stream but the LinphoneVideoActivationPolicy of the LinphoneCore is to not automatically accept video, then the LinphoneCallParams will get its video stream disabled. The application is free to modify the LinphoneCallParams before passing it to linphone_call_accept_update(). Using null as params argument is allowed and equivalent to passing a LinphoneCallParams created by linphone_core_create_call_params() and left unmodified.
The answer generated by linphone_call_accept_update() at first follows RFC3264 SDP offer answer model rules. The supplied LinphoneCallParams allows to give application instructions about the response to generate, such as accepting or not the enablement of new stream. linphone_call_accept_update() does not have the pretention to control every aspect of the generation of the answer of an SDP offer/answer procedure.
| call | A LinphoneCall object |
| params | A LinphoneCallParams object describing the call parameters to accept. |
| LinphoneStatus linphone_call_accept_with_params | ( | LinphoneCall * | call, |
| const LinphoneCallParams * | params | ||
| ) |
Accepts 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 #LinphoneCallStateIncoming event with the associated LinphoneCall object. The application can later accept the call using this method.
| call | A LinphoneCall object |
| params | The specific parameters for this call, for example whether video is accepted or not. Use NULL to use default parameters. |
| bool_t linphone_call_asked_to_autoanswer | ( | LinphoneCall * | call | ) |
Tells whether a call has been asked to autoanswer.
| call | LinphoneCall object. |
| bool_t linphone_call_camera_enabled | ( | const LinphoneCall * | call | ) |
Returns if camera pictures are allowed to be sent to the remote party.
| call | LinphoneCall object. |
| void linphone_call_cancel_dtmfs | ( | LinphoneCall * | call | ) |
Stops 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.
| call | The LinphoneCall object |
| LinphoneCallCbsAckProcessingCb linphone_call_cbs_get_ack_processing | ( | LinphoneCallCbs * | cbs | ) |
Get the ACK processing callback.
| cbs | LinphoneCallCbs object. |
| LinphoneCallCbsAudioDeviceChangedCb linphone_call_cbs_get_audio_device_changed | ( | LinphoneCallCbs * | cbs | ) |
Get the audio device changed callback.
| cbs | The LinphoneCallCbs object. |
| LinphoneCallCbsAuthenticationTokenVerifiedCb linphone_call_cbs_get_authentication_token_verified | ( | LinphoneCallCbs * | cbs | ) |
Get the authentication token verified callback.
| cbs | LinphoneCallCbs object. |
| LinphoneCallCbsBaudotDetectedCb linphone_call_cbs_get_baudot_detected | ( | LinphoneCallCbs * | cbs | ) |
Get the Baudot detected callback.
| [in] | cbs | The LinphoneCallCbs object. |
| LinphoneCallCbsCameraNotWorkingCb linphone_call_cbs_get_camera_not_working | ( | LinphoneCallCbs * | cbs | ) |
Get the camera not working callback.
| cbs | The LinphoneCallCbs object. |
| LinphoneCallCbsDtmfReceivedCb linphone_call_cbs_get_dtmf_received | ( | LinphoneCallCbs * | cbs | ) |
Get the dtmf received callback.
| cbs | LinphoneCallCbs object. |
| LinphoneCallCbsEncryptionChangedCb linphone_call_cbs_get_encryption_changed | ( | LinphoneCallCbs * | cbs | ) |
Get the encryption changed callback.
| cbs | LinphoneCallCbs object. |
| LinphoneCallCbsGoClearAckSentCb linphone_call_cbs_get_goclear_ack_sent | ( | LinphoneCallCbs * | cbs | ) |
Get the GoClear Ack sent callback.
| cbs | LinphoneCallCbs object. |
| LinphoneCallCbsInfoMessageReceivedCb linphone_call_cbs_get_info_message_received | ( | LinphoneCallCbs * | cbs | ) |
Get the info message received callback.
| cbs | LinphoneCallCbs object. |
| LinphoneCallCbsNextVideoFrameDecodedCb linphone_call_cbs_get_next_video_frame_decoded | ( | LinphoneCallCbs * | cbs | ) |
Get the next video frame decoded callback.
| cbs | The LinphoneCallCbs object. |
| LinphoneCallCbsReceiveMasterKeyChangedCb linphone_call_cbs_get_receive_master_key_changed | ( | LinphoneCallCbs * | cbs | ) |
Get the receive master key changed callback.
| cbs | LinphoneCallCbs object. |
| LinphoneCallCbsReferRequestedCb linphone_call_cbs_get_refer_requested | ( | LinphoneCallCbs * | cbs | ) |
Get the refer requested callback.
| cbs | LinphoneCallCbs object. |
| LinphoneCallCbsRemoteRecordingCb linphone_call_cbs_get_remote_recording | ( | LinphoneCallCbs * | cbs | ) |
Get the call remote recording callback.
| cbs | The LinphoneCallCbs object. |
| LinphoneCallCbsSecurityLevelDowngradedCb linphone_call_cbs_get_security_level_downgraded | ( | LinphoneCallCbs * | cbs | ) |
Get the security level downgraded callback.
| cbs | LinphoneCallCbs object. |
| LinphoneCallCbsSendMasterKeyChangedCb linphone_call_cbs_get_send_master_key_changed | ( | LinphoneCallCbs * | cbs | ) |
Get the send master key changed callback.
| cbs | LinphoneCallCbs object. |
| LinphoneCallCbsSnapshotTakenCb linphone_call_cbs_get_snapshot_taken | ( | LinphoneCallCbs * | cbs | ) |
Get the snapshot taken callback.
| cbs | The LinphoneCallCbs object. |
| LinphoneCallCbsStateChangedCb linphone_call_cbs_get_state_changed | ( | LinphoneCallCbs * | cbs | ) |
Get the state changed callback.
| cbs | LinphoneCallCbs object. |
| LinphoneCallCbsStatsUpdatedCb linphone_call_cbs_get_stats_updated | ( | LinphoneCallCbs * | cbs | ) |
Get the stats updated callback.
| cbs | LinphoneCallCbs object. |
| LinphoneCallCbsTmmbrReceivedCb linphone_call_cbs_get_tmmbr_received | ( | LinphoneCallCbs * | cbs | ) |
Get the TMMBR received callback.
| cbs | The LinphoneCallCbs object. |
| LinphoneCallCbsTransferStateChangedCb linphone_call_cbs_get_transfer_state_changed | ( | LinphoneCallCbs * | cbs | ) |
Get the transfer state changed callback.
| cbs | LinphoneCallCbs object. |
| void* linphone_call_cbs_get_user_data | ( | const LinphoneCallCbs * | cbs | ) |
Retrieve the user pointer associated with the LinphoneCallCbs object.
| cbs | LinphoneCallCbs object. |
| LinphoneCallCbsVideoDisplayErrorOccurredCb linphone_call_cbs_get_video_display_error_occurred | ( | LinphoneCallCbs * | cbs | ) |
Get the callback that will be used to notify that there are errors from the video rendering.
Check LinphoneCallCbsVideoDisplayErrorOccurredCb for more details.
| cbs | The LinphoneCallCbs object. |
| LinphoneCallCbs* linphone_call_cbs_ref | ( | LinphoneCallCbs * | cbs | ) |
Acquire a reference to the LinphoneCallCbs object.
| cbs | LinphoneCallCbs object. |
| void linphone_call_cbs_set_ack_processing | ( | LinphoneCallCbs * | cbs, |
| LinphoneCallCbsAckProcessingCb | cb | ||
| ) |
Set ACK processing callback.
| cbs | LinphoneCallCbs object. | |
| [in] | cb | The ack processing callback to be used. |
| void linphone_call_cbs_set_audio_device_changed | ( | LinphoneCallCbs * | cbs, |
| LinphoneCallCbsAudioDeviceChangedCb | cb | ||
| ) |
Set the audio device changed callback.
| cbs | The LinphoneCallCbs object. | |
| [in] | cb | The audio device changedcallback to be used. |
| void linphone_call_cbs_set_authentication_token_verified | ( | LinphoneCallCbs * | cbs, |
| LinphoneCallCbsAuthenticationTokenVerifiedCb | cb | ||
| ) |
Set the authentication token verified callback.
| cbs | LinphoneCallCbs object. | |
| [in] | cb | The authentication token verified callback to be used. |
| void linphone_call_cbs_set_baudot_detected | ( | LinphoneCallCbs * | cbs, |
| LinphoneCallCbsBaudotDetectedCb | cb | ||
| ) |
Set the Baudot detected callback.
| [in] | cbs | The LinphoneCallCbs object. |
| [in] | cb | the Baudot detected callback to be used. |
| void linphone_call_cbs_set_camera_not_working | ( | LinphoneCallCbs * | cbs, |
| LinphoneCallCbsCameraNotWorkingCb | cb | ||
| ) |
Set the camera not working callback.
| cbs | The LinphoneCallCbs object. | |
| [in] | cb | The camera not working callback to be used. |
| void linphone_call_cbs_set_dtmf_received | ( | LinphoneCallCbs * | cbs, |
| LinphoneCallCbsDtmfReceivedCb | cb | ||
| ) |
Set the dtmf received callback.
| cbs | LinphoneCallCbs object. | |
| [in] | cb | The dtmf received callback to be used. |
| void linphone_call_cbs_set_encryption_changed | ( | LinphoneCallCbs * | cbs, |
| LinphoneCallCbsEncryptionChangedCb | cb | ||
| ) |
Set the encryption changed callback.
| cbs | LinphoneCallCbs object. | |
| [in] | cb | The encryption changed callback to be used. |
| void linphone_call_cbs_set_goclear_ack_sent | ( | LinphoneCallCbs * | cbs, |
| LinphoneCallCbsGoClearAckSentCb | cb | ||
| ) |
Set the GoClear Ack sent callback.
| cbs | LinphoneCallCbs object. | |
| [in] | cb | The GoClear Ack sent callback to be used. |
| void linphone_call_cbs_set_info_message_received | ( | LinphoneCallCbs * | cbs, |
| LinphoneCallCbsInfoMessageReceivedCb | cb | ||
| ) |
Set the info message received callback.
| cbs | LinphoneCallCbs object. | |
| [in] | cb | The info message received callback to be used. |
| void linphone_call_cbs_set_next_video_frame_decoded | ( | LinphoneCallCbs * | cbs, |
| LinphoneCallCbsNextVideoFrameDecodedCb | cb | ||
| ) |
Set the next video frame decoded callback.
| cbs | The LinphoneCallCbs object. | |
| [in] | cb | The next video frame decoded callback to be used. |
| void linphone_call_cbs_set_receive_master_key_changed | ( | LinphoneCallCbs * | cbs, |
| LinphoneCallCbsReceiveMasterKeyChangedCb | cb | ||
| ) |
Set the receive master key changed callback.
| cbs | LinphoneCallCbs object. | |
| [in] | cb | The receive master key changed callback to be used. |
| void linphone_call_cbs_set_refer_requested | ( | LinphoneCallCbs * | cbs, |
| LinphoneCallCbsReferRequestedCb | cb | ||
| ) |
Set the refer requested callback.
| cbs | LinphoneCallCbs object. | |
| [in] | cb | The refer requested callback to be used. |
| void linphone_call_cbs_set_remote_recording | ( | LinphoneCallCbs * | cbs, |
| LinphoneCallCbsRemoteRecordingCb | cb | ||
| ) |
Set the call remote recording callback.
| cbs | The LinphoneCallCbs object. | |
| [in] | cb | The call remote recording callback to be used. |
| void linphone_call_cbs_set_security_level_downgraded | ( | LinphoneCallCbs * | cbs, |
| LinphoneCallCbsSecurityLevelDowngradedCb | cb | ||
| ) |
Set the security level downgraded callback.
| cbs | LinphoneCallCbs object. | |
| [in] | cb | The security level downgraded callback to be used. |
| void linphone_call_cbs_set_send_master_key_changed | ( | LinphoneCallCbs * | cbs, |
| LinphoneCallCbsSendMasterKeyChangedCb | cb | ||
| ) |
Set the send master key changed callback.
| cbs | LinphoneCallCbs object. | |
| [in] | cb | The send master key changed callback to be used. |
| void linphone_call_cbs_set_snapshot_taken | ( | LinphoneCallCbs * | cbs, |
| LinphoneCallCbsSnapshotTakenCb | cb | ||
| ) |
Set the snapshot taken callback.
| cbs | The LinphoneCallCbs object. | |
| [in] | cb | The snapshot taken callback to be used. |
| void linphone_call_cbs_set_state_changed | ( | LinphoneCallCbs * | cbs, |
| LinphoneCallCbsStateChangedCb | cb | ||
| ) |
Set the state changed callback.
| cbs | LinphoneCallCbs object. | |
| [in] | cb | The state changed callback to be used. |
| void linphone_call_cbs_set_stats_updated | ( | LinphoneCallCbs * | cbs, |
| LinphoneCallCbsStatsUpdatedCb | cb | ||
| ) |
Set the stats updated callback.
| cbs | LinphoneCallCbs object. | |
| [in] | cb | The stats updated callback to be used. |
| void linphone_call_cbs_set_tmmbr_received | ( | LinphoneCallCbs * | cbs, |
| LinphoneCallCbsTmmbrReceivedCb | cb | ||
| ) |
Set the TMMBR received callback.
| cbs | The LinphoneCallCbs object. | |
| [in] | cb | The TMMBR received callback to be used. |
| void linphone_call_cbs_set_transfer_state_changed | ( | LinphoneCallCbs * | cbs, |
| LinphoneCallCbsTransferStateChangedCb | cb | ||
| ) |
Set the transfer state changed callback.
| cbs | LinphoneCallCbs object. | |
| [in] | cb | The transfer state changed callback to be used. |
| void linphone_call_cbs_set_user_data | ( | LinphoneCallCbs * | cbs, |
| void * | user_data | ||
| ) |
Assign a user pointer to the LinphoneCallCbs object.
| cbs | LinphoneCallCbs object. | |
| [in] | user_data | The user pointer to associate with the LinphoneCallCbs object. |
| void linphone_call_cbs_set_video_display_error_occurred | ( | LinphoneCallCbs * | cbs, |
| LinphoneCallCbsVideoDisplayErrorOccurredCb | cb | ||
| ) |
Set the callback that will be used to notify that there are errors from the video rendering.
Check LinphoneCallCbsVideoDisplayErrorOccurredCb for more details.
| cbs | The LinphoneCallCbs object. | |
| [in] | cb | The failing rendering callback to be used. |
| void linphone_call_cbs_unref | ( | LinphoneCallCbs * | cbs | ) |
Release reference to the LinphoneCallCbs object.
| cbs | LinphoneCallCbs object. |
| void linphone_call_check_authentication_token_selected | ( | LinphoneCall * | call, |
| const char * | selected_value | ||
| ) |
Verifies that the half ZRTP short authentication string (SAS) selected by the user is correct, and set the verification result accordingly.
If the remote party also verifies his/her half code correctly, the ZRTP cache will be updated to prevent future verification requirements for these two users.
| call | The LinphoneCall object |
| selected_value | The ZRTP SAS selected by the user, or an empty string if the user cannot find the SAS |
| LinphoneStatus linphone_call_decline | ( | LinphoneCall * | call, |
| LinphoneReason | reason | ||
| ) |
Declines a pending incoming call, with a reason.
| call | A LinphoneCall object that must be in the IncomingReceived state |
| reason | The reason for rejecting the call: LinphoneReasonDeclined or LinphoneReasonBusy |
| int linphone_call_decline_with_error_info | ( | LinphoneCall * | call, |
| const LinphoneErrorInfo * | ei | ||
| ) |
Declines a pending incoming call, with a LinphoneErrorInfo object.
| call | A LinphoneCall object that must be in the IncomingReceived state |
| ei | LinphoneErrorInfo containing more information on the call rejection. |
| LinphoneStatus linphone_call_defer_update | ( | LinphoneCall * | call | ) |
When receiving a LinphoneCallStateUpdatedByRemote state notification, prevent LinphoneCore from performing an automatic answer.
When receiving a LinphoneCallStateUpdatedByRemote state notification (ie an incoming reINVITE), the default behaviour of LinphoneCore is defined by the "defer_update_default" option of the "sip" section of the config. If this option is 0 (the default) then the LinphoneCore 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 linphone_call_accept_update() to answer the reINVITE, with video possibly enabled in the LinphoneCallParams argument.
The LinphoneCallStateUpdatedByRemote notification can also happen 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, LinphoneCallStateUpdatedByRemote 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 generated an offer.
| call | A LinphoneCall object |
| void linphone_call_enable_camera | ( | LinphoneCall * | call, |
| bool_t | enabled | ||
| ) |
Indicates whether camera input should be sent to remote end.
| call | LinphoneCall object. |
| enabled | wether or not to send local video stream. |
| const char* linphone_call_get_authentication_token | ( | const LinphoneCall * | call | ) |
Returns the ZRTP authentication token to verify.
| call | The LinphoneCall object |
| bool_t linphone_call_get_authentication_token_verified | ( | const LinphoneCall * | call | ) |
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 linphone_call_set_authentication_token_verified().
| call | The LinphoneCall object |
| LinphoneCallLog* linphone_call_get_call_log | ( | const LinphoneCall * | call | ) |
Gets the call log associated to this call.
| call | LinphoneCall object. |
| LinphoneConference* linphone_call_get_conference | ( | const LinphoneCall * | call | ) |
Returns the associated conference object if any.
| call | The LinphoneCall object |
| LinphoneCore* linphone_call_get_core | ( | const LinphoneCall * | call | ) |
Gets the core that has created the specified call.
| call | LinphoneCall object. |
| const LinphoneCallParams* linphone_call_get_current_params | ( | const LinphoneCall * | call | ) |
Returns current parameters associated to the call.
| call | LinphoneCall object. |
| LinphoneCallDir linphone_call_get_dir | ( | const LinphoneCall * | call | ) |
Returns direction of the call (incoming or outgoing).
| call | LinphoneCall object. |
| const LinphoneAddress* linphone_call_get_diversion_address | ( | const LinphoneCall * | call | ) |
Returns the diversion address associated to this call.
| call | LinphoneCall object. |
| int linphone_call_get_duration | ( | const LinphoneCall * | call | ) |
Returns call's duration in seconds.
| call | LinphoneCall object. |
| const LinphoneErrorInfo* linphone_call_get_error_info | ( | const LinphoneCall * | call | ) |
Returns full details about call errors or termination reasons.
| call | LinphoneCall object. on which we want the information error |
| const char* linphone_call_get_local_authentication_token | ( | const LinphoneCall * | call | ) |
Returns the local ZRTP authentication token to verify by the remote.
| call | The LinphoneCall object |
| RtpTransport* linphone_call_get_meta_rtcp_transport | ( | const LinphoneCall * | call, |
| int | stream_index | ||
| ) |
Returns the meta rtcp transport for the given stream index.
| RtpTransport* linphone_call_get_meta_rtp_transport | ( | const LinphoneCall * | call, |
| int | stream_index | ||
| ) |
Returns the meta rtp transport for the given stream index.
| LinphoneReason linphone_call_get_reason | ( | const LinphoneCall * | call | ) |
Returns the reason for a call termination (either error or normal termination)
| call | LinphoneCall object. |
| const char* linphone_call_get_refer_to | ( | const LinphoneCall * | call | ) |
Gets the refer-to uri (if the call was transferred).
| call | LinphoneCall object. |
| const LinphoneAddress* linphone_call_get_refer_to_address | ( | const LinphoneCall * | call | ) |
Gets the refer-to uri (if the call was transferred).
| call | LinphoneCall object. |
| const LinphoneAddress* linphone_call_get_referred_by_address | ( | const LinphoneCall * | call | ) |
Gets the referred-by address, which is set when an incoming call is received as a consequence of a call transfer operation by a third party.
The referred-by address is the sip identity of the one who initiated the transfer.
| call | The LinphoneCall |
| const LinphoneAddress* linphone_call_get_remote_address | ( | const LinphoneCall * | call | ) |
Returns the remote address associated to this call.
| call | LinphoneCall object. |
| const bctbx_list_t* linphone_call_get_remote_authentication_tokens | ( | const LinphoneCall * | call | ) |
Returns a list of 4 remote ZRTP authentication tokens.
The user needs to select one.
| call | The LinphoneCall object |
| const char* linphone_call_get_remote_contact | ( | LinphoneCall * | call | ) |
Returns the far end's sip contact as a string, if available.
| call | LinphoneCall object. |
| const LinphoneAddress* linphone_call_get_remote_contact_address | ( | LinphoneCall * | call | ) |
Returns the far end's sip contact as an address, if available.
| call | LinphoneCall object. |
| const LinphoneCallParams* linphone_call_get_remote_params | ( | const LinphoneCall * | call | ) |
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.
| call | LinphoneCall object. |
| const char* linphone_call_get_remote_user_agent | ( | LinphoneCall * | call | ) |
Returns the far end's user agent description string, if available.
| call | LinphoneCall object. |
| LinphoneCall* linphone_call_get_replaced_call | ( | LinphoneCall * | call | ) |
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.
| call | LinphoneCall object. |
| const LinphoneAddress* linphone_call_get_request_address | ( | const LinphoneCall * | call | ) |
The address to which the call has been sent, taken directly from the SIP request-URI of the INVITE.
Usually equal to the To field, except when e.g. using a fallback contact address. You should probably use getToAddress() instead, unless you know what you're doing.
| call | LinphoneCall object. |
| LinphoneCallState linphone_call_get_state | ( | const LinphoneCall * | call | ) |
Retrieves the call's current state.
| call | LinphoneCall object. |
| int linphone_call_get_stream_count | ( | const LinphoneCall * | call | ) |
Returns the number of stream for the given call.
| call | The LinphoneCall object |
| MSFormatType linphone_call_get_stream_type | ( | const LinphoneCall * | call, |
| int | stream_index | ||
| ) |
Returns the type of stream for the given stream index.
| const LinphoneAddress* linphone_call_get_to_address | ( | const LinphoneCall * | call | ) |
Returns the to address with its headers associated to this call.
| call | LinphoneCall object. |
| const char* linphone_call_get_to_header | ( | const LinphoneCall * | call, |
| const char * | header_name | ||
| ) |
Returns the value of the header name.
| call | LinphoneCall object. |
| header_name | the name of the header to check. |
| LinphoneCallState linphone_call_get_transfer_state | ( | LinphoneCall * | call | ) |
Returns the current transfer state, if a transfer has been initiated from this call.
| call | LinphoneCall object. |
| LinphoneCall* linphone_call_get_transfer_target_call | ( | const LinphoneCall * | call | ) |
When this call has received a transfer request, returns the new call that was automatically created as a result of the transfer.
| call | LinphoneCall object. |
| LinphoneCall* linphone_call_get_transferer_call | ( | const LinphoneCall * | call | ) |
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.
| call | LinphoneCall object. |
| void* linphone_call_get_user_data | ( | const LinphoneCall * | call | ) |
Retrieves the user pointer associated with the call.
| call | The LinphoneCall object. |
| bool_t linphone_call_get_zrtp_cache_mismatch_flag | ( | const LinphoneCall * | call | ) |
Returns whether ZRTP cache mismatch.
If mismatch, the ZRTP authentication token must be verified by users as described in ZRTP procedure.
| call | The LinphoneCall object |
| bool_t linphone_call_has_transfer_pending | ( | const LinphoneCall * | call | ) |
Returns 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.
| call | LinphoneCall object. |
| void linphone_call_params_add_custom_header | ( | LinphoneCallParams * | call_params, |
| const char * | header_name, | ||
| const char * | header_value | ||
| ) |
Add a custom SIP header in the INVITE for a call.
| call_params | The LinphoneCallParams to add a custom SIP header to. |
| header_name | The name of the header to add. |
| header_value | The content of the header to add. |
| bool_t linphone_call_params_audio_enabled | ( | const LinphoneCallParams * | call_params | ) |
Tell whether audio is enabled or not.
| call_params | LinphoneCallParams object |
| bool_t linphone_call_params_avpf_enabled | ( | const LinphoneCallParams * | params | ) |
Whether or not the feedback extension will be used for AVP.
| [in] | params | LinphoneCallParams object |
| bool_t linphone_call_params_camera_enabled | ( | const LinphoneCallParams * | call_params | ) |
Tell whether camera is enabled or not.
The value returned by this function has a different meaning whether it is from local or remote parameters. The former states the will of the user to use the camera of his/her device. On the other hand, the latter is just a guess to know whether the remote party enabled its camera or not. For example, while the call is part of a conference a core will understand that the remote party disabled its camera if the thumbnail stream's direction is inactive.
| call_params | LinphoneCallParams object |
| MS2_DEPRECATED LinphoneCallParams* linphone_call_params_copy | ( | const LinphoneCallParams * | call_params | ) |
Copy an existing LinphoneCallParams object to a new LinphoneCallParams object.
linphone_call_params_copy() is error-prone, leading to inconsistent parameters being passed to linphone_core_invite_address_with_params() or linphone_call_accept_with_params().
| call_params | The LinphoneCallParams object to copy. |
| bool_t linphone_call_params_early_media_sending_enabled | ( | const LinphoneCallParams * | call_params | ) |
Indicate whether sending of early media was enabled.
| call_params | LinphoneCallParams object |
| void linphone_call_params_enable_audio | ( | LinphoneCallParams * | call_params, |
| bool_t | enabled | ||
| ) |
Enable audio stream.
| call_params | LinphoneCallParams object |
| enabled | A boolean value telling whether to enable audio or not. |
| void linphone_call_params_enable_avpf | ( | LinphoneCallParams * | params, |
| bool_t | enable | ||
| ) |
Toggle feedback extension for AVP.
| [in] | params | LinphoneCallParams object |
| [in] | enable | wether or not AVPF should be enabled |
| void linphone_call_params_enable_camera | ( | LinphoneCallParams * | call_params, |
| bool_t | enabled | ||
| ) |
Enable camera stream.
| call_params | LinphoneCallParams object |
| enabled | A boolean value telling whether to enable camera or not. |
| void linphone_call_params_enable_capability_negotiations | ( | LinphoneCallParams * | params, |
| bool_t | enabled | ||
| ) |
Enable capability negotiations (RFC5939).
| params | LinphoneCallParams object |
| enabled | A boolean value telling whether to enable capability negotiations or not. |
| void linphone_call_params_enable_cfg_lines_merging | ( | LinphoneCallParams * | params, |
| bool_t | enabled | ||
| ) |
Enable merging of cfg lines with consecutive indexes if capability negotiations (RFC5939) is enabled.
| params | LinphoneCallParams object |
| enabled | A boolean value telling whether to merge pcfg and acfg lines |
| void linphone_call_params_enable_early_media_sending | ( | LinphoneCallParams * | call_params, |
| bool_t | enabled | ||
| ) |
Enable sending of real early media (during outgoing calls).
| call_params | LinphoneCallParams object |
| enabled | A boolean value telling whether to enable early media sending or not. |
| void linphone_call_params_enable_low_bandwidth | ( | LinphoneCallParams * | call_params, |
| bool_t | enabled | ||
| ) |
Indicate low bandwith mode.
Configuring a call to low bandwidth mode will result in the core to activate several settings for the call in order to ensure that bitrate usage is lowered to the minimum possible. Typically, ptime (packetization time) will be increased, audio codec's output bitrate will be targetted to 20kbit/s provided that it is achievable by the codec selected after SDP handshake. Video is automatically disabled.
| call_params | LinphoneCallParams object |
| enabled | A boolean value telling whether to activate the low bandwidth mode or not. |
| void linphone_call_params_enable_screen_sharing | ( | LinphoneCallParams * | call_params, |
| bool_t | enabled | ||
| ) |
Enable screen sharing stream.
| call_params | LinphoneCallParams object |
| enabled | A boolean value telling whether to enable screen sharing or not. |
| void linphone_call_params_enable_tcap_line_merging | ( | LinphoneCallParams * | params, |
| bool_t | enabled | ||
| ) |
Enable merging of tcap lines with consecutive indexes if capability negotiations (RFC5939) is enabled.
| params | LinphoneCallParams object |
| enabled | A boolean value telling whether to merge tcap lines |
| void linphone_call_params_enable_video | ( | LinphoneCallParams * | call_params, |
| bool_t | enabled | ||
| ) |
Enable video stream.
| call_params | LinphoneCallParams object |
| enabled | A boolean value telling whether to enable video or not. |
| bool_t linphone_call_params_fec_enabled | ( | const LinphoneCallParams * | call_params | ) |
Tell whether FEC is enabled or not.
The FEC is enbaled whether a FEC stream is found.
| call_params | LinphoneCallParams object |
| LinphoneAccount* linphone_call_params_get_account | ( | const LinphoneCallParams * | params | ) |
Get the LinphoneAccount that is used for the call.
| params | the LinphoneCallParams |
| LinphoneMediaDirection linphone_call_params_get_audio_direction | ( | const LinphoneCallParams * | call_params | ) |
Get the audio stream direction.
| call_params | LinphoneCallParams object |
| LinphoneConferenceLayout linphone_call_params_get_conference_video_layout | ( | const LinphoneCallParams * | params | ) |
Set video layout for conference.
| params | The LinphoneCallParams to get the custom SIP header from. |
| const char* linphone_call_params_get_custom_header | ( | const LinphoneCallParams * | call_params, |
| const char * | header_name | ||
| ) |
Get a custom SIP header.
| call_params | The LinphoneCallParams to get the custom SIP header from. |
| header_name | The name of the header to get. |
| const char* linphone_call_params_get_from_header | ( | const LinphoneCallParams * | call_params | ) |
Get the from header in the CallParams.
| call_params | The LinphoneCallParams to get the from header from. |
| const LinphoneAudioDevice* linphone_call_params_get_input_audio_device | ( | const LinphoneCallParams * | params | ) |
Gets the default input audio device for a call that will be created using this call params.
| params | The LinphoneCallParams |
| bool_t linphone_call_params_get_local_conference_mode | ( | const LinphoneCallParams * | call_params | ) |
Tell whether the call is part of the locally managed conference.
| call_params | LinphoneCallParams object |
| LinphoneMediaEncryption linphone_call_params_get_media_encryption | ( | const LinphoneCallParams * | call_params | ) |
Get the kind of media encryption selected for the call.
| call_params | LinphoneCallParams object |
| const LinphoneAudioDevice* linphone_call_params_get_output_audio_device | ( | const LinphoneCallParams * | params | ) |
Gets the default output audio device for a call that will be created using this call params.
| params | The LinphoneCallParams |
| LinphonePrivacyMask linphone_call_params_get_privacy | ( | const LinphoneCallParams * | call_params | ) |
Get requested level of privacy for the call.
| call_params | LinphoneCallParams object |
| MS2_DEPRECATED LinphoneProxyConfig* linphone_call_params_get_proxy_config | ( | const LinphoneCallParams * | params | ) |
Get the LinphoneProxyConfig that is used for the call.
| params | the LinphoneCallParams |
| float linphone_call_params_get_received_framerate | ( | const LinphoneCallParams * | call_params | ) |
Get the framerate of the video that is received.
| call_params | LinphoneCallParams object |
| const LinphoneVideoDefinition* linphone_call_params_get_received_video_definition | ( | const LinphoneCallParams * | call_params | ) |
Get the definition of the received video.
| call_params | LinphoneCallParams object |
| MS2_DEPRECATED MSVideoSize linphone_call_params_get_received_video_size | ( | const LinphoneCallParams * | call_params | ) |
Get the size of the video that is received.
| call_params | LinphoneCallParams object |
| const char* linphone_call_params_get_record_file | ( | const LinphoneCallParams * | call_params | ) |
Get the path for the audio recording of the call.
| call_params | LinphoneCallParams object |
| const char* linphone_call_params_get_rtp_profile | ( | const LinphoneCallParams * | call_params | ) |
Get the RTP profile being used.
| call_params | LinphoneCallParams object |
| float linphone_call_params_get_sent_framerate | ( | const LinphoneCallParams * | call_params | ) |
Get the framerate of the video that is sent.
| call_params | LinphoneCallParams object |
| const LinphoneVideoDefinition* linphone_call_params_get_sent_video_definition | ( | const LinphoneCallParams * | call_params | ) |
Get the definition of the sent video.
| call_params | LinphoneCallParams object |
| MS2_DEPRECATED MSVideoSize linphone_call_params_get_sent_video_size | ( | const LinphoneCallParams * | call_params | ) |
Gets the size of the video that is sent.
| call_params | LinphoneCallParams object |
| const char* linphone_call_params_get_session_name | ( | const LinphoneCallParams * | call_params | ) |
Get the session name of the media session (ie in SDP).
Subject from the SIP message can be retrieved using linphone_call_params_get_custom_header() and is different.
| call_params | LinphoneCallParams object |
| const LinphonePayloadType* linphone_call_params_get_used_audio_payload_type | ( | const LinphoneCallParams * | call_params | ) |
Get the audio payload type that has been selected by a call.
| call_params | The LinphoneCallParams object. |
| const LinphonePayloadType* linphone_call_params_get_used_text_payload_type | ( | const LinphoneCallParams * | call_params | ) |
Get the text payload type that has been selected by a call.
| call_params | The LinphoneCallParams object. |
| const LinphonePayloadType* linphone_call_params_get_used_video_payload_type | ( | const LinphoneCallParams * | call_params | ) |
Get the video payload type that has been selected by a call.
| call_params | The LinphoneCallParams object. |
| void* linphone_call_params_get_user_data | ( | const LinphoneCallParams * | call_params | ) |
Get the user data associated with the call params.
| call_params | LinphoneCallParams object |
| LinphoneMediaDirection linphone_call_params_get_video_direction | ( | const LinphoneCallParams * | call_params | ) |
Get the video stream direction.
| call_params | LinphoneCallParams object |
| bool_t linphone_call_params_is_recording | ( | const LinphoneCallParams * | params | ) |
Indicates whether the call is being recorded.
| params | the LinphoneCallParams |
| bool_t linphone_call_params_is_valid | ( | const LinphoneCallParams * | params | ) |
Check if call parameters are valid.
| params | the LinphoneCallParams |
| bool_t linphone_call_params_low_bandwidth_enabled | ( | const LinphoneCallParams * | call_params | ) |
Tell whether the call has been configured in low bandwidth mode or not.
This mode can be automatically discovered thanks to a stun server when activate_edge_workarounds=1 in section [net] of configuration file. An application that would have reliable way to know network capacity may not use activate_edge_workarounds=1 but instead manually configure low bandwidth mode with linphone_call_params_enable_low_bandwidth(). When enabled, this param may transform a call request with video in audio only mode.
| call_params | LinphoneCallParams object |
| LinphoneCallParams* linphone_call_params_ref | ( | LinphoneCallParams * | call_params | ) |
Acquire a reference to the call params.
| call_params | LinphoneCallParams object |
| bool_t linphone_call_params_screen_sharing_enabled | ( | const LinphoneCallParams * | call_params | ) |
Tell whether screen sharing is enabled or not.
| call_params | LinphoneCallParams object |
| void linphone_call_params_set_account | ( | LinphoneCallParams * | params, |
| LinphoneAccount * | account | ||
| ) |
Set the LinphoneAccount to use for the call.
| params | the LinphoneCallParams |
| account | The LinphoneAccount to use, or NULL if none has been selected. The LinphoneCallParams keeps a reference to it and removes the previous one, if any. |
| void linphone_call_params_set_audio_bandwidth_limit | ( | LinphoneCallParams * | call_params, |
| int | bandwidth | ||
| ) |
Refine bandwidth settings for this call by setting a bandwidth limit for audio streams.
As a consequence, codecs whose bitrates are not compatible with this limit won't be used.
| call_params | LinphoneCallParams object |
| bandwidth | The audio bandwidth limit to set in kbit/s. |
| void linphone_call_params_set_audio_direction | ( | LinphoneCallParams * | call_params, |
| LinphoneMediaDirection | direction | ||
| ) |
Set the audio stream direction.
| call_params | LinphoneCallParams object |
| direction | The audio stream LinphoneMediaDirection associated with this call params. |
| void linphone_call_params_set_conference_video_layout | ( | LinphoneCallParams * | params, |
| LinphoneConferenceLayout | layout | ||
| ) |
Set video layout for conference.
| params | The LinphoneCallParams to get the custom SIP header from. |
| layout | LinphoneConferenceLayout to use as default when creating a conference |
| void linphone_call_params_set_from_header | ( | LinphoneCallParams * | call_params, |
| const char * | from_value | ||
| ) |
Force the from header of a call when instanciating it (if set, it precludes the search in proxy and primary contact)
| call_params | The LinphoneCallParams to add the forced from to. |
| from_value | The value of the forced from, null to delete it. |
| void linphone_call_params_set_input_audio_device | ( | LinphoneCallParams * | params, |
| LinphoneAudioDevice * | audio_device | ||
| ) |
Sets the given LinphoneAudioDevice as default input for a call to be created later.
| params | The LinphoneCallParams |
| audio_device | The LinphoneAudioDevice. NULL does nothing. |
| void linphone_call_params_set_media_encryption | ( | LinphoneCallParams * | call_params, |
| LinphoneMediaEncryption | encryption | ||
| ) |
Set requested media encryption for a call.
| call_params | LinphoneCallParams object |
| encryption | The LinphoneMediaEncryption to use for the call. |
| void linphone_call_params_set_output_audio_device | ( | LinphoneCallParams * | params, |
| LinphoneAudioDevice * | audio_device | ||
| ) |
Sets the given LinphoneAudioDevice as default output for a call to be created later.
| params | The LinphoneCallParams |
| audio_device | The LinphoneAudioDevice. NULL does nothing. |
| void linphone_call_params_set_privacy | ( | LinphoneCallParams * | call_params, |
| LinphonePrivacyMask | privacy | ||
| ) |
Set requested level of privacy for the call.
| call_params | LinphoneCallParams object |
| privacy | The LinphonePrivacyMask to used for the call. |
| MS2_DEPRECATED void linphone_call_params_set_proxy_config | ( | LinphoneCallParams * | params, |
| LinphoneProxyConfig * | proxy_config | ||
| ) |
Set the LinphoneProxyConfig to use for the call.
| params | the LinphoneCallParams |
| proxy_config | The LinphoneProxyConfig to use, or NULL if none has been selected. The LinphoneCallParams keep a reference on it and remove the older if it exists. |
| void linphone_call_params_set_record_file | ( | LinphoneCallParams * | call_params, |
| const char * | path | ||
| ) |
Enable recording of the call.
This function must be used before the call parameters are assigned to the call. The call recording can be started and paused after the call is established with linphone_call_start_recording() and linphone_call_pause_recording().
| call_params | LinphoneCallParams object |
| path | A string containing the path and filename of the file where audio/video streams are to be written. The filename must have an extension that maps to any of the supported file formats listed in LinphoneMediaFileFormat enum. |
| void linphone_call_params_set_session_name | ( | LinphoneCallParams * | call_params, |
| const char * | name | ||
| ) |
Set the session name of the media session (ie in SDP).
Subject from the SIP message (which is different) can be set using linphone_call_params_set_custom_header().
| call_params | LinphoneCallParams object |
| name | The session name to be used. |
| void linphone_call_params_set_supported_encryptions | ( | LinphoneCallParams * | params, |
| bctbx_list_t * | encs | ||
| ) |
Sets the list of supported encryptions.
| params | LinphoneCallParams object |
| encs | list with the list of encryptions supported in a given call |
| void linphone_call_params_set_user_data | ( | LinphoneCallParams * | call_params, |
| void * | user_data | ||
| ) |
Assign a user data to the call params.
| call_params | LinphoneCallParams object |
| user_data | The user data to associate with the call params. |
| void linphone_call_params_set_video_direction | ( | LinphoneCallParams * | call_params, |
| LinphoneMediaDirection | direction | ||
| ) |
Set the video stream direction.
| call_params | LinphoneCallParams object |
| direction | The video stream LinphoneMediaDirection associated with this call params. |
| void linphone_call_params_unref | ( | LinphoneCallParams * | call_params | ) |
Release a reference to the call params.
| call_params | LinphoneCallParams object |
| bool_t linphone_call_params_video_enabled | ( | const LinphoneCallParams * | call_params | ) |
Tell whether video is enabled or not.
| call_params | LinphoneCallParams object |
| LinphoneStatus linphone_call_pause | ( | LinphoneCall * | call | ) |
Pauses the call.
If a music file has been setup using linphone_core_set_play_file(), this file will be played to the remote user. The only way to resume a paused call is to call linphone_call_resume().
| call | LinphoneCall object. |
| LinphoneStatus linphone_call_redirect_to | ( | LinphoneCall * | call, |
| LinphoneAddress * | redirect_address | ||
| ) |
Redirects the specified call to the given redirect Address.
| call | The LinphoneCall object |
| redirect_address | The LinphoneAddress to redirect the call to |
| LinphoneCall* linphone_call_ref | ( | LinphoneCall * | call | ) |
Acquires a reference to the call.
An application that wishes to retain a pointer to call object must use this function to unsure the pointer remains valid. Once the application no more needs this pointer, it must call linphone_call_unref().
| call | The LinphoneCall object. |
| void linphone_call_request_notify_next_video_frame_decoded | ( | LinphoneCall * | call | ) |
Requests 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.
| call | the LinphoneCall |
| LinphoneStatus linphone_call_resume | ( | LinphoneCall * | call | ) |
Resumes a call.
The call needs to have been paused previously with linphone_call_pause().
| call | LinphoneCall object. |
| LinphoneStatus linphone_call_send_dtmf | ( | LinphoneCall * | call, |
| char | dtmf | ||
| ) |
Sends the specified dtmf.
The dtmf is automatically played to the user.
| call | The LinphoneCall object |
| dtmf | The dtmf name specified as a char, such as '0', '#' etc... |
| LinphoneStatus linphone_call_send_dtmfs | ( | LinphoneCall * | call, |
| const char * | dtmfs | ||
| ) |
Sends 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.
| call | The LinphoneCall object |
| dtmfs | A dtmf sequence such as '123#123123' |
| void linphone_call_send_vfu_request | ( | LinphoneCall * | call | ) |
Requests remote side to send us a Video Fast Update.
| call | LinphoneCall object. |
| void linphone_call_set_authentication_token_verified | ( | LinphoneCall * | call, |
| bool_t | verified | ||
| ) |
Sets 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.
| call | The LinphoneCall object |
| verified | whether the ZRTP SAS is verified. |
| void linphone_call_set_user_data | ( | LinphoneCall * | call, |
| void * | user_data | ||
| ) |
Assigns a user pointer to the call.
| call | The LinphoneCall object. |
| user_data | The user pointer to associate with the call. |
| void linphone_call_skip_zrtp_authentication | ( | LinphoneCall * | call | ) |
If the user skips the ZRTP authentication check, stop the security alert.
| call | The LinphoneCall object |
| LinphoneStatus linphone_call_take_preview_snapshot | ( | LinphoneCall * | call, |
| const char * | file_path | ||
| ) |
Takes 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.
| call | LinphoneCall object. |
| file_path | a path where to write the jpeg content. |
| LinphoneStatus linphone_call_take_video_snapshot | ( | LinphoneCall * | call, |
| const char * | file_path | ||
| ) |
Takes 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.
| call | LinphoneCall object. |
| file_path | a path where to write the jpeg content. |
| LinphoneStatus linphone_call_terminate | ( | LinphoneCall * | call | ) |
| LinphoneStatus linphone_call_terminate_with_error_info | ( | LinphoneCall * | call, |
| const LinphoneErrorInfo * | ei | ||
| ) |
Terminates a call with additional information, serialized as a Reason header.
| call | The LinphoneCall object |
| ei | LinphoneErrorInfo |
| LinphoneStatus linphone_call_transfer_to | ( | LinphoneCall * | call, |
| const LinphoneAddress * | refer_to | ||
| ) |
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 LinphoneCoreCbs is invoked to notify of the state of the new call to the other party. The notified states are LinphoneCallStateOutgoingInit , LinphoneCallStateOutgoingProgress, LinphoneCallStateOutgoingRinging and LinphoneCallStateConnected.
| call | The call to be transferred |
| refer_to | The LinphoneAddress the call is to be referred to. |
| LinphoneStatus linphone_call_transfer_to_another | ( | LinphoneCall * | call, |
| LinphoneCall * | dest | ||
| ) |
Transfers a call to destination of another running call.
This is used for "attended transfer" scenarios. The transferred 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 transferred person. This method will send a transfer request to the transferred person. The phone of the transferred 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 LinphoneCoreCbs is invoked to notify of the state of the new call to the other party. The notified states are LinphoneCallStateOutgoingInit , LinphoneCallStateOutgoingProgress, LinphoneCallStateOutgoingRinging and LinphoneCallStateConnected.
| call | A running call you want to transfer |
| dest | A running call whose remote person will receive the transfer |
| void linphone_call_unref | ( | LinphoneCall * | call | ) |
Releases reference to the call.
| call | The LinphoneCall object. |
| LinphoneStatus linphone_call_update | ( | LinphoneCall * | call, |
| const LinphoneCallParams * | params | ||
| ) |
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 NULL as params argument. In case no changes are requested through the LinphoneCallParams argument, then this argument can be omitted and set to NULL. WARNING: Updating a call in the LinphoneCallStatePaused 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 linphone_call_resume().
| call | A LinphoneCall object |
| params | The new call parameters to use (may be NULL). |
| void linphone_call_zoom | ( | LinphoneCall * | call, |
| float | zoom_factor, | ||
| float | cx, | ||
| float | cy | ||
| ) |
Performs a zoom of the video displayed during a call.
The zoom ensures that all the screen is fullfilled with the video.
| call | The LinphoneCall object |
| zoom_factor | a floating point number describing the zoom factor. A value 1.0 corresponds to no zoom applied. |
| cx | a floating point number pointing the horizontal center of the zoom to be applied. This value should be between 0.0 and 1.0. |
| cy | a floating point number pointing the vertical center of the zoom to be applied. This value should be between 0.0 and 1.0. |
| MS2_DEPRECATED LinphoneStatus linphone_core_accept_call | ( | LinphoneCore * | core, |
| LinphoneCall * | call | ||
| ) |
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 #LinphoneCallStateIncoming event with the associated LinphoneCall object. The application can later accept the call using this method.
| core | LinphoneCore object |
| call | The LinphoneCall object representing the call to be answered |
| MS2_DEPRECATED LinphoneStatus linphone_core_accept_call_update | ( | LinphoneCore * | core, |
| LinphoneCall * | call, | ||
| const LinphoneCallParams * | params | ||
| ) |
Accept call modifications initiated by other end.
This call may be performed in response to a LinphoneCallStateUpdatedByRemote state notification. When such notification arrives, the application can decide to call linphone_core_defer_update_call() so that it can have the time to prompt the user. linphone_call_get_remote_params() 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, linphone_core_accept_call_update() can be done to answer to the other party. If params is NULL, then the same call parameters established before the update request will continue to be used (no change). If params is not NULL, 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 linphone_call_params_enable_video()).
| core | LinphoneCore object |
| call | The call for which to accept an update |
| params | A LinphoneCallParams object describing the call parameters to accept |
| MS2_DEPRECATED LinphoneStatus linphone_core_accept_call_with_params | ( | LinphoneCore * | core, |
| LinphoneCall * | call, | ||
| const LinphoneCallParams * | params | ||
| ) |
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 #LinphoneCallStateIncoming event with the associated LinphoneCall object. The application can later accept the call using this method.
| core | LinphoneCore object |
| call | The LinphoneCall object representing the call to be answered |
| params | The specific parameters for this call, for example whether video is accepted or not. Use NULL to use default parameters |
| MS2_DEPRECATED LinphoneStatus linphone_core_accept_early_media | ( | LinphoneCore * | core, |
| LinphoneCall * | call | ||
| ) |
Accept an early media session for an incoming call.
This is identical as calling linphone_core_accept_early_media_with_params() with NULL call parameters.
| core | LinphoneCore object |
| call | The incoming call to accept |
| MS2_DEPRECATED LinphoneStatus linphone_core_accept_early_media_with_params | ( | LinphoneCore * | core, |
| LinphoneCall * | call, | ||
| const LinphoneCallParams * | params | ||
| ) |
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 linphone_core_accept_call() or linphone_core_accept_call_with_params().
| core | LinphoneCore object |
| call | The call to accept |
| params | The call parameters to use (can be NULL) |
| LinphoneCallParams* linphone_core_create_call_params | ( | LinphoneCore * | core, |
| LinphoneCall * | call | ||
| ) |
Creates a LinphoneCallParams suitable for linphone_core_invite_with_params(), linphone_call_accept_with_params(), linphone_call_accept_early_media_with_params(), linphone_call_update() or linphone_call_accept_update_with_params().
The parameters are initialized according to the current LinphoneCore configuration and the current state of the call if any. In order to create a LinphoneCallParams for an already created call, the call argument must not be null.
| core | LinphoneCore object |
| call | LinphoneCall for which the parameters are to be built, or NULL in the case where the parameters are to be used for a new outgoing call. |
| MS2_DEPRECATED LinphoneStatus linphone_core_decline_call | ( | LinphoneCore * | core, |
| LinphoneCall * | call, | ||
| LinphoneReason | reason | ||
| ) |
Decline a pending incoming call, with a reason.
| core | LinphoneCore object |
| call | The LinphoneCall to decline, must be in the IncomingReceived state |
| reason | The reason for rejecting the call: LinphoneReasonDeclined or LinphoneReasonBusy |
| MS2_DEPRECATED LinphoneStatus linphone_core_defer_call_update | ( | LinphoneCore * | core, |
| LinphoneCall * | call | ||
| ) |
When receiving a LinphoneCallStateUpdatedByRemote state notification, prevent LinphoneCore from performing an automatic answer.
When receiving a LinphoneCallStateUpdatedByRemote state notification (ie an incoming reINVITE), the default behaviour of LinphoneCore is defined by the "defer_update_default" option of the "sip" section of the config. If this option is 0 (the default) then the LinphoneCore 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 linphone_core_accept_call_update() to answer the reINVITE, with eventually video enabled in the LinphoneCallParams argument.
The LinphoneCallStateUpdatedByRemote 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, LinphoneCallStateUpdatedByRemote 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.
| core | LinphoneCore object |
| call | The call for which to defer the update |
| LinphoneCall* linphone_core_find_call_from_uri | ( | const LinphoneCore * | core, |
| const char * | uri | ||
| ) |
Search from the list of current calls if a remote address match uri.
| core | the LinphoneCore object. |
| uri | which should match call remote uri |
| LinphoneCall* linphone_core_get_call_by_callid | ( | const LinphoneCore * | core, |
| const char * | call_id | ||
| ) |
Gets the call by its SIP callid.
| core | The LinphoneCore object |
| call_id | of call |
| MS2_DEPRECATED LinphoneCall* linphone_core_get_call_by_remote_address | ( | const LinphoneCore * | core, |
| const char * | remote_address | ||
| ) |
Get the call with the remote_address specified.
| core | LinphoneCore object |
| remote_address | The remote address of the call that we want to get |
| LinphoneCall* linphone_core_get_call_by_remote_address2 | ( | const LinphoneCore * | core, |
| const LinphoneAddress * | remote_address | ||
| ) |
Get the call with the specified LinphoneAddress.
| core | the LinphoneCore |
| remote_address | the LinphoneAddress for which the call remote address must match |
| const bctbx_list_t* linphone_core_get_calls | ( | LinphoneCore * | core | ) |
Gets the current list of calls.
Note that this list is read-only and might be changed by the core after a function call to linphone_core_iterate(). Similarly the LinphoneCall objects inside it might be destroyed without prior notice. To hold references to LinphoneCall object into your program, you must use linphone_call_ref().
| core | The LinphoneCore object |
| int linphone_core_get_calls_nb | ( | const LinphoneCore * | core | ) |
| LinphoneCall* linphone_core_get_current_call | ( | const LinphoneCore * | core | ) |
Gets the current call.
The current call is defined as follows: If multiple concurrent calls exist, it is the only one that currelty uses the microphone or speaker, otherwise it is the unique call that exists unless this call is in LinphoneCallStatePaused state.
| core | LinphoneCore object |
| const LinphoneAddress* linphone_core_get_current_call_remote_address | ( | LinphoneCore * | core | ) |
Gets the remote address of the current call.
| core | LinphoneCore object. |
| MS2_DEPRECATED int linphone_core_get_delayed_timeout | ( | LinphoneCore * | core | ) |
Gets the delayed timeout See linphone_core_set_delayed_timeout() for details.
| core | LinphoneCore object |
| int linphone_core_get_in_call_timeout | ( | LinphoneCore * | core | ) |
Gets the maximum duration of a call.
See linphone_core_set_in_call_timeout() for details.
| core | LinphoneCore object |
| int linphone_core_get_inc_timeout | ( | LinphoneCore * | core | ) |
Returns the incoming call timeout See linphone_core_set_inc_timeout() for details.
| core | LinphoneCore object |
| LinphoneMediaResourceMode linphone_core_get_media_resource_mode | ( | const LinphoneCore * | core | ) |
This function returns the media resource mode for this core.
| core | A LinphoneCore object |
| int linphone_core_get_push_incoming_call_timeout | ( | const LinphoneCore * | core | ) |
Returns the push incoming call timeout See linphone_core_set_push_incoming_call_timeout() for details.
| core | LinphoneCore object |
| LinphoneSupportLevel linphone_core_get_tag_100rel_support_level | ( | const LinphoneCore * | core | ) |
Gets the support level of the 100rel attribute.
| core | LinphoneCore object. |
| bool_t linphone_core_in_call | ( | const LinphoneCore * | core | ) |
Tells whether there is a call running.
| core | LinphoneCore object |
| LinphoneCall* linphone_core_invite | ( | LinphoneCore * | core, |
| const char * | url | ||
| ) |
Initiates an outgoing call.
The application doesn't own a reference to the returned LinphoneCall object. Use linphone_call_ref() to safely keep the LinphoneCall pointer valid within your application.
| core | LinphoneCore object |
| url | The destination of the call (sip address, or phone number). |
| LinphoneCall* linphone_core_invite_address | ( | LinphoneCore * | core, |
| const LinphoneAddress * | addr | ||
| ) |
Initiates an outgoing call given a destination LinphoneAddress The LinphoneAddress can be constructed directly using linphone_factory_create_address(), or created by linphone_core_interpret_url_2().
In C, the application doesn't own a reference to the returned LinphoneCall object. Use linphone_call_ref() to safely keep the LinphoneCall pointer valid within your application.
| core | LinphoneCore object |
| addr | The destination of the call (sip address). |
| LinphoneCall* linphone_core_invite_address_with_params | ( | LinphoneCore * | core, |
| const LinphoneAddress * | addr, | ||
| const LinphoneCallParams * | params | ||
| ) |
Initiates an outgoing call given a destination LinphoneAddress The LinphoneAddress can be constructed directly using linphone_factory_create_address(), or created by linphone_core_interpret_url_2().
In C, the application doesn't own a reference to the returned LinphoneCall object. Use linphone_call_ref() to safely keep the LinphoneCall pointer valid within your application. If the LinphoneAccount is not specified in parameters, the caller's account will be automatically selected by finding what is the best to reach the destination of the call.
| core | LinphoneCore object |
| addr | The destination of the call (sip address). |
| params | Call parameters |
| LinphoneCall* linphone_core_invite_address_with_params_2 | ( | LinphoneCore * | core, |
| const LinphoneAddress * | addr, | ||
| const LinphoneCallParams * | params, | ||
| const char * | subject, | ||
| const LinphoneContent * | content | ||
| ) |
Initiates an outgoing call given a destination LinphoneAddress The LinphoneAddress can be constructed directly using linphone_factory_create_address(), or created by linphone_core_interpret_url_2().
In C, the application doesn't own a reference to the returned LinphoneCall object. Use linphone_call_ref() to safely keep the LinphoneCall pointer valid within your application. If the LinphoneAccount is not specified in parameters, the caller's account will be automatically selected by finding what is the best to reach the destination of the call.
| core | LinphoneCore object |
| addr | The destination of the call (sip address). |
| params | Call parameters |
| subject | Subject of the call, UTF-8 encoded |
| content | Body of the SIP INVITE |
| LinphoneCall* linphone_core_invite_with_params | ( | LinphoneCore * | core, |
| const char * | url, | ||
| const LinphoneCallParams * | params | ||
| ) |
Initiates an outgoing call according to supplied call parameters In C, the application doesn't own a reference to the returned LinphoneCall object.
Use linphone_call_ref() to safely keep the LinphoneCall pointer valid within your application.
| core | LinphoneCore object |
| url | The destination of the call (sip address, or phone number). |
| params | the LinphoneCallParams call parameters |
| bool_t linphone_core_is_incoming_invite_pending | ( | LinphoneCore * | core | ) |
Tells whether there is an incoming invite pending.
| core | LinphoneCore object |
| LinphoneStatus linphone_core_pause_all_calls | ( | LinphoneCore * | core | ) |
| MS2_DEPRECATED LinphoneStatus linphone_core_pause_call | ( | LinphoneCore * | core, |
| LinphoneCall * | call | ||
| ) |
Pauses the call.
If a music file has been setup using linphone_core_set_play_file(), this file will be played to the remote user.
The only way to resume a paused call is to call linphone_core_resume_call().
| core | LinphoneCore object |
| call | The call to pause |
| int linphone_core_preempt_sound_resources | ( | LinphoneCore * | core | ) |
Empties sound resources to allow a new call to be accepted.
This function is autyomatically called by the core if the media resource mode is set to unique.
| core | A LinphoneCore object |
| MS2_DEPRECATED LinphoneStatus linphone_core_redirect_call | ( | LinphoneCore * | core, |
| LinphoneCall * | call, | ||
| const char * | redirect_uri | ||
| ) |
Redirect the specified call to the given redirect URI.
| core | LinphoneCore object |
| call | The LinphoneCall to redirect |
| redirect_uri | The URI to redirect the call to |
| MS2_DEPRECATED LinphoneStatus linphone_core_resume_call | ( | LinphoneCore * | core, |
| LinphoneCall * | call | ||
| ) |
Resumes a call.
The call needs to have been paused previously with linphone_core_pause_call().
| core | LinphoneCore object |
| call | The call to resume |
| MS2_DEPRECATED void linphone_core_set_delayed_timeout | ( | LinphoneCore * | core, |
| int | seconds | ||
| ) |
Set the in delayed timeout in seconds.
After this timeout period, a delayed call (internal call initialisation or resolution) is resumed.
| core | LinphoneCore object |
| seconds | The new delayed timeout |
| void linphone_core_set_in_call_timeout | ( | LinphoneCore * | core, |
| int | seconds | ||
| ) |
Sets the maximum duration of a call in seconds.
After this timeout period, the call is automatically hangup. A value of 0 disables this feature.
| core | LinphoneCore object |
| seconds | The new timeout in seconds |
| void linphone_core_set_inc_timeout | ( | LinphoneCore * | core, |
| int | seconds | ||
| ) |
Sets the incoming call timeout in seconds.
If an incoming call isn't answered for this timeout period, it is automatically declined.
| core | LinphoneCore object |
| seconds | The new timeout in seconds |
| void linphone_core_set_media_resource_mode | ( | LinphoneCore * | core, |
| LinphoneMediaResourceMode | mode | ||
| ) |
Sets the media resources mode.
Value values are: unique and shared. When the mode is set to unique, then only one call in the state StreamsRunning is allowed. While accepting a call, the core will try to free media resource used by the current call. If it is unsuccessful, then the call is not accepted. If mode is set to shared, then the media resources of the current call (if any) are not emptied when taking a new call. If the user whishes to free them, he/she is responsible to call linphone_core_preempt_sound_resources himself/herself
| core | A LinphoneCore object |
| mode | the chosen mode |
| void linphone_core_set_push_incoming_call_timeout | ( | LinphoneCore * | core, |
| int | seconds | ||
| ) |
Configures the minimum interval between a push notification and the corresponding incoming INVITE.
If exceeded, Linphone Call is transitioned to CallError and further incoming invite associated to this push is declined if any.
| core | LinphoneCore object |
| seconds | The new timeout in seconds |
| void linphone_core_set_tag_100rel_support_level | ( | LinphoneCore * | core, |
| LinphoneSupportLevel | level | ||
| ) |
Defines what level of support is provided to the 100rel attribute.
| core | LinphoneCore object. |
| level | support level of 100rel |
| bool_t linphone_core_sound_resources_locked | ( | LinphoneCore * | core | ) |
Checks if a call will need the sound resources in near future (typically an outgoing call that is awaiting response).
In liblinphone, it is not possible to have two independant calls using sound device or camera at the same time. In order to prevent this situation, an application can use linphone_core_sound_resources_locked() to know whether it is possible at a given time to start a new outgoing call. When the function returns TRUE, an application should not allow the user to start an outgoing call.
| core | LinphoneCore object |
| LinphoneStatus linphone_core_terminate_all_calls | ( | LinphoneCore * | core | ) |
| MS2_DEPRECATED LinphoneStatus linphone_core_terminate_call | ( | LinphoneCore * | core, |
| LinphoneCall * | call | ||
| ) |
Terminates a call.
| core | LinphoneCore object |
| call | The LinphoneCall object representing the call to be terminated |
| MS2_DEPRECATED LinphoneStatus linphone_core_transfer_call | ( | LinphoneCore * | core, |
| LinphoneCall * | call, | ||
| const char * | refer_to | ||
| ) |
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 LinphoneCallStateOutgoingInit , LinphoneCallStateOutgoingProgress, LinphoneCallStateOutgoingRinging and LinphoneCallStateConnected.
| core | LinphoneCore object |
| call | The call to be transferred |
| refer_to | The destination the call is to be referred to |
| MS2_DEPRECATED LinphoneStatus linphone_core_transfer_call_to_another | ( | LinphoneCore * | core, |
| LinphoneCall * | call, | ||
| LinphoneCall * | dest | ||
| ) |
Transfers a call to destination of another running call.
This is used for "attended transfer" scenarios.
The transferred 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 transferred person. This method will send a transfer request to the transferred person. The phone of the transferred 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 LinphoneCallStateOutgoingInit , LinphoneCallStateOutgoingProgress, LinphoneCallStateOutgoingRinging and LinphoneCallStateConnected.
| core | LinphoneCore object |
| call | A running call you want to transfer |
| dest | A running call whose remote person will receive the transfer |
| MS2_DEPRECATED LinphoneStatus linphone_core_update_call | ( | LinphoneCore * | core, |
| LinphoneCall * | call, | ||
| const LinphoneCallParams * | params | ||
| ) |
Updates a running call according to supplied call parameters or parameters changed in the LinphoneCore.
In this version this is limited to the following use cases:
| core | LinphoneCore object |
| call | The call to be updated |
| params | The new call parameters to use (may be NULL) |
| LinphoneEventCbsNotifyReceivedCb linphone_event_cbs_get_notify_received | ( | const LinphoneEventCbs * | cbs | ) |
Get the notify received callback.
| cbs | LinphoneEventCbs object. |
| LinphoneEventCbsNotifyResponseCb linphone_event_cbs_get_notify_response | ( | const LinphoneEventCbs * | cbs | ) |
Get the notify response callback.
| cbs | LinphoneEventCbs object. |
| LinphoneEventCbsPublishReceivedCb linphone_event_cbs_get_publish_received | ( | const LinphoneEventCbs * | cbs | ) |
Get the publish received callback.
| cbs | LinphoneEventCbs object. |
| LinphoneEventCbsPublishStateChangedCb linphone_event_cbs_get_publish_state_changed | ( | const LinphoneEventCbs * | cbs | ) |
Get the publish state changed callback.
| cbs | LinphoneEventCbs object. |
| LinphoneEventCbsSubscribeReceivedCb linphone_event_cbs_get_subscribe_received | ( | const LinphoneEventCbs * | cbs | ) |
Get the subscribe received callback.
| cbs | LinphoneEventCbs object. |
| LinphoneEventCbsSubscribeStateChangedCb linphone_event_cbs_get_subscribe_state_changed | ( | const LinphoneEventCbs * | cbs | ) |
Get the subscribe state changed callback.
| cbs | LinphoneEventCbs object. |
| void* linphone_event_cbs_get_user_data | ( | const LinphoneEventCbs * | cbs | ) |
Retrieve the user pointer associated with a LinphoneEventCbs object.
| cbs | LinphoneEventCbs object. |
| LinphoneEventCbs* linphone_event_cbs_ref | ( | LinphoneEventCbs * | cbs | ) |
Acquire a reference to a LinphoneEventCbs object.
| void linphone_event_cbs_set_notify_received | ( | LinphoneEventCbs * | cbs, |
| LinphoneEventCbsNotifyReceivedCb | cb | ||
| ) |
Set the notify received callback.
| cbs | LinphoneEventCbs object. |
| cb | The notify received callback to be used. |
| void linphone_event_cbs_set_notify_response | ( | LinphoneEventCbs * | cbs, |
| LinphoneEventCbsNotifyResponseCb | cb | ||
| ) |
Set the notify response callback.
| cbs | LinphoneEventCbs object. |
| cb | The notify response callback to be used. |
| void linphone_event_cbs_set_publish_received | ( | LinphoneEventCbs * | cbs, |
| LinphoneEventCbsPublishReceivedCb | cb | ||
| ) |
Set the publish received callback.
| cbs | LinphoneEventCbs object. |
| cb | The publish received callback to be used. |
| void linphone_event_cbs_set_publish_state_changed | ( | LinphoneEventCbs * | cbs, |
| LinphoneEventCbsPublishStateChangedCb | cb | ||
| ) |
Set the publish state changed callback.
| cbs | LinphoneEventCbs object. |
| cb | The publish state changed callback to be used. |
| void linphone_event_cbs_set_subscribe_received | ( | LinphoneEventCbs * | cbs, |
| LinphoneEventCbsSubscribeReceivedCb | cb | ||
| ) |
Set the subscribe received callback.
| cbs | LinphoneEventCbs object. |
| cb | The subscribe received callback to be used. |
| void linphone_event_cbs_set_subscribe_state_changed | ( | LinphoneEventCbs * | cbs, |
| LinphoneEventCbsSubscribeStateChangedCb | cb | ||
| ) |
Set the subscribe state changed callback.
| cbs | LinphoneEventCbs object. |
| cb | The subscribe state changed callback to be used. |
| void linphone_event_cbs_set_user_data | ( | LinphoneEventCbs * | cbs, |
| void * | user_data | ||
| ) |
Assign a user pointer to a LinphoneEventCbs object.
| cbs | LinphoneEventCbs object. |
| user_data | The user pointer to associate with the LinphoneEventCbs object. |
| void linphone_event_cbs_unref | ( | LinphoneEventCbs * | cbs | ) |
Release a reference to a LinphoneEventCbs object.
| cbs | LinphoneEventCbs object. |
| void linphone_player_add_callbacks | ( | LinphonePlayer * | player, |
| LinphonePlayerCbs * | cbs | ||
| ) |
Adds a LinphonePlayerCbs object associated to the LinphonePlayer.
| player | LinphonePlayer object |
| cbs | The LinphonePlayerCbs object to be added to the LinphonePlayer. |
| LinphonePlayerCbsEofReachedCb linphone_player_cbs_get_eof_reached | ( | const LinphonePlayerCbs * | cbs | ) |
Get the end-of-file reached callback.
| cbs | LinphonePlayerCbs object. |
| void* linphone_player_cbs_get_user_data | ( | const LinphonePlayerCbs * | cbs | ) |
Retrieve the user pointer associated with the LinphonePlayerCbs object.
| cbs | LinphonePlayerCbs object. |
| LinphonePlayerCbs* linphone_player_cbs_ref | ( | LinphonePlayerCbs * | cbs | ) |
Acquire a reference to the LinphonePlayerCbs object.
| cbs | LinphonePlayerCbs object. |
| void linphone_player_cbs_set_eof_reached | ( | LinphonePlayerCbs * | cbs, |
| LinphonePlayerCbsEofReachedCb | cb | ||
| ) |
Set the end-of-file reached callback.
| cbs | LinphonePlayerCbs object. |
| cb | The end-of-file reached callback to be used. |
| void linphone_player_cbs_set_user_data | ( | LinphonePlayerCbs * | cbs, |
| void * | user_data | ||
| ) |
Assign a user pointer to the LinphonePlayerCbs object.
| cbs | LinphonePlayerCbs object. |
| user_data | The user pointer to associate with the LinphonePlayerCbs object. |
| void linphone_player_cbs_unref | ( | LinphonePlayerCbs * | cbs | ) |
Release reference to the LinphonePlayerCbs object.
| cbs | LinphonePlayerCbs object. |
| void linphone_player_close | ( | LinphonePlayer * | player | ) |
Close the opened file.
| player | LinphonePlayer object |
| void* linphone_player_create_window_id | ( | LinphonePlayer * | player | ) |
Create a window id to be used to display video if any.
| player | LinphonePlayer object |
| LinphoneCore* linphone_player_get_core | ( | const LinphonePlayer * | player | ) |
Returns the LinphoneCore object managing this player's call, if any.
| player | LinphonePlayer object |
| LinphonePlayerCbs* linphone_player_get_current_callbacks | ( | const LinphonePlayer * | player | ) |
Returns the current LinphonePlayerCbsCbs object.
| player | LinphonePlayer object |
| int linphone_player_get_current_position | ( | LinphonePlayer * | player | ) |
Get the current position in the opened file.
| player | LinphonePlayer object |
| int linphone_player_get_duration | ( | LinphonePlayer * | player | ) |
Get the duration of the opened file.
| player | LinphonePlayer object |
| bool_t linphone_player_get_is_video_available | ( | LinphonePlayer * | player | ) |
Returns whether the file has video and if it can be displayed.
| player | LinphonePlayer object |
| LinphonePlayerState linphone_player_get_state | ( | LinphonePlayer * | player | ) |
Get the current state of a player.
| player | LinphonePlayer object |
| void* linphone_player_get_user_data | ( | const LinphonePlayer * | player | ) |
Retrieve the user pointer associated with the player.
| player | LinphonePlayer object. |
| float linphone_player_get_volume_gain | ( | LinphonePlayer * | player | ) |
Get the volume gain of the player.
| player | LinphonePlayer object |
| LinphoneStatus linphone_player_open | ( | LinphonePlayer * | player, |
| const char * | filename | ||
| ) |
Open a file for playing.
Actually, only WAVE and MKV/MKA file formats are supported and a limited set of codecs depending of the selected format. Here are the list of working combinations:
| player | LinphonePlayer object |
| filename | The path to the file to open |
| LinphoneStatus linphone_player_pause | ( | LinphonePlayer * | player | ) |
Pause the playing of a file.
| player | LinphonePlayer object |
| LinphonePlayer* linphone_player_ref | ( | LinphonePlayer * | player | ) |
Acquire a reference to the player.
| player | LinphonePlayer object. |
| void linphone_player_remove_callbacks | ( | LinphonePlayer * | player, |
| LinphonePlayerCbs * | cbs | ||
| ) |
Removes a LinphonePlayerCbs object associated to the LinphonePlayer.
| player | LinphonePlayer object |
| cbs | The LinphonePlayerCbs object to be removed from the LinphonePlayer. |
| LinphoneStatus linphone_player_seek | ( | LinphonePlayer * | player, |
| int | time_ms | ||
| ) |
Seek in an opened file.
| player | LinphonePlayer object |
| time_ms | The time we want to go to in the file (in milliseconds). |
| void linphone_player_set_user_data | ( | LinphonePlayer * | player, |
| void * | user_data | ||
| ) |
Assign a user pointer to the player.
| player | LinphonePlayer object. |
| user_data | The user pointer to associate with the player. |
| void linphone_player_set_volume_gain | ( | LinphonePlayer * | player, |
| float | gain | ||
| ) |
Set the volume gain of the player.
| player | LinphonePlayer object |
| gain | Percentage of the gain. Valid values are in [ 0.0 : 1.0 ]. |
| void linphone_player_set_window_id | ( | LinphonePlayer * | player, |
| void * | window_id | ||
| ) |
Sets a window id to be used to display video if any.
| player | LinphonePlayer object |
| window_id | The window id pointer to use. |
| LinphoneStatus linphone_player_start | ( | LinphonePlayer * | player | ) |
Start playing a file that has been opened with linphone_player_open().
| player | LinphonePlayer object |
| void linphone_player_unref | ( | LinphonePlayer * | player | ) |
Release reference to the player.
| player | LinphonePlayer object. |
| LinphoneVideoSourceDescriptor* linphone_video_source_descriptor_clone | ( | const LinphoneVideoSourceDescriptor * | descriptor | ) |
Instantiate a new video source descriptor with values from source.
| descriptor | The LinphoneVideoSourceDescriptor object to be cloned. |
| LinphoneCall* linphone_video_source_descriptor_get_call | ( | const LinphoneVideoSourceDescriptor * | descriptor | ) |
Gets the call of a LinphoneVideoSourceDescriptor.
| descriptor | The LinphoneVideoSourceDescriptor object. |
| const char* linphone_video_source_descriptor_get_camera_id | ( | const LinphoneVideoSourceDescriptor * | descriptor | ) |
Gets the camera id of a LinphoneVideoSourceDescriptor.
| descriptor | The LinphoneVideoSourceDescriptor object. |
| const char* linphone_video_source_descriptor_get_image | ( | const LinphoneVideoSourceDescriptor * | descriptor | ) |
Gets the image path of a LinphoneVideoSourceDescriptor.
| descriptor | The LinphoneVideoSourceDescriptor object. |
| void* linphone_video_source_descriptor_get_screen_sharing | ( | const LinphoneVideoSourceDescriptor * | descriptor | ) |
Gets the screen sharing description of a LinphoneVideoSourceDescriptor.
| descriptor | The LinphoneVideoSourceDescriptor object. |
| LinphoneVideoSourceScreenSharingType linphone_video_source_descriptor_get_screen_sharing_type | ( | const LinphoneVideoSourceDescriptor * | descriptor | ) |
Gets the screen sharing type of a LinphoneVideoSourceDescriptor.
| descriptor | The LinphoneVideoSourceDescriptor object. |
| LinphoneVideoSourceType linphone_video_source_descriptor_get_type | ( | const LinphoneVideoSourceDescriptor * | descriptor | ) |
Gets the type of a LinphoneVideoSourceDescriptor.
| descriptor | The LinphoneVideoSourceDescriptor object. |
| LinphoneVideoSourceDescriptor* linphone_video_source_descriptor_new | ( | void | ) |
Create a new LinphoneVideoSourceDescriptor object.
| LinphoneVideoSourceDescriptor* linphone_video_source_descriptor_ref | ( | LinphoneVideoSourceDescriptor * | descriptor | ) |
Take a reference on a LinphoneVideoSourceDescriptor.
| descriptor | The LinphoneVideoSourceDescriptor object. |
| void linphone_video_source_descriptor_set_call | ( | LinphoneVideoSourceDescriptor * | descriptor, |
| LinphoneCall * | call | ||
| ) |
Sets the source of a LinphoneVideoSourceDescriptor with a call.
Setting a LinphoneVideoSourceDescriptor with a call will require the lib to have two calls running at the same time. To do so the media resource mode has to be set to LinphoneSharedMediaResources with linphone_core_set_media_resource_mode().
| descriptor | The LinphoneVideoSourceDescriptor object. |
| call | The LinphoneCall that will be used as a video source. |
| void linphone_video_source_descriptor_set_camera_id | ( | LinphoneVideoSourceDescriptor * | descriptor, |
| const char * | camera_id | ||
| ) |
Sets the source of a LinphoneVideoSourceDescriptor with a camera id.
| descriptor | The LinphoneVideoSourceDescriptor object. |
| camera_id | The camera id that will be used as a video source. |
| void linphone_video_source_descriptor_set_image | ( | LinphoneVideoSourceDescriptor * | descriptor, |
| const char * | image_path | ||
| ) |
Sets the source of a LinphoneVideoSourceDescriptor with an image path.
| descriptor | The LinphoneVideoSourceDescriptor object. |
| image_path | The image path that will be used as a video source. |
| void linphone_video_source_descriptor_set_screen_sharing | ( | LinphoneVideoSourceDescriptor * | descriptor, |
| LinphoneVideoSourceScreenSharingType | type, | ||
| void * | native_data | ||
| ) |
Sets the source of a LinphoneVideoSourceDescriptor as screen sharing.
native_data depends of the type and the current platform:
| descriptor | The LinphoneVideoSourceDescriptor object. |
| type | The LinphoneVideoSourceScreenSharingType type of native_data. |
| native_data | The screen handle that will be used as a video source. |
| void linphone_video_source_descriptor_unref | ( | LinphoneVideoSourceDescriptor * | descriptor | ) |
Release a LinphoneVideoSourceDescriptor.
| descriptor | The LinphoneVideoSourceDescriptor object. |
1.8.13