Liblinphone  5.1.0
Data Structures | Macros | Typedefs | Enumerations | Functions
Media parameters

Controlling media parameters. More...

Data Structures

struct  _LinphoneVideoPolicy
 Structure describing policy regarding video streams establishments. More...
 

Macros

#define LINPHONE_VIDEO_DISPLAY_AUTO   (void*)((unsigned long) 0)
 For MacOS, Linux, Windows: core will create its own window.
 
#define LINPHONE_VIDEO_DISPLAY_NONE   (void*)((unsigned long) -1)
 For MacOS, Linux, Windows: do nothing.
 
#define LINPHONE_FIND_PAYLOAD_IGNORE_RATE   -1
 Wildcard value used by linphone_core_find_payload_type() to ignore rate in search algorithm.
 
#define LINPHONE_FIND_PAYLOAD_IGNORE_CHANNELS   -1
 Wildcard value used by linphone_core_find_payload_type() to ignore channel in search algorithm.
 

Typedefs

typedef struct _LinphoneVideoActivationPolicy LinphoneVideoActivationPolicy
 Object describing policy regarding video streams establishments. More...
 
typedef struct _LinphoneVideoDefinition LinphoneVideoDefinition
 This object represents a video definition, eg. More...
 
typedef enum _LinphoneAVPFMode LinphoneAVPFMode
 Enum describing RTP AVPF activation modes.
 
typedef enum _LinphoneEcCalibratorStatus LinphoneEcCalibratorStatus
 Enum describing the result of the echo canceller calibration process.
 
typedef enum _LinphoneMediaResourceMode LinphoneMediaResourceMode
 Media resource usage.
 
typedef enum _LinphoneMediaEncryption LinphoneMediaEncryption
 Enum describing type of media encryption types.
 
typedef enum _LinphoneZrtpPeerStatus LinphoneZrtpPeerStatus
 Enum describing the ZRTP SAS validation status of a peer URI.
 
typedef struct _LinphoneVideoPolicy LinphoneVideoPolicy
 Structure describing policy regarding video streams establishments. More...
 
typedef struct _LinphonePayloadType LinphonePayloadType
 Object representing an RTP payload type.
 

Enumerations

enum  _LinphoneAVPFMode {
  LinphoneAVPFDefault = -1,
  LinphoneAVPFDisabled = 0,
  LinphoneAVPFEnabled = 1
}
 Enum describing RTP AVPF activation modes. More...
 
enum  _LinphoneEcCalibratorStatus {
  LinphoneEcCalibratorInProgress = 0,
  LinphoneEcCalibratorDone = 1,
  LinphoneEcCalibratorFailed = 2,
  LinphoneEcCalibratorDoneNoEcho = 3
}
 Enum describing the result of the echo canceller calibration process. More...
 
enum  _LinphoneMediaResourceMode {
  LinphoneExclusiveMediaResources = 0,
  LinphoneSharedMediaResources = 1
}
 Media resource usage. More...
 
enum  _LinphoneMediaEncryption {
  LinphoneMediaEncryptionNone = 0,
  LinphoneMediaEncryptionSRTP = 1,
  LinphoneMediaEncryptionZRTP = 2,
  LinphoneMediaEncryptionDTLS = 3
}
 Enum describing type of media encryption types. More...
 
enum  _LinphoneZrtpPeerStatus {
  LinphoneZrtpPeerStatusUnknown = 0,
  LinphoneZrtpPeerStatusInvalid = 1,
  LinphoneZrtpPeerStatusValid = 2
}
 Enum describing the ZRTP SAS validation status of a peer URI. More...
 

Functions

bool_t linphone_call_params_is_capability_negotiation_reinvite_enabled (const LinphoneCallParams *params)
 Check if the capability negotiation (RFC5939) reINVITE is enabled or not. More...
 
bool_t linphone_call_params_capability_negotiation_reinvite_enabled (const LinphoneCallParams *params)
 Check if the capability negotiation (RFC5939) reINVITE is enabled or not. More...
 
void linphone_call_params_enable_capability_negotiation_reinvite (LinphoneCallParams *params, bool_t enable)
 Define whether capability negotiation (RFC5939) reINVITE is enabled. More...
 
bool_t linphone_call_params_capability_negotiations_enabled (const LinphoneCallParams *params)
 Indicates whether capability negotiations (RFC5939) is enabled. More...
 
bool_t linphone_call_params_tcap_lines_merged (const LinphoneCallParams *params)
 Indicates whether tcap lines with consecutive indexes are going to be merged or not if capability negotiations (RFC5939) is enabled. More...
 
bool_t linphone_call_params_is_media_encryption_supported (const LinphoneCallParams *params, const LinphoneMediaEncryption encryption)
 Returns the encryption is supported. More...
 
bctbx_list_t * linphone_call_params_get_supported_encryptions (const LinphoneCallParams *params)
 Returns the list of supported encryptions in the call. More...
 
void linphone_call_params_enable_audio_multicast (LinphoneCallParams *params, bool_t yesno)
 Use to enable multicast rtp for audio stream. More...
 
bool_t linphone_call_params_audio_multicast_enabled (const LinphoneCallParams *params)
 Use to get multicast state of audio stream. More...
 
void linphone_call_params_enable_video_multicast (LinphoneCallParams *params, bool_t yesno)
 Use to enable multicast rtp for video stream. More...
 
bool_t linphone_call_params_video_multicast_enabled (const LinphoneCallParams *params)
 Use to get multicast state of video stream. More...
 
LinphoneStatus linphone_call_params_enable_realtime_text (LinphoneCallParams *params, bool_t yesno)
 Use to enable real time text following rfc4103. More...
 
bool_t linphone_call_params_realtime_text_enabled (const LinphoneCallParams *params)
 Use to get real time text following rfc4103. More...
 
void linphone_call_params_set_realtime_text_keepalive_interval (LinphoneCallParams *params, unsigned int interval)
 Use to set keep alive interval for real time text following rfc4103. More...
 
unsigned int linphone_call_params_get_realtime_text_keepalive_interval (const LinphoneCallParams *params)
 Use to get keep alive interval of real time text following rfc4103. More...
 
void linphone_call_params_add_custom_sdp_attribute (LinphoneCallParams *params, const char *attribute_name, const char *attribute_value)
 Add a custom attribute related to all the streams in the SDP exchanged within SIP messages during a call. More...
 
void linphone_call_params_add_custom_sdp_media_attribute (LinphoneCallParams *params, LinphoneStreamType type, const char *attribute_name, const char *attribute_value)
 Add a custom attribute related to a specific stream in the SDP exchanged within SIP messages during a call. More...
 
const char * linphone_call_params_get_custom_sdp_attribute (const LinphoneCallParams *params, const char *attribute_name)
 Get a custom SDP attribute that is related to all the streams. More...
 
const char * linphone_call_params_get_custom_sdp_media_attribute (const LinphoneCallParams *params, LinphoneStreamType type, const char *attribute_name)
 Get a custom SDP attribute that is related to a specific stream. More...
 
void linphone_call_params_clear_custom_sdp_attributes (LinphoneCallParams *params)
 Clear the custom SDP attributes related to all the streams in the SDP exchanged within SIP messages during a call. More...
 
void linphone_call_params_clear_custom_sdp_media_attributes (LinphoneCallParams *params, LinphoneStreamType type)
 Clear the custom SDP attributes related to a specific stream in the SDP exchanged within SIP messages during a call. More...
 
bctbx_list_t * linphone_call_params_get_custom_contents (const LinphoneCallParams *params)
 Gets a list of LinphoneContent set if exists. More...
 
void linphone_call_params_add_custom_content (LinphoneCallParams *params, LinphoneContent *content)
 Adds a LinphoneContent to be added to the INVITE SDP. More...
 
bool_t linphone_call_params_rtp_bundle_enabled (const LinphoneCallParams *params)
 Indicates whether RTP bundle mode (also known as Media Multiplexing) is enabled. More...
 
void linphone_call_params_enable_rtp_bundle (LinphoneCallParams *params, bool_t value)
 Enables or disables RTP bundle mode (Media Multiplexing). More...
 
bool_t linphone_core_retransmission_on_nack_enabled (LinphoneCore *core)
 Tells whether NACK context is enabled or not. More...
 
void linphone_core_enable_retransmission_on_nack (LinphoneCore *core, bool_t enable)
 Turns NACK context on or off. More...
 
void linphone_core_set_download_bandwidth (LinphoneCore *core, int bandwidth)
 Sets maximum available download bandwidth This is IP bandwidth, in kbit/s. More...
 
void linphone_core_set_upload_bandwidth (LinphoneCore *core, int bandwidth)
 Sets maximum available upload bandwidth This is IP bandwidth, in kbit/s. More...
 
void linphone_core_set_expected_bandwidth (LinphoneCore *core, int bandwidth)
 Sets expected available upload bandwidth This is IP bandwidth, in kbit/s. More...
 
int linphone_core_get_download_bandwidth (const LinphoneCore *core)
 Retrieve the maximum available download bandwidth. More...
 
int linphone_core_get_upload_bandwidth (const LinphoneCore *core)
 Retrieve the maximum available upload bandwidth. More...
 
void linphone_core_enable_adaptive_rate_control (LinphoneCore *core, bool_t enabled)
 Enable adaptive rate control. More...
 
bool_t linphone_core_adaptive_rate_control_enabled (const LinphoneCore *core)
 Returns whether adaptive rate control is enabled. More...
 
void linphone_core_set_adaptive_rate_algorithm (LinphoneCore *core, const char *algorithm)
 Sets adaptive rate algorithm. More...
 
const char * linphone_core_get_adaptive_rate_algorithm (const LinphoneCore *core)
 Returns which adaptive rate algorithm is currently configured for future calls. More...
 
void linphone_core_set_download_ptime (LinphoneCore *core, int ptime)
 Set audio packetization time linphone expects to receive from peer. More...
 
int linphone_core_get_download_ptime (LinphoneCore *core)
 Get audio packetization time linphone expects to receive from peer. More...
 
void linphone_core_set_upload_ptime (LinphoneCore *core, int ptime)
 Set audio packetization time linphone will send (in absence of requirement from peer) A value of 0 stands for the current codec default packetization time. More...
 
int linphone_core_get_upload_ptime (LinphoneCore *core)
 Set audio packetization time linphone will send (in absence of requirement from peer) A value of 0 stands for the current codec default packetization time. More...
 
void linphone_core_set_sip_transport_timeout (LinphoneCore *core, int timeout_ms)
 Set the SIP transport timeout. More...
 
int linphone_core_get_sip_transport_timeout (LinphoneCore *core)
 Get the SIP transport timeout. More...
 
void linphone_core_enable_dns_srv (LinphoneCore *core, bool_t enable)
 Enable or disable DNS SRV resolution. More...
 
bool_t linphone_core_dns_srv_enabled (const LinphoneCore *core)
 Tells whether DNS SRV resolution is enabled. More...
 
void linphone_core_enable_dns_search (LinphoneCore *core, bool_t enable)
 Enable or disable DNS search (use of local domain if the fully qualified name did return results). More...
 
bool_t linphone_core_dns_search_enabled (const LinphoneCore *core)
 Tells whether DNS search (use of local domain if the fully qualified name did return results) is enabled. More...
 
bool_t linphone_core_get_dns_set_by_app (LinphoneCore *core)
 Tells if the DNS was set by an application. More...
 
void linphone_core_set_dns_servers_app (LinphoneCore *core, const bctbx_list_t *servers)
 Forces liblinphone to use the supplied list of dns servers, instead of system's ones and set dns_set_by_app at true or false according to value of servers list. More...
 
void linphone_core_set_dns_servers (LinphoneCore *core, const bctbx_list_t *servers)
 Forces liblinphone to use the supplied list of dns servers, instead of system's ones. More...
 
bctbx_list_t * linphone_core_get_audio_payload_types (LinphoneCore *core)
 Return the list of the available audio payload types. More...
 
void linphone_core_set_audio_payload_types (LinphoneCore *core, const bctbx_list_t *payload_types)
 Redefine the list of the available payload types. More...
 
bctbx_list_t * linphone_core_get_video_payload_types (LinphoneCore *core)
 Return the list of the available video payload types. More...
 
void linphone_core_set_video_payload_types (LinphoneCore *core, const bctbx_list_t *payload_types)
 Redefine the list of the available video payload types. More...
 
bctbx_list_t * linphone_core_get_text_payload_types (LinphoneCore *core)
 Return the list of the available text payload types. More...
 
void linphone_core_set_text_payload_types (LinphoneCore *core, const bctbx_list_t *payload_types)
 Redefine the list of the available payload types. More...
 
LinphonePayloadTypelinphone_core_get_payload_type (LinphoneCore *core, const char *type, int rate, int channels)
 Get payload type from mime type and clock rate. More...
 
void linphone_core_enable_audio_adaptive_jittcomp (LinphoneCore *core, bool_t enable)
 Enable or disable the audio adaptive jitter compensation. More...
 
bool_t linphone_core_audio_adaptive_jittcomp_enabled (LinphoneCore *core)
 Tells whether the audio adaptive jitter compensation is enabled. More...
 
int linphone_core_get_audio_jittcomp (LinphoneCore *core)
 Returns the nominal audio jitter buffer size in milliseconds. More...
 
void linphone_core_set_audio_jittcomp (LinphoneCore *core, int milliseconds)
 Sets the nominal audio jitter buffer size in milliseconds. More...
 
void linphone_core_enable_video_adaptive_jittcomp (LinphoneCore *core, bool_t enable)
 Enable or disable the video adaptive jitter compensation. More...
 
bool_t linphone_core_video_adaptive_jittcomp_enabled (LinphoneCore *core)
 Tells whether the video adaptive jitter compensation is enabled. More...
 
int linphone_core_get_video_jittcomp (LinphoneCore *core)
 Returns the nominal video jitter buffer size in milliseconds. More...
 
void linphone_core_set_video_jittcomp (LinphoneCore *core, int milliseconds)
 Sets the nominal video jitter buffer size in milliseconds. More...
 
int linphone_core_get_nortp_timeout (const LinphoneCore *core)
 Gets the value of the no-rtp timeout. More...
 
void linphone_core_set_audio_port_range (LinphoneCore *core, int min_port, int max_port)
 Sets the UDP port range from which to randomly select the port used for audio streaming. More...
 
void linphone_core_set_video_port_range (LinphoneCore *core, int min_port, int max_port)
 Sets the UDP port range from which to randomly select the port used for video streaming. More...
 
void linphone_core_set_text_port_range (LinphoneCore *core, int min_port, int max_port)
 Sets the UDP port range from which to randomly select the port used for text streaming. More...
 
void linphone_core_set_nortp_timeout (LinphoneCore *core, int seconds)
 Sets the no-rtp timeout value in seconds. More...
 
void linphone_core_set_use_info_for_dtmf (LinphoneCore *core, bool_t use_info)
 Sets whether SIP INFO is to be used to send digits. More...
 
bool_t linphone_core_get_use_info_for_dtmf (LinphoneCore *core)
 Indicates whether SIP INFO is used to send digits. More...
 
void linphone_core_set_use_rfc2833_for_dtmf (LinphoneCore *core, bool_t use_rfc2833)
 Sets whether RFC2833 is to be used to send digits. More...
 
bool_t linphone_core_get_use_rfc2833_for_dtmf (LinphoneCore *core)
 Indicates whether RFC2833 is used to send digits. More...
 
bctbx_list_t * linphone_core_get_sound_devices_list (const LinphoneCore *core)
 Gets the list of the available sound devices. More...
 
void linphone_core_reload_sound_devices (LinphoneCore *core)
 Update detection of sound devices. More...
 
void linphone_core_set_mic_gain_db (LinphoneCore *core, float level)
 Allow to control microphone level: gain in db. More...
 
float linphone_core_get_mic_gain_db (LinphoneCore *core)
 Get microphone gain in db. More...
 
void linphone_core_set_disable_record_on_mute (LinphoneCore *core, bool_t disable)
 Calling this method with disable=true will cause the microhone to be completely deactivated when muted, when given possible by the implementation on the platform on which liblinphone is running. More...
 
bool_t linphone_core_get_disable_record_on_mute (LinphoneCore *core)
 Get whether the microphone will be completely deactivated when muted. More...
 
void linphone_core_set_playback_gain_db (LinphoneCore *core, float level)
 Allow to control play level before entering sound card: gain in db. More...
 
float linphone_core_get_playback_gain_db (LinphoneCore *core)
 Get playback gain in db before entering sound card. More...
 
const char * linphone_core_get_ringer_device (LinphoneCore *core)
 Gets the name of the currently assigned sound device for ringing. More...
 
const char * linphone_core_get_playback_device (LinphoneCore *core)
 Gets the name of the currently assigned sound device for playback. More...
 
const char * linphone_core_get_capture_device (LinphoneCore *core)
 Gets the name of the currently assigned sound device for capture. More...
 
const char * linphone_core_get_media_device (LinphoneCore *core)
 Gets the name of the currently assigned sound device for media. More...
 
LinphoneStatus linphone_core_set_ringer_device (LinphoneCore *core, const char *devid)
 Sets the sound device used for ringing. More...
 
LinphoneStatus linphone_core_set_playback_device (LinphoneCore *core, const char *devid)
 Sets the sound device used for playback. More...
 
LinphoneStatus linphone_core_set_capture_device (LinphoneCore *core, const char *devid)
 Sets the sound device used for capture. More...
 
LinphoneStatus linphone_core_set_media_device (LinphoneCore *core, const char *devid)
 Sets the sound device used for media. More...
 
void linphone_core_stop_ringing (LinphoneCore *core)
 Whenever the liblinphone is playing a ring to advertise an incoming call or ringback of an outgoing call, this function stops the ringing. More...
 
void linphone_core_set_ring (LinphoneCore *core, const char *path)
 Sets the path to a wav file used for ringing. More...
 
const char * linphone_core_get_ring (const LinphoneCore *core)
 Returns the path to the wav file used for ringing. More...
 
void linphone_core_set_native_ringing_enabled (LinphoneCore *core, bool_t enable)
 Sets whether to use the native ringing (Android only). More...
 
void linphone_core_enable_native_ringing (LinphoneCore *core, bool_t enable)
 Sets whether to use the native ringing (Android only). More...
 
bool_t linphone_core_is_native_ringing_enabled (const LinphoneCore *core)
 Returns whether the native ringing is enabled or not. More...
 
bool_t linphone_core_native_ringing_enabled (const LinphoneCore *core)
 Returns whether the native ringing is enabled or not. More...
 
void linphone_core_set_ringback (LinphoneCore *core, const char *path)
 Sets the path to a wav file used for ringing back. More...
 
const char * linphone_core_get_ringback (const LinphoneCore *core)
 Returns the path to the wav file used for ringing back. More...
 
void linphone_core_set_remote_ringback_tone (LinphoneCore *core, const char *ring)
 Specify a ring back tone to be played to far end during incoming calls. More...
 
const char * linphone_core_get_remote_ringback_tone (const LinphoneCore *core)
 Get the ring back tone played to far end during incoming calls. More...
 
void linphone_core_set_ring_during_incoming_early_media (LinphoneCore *core, bool_t enable)
 Enable or disable the ring play during an incoming early media call. More...
 
bool_t linphone_core_get_ring_during_incoming_early_media (const LinphoneCore *core)
 Tells whether the ring play is enabled during an incoming early media call. More...
 
void linphone_core_enable_echo_cancellation (LinphoneCore *core, bool_t enable)
 Enables or disable echo cancellation. More...
 
bool_t linphone_core_echo_cancellation_enabled (const LinphoneCore *core)
 Returns TRUE if echo cancellation is enabled. More...
 
void linphone_core_enable_echo_limiter (LinphoneCore *core, bool_t enable)
 Enables or disable echo limiter. More...
 
bool_t linphone_core_echo_limiter_enabled (const LinphoneCore *core)
 Tells whether echo limiter is enabled. More...
 
void linphone_core_enable_mic (LinphoneCore *core, bool_t enable)
 Enable or disable the microphone. More...
 
bool_t linphone_core_mic_enabled (LinphoneCore *core)
 Tells whether the microphone is enabled. More...
 
bool_t linphone_core_video_enabled (LinphoneCore *core)
 Returns TRUE if either capture or display is enabled, FALSE otherwise. More...
 
void linphone_core_enable_video_capture (LinphoneCore *core, bool_t enable)
 Enable or disable video capture. More...
 
void linphone_core_enable_video_display (LinphoneCore *core, bool_t enable)
 Enable or disable video display. More...
 
void linphone_core_enable_video_source_reuse (LinphoneCore *core, bool_t enable)
 Enable or disable video source reuse when switching from preview to actual video call. More...
 
bool_t linphone_core_video_capture_enabled (LinphoneCore *core)
 Tells whether video capture is enabled. More...
 
bool_t linphone_core_video_display_enabled (LinphoneCore *core)
 Tells whether video display is enabled. More...
 
LinphoneVideoActivationPolicylinphone_video_activation_policy_ref (LinphoneVideoActivationPolicy *policy)
 Increment refcount. More...
 
void linphone_video_activation_policy_unref (LinphoneVideoActivationPolicy *policy)
 Decrement refcount and possibly free the object. More...
 
void * linphone_video_activation_policy_get_user_data (const LinphoneVideoActivationPolicy *policy)
 Gets the user data in the LinphoneVideoActivationPolicy object. More...
 
void linphone_video_activation_policy_set_user_data (LinphoneVideoActivationPolicy *policy, void *user_data)
 Sets the user data in the LinphoneVideoActivationPolicy object. More...
 
bool_t linphone_video_activation_policy_get_automatically_accept (const LinphoneVideoActivationPolicy *policy)
 Gets the value for the automatically accept video policy. More...
 
bool_t linphone_video_activation_policy_get_automatically_initiate (const LinphoneVideoActivationPolicy *policy)
 Gets the value for the automatically initiate video policy. More...
 
void linphone_video_activation_policy_set_automatically_accept (LinphoneVideoActivationPolicy *policy, bool_t enable)
 Sets the value for the automatically accept video policy. More...
 
void linphone_video_activation_policy_set_automatically_initiate (LinphoneVideoActivationPolicy *policy, bool_t enable)
 Sets the value for the automatically initiate video policy. More...
 
void linphone_core_set_video_activation_policy (LinphoneCore *core, const LinphoneVideoActivationPolicy *policy)
 Sets the default policy for video. More...
 
LinphoneVideoActivationPolicylinphone_core_get_video_activation_policy (const LinphoneCore *core)
 Get the default policy for video. More...
 
void linphone_core_set_preferred_video_definition (LinphoneCore *core, LinphoneVideoDefinition *video_definition)
 Set the preferred video definition for the stream that is captured and sent to the remote party. More...
 
void linphone_core_set_preferred_video_definition_by_name (LinphoneCore *core, const char *name)
 Sets the preferred video definition by its name. More...
 
void linphone_core_set_preview_video_definition (LinphoneCore *core, LinphoneVideoDefinition *video_definition)
 Set the video definition for the captured (preview) video. More...
 
void linphone_core_set_preview_video_definition_by_name (LinphoneCore *core, const char *name)
 
const LinphoneVideoDefinitionlinphone_core_get_preview_video_definition (const LinphoneCore *core)
 Get the definition of the captured video. More...
 
LinphoneVideoDefinitionlinphone_core_get_current_preview_video_definition (const LinphoneCore *core)
 Get the effective video definition provided by the camera for the captured video. More...
 
const LinphoneVideoDefinitionlinphone_core_get_preferred_video_definition (const LinphoneCore *core)
 Get the preferred video definition for the stream that is captured and sent to the remote party. More...
 
void linphone_core_set_preferred_framerate (LinphoneCore *core, float fps)
 Set the preferred frame rate for video. More...
 
float linphone_core_get_preferred_framerate (LinphoneCore *core)
 Returns the preferred video framerate, previously set by linphone_core_set_preferred_framerate(). More...
 
void linphone_core_preview_ogl_render (const LinphoneCore *core)
 Call generic OpenGL render for a given core. More...
 
void linphone_core_enable_video_preview (LinphoneCore *core, bool_t enable)
 Controls video preview enablement. More...
 
bool_t linphone_core_video_preview_enabled (const LinphoneCore *core)
 Tells whether video preview is enabled. More...
 
void linphone_core_enable_qrcode_video_preview (LinphoneCore *core, bool_t enable)
 Controls QRCode enablement. More...
 
void linphone_core_set_qrcode_decode_rect (LinphoneCore *core, const int x, const int y, const int w, const int h)
 Set the rectangle where the decoder will search a QRCode. More...
 
bool_t linphone_core_qrcode_video_preview_enabled (const LinphoneCore *core)
 Tells whether QRCode is enabled in the preview. More...
 
void linphone_core_enable_self_view (LinphoneCore *core, bool_t enable)
 Enables or disable self view during calls. More...
 
bool_t linphone_core_self_view_enabled (const LinphoneCore *core)
 Tells whether video self view during call is enabled or not. More...
 
void linphone_core_reload_video_devices (LinphoneCore *core)
 Update detection of camera devices. More...
 
bctbx_list_t * linphone_core_get_video_devices_list (const LinphoneCore *core)
 Gets the list of the available video capture devices. More...
 
LinphoneStatus linphone_core_set_video_device (LinphoneCore *core, const char *id)
 Sets the active video device. More...
 
const char * linphone_core_get_video_device (const LinphoneCore *core)
 Returns the name of the currently active video device. More...
 
LinphoneStatus linphone_core_set_static_picture (LinphoneCore *core, const char *path)
 Set the path to the image file to stream when "Static picture" is set as the video device. More...
 
const char * linphone_core_get_static_picture (LinphoneCore *core)
 Get the path to the image file streamed when "Static picture" is set as the video device. More...
 
LinphoneStatus linphone_core_set_static_picture_fps (LinphoneCore *core, float fps)
 Set the frame rate for static picture. More...
 
float linphone_core_get_static_picture_fps (LinphoneCore *core)
 Get the frame rate for static picture. More...
 
void * linphone_core_get_native_video_window_id (const LinphoneCore *core)
 Get the native window handle of the video window. More...
 
void linphone_core_set_native_video_window_id (LinphoneCore *core, void *window_id)
 Set the native video window id where the video is to be displayed. More...
 
void * linphone_core_get_native_preview_window_id (LinphoneCore *core)
 Get the native window handle of the video preview window. More...
 
void linphone_core_set_native_preview_window_id (LinphoneCore *core, void *window_id)
 Set the native window id where the preview video (local camera) is to be displayed. More...
 
void linphone_core_use_preview_window (LinphoneCore *core, bool_t yesno)
 Tells the core to use a separate window for local camera preview video, instead of inserting local view within the remote video window. More...
 
int linphone_core_get_device_rotation (LinphoneCore *core)
 Gets the current device orientation. More...
 
void linphone_core_set_device_rotation (LinphoneCore *core, int rotation)
 Tells the core the device current orientation. More...
 
int linphone_core_get_camera_sensor_rotation (LinphoneCore *core)
 Get the camera sensor rotation. More...
 
void linphone_core_set_use_files (LinphoneCore *core, bool_t yesno)
 Ask the core to stream audio from and to files, instead of using the soundcard. More...
 
bool_t linphone_core_get_use_files (LinphoneCore *core)
 Gets whether linphone is currently streaming audio from and to files, rather than using the soundcard. More...
 
const char * linphone_core_get_play_file (const LinphoneCore *core)
 Get the wav file that is played when putting somebody on hold, or when files are used instead of soundcards (see linphone_core_set_use_files()). More...
 
void linphone_core_set_play_file (LinphoneCore *core, const char *file)
 Sets a wav file to be played when putting somebody on hold, or when files are used instead of soundcards (see linphone_core_set_use_files()). More...
 
const char * linphone_core_get_record_file (const LinphoneCore *core)
 Get the wav file where incoming stream is recorded, when files are used instead of soundcards (see linphone_core_set_use_files()). More...
 
void linphone_core_set_record_file (LinphoneCore *core, const char *file)
 Sets a wav file where incoming stream is to be recorded, when files are used instead of soundcards (see linphone_core_set_use_files()). More...
 
void linphone_core_play_dtmf (LinphoneCore *core, char dtmf, int duration_ms)
 Plays a dtmf sound to the local user. More...
 
void linphone_core_stop_dtmf (LinphoneCore *core)
 Stops playing a dtmf started by linphone_core_play_dtmf(). More...
 
int linphone_core_get_mtu (const LinphoneCore *core)
 Returns the maximum transmission unit size in bytes.
 
void linphone_core_set_mtu (LinphoneCore *core, int mtu)
 Sets the maximum transmission unit size in bytes. More...
 
void linphone_core_set_enable_sip_update (const LinphoneCore *core, int value)
 Enable or disable the UPDATE method support. More...
 
void linphone_core_set_session_expires_enabled (const LinphoneCore *core, bool_t enabled)
 Enable the Session Timers support. More...
 
void linphone_core_enable_session_expires (const LinphoneCore *core, bool_t enabled)
 Enable the Session Timers support. More...
 
bool_t linphone_core_get_session_expires_enabled (const LinphoneCore *core)
 Check if the Session Timers feature is enabled. More...
 
bool_t linphone_core_session_expires_enabled (const LinphoneCore *core)
 Check if the Session Timers feature is enabled. More...
 
void linphone_core_set_session_expires_value (const LinphoneCore *core, int expires)
 Sets the session expires value, 0 by default. More...
 
int linphone_core_get_session_expires_value (const LinphoneCore *core)
 Returns the session expires value. More...
 
void linphone_core_set_session_expires_refresher_value (const LinphoneCore *core, LinphoneSessionExpiresRefresher refresher)
 Sets the session expires refresher value. More...
 
LinphoneSessionExpiresRefresher linphone_core_get_session_expires_refresher_value (const LinphoneCore *core)
 Returns the session expires refresher value. More...
 
void linphone_core_set_session_expires_min_value (const LinphoneCore *core, int min)
 Sets the session expires minSE value, forced to a minimum of 90 by default. More...
 
int linphone_core_get_session_expires_min_value (const LinphoneCore *core)
 Returns the session expires min value, 90 by default. More...
 
LinphoneZrtpPeerStatus linphone_core_get_zrtp_status (LinphoneCore *core, const char *addr)
 Get the zrtp sas validation status for a peer uri. More...
 
LinphoneStatus linphone_core_set_media_encryption (LinphoneCore *core, LinphoneMediaEncryption menc)
 Choose the media encryption policy to be used for RTP packets. More...
 
LinphoneMediaEncryption linphone_core_get_media_encryption (const LinphoneCore *core)
 Get the media encryption policy being used for RTP packets. More...
 
bool_t linphone_core_is_media_encryption_mandatory (LinphoneCore *core)
 Check if the configured media encryption is mandatory or not. More...
 
void linphone_core_set_supported_media_encryptions (LinphoneCore *lc, const bctbx_list_t *encs)
 Sets the supported media encryptions. More...
 
const bctbx_list_t * linphone_core_get_supported_media_encryptions (LinphoneCore *lc)
 Get list of supported media descriptions. More...
 
bool_t linphone_core_is_media_encryption_supported (LinphoneCore *core, LinphoneMediaEncryption menc)
 Check if media encryption is supported. More...
 
void linphone_core_set_media_encryption_mandatory (LinphoneCore *core, bool_t mandatory)
 Define whether the configured media encryption is mandatory, if it is and the negotation cannot result in the desired media encryption then the call will fail. More...
 
bool_t linphone_core_tcap_lines_merging_enabled (const LinphoneCore *core)
 Check if tcap lines are going to the merged if the capability negotiation (RFC5939) is supported or not. More...
 
void linphone_core_enable_tcap_line_merging (LinphoneCore *core, bool_t merge)
 Define whether tcap lines are going to be merged if capability negotiation (RFC5939) is supported. More...
 
bool_t linphone_core_is_capability_negotiation_reinvite_enabled (const LinphoneCore *core)
 Check if the capability negotiation (RFC5939) reINVITE is enabled or not. More...
 
bool_t linphone_core_capability_negotiation_reinvite_enabled (const LinphoneCore *core)
 Check if the capability negotiation (RFC5939) reINVITE is enabled or not. More...
 
void linphone_core_enable_zero_rtp_port_for_stream_inactive (LinphoneCore *lc, bool_t enable)
 Define whether RTP port is set to 0 when a stream is inactive. More...
 
bool_t linphone_core_is_zero_rtp_port_for_stream_inactive_enabled (const LinphoneCore *lc)
 Check if RTP port is set to 0 when a stream is inactive. More...
 
bool_t linphone_core_zero_rtp_port_for_stream_inactive_enabled (const LinphoneCore *lc)
 Check if RTP port is set to 0 when a stream is inactive. More...
 
void linphone_core_enable_capability_negotiation_reinvite (LinphoneCore *core, bool_t enable)
 Define whether capability negotiation (RFC5939) reINVITE is enabled. More...
 
bool_t linphone_core_capability_negociation_enabled (const LinphoneCore *core)
 Check if the capability negotiation (RFC5939) is supported or not. More...
 
void linphone_core_enable_capability_negociation (LinphoneCore *core, bool_t enable)
 Define whether capability negotiation (RFC5939) is supported. More...
 
const char * linphone_core_get_video_display_filter (LinphoneCore *core)
 Get the name of the mediastreamer2 filter used for rendering video. More...
 
void linphone_core_set_video_display_filter (LinphoneCore *core, const char *filter_name)
 Set the name of the mediastreamer2 filter to be used for rendering video. More...
 
const char * linphone_core_get_default_video_display_filter (LinphoneCore *core)
 Get the name of the default mediastreamer2 filter used for rendering video on the current platform. More...
 
bool_t linphone_core_is_media_filter_supported (LinphoneCore *core, const char *filtername)
 Checks if the given media filter is loaded and usable. More...
 
const char * linphone_core_get_echo_canceller_filter_name (const LinphoneCore *core)
 Get the name of the mediastreamer2 filter used for echo cancelling. More...
 
void linphone_core_set_echo_canceller_filter_name (LinphoneCore *core, const char *filtername)
 Set the name of the mediastreamer2 filter to be used for echo cancelling. More...
 
void linphone_core_set_tone (LinphoneCore *core, LinphoneToneID tone_id, const char *audiofile)
 Assign an audio file to be played as a specific tone id. More...
 
bctbx_list_t * linphone_core_get_supported_file_formats_list (LinphoneCore *core)
 Returns a null terminated table of strings containing the file format extension supported for call recording. More...
 
bool_t linphone_core_file_format_supported (LinphoneCore *core, const char *fmt)
 Returns whether a specific file format is supported. More...
 
void linphone_core_set_avpf_mode (LinphoneCore *core, LinphoneAVPFMode mode)
 Enable RTCP feedback (also known as RTP/AVPF profile). More...
 
LinphoneAVPFMode linphone_core_get_avpf_mode (const LinphoneCore *core)
 Return AVPF enablement. More...
 
void linphone_core_set_avpf_rr_interval (LinphoneCore *core, int interval)
 Set the avpf report interval in seconds. More...
 
int linphone_core_get_avpf_rr_interval (const LinphoneCore *core)
 Return the avpf report interval in seconds. More...
 
LinphoneStatus linphone_core_set_audio_multicast_addr (LinphoneCore *core, const char *ip)
 Use to set multicast address to be used for audio stream. More...
 
LinphoneStatus linphone_core_set_video_multicast_addr (LinphoneCore *core, const char *ip)
 Use to set multicast address to be used for video stream. More...
 
const char * linphone_core_get_audio_multicast_addr (const LinphoneCore *core)
 Use to get multicast address to be used for audio stream. More...
 
const char * linphone_core_get_video_multicast_addr (const LinphoneCore *core)
 Use to get multicast address to be used for video stream. More...
 
LinphoneStatus linphone_core_set_audio_multicast_ttl (LinphoneCore *core, int ttl)
 Use to set multicast ttl to be used for audio stream. More...
 
LinphoneStatus linphone_core_set_video_multicast_ttl (LinphoneCore *core, int ttl)
 Use to set multicast ttl to be used for video stream. More...
 
int linphone_core_get_audio_multicast_ttl (const LinphoneCore *core)
 Use to get multicast ttl to be used for audio stream. More...
 
int linphone_core_get_video_multicast_ttl (const LinphoneCore *core)
 Use to get multicast ttl to be used for video stream. More...
 
void linphone_core_enable_audio_multicast (LinphoneCore *core, bool_t yesno)
 Use to enable multicast rtp for audio stream. More...
 
bool_t linphone_core_audio_multicast_enabled (const LinphoneCore *core)
 Use to get multicast state of audio stream. More...
 
void linphone_core_enable_video_multicast (LinphoneCore *core, bool_t yesno)
 Use to enable multicast rtp for video stream. More...
 
bool_t linphone_core_video_multicast_enabled (const LinphoneCore *core)
 Use to get multicast state of video stream. More...
 
bool_t linphone_core_rtp_bundle_enabled (const LinphoneCore *core)
 Returns whether RTP bundle mode (also known as Media Multiplexing) is enabled. More...
 
void linphone_core_enable_rtp_bundle (LinphoneCore *core, bool_t value)
 Enables or disables RTP bundle mode (Media Multiplexing). More...
 
LinphoneStatus linphone_core_set_network_simulator_params (LinphoneCore *core, const OrtpNetworkSimulatorParams *params)
 Set the network simulator parameters. More...
 
const OrtpNetworkSimulatorParams * linphone_core_get_network_simulator_params (const LinphoneCore *core)
 Get the previously set network simulation parameters. More...
 
void linphone_core_set_video_preset (LinphoneCore *core, const char *preset)
 Set the video preset to be used for video calls. More...
 
const char * linphone_core_get_video_preset (const LinphoneCore *core)
 Get the video preset used for video calls. More...
 
bool_t linphone_core_realtime_text_enabled (LinphoneCore *core)
 Gets if realtime text is enabled or not. More...
 
unsigned int linphone_core_realtime_text_get_keepalive_interval (const LinphoneCore *core)
 Gets keep alive interval of real time text. More...
 
MS2_DEPRECATED void linphone_core_send_dtmf (LinphoneCore *core, char dtmf)
 Send the specified dtmf. More...
 
MS2_DEPRECATED const bctbx_list_t * linphone_core_get_audio_codecs (const LinphoneCore *core)
 Returns the list of available audio codecs. More...
 
MS2_DEPRECATED LinphoneStatus linphone_core_set_audio_codecs (LinphoneCore *core, bctbx_list_t *codecs)
 Sets the list of audio codecs. More...
 
MS2_DEPRECATED const bctbx_list_t * linphone_core_get_video_codecs (const LinphoneCore *core)
 Returns the list of available video codecs. More...
 
MS2_DEPRECATED LinphoneStatus linphone_core_set_video_codecs (LinphoneCore *core, bctbx_list_t *codecs)
 Sets the list of video codecs. More...
 
MS2_DEPRECATED const bctbx_list_t * linphone_core_get_text_codecs (const LinphoneCore *core)
 Returns the list of available text codecs. More...
 
MS2_DEPRECATED LinphoneStatus linphone_core_set_text_codecs (LinphoneCore *core, bctbx_list_t *codecs)
 Sets the list of text codecs. More...
 
MS2_DEPRECATED bool_t linphone_core_payload_type_enabled (const LinphoneCore *core, const OrtpPayloadType *pt)
 Tells whether the specified payload type is enabled. More...
 
MS2_DEPRECATED bool_t linphone_core_payload_type_is_vbr (const LinphoneCore *core, const OrtpPayloadType *pt)
 Tells whether the specified payload type represents a variable bitrate codec. More...
 
MS2_DEPRECATED void linphone_core_set_payload_type_bitrate (LinphoneCore *core, OrtpPayloadType *pt, int bitrate)
 Set an explicit bitrate (IP bitrate, not codec bitrate) for a given codec, in kbit/s. More...
 
MS2_DEPRECATED int linphone_core_get_payload_type_bitrate (LinphoneCore *core, const OrtpPayloadType *pt)
 Get the bitrate explicitely set with linphone_core_set_payload_type_bitrate(). More...
 
MS2_DEPRECATED LinphoneStatus linphone_core_enable_payload_type (LinphoneCore *core, OrtpPayloadType *pt, bool_t enable)
 Enable or disable the use of the specified payload type. More...
 
MS2_DEPRECATED OrtpPayloadType * linphone_core_find_payload_type (LinphoneCore *core, const char *type, int rate, int channels)
 Get payload type from mime type and clock rate. More...
 
MS2_DEPRECATED int linphone_core_get_payload_type_number (LinphoneCore *core, const OrtpPayloadType *pt)
 Returns the payload type number assigned for this codec. More...
 
MS2_DEPRECATED void linphone_core_set_payload_type_number (LinphoneCore *core, OrtpPayloadType *pt, int number)
 Force a number for a payload type. More...
 
MS2_DEPRECATED bool_t linphone_core_check_payload_type_usability (LinphoneCore *core, const OrtpPayloadType *pt)
 Return TRUE if codec can be used with bandwidth, FALSE else. More...
 
MS2_DEPRECATED const char ** linphone_core_get_sound_devices (LinphoneCore *core)
 Gets the list of the available sound devices. More...
 
MS2_DEPRECATED bool_t linphone_core_sound_device_can_capture (LinphoneCore *core, const char *device)
 Tells whether a specified sound device can capture sound. More...
 
MS2_DEPRECATED bool_t linphone_core_sound_device_can_playback (LinphoneCore *core, const char *device)
 Tells whether a specified sound device can play sound. More...
 
MS2_DEPRECATED int linphone_core_get_ring_level (LinphoneCore *core)
 Get ring sound level in 0-100 scale. More...
 
MS2_DEPRECATED int linphone_core_get_play_level (LinphoneCore *core)
 Get playback sound level in 0-100 scale. More...
 
MS2_DEPRECATED int linphone_core_get_rec_level (LinphoneCore *core)
 Get sound capture level in 0-100 scale. More...
 
MS2_DEPRECATED int linphone_core_get_media_level (LinphoneCore *core)
 Get sound media level in 0-100 scale. More...
 
MS2_DEPRECATED void linphone_core_set_ring_level (LinphoneCore *core, int level)
 Set sound ring level in 0-100 scale. More...
 
MS2_DEPRECATED void linphone_core_set_play_level (LinphoneCore *core, int level)
 Set sound playback level in 0-100 scale. More...
 
MS2_DEPRECATED void linphone_core_set_rec_level (LinphoneCore *core, int level)
 Set sound capture level in 0-100 scale. More...
 
MS2_DEPRECATED void linphone_core_set_media_level (LinphoneCore *core, int level)
 Set sound media level in 0-100 scale. More...
 
MS2_DEPRECATED void linphone_core_enable_video (LinphoneCore *core, bool_t vcap_enabled, bool_t display_enabled)
 Enables video globally. More...
 
MS2_DEPRECATED void linphone_core_set_video_policy (LinphoneCore *core, const LinphoneVideoPolicy *policy)
 Sets the default policy for video. More...
 
MS2_DEPRECATED const LinphoneVideoPolicylinphone_core_get_video_policy (const LinphoneCore *core)
 Get the default policy for video. More...
 
MS2_DEPRECATED const MSVideoSizeDeflinphone_core_get_supported_video_sizes (LinphoneCore *core)
 Returns the zero terminated table of supported video resolutions. More...
 
MS2_DEPRECATED void linphone_core_set_preferred_video_size (LinphoneCore *core, MSVideoSize vsize)
 Sets the preferred video size. More...
 
MS2_DEPRECATED void linphone_core_set_preview_video_size (LinphoneCore *core, MSVideoSize vsize)
 Sets the video size for the captured (preview) video. More...
 
MS2_DEPRECATED void linphone_core_set_preview_video_size_by_name (LinphoneCore *core, const char *name)
 Sets the preview video size by its name. More...
 
MS2_DEPRECATED MSVideoSize linphone_core_get_preview_video_size (const LinphoneCore *core)
 Returns video size for the captured video if it was previously set by linphone_core_set_preview_video_size(), otherwise returns a 0,0 size. More...
 
MS2_DEPRECATED MSVideoSize linphone_core_get_current_preview_video_size (const LinphoneCore *core)
 Returns the effective video size for the captured video as provided by the camera. More...
 
MS2_DEPRECATED MSVideoSize linphone_core_get_preferred_video_size (const LinphoneCore *core)
 Returns the current preferred video size for sending. More...
 
MS2_DEPRECATED void linphone_core_set_preferred_video_size_by_name (LinphoneCore *core, const char *name)
 Sets the preferred video size by its name. More...
 
MS2_DEPRECATED const char ** linphone_core_get_video_devices (const LinphoneCore *core)
 Gets the list of the available video capture devices. More...
 
MS2_DEPRECATED const char ** linphone_core_get_supported_file_formats (LinphoneCore *core)
 Returns a null terminated table of strings containing the file format extension supported for call recording. More...
 
const char * linphone_media_encryption_to_string (LinphoneMediaEncryption media_encryption)
 Convert enum member to string. More...
 
int linphone_media_encryption_from_string (const char *value)
 Convert string to enum member. More...
 
LinphonePayloadTypelinphone_payload_type_clone (const LinphonePayloadType *orig)
 Instantiates a new payload type with values from source. More...
 
LinphonePayloadTypelinphone_payload_type_ref (LinphonePayloadType *payload_type)
 Take a reference on a LinphonePayloadType. More...
 
void linphone_payload_type_unref (LinphonePayloadType *payload_type)
 Release a reference on a LinphonePayloadType. More...
 
int linphone_payload_type_get_type (const LinphonePayloadType *payload_type)
 Get the type of a payload type. More...
 
int linphone_payload_type_enable (LinphonePayloadType *payload_type, bool_t enabled)
 Enable/disable a payload type. More...
 
bool_t linphone_payload_type_enabled (const LinphonePayloadType *payload_type)
 Check whether a palyoad type is enabled. More...
 
char * linphone_payload_type_get_description (const LinphonePayloadType *payload_type)
 Return a string describing a payload type. More...
 
const char * linphone_payload_type_get_encoder_description (const LinphonePayloadType *payload_type)
 Get a description of the encoder used to provide a payload type. More...
 
int linphone_payload_type_get_normal_bitrate (const LinphonePayloadType *payload_type)
 Get the normal bitrate in bits/s. More...
 
void linphone_payload_type_set_normal_bitrate (LinphonePayloadType *payload_type, int bitrate)
 Change the normal bitrate of a payload type. More...
 
const char * linphone_payload_type_get_mime_type (const LinphonePayloadType *payload_type)
 Get the mime type. More...
 
int linphone_payload_type_get_channels (const LinphonePayloadType *payload_type)
 Get the number of channels. More...
 
int linphone_payload_type_get_number (const LinphonePayloadType *payload_type)
 Returns the payload type number assigned for this codec. More...
 
void linphone_payload_type_set_number (LinphonePayloadType *payload_type, int number)
 Force a number for a payload type. More...
 
const char * linphone_payload_type_get_recv_fmtp (const LinphonePayloadType *payload_type)
 Get the format parameters for incoming streams. More...
 
void linphone_payload_type_set_recv_fmtp (LinphonePayloadType *payload_type, const char *recv_fmtp)
 Set the format parameters for incoming streams. More...
 
const char * linphone_payload_type_get_send_fmtp (const LinphonePayloadType *payload_type)
 Get the format parameters for outgoing streams. More...
 
void linphone_payload_type_set_send_fmtp (LinphonePayloadType *payload_type, const char *send_fmtp)
 Set the format parameters for outgoing streams. More...
 
int linphone_payload_type_get_clock_rate (const LinphonePayloadType *payload_type)
 Get the clock rate of a payload type. More...
 
bool_t linphone_payload_type_is_vbr (const LinphonePayloadType *payload_type)
 Tells whether the specified payload type represents a variable bitrate codec. More...
 
bool_t linphone_payload_type_is_usable (const LinphonePayloadType *payload_type)
 Check whether the payload is usable according the bandwidth targets set in the core. More...
 
LinphoneVideoDefinitionlinphone_video_definition_ref (LinphoneVideoDefinition *video_definition)
 Acquire a reference to the video definition. More...
 
void linphone_video_definition_unref (LinphoneVideoDefinition *video_definition)
 Release reference to the video definition. More...
 
void * linphone_video_definition_get_user_data (const LinphoneVideoDefinition *video_definition)
 Retrieve the user pointer associated with the video definition. More...
 
void linphone_video_definition_set_user_data (LinphoneVideoDefinition *video_definition, void *user_data)
 Assign a user pointer to the video definition. More...
 
LinphoneVideoDefinitionlinphone_video_definition_clone (const LinphoneVideoDefinition *video_definition)
 Clone a video definition. More...
 
unsigned int linphone_video_definition_get_width (const LinphoneVideoDefinition *video_definition)
 Get the width of the video definition. More...
 
void linphone_video_definition_set_width (LinphoneVideoDefinition *video_definition, unsigned int width)
 Set the width of the video definition. More...
 
unsigned int linphone_video_definition_get_height (const LinphoneVideoDefinition *video_definition)
 Get the height of the video definition. More...
 
void linphone_video_definition_set_height (LinphoneVideoDefinition *video_definition, unsigned int height)
 Set the height of the video definition. More...
 
void linphone_video_definition_set_definition (LinphoneVideoDefinition *video_definition, unsigned int width, unsigned int height)
 Set the width and the height of the video definition. More...
 
const char * linphone_video_definition_get_name (const LinphoneVideoDefinition *video_definition)
 Get the name of the video definition. More...
 
void linphone_video_definition_set_name (LinphoneVideoDefinition *video_definition, const char *name)
 Set the name of the video definition. More...
 
bool_t linphone_video_definition_equals (const LinphoneVideoDefinition *video_definition1, const LinphoneVideoDefinition *video_definition2)
 Tells whether two LinphoneVideoDefinition objects are equal (the widths and the heights are the same but can be switched). More...
 
bool_t linphone_video_definition_strict_equals (const LinphoneVideoDefinition *video_definition1, const LinphoneVideoDefinition *video_definition2)
 Tells whether two LinphoneVideoDefinition objects are strictly equal (the widths are the same and the heights are the same). More...
 
bool_t linphone_video_definition_is_undefined (const LinphoneVideoDefinition *video_definition)
 Tells whether a LinphoneVideoDefinition is undefined. More...
 
void * linphone_call_get_native_video_window_id (const LinphoneCall *call)
 Get the native window handle of the video window, casted as an unsigned long. More...
 
void linphone_call_set_native_video_window_id (LinphoneCall *call, void *window_id)
 Set the native video window id where the video is to be displayed. More...
 
void linphone_call_enable_echo_cancellation (LinphoneCall *call, bool_t enable)
 Enables or disable echo cancellation for this call. More...
 
bool_t linphone_call_echo_cancellation_enabled (const LinphoneCall *call)
 Returns if echo cancellation is enabled. More...
 
void linphone_call_enable_echo_limiter (LinphoneCall *call, bool_t enable)
 Enables or disable echo limiter for this call. More...
 
bool_t linphone_call_echo_limiter_enabled (const LinphoneCall *call)
 Returns if echo limiter is enabled. More...
 

Detailed Description

Controlling media parameters.

Multicast

Call using rtp multicast addresses are supported for both audio and video with some limitations. Limitations are, no stun, no ice, no encryption.

Typedef Documentation

◆ LinphoneVideoActivationPolicy

typedef struct _LinphoneVideoActivationPolicy LinphoneVideoActivationPolicy

Object describing policy regarding video streams establishments.

Use linphone_video_activation_policy_set_automatically_accept() and linphone_video_activation_policy_set_automatically_initiate() to tell the Core to automatically accept or initiate video during calls.

Even if disabled, you'll still be able to add it later while the call is running.

◆ LinphoneVideoDefinition

typedef struct _LinphoneVideoDefinition LinphoneVideoDefinition

This object represents a video definition, eg.

it's width, it's height and possibly it's name.

It is mostly used to configure the default video size sent by your camera during a video call with linphone_core_set_preferred_video_definition() method.

◆ LinphoneVideoPolicy

Structure describing policy regarding video streams establishments.

Deprecated:
18/04/17

Enumeration Type Documentation

◆ _LinphoneAVPFMode

Enum describing RTP AVPF activation modes.

Enumerator
LinphoneAVPFDefault 

Use default value defined at upper level.

LinphoneAVPFDisabled 

AVPF is disabled.

LinphoneAVPFEnabled 

AVPF is enabled.

◆ _LinphoneEcCalibratorStatus

Enum describing the result of the echo canceller calibration process.

Enumerator
LinphoneEcCalibratorInProgress 

The echo canceller calibration process is on going.

LinphoneEcCalibratorDone 

The echo canceller calibration has been performed and produced an echo delay measure.

LinphoneEcCalibratorFailed 

The echo canceller calibration process has failed.

LinphoneEcCalibratorDoneNoEcho 

The echo canceller calibration has been performed and no echo has been detected.

◆ _LinphoneMediaEncryption

Enum describing type of media encryption types.

Enumerator
LinphoneMediaEncryptionNone 

No media encryption is used.

LinphoneMediaEncryptionSRTP 

Use SRTP media encryption.

LinphoneMediaEncryptionZRTP 

Use ZRTP media encryption.

LinphoneMediaEncryptionDTLS 

Use DTLS media encryption.

◆ _LinphoneMediaResourceMode

Media resource usage.

Enumerator
LinphoneExclusiveMediaResources 

Media resources are not shared.

LinphoneSharedMediaResources 

Media resources are shared.

◆ _LinphoneZrtpPeerStatus

Enum describing the ZRTP SAS validation status of a peer URI.

Enumerator
LinphoneZrtpPeerStatusUnknown 

Peer URI unkown or never validated/invalidated the SAS.

LinphoneZrtpPeerStatusInvalid 

Peer URI SAS rejected in database.

LinphoneZrtpPeerStatusValid 

Peer URI SAS validated in database.

Function Documentation

◆ linphone_call_echo_cancellation_enabled()

bool_t linphone_call_echo_cancellation_enabled ( const LinphoneCall call)

Returns if echo cancellation is enabled.

Parameters
callthe LinphoneCall object
Returns
TRUE if echo cancellation is enabled, FALSE otherwise.

◆ linphone_call_echo_limiter_enabled()

bool_t linphone_call_echo_limiter_enabled ( const LinphoneCall call)

Returns if echo limiter is enabled.

Parameters
callthe LinphoneCall object
Returns
TRUE if echo limiter is enabled, FALSE otherwise.

◆ linphone_call_enable_echo_cancellation()

void linphone_call_enable_echo_cancellation ( LinphoneCall call,
bool_t  enable 
)

Enables or disable echo cancellation for this call.

Parameters
callthe LinphoneCall object
enablewether to enable echo cancellation or not.

◆ linphone_call_enable_echo_limiter()

void linphone_call_enable_echo_limiter ( LinphoneCall call,
bool_t  enable 
)

Enables or disable echo limiter for this call.

Parameters
callthe LinphoneCall object
enablewether to enable echo limiter or not.

◆ linphone_call_get_native_video_window_id()

void* linphone_call_get_native_video_window_id ( const LinphoneCall call)

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

Parameters
callthe LinphoneCall object
Returns
the native video window id (type may vary depending on platform).

◆ linphone_call_params_add_custom_content()

void linphone_call_params_add_custom_content ( LinphoneCallParams params,
LinphoneContent content 
)

Adds a LinphoneContent to be added to the INVITE SDP.

Parameters
paramsThe LinphoneCallParams in which to set the custom LinphoneContent.
contentThe LinphoneContent to be added.

◆ linphone_call_params_add_custom_sdp_attribute()

void linphone_call_params_add_custom_sdp_attribute ( LinphoneCallParams params,
const char *  attribute_name,
const char *  attribute_value 
)

Add a custom attribute related to all the streams in the SDP exchanged within SIP messages during a call.

Parameters
paramsThe LinphoneCallParams to add a custom SDP attribute to.
attribute_nameThe name of the attribute to add.
attribute_valueThe content value of the attribute to add.

◆ linphone_call_params_add_custom_sdp_media_attribute()

void linphone_call_params_add_custom_sdp_media_attribute ( LinphoneCallParams params,
LinphoneStreamType  type,
const char *  attribute_name,
const char *  attribute_value 
)

Add a custom attribute related to a specific stream in the SDP exchanged within SIP messages during a call.

Parameters
paramsThe LinphoneCallParams to add a custom SDP attribute to.
typeThe type of the stream to add a custom SDP attribute to.
attribute_nameThe name of the attribute to add.
attribute_valueThe content value of the attribute to add.

◆ linphone_call_params_audio_multicast_enabled()

bool_t linphone_call_params_audio_multicast_enabled ( const LinphoneCallParams params)

Use to get multicast state of audio stream.

Parameters
paramsLinphoneCallParams
Returns
true if subsequent calls will propose multicast ip set by linphone_core_set_audio_multicast_addr()

◆ linphone_call_params_capability_negotiation_reinvite_enabled()

bool_t linphone_call_params_capability_negotiation_reinvite_enabled ( const LinphoneCallParams params)

Check if the capability negotiation (RFC5939) reINVITE is enabled or not.

Parameters
paramsthe LinphoneCallParams
Returns
TRUE if capability negotiation reINVITE is enabled; FALSE otherwise.

◆ linphone_call_params_capability_negotiations_enabled()

bool_t linphone_call_params_capability_negotiations_enabled ( const LinphoneCallParams params)

Indicates whether capability negotiations (RFC5939) is enabled.

Parameters
paramsthe LinphoneCallParams
Returns
a boolean indicating the enablement of capability negotiations.

◆ linphone_call_params_clear_custom_sdp_attributes()

void linphone_call_params_clear_custom_sdp_attributes ( LinphoneCallParams params)

Clear the custom SDP attributes related to all the streams in the SDP exchanged within SIP messages during a call.

Parameters
paramsThe LinphoneCallParams to clear the custom SDP attributes from.

◆ linphone_call_params_clear_custom_sdp_media_attributes()

void linphone_call_params_clear_custom_sdp_media_attributes ( LinphoneCallParams params,
LinphoneStreamType  type 
)

Clear the custom SDP attributes related to a specific stream in the SDP exchanged within SIP messages during a call.

Parameters
paramsThe LinphoneCallParams to clear the custom SDP attributes from.
typeThe type of the stream to clear the custom SDP attributes from.

◆ linphone_call_params_enable_audio_multicast()

void linphone_call_params_enable_audio_multicast ( LinphoneCallParams params,
bool_t  yesno 
)

Use to enable multicast rtp for audio stream.

◆ linphone_call_params_enable_capability_negotiation_reinvite()

void linphone_call_params_enable_capability_negotiation_reinvite ( LinphoneCallParams params,
bool_t  enable 
)

Define whether capability negotiation (RFC5939) reINVITE is enabled.

Parameters
paramsthe LinphoneCallParams
enableTRUE to enable capability negotiation reINVITE; FALSE otherwise.

◆ linphone_call_params_enable_realtime_text()

LinphoneStatus linphone_call_params_enable_realtime_text ( LinphoneCallParams params,
bool_t  yesno 
)

Use to enable real time text following rfc4103.

If enabled, outgoing calls put a m=text line in SDP offer .

Parameters
paramsLinphoneCallParams
yesnoif yes, subsequent outgoing calls will propose rtt
Returns
0

◆ linphone_call_params_enable_rtp_bundle()

void linphone_call_params_enable_rtp_bundle ( LinphoneCallParams params,
bool_t  value 
)

Enables or disables RTP bundle mode (Media Multiplexing).

See https://tools.ietf.org/html/draft-ietf-mmusic-sdp-bundle-negotiation-54 for more information about the feature. When enabled, liblinphone will try to negociate the use of a single port for all streams. It automatically enables rtcp-mux.

Parameters
paramsthe LinphoneCallParams
valuea boolean to indicate whether the feature is to be enabled.

◆ linphone_call_params_enable_video_multicast()

void linphone_call_params_enable_video_multicast ( LinphoneCallParams params,
bool_t  yesno 
)

Use to enable multicast rtp for video stream.

If enabled, outgoing calls put a multicast address from linphone_core_get_video_multicast_addr() into video cline. In case of outgoing call video stream is sent to this multicast address.
For incoming calls behavior is unchanged.

Parameters
paramsLinphoneCallParams
yesnoif yes, subsequent outgoing calls will propose multicast ip set by linphone_core_set_video_multicast_addr()

◆ linphone_call_params_get_custom_contents()

bctbx_list_t* linphone_call_params_get_custom_contents ( const LinphoneCallParams params)

Gets a list of LinphoneContent set if exists.

Parameters
paramsThe LinphoneCallParams to get the custom Content from.
Returns
A list of LinphoneContent set if exists, NULL otherwise.

◆ linphone_call_params_get_custom_sdp_attribute()

const char* linphone_call_params_get_custom_sdp_attribute ( const LinphoneCallParams params,
const char *  attribute_name 
)

Get a custom SDP attribute that is related to all the streams.

Parameters
paramsThe LinphoneCallParams to get the custom SDP attribute from.
attribute_nameThe name of the attribute to get.
Returns
The content value of the attribute or NULL if not found.

◆ linphone_call_params_get_custom_sdp_media_attribute()

const char* linphone_call_params_get_custom_sdp_media_attribute ( const LinphoneCallParams params,
LinphoneStreamType  type,
const char *  attribute_name 
)

Get a custom SDP attribute that is related to a specific stream.

Parameters
paramsThe LinphoneCallParams to get the custom SDP attribute from.
typeThe type of the stream to add a custom SDP attribute to.
attribute_nameThe name of the attribute to get.
Returns
The content value of the attribute or NULL if not found.

◆ linphone_call_params_get_realtime_text_keepalive_interval()

unsigned int linphone_call_params_get_realtime_text_keepalive_interval ( const LinphoneCallParams params)

Use to get keep alive interval of real time text following rfc4103.

Parameters
paramsLinphoneCallParams
Returns
returns keep alive interval of real time text.

◆ linphone_call_params_get_supported_encryptions()

bctbx_list_t* linphone_call_params_get_supported_encryptions ( const LinphoneCallParams params)

Returns the list of supported encryptions in the call.

Parameters
paramsthe LinphoneCallParams
Returns
a list of encryptions supported in a given call

◆ linphone_call_params_is_capability_negotiation_reinvite_enabled()

bool_t linphone_call_params_is_capability_negotiation_reinvite_enabled ( const LinphoneCallParams params)

Check if the capability negotiation (RFC5939) reINVITE is enabled or not.

Parameters
paramsthe LinphoneCallParams
Returns
TRUE if capability negotiation reINVITE is enabled; FALSE otherwise.
Deprecated:
16/12/2021 Use linphone_call_params_capability_negotiation_reinvite_enabled() instead.

◆ linphone_call_params_is_media_encryption_supported()

bool_t linphone_call_params_is_media_encryption_supported ( const LinphoneCallParams params,
const LinphoneMediaEncryption  encryption 
)

Returns the encryption is supported.

Parameters
paramsthe LinphoneCallParams
encryptionThe LinphoneMediaEncryption to check whether is supported
Returns
a boolean indicating whether the encryption is supported

◆ linphone_call_params_realtime_text_enabled()

bool_t linphone_call_params_realtime_text_enabled ( const LinphoneCallParams params)

Use to get real time text following rfc4103.

Parameters
paramsLinphoneCallParams
Returns
returns true if call rtt is activated.

◆ linphone_call_params_rtp_bundle_enabled()

bool_t linphone_call_params_rtp_bundle_enabled ( const LinphoneCallParams params)

Indicates whether RTP bundle mode (also known as Media Multiplexing) is enabled.

See https://tools.ietf.org/html/draft-ietf-mmusic-sdp-bundle-negotiation-54 for more information.

Parameters
paramsthe LinphoneCallParams
Returns
a boolean indicating the enablement of rtp bundle mode.

◆ linphone_call_params_set_realtime_text_keepalive_interval()

void linphone_call_params_set_realtime_text_keepalive_interval ( LinphoneCallParams params,
unsigned int  interval 
)

Use to set keep alive interval for real time text following rfc4103.

Parameters
paramsLinphoneCallParams
intervalThe keep alive interval for real time text, 25000 by default.

◆ linphone_call_params_tcap_lines_merged()

bool_t linphone_call_params_tcap_lines_merged ( const LinphoneCallParams params)

Indicates whether tcap lines with consecutive indexes are going to be merged or not if capability negotiations (RFC5939) is enabled.

Parameters
paramsthe LinphoneCallParams
Returns
a boolean indicating the enablement of tcap line merging

◆ linphone_call_params_video_multicast_enabled()

bool_t linphone_call_params_video_multicast_enabled ( const LinphoneCallParams params)

Use to get multicast state of video stream.

Parameters
paramsLinphoneCallParams
Returns
true if subsequent calls will propose multicast ip set by linphone_core_set_video_multicast_addr()

◆ linphone_call_set_native_video_window_id()

void linphone_call_set_native_video_window_id ( LinphoneCall call,
void *  window_id 
)

Set the native video window id where the video is to be displayed.

For MacOS, Linux, Windows: if not set or 0 a window will be automatically created, unless the special id -1 is given.

Parameters
callthe LinphoneCall object
window_idthe native video window id.

◆ linphone_core_adaptive_rate_control_enabled()

bool_t linphone_core_adaptive_rate_control_enabled ( const LinphoneCore core)

Returns whether adaptive rate control is enabled.

See also
linphone_core_enable_adaptive_rate_control()
Parameters
corethe LinphoneCore
Returns
TRUE if adaptive rate control is enabled, FALSE otherwise

◆ linphone_core_audio_adaptive_jittcomp_enabled()

bool_t linphone_core_audio_adaptive_jittcomp_enabled ( LinphoneCore core)

Tells whether the audio adaptive jitter compensation is enabled.

Parameters
coreLinphoneCore object
Returns
TRUE if the audio adaptive jitter compensation is enabled, FALSE otherwise.

◆ linphone_core_audio_multicast_enabled()

bool_t linphone_core_audio_multicast_enabled ( const LinphoneCore core)

Use to get multicast state of audio stream.

Parameters
coreLinphoneCore
Returns
TRUE if subsequent calls will propose multicast ip set by linphone_core_set_audio_multicast_addr()

◆ linphone_core_capability_negociation_enabled()

bool_t linphone_core_capability_negociation_enabled ( const LinphoneCore core)

Check if the capability negotiation (RFC5939) is supported or not.

Parameters
coreLinphoneCore object.
Returns
TRUE if capability negotiation is supported; FALSE otherwise.

◆ linphone_core_capability_negotiation_reinvite_enabled()

bool_t linphone_core_capability_negotiation_reinvite_enabled ( const LinphoneCore core)

Check if the capability negotiation (RFC5939) reINVITE is enabled or not.

Parameters
coreLinphoneCore object.
Returns
TRUE if capability negotiation reINVITE is enabled; FALSE otherwise.

◆ linphone_core_check_payload_type_usability()

MS2_DEPRECATED bool_t linphone_core_check_payload_type_usability ( LinphoneCore core,
const OrtpPayloadType *  pt 
)

Return TRUE if codec can be used with bandwidth, FALSE else.

Deprecated:
31/03/2017 Use linphone_payload_type_is_usable() instead.

◆ linphone_core_dns_search_enabled()

bool_t linphone_core_dns_search_enabled ( const LinphoneCore core)

Tells whether DNS search (use of local domain if the fully qualified name did return results) is enabled.

Parameters
coreLinphoneCore object.
Returns
TRUE if DNS search is enabled, FALSE if disabled.

◆ linphone_core_dns_srv_enabled()

bool_t linphone_core_dns_srv_enabled ( const LinphoneCore core)

Tells whether DNS SRV resolution is enabled.

Parameters
coreLinphoneCore object.
Returns
TRUE if DNS SRV resolution is enabled, FALSE if disabled.

◆ linphone_core_echo_cancellation_enabled()

bool_t linphone_core_echo_cancellation_enabled ( const LinphoneCore core)

Returns TRUE if echo cancellation is enabled.

Parameters
coreLinphoneCore object
Returns
A boolean value telling whether echo cancellation is enabled or disabled

◆ linphone_core_echo_limiter_enabled()

bool_t linphone_core_echo_limiter_enabled ( const LinphoneCore core)

Tells whether echo limiter is enabled.

Parameters
coreLinphoneCore object.
Returns
TRUE if the echo limiter is enabled, FALSE otherwise.

◆ linphone_core_enable_adaptive_rate_control()

void linphone_core_enable_adaptive_rate_control ( LinphoneCore core,
bool_t  enabled 
)

Enable adaptive rate control.

Adaptive rate control consists in using RTCP feedback provided information to dynamically control the output bitrate of the audio and video encoders, so that we can adapt to the network conditions and available bandwidth. Control of the audio encoder is done in case of audio-only call, and control of the video encoder is done for audio & video calls. Adaptive rate control feature is enabled by default.

Parameters
corethe LinphoneCore
enabledTRUE to enable adaptive rate control, FALSE otherwise

◆ linphone_core_enable_audio_adaptive_jittcomp()

void linphone_core_enable_audio_adaptive_jittcomp ( LinphoneCore core,
bool_t  enable 
)

Enable or disable the audio adaptive jitter compensation.

Parameters
coreLinphoneCore object
enableTRUE to enable the audio adaptive jitter compensation, FALSE to disable it.

◆ linphone_core_enable_audio_multicast()

void linphone_core_enable_audio_multicast ( LinphoneCore core,
bool_t  yesno 
)

Use to enable multicast rtp for audio stream.

If enabled, outgoing calls put a multicast address from linphone_core_get_video_multicast_addr() into audio cline. In case of outgoing call audio stream is sent to this multicast address. For incoming calls behavior is unchanged.

Parameters
coreLinphoneCore
yesnoif yes, subsequent calls will propose multicast ip set by linphone_core_set_audio_multicast_addr()

◆ linphone_core_enable_capability_negociation()

void linphone_core_enable_capability_negociation ( LinphoneCore core,
bool_t  enable 
)

Define whether capability negotiation (RFC5939) is supported.

Parameters
coreLinphoneCore object.
supportTRUE to support RFC5939; FALSE otherwise.

◆ linphone_core_enable_capability_negotiation_reinvite()

void linphone_core_enable_capability_negotiation_reinvite ( LinphoneCore core,
bool_t  enable 
)

Define whether capability negotiation (RFC5939) reINVITE is enabled.

Parameters
coreLinphoneCore object.
enableTRUE to enable capability negotiation reINVITE; FALSE otherwise.

◆ linphone_core_enable_dns_search()

void linphone_core_enable_dns_search ( LinphoneCore core,
bool_t  enable 
)

Enable or disable DNS search (use of local domain if the fully qualified name did return results).

Parameters
coreLinphoneCore object.
enableTRUE to enable DNS search, FALSE to disable it.

◆ linphone_core_enable_dns_srv()

void linphone_core_enable_dns_srv ( LinphoneCore core,
bool_t  enable 
)

Enable or disable DNS SRV resolution.

Parameters
coreLinphoneCore object.
enableTRUE to enable DNS SRV resolution, FALSE to disable it.

◆ linphone_core_enable_echo_cancellation()

void linphone_core_enable_echo_cancellation ( LinphoneCore core,
bool_t  enable 
)

Enables or disable echo cancellation.

Value is saved and used for subsequent calls. This actually controls software echo cancellation. If hardware echo cancellation is available, it will be always used and activated for calls, regardless of the value passed to this function. When hardware echo cancellation is available, the software one is of course not activated.

Parameters
coreLinphoneCore object
enableA boolean value telling whether echo cancellation is to be enabled or disabled.

◆ linphone_core_enable_echo_limiter()

void linphone_core_enable_echo_limiter ( LinphoneCore core,
bool_t  enable 
)

Enables or disable echo limiter.

Parameters
coreLinphoneCore object.
enableTRUE to enable echo limiter, FALSE to disable it.

◆ linphone_core_enable_mic()

void linphone_core_enable_mic ( LinphoneCore core,
bool_t  enable 
)

Enable or disable the microphone.

This effectively enable or disable microphone (mute) for currently the running call or conference if any, as well as it applies to future currently running calls or conferences.

Parameters
coreLinphoneCore object
enableTRUE to enable the microphone, FALSE to disable it.

◆ linphone_core_enable_native_ringing()

void linphone_core_enable_native_ringing ( LinphoneCore core,
bool_t  enable 
)

Sets whether to use the native ringing (Android only).

Parameters
coreLinphoneCore object
enableTrue to enable native ringing, false otherwise

◆ linphone_core_enable_payload_type()

MS2_DEPRECATED LinphoneStatus linphone_core_enable_payload_type ( LinphoneCore core,
OrtpPayloadType *  pt,
bool_t  enable 
)

Enable or disable the use of the specified payload type.

Parameters
coreLinphoneCore object.
ptThe payload type to enable or disable. It can be retrieved using linphone_core_find_payload_type()
enableTRUE to enable the payload type, FALSE to disable it.
Returns
0 if successful, any other value otherwise.
Deprecated:
31/03/2017 Use linphone_payload_type_enable().

◆ linphone_core_enable_qrcode_video_preview()

void linphone_core_enable_qrcode_video_preview ( LinphoneCore core,
bool_t  enable 
)

Controls QRCode enablement.

Parameters
coreLinphoneCore object
enableA boolean value telling whether the QRCode is enabled in the preview.

◆ linphone_core_enable_retransmission_on_nack()

void linphone_core_enable_retransmission_on_nack ( LinphoneCore core,
bool_t  enable 
)

Turns NACK context on or off.

Parameters
coreLinphoneCore object
enableA boolean value telling whether to enable NACK context

◆ linphone_core_enable_rtp_bundle()

void linphone_core_enable_rtp_bundle ( LinphoneCore core,
bool_t  value 
)

Enables or disables RTP bundle mode (Media Multiplexing).

See https://tools.ietf.org/html/draft-ietf-mmusic-sdp-bundle-negotiation-54 for more information about the feature. When enabled, liblinphone will try to negociate the use of a single port for all streams when doing an outgoing call. It automatically enables rtcp-mux. This feature can also be enabled per-call using LinphoneCallParams.

Parameters
corethe LinphoneCore
valuea boolean to indicate whether the feature is to be enabled.

◆ linphone_core_enable_self_view()

void linphone_core_enable_self_view ( LinphoneCore core,
bool_t  enable 
)

Enables or disable self view during calls.

Parameters
coreLinphoneCore object
enableA boolean value telling whether to enable self view Self-view refers to having local webcam image inserted in corner of the video window during calls. This function works at any time, including during calls.

◆ linphone_core_enable_session_expires()

void linphone_core_enable_session_expires ( const LinphoneCore core,
bool_t  enabled 
)

Enable the Session Timers support.

Parameters
coreLinphoneCore object
enabledEnable or disable it

◆ linphone_core_enable_tcap_line_merging()

void linphone_core_enable_tcap_line_merging ( LinphoneCore core,
bool_t  merge 
)

Define whether tcap lines are going to be merged if capability negotiation (RFC5939) is supported.

Parameters
coreLinphoneCore object.
mergeTRUE to merge tcap lines with consecutive indexes; FALSE otherwise.

◆ linphone_core_enable_video()

MS2_DEPRECATED void linphone_core_enable_video ( LinphoneCore core,
bool_t  vcap_enabled,
bool_t  display_enabled 
)

Enables video globally.

This function does not have any effect during calls. It just indicates LinphoneCore to initiate future calls with video or not. The two boolean parameters indicate in which direction video is enabled. Setting both to false disables video entirely.

Parameters
coreThe LinphoneCore object
vcap_enabledindicates whether video capture is enabled
display_enabledindicates whether video display should be shown
Deprecated:
09/10/2013 Use linphone_core_enable_video_capture() and linphone_core_enable_video_display() instead.

◆ linphone_core_enable_video_adaptive_jittcomp()

void linphone_core_enable_video_adaptive_jittcomp ( LinphoneCore core,
bool_t  enable 
)

Enable or disable the video adaptive jitter compensation.

Parameters
coreLinphoneCore object
enableTRUE to enable the video adaptive jitter compensation, FALSE to disable it.

◆ linphone_core_enable_video_capture()

void linphone_core_enable_video_capture ( LinphoneCore core,
bool_t  enable 
)

Enable or disable video capture.

This function does not have any effect during calls. It just indicates the LinphoneCore to initiate future calls with video capture or not.

Parameters
coreLinphoneCore object.
enableTRUE to enable video capture, FALSE to disable it.

◆ linphone_core_enable_video_display()

void linphone_core_enable_video_display ( LinphoneCore core,
bool_t  enable 
)

Enable or disable video display.

This function does not have any effect during calls. It just indicates the LinphoneCore to initiate future calls with video display or not.

Parameters
coreLinphoneCore object.
enableTRUE to enable video display, FALSE to disable it.

◆ linphone_core_enable_video_multicast()

void linphone_core_enable_video_multicast ( LinphoneCore core,
bool_t  yesno 
)

Use to enable multicast rtp for video stream.

If enabled, outgoing calls put a multicast address from linphone_core_get_video_multicast_addr() into video cline. In case of outgoing call video stream is sent to this multicast address. For incoming calls behavior is unchanged.

Parameters
coreLinphoneCore
yesnoif yes, subsequent outgoing calls will propose multicast ip set by linphone_core_set_video_multicast_addr()

◆ linphone_core_enable_video_preview()

void linphone_core_enable_video_preview ( LinphoneCore core,
bool_t  enable 
)

Controls video preview enablement.

Parameters
coreLinphoneCore object
enableA boolean value telling whether the video preview is to be shown Video preview refers to the action of displaying the local webcam image to the user while not in call.

◆ linphone_core_enable_video_source_reuse()

void linphone_core_enable_video_source_reuse ( LinphoneCore core,
bool_t  enable 
)

Enable or disable video source reuse when switching from preview to actual video call.

This source reuse is useful when you always display the preview, even before calls are initiated. By keeping the video source for the transition to a real video call, you will smooth out the source close/reopen cycle.

This function does not have any effect durfing calls. It just indicates the LinphoneCore to initiate future calls with video source reuse or not. Also, at the end of a video call, the source will be closed whatsoever for now.

Parameters
coreLinphoneCore object
enableTRUE to enable video source reuse. FALSE to disable it for subsequent calls.

◆ linphone_core_enable_zero_rtp_port_for_stream_inactive()

void linphone_core_enable_zero_rtp_port_for_stream_inactive ( LinphoneCore lc,
bool_t  enable 
)

Define whether RTP port is set to 0 when a stream is inactive.

Parameters
coreLinphoneCore object.
enableTRUE to set the RTP port to 0 if the stream direction is inactive; FALSE otherwise.

◆ linphone_core_file_format_supported()

bool_t linphone_core_file_format_supported ( LinphoneCore core,
const char *  fmt 
)

Returns whether a specific file format is supported.

See also
linphone_core_get_supported_file_formats()
Parameters
coreA LinphoneCore object
fmtThe format extension (wav, mkv).
Returns
TRUE if the file format is supported, FALSE otherwise

◆ linphone_core_find_payload_type()

MS2_DEPRECATED OrtpPayloadType* linphone_core_find_payload_type ( LinphoneCore core,
const char *  type,
int  rate,
int  channels 
)

Get payload type from mime type and clock rate.

This function searches in audio and video codecs for the given payload type name and clockrate.

Parameters
coreLinphoneCore object
typepayload mime type (I.E SPEEX, PCMU, VP8)
ratecan be LINPHONE_FIND_PAYLOAD_IGNORE_RATE
channelsnumber of channels, can be LINPHONE_FIND_PAYLOAD_IGNORE_CHANNELS
Returns
Returns NULL if not found.
Deprecated:
31/03/2017 Use linphone_core_get_payload_type() instead.

◆ linphone_core_get_adaptive_rate_algorithm()

const char* linphone_core_get_adaptive_rate_algorithm ( const LinphoneCore core)

Returns which adaptive rate algorithm is currently configured for future calls.

See also
linphone_core_set_adaptive_rate_algorithm()
Parameters
corethe LinphoneCore
Returns
the adaptive rate algorithm. Currently two values are supported: 'advanced', which is the default value, or 'basic'.

◆ linphone_core_get_audio_codecs()

MS2_DEPRECATED const bctbx_list_t* linphone_core_get_audio_codecs ( const LinphoneCore core)

Returns the list of available audio codecs.

Parameters
coreThe LinphoneCore object
Returns
A list of #OrtpPayloadType.

This list is unmodifiable. The ->data field of the bctbx_list_t points a PayloadType structure holding the codec information. It is possible to make copy of the list with bctbx_list_copy() in order to modify it (such as the order of codecs).

Deprecated:
31/03/2017 Use linphone_core_get_audio_payload_types() instead.

◆ linphone_core_get_audio_jittcomp()

int linphone_core_get_audio_jittcomp ( LinphoneCore core)

Returns the nominal audio jitter buffer size in milliseconds.

Parameters
coreLinphoneCore object
Returns
The nominal audio jitter buffer size in milliseconds

◆ linphone_core_get_audio_multicast_addr()

const char* linphone_core_get_audio_multicast_addr ( const LinphoneCore core)

Use to get multicast address to be used for audio stream.

Parameters
coreLinphoneCore
Returns
an ipv4/6 multicast address or default value.

◆ linphone_core_get_audio_multicast_ttl()

int linphone_core_get_audio_multicast_ttl ( const LinphoneCore core)

Use to get multicast ttl to be used for audio stream.

Parameters
coreLinphoneCore
Returns
a time to leave value

◆ linphone_core_get_audio_payload_types()

bctbx_list_t* linphone_core_get_audio_payload_types ( LinphoneCore core)

Return the list of the available audio payload types.

Parameters
coreThe core.
Returns
A freshly allocated list of the available payload types. The list must be destroyed with bctbx_list_free() after usage. The elements of the list haven't to be unref.

◆ linphone_core_get_avpf_mode()

LinphoneAVPFMode linphone_core_get_avpf_mode ( const LinphoneCore core)

Return AVPF enablement.

See linphone_core_set_avpf_mode() .

Parameters
coreLinphoneCore object
Returns
The current LinphoneAVPFMode mode

◆ linphone_core_get_avpf_rr_interval()

int linphone_core_get_avpf_rr_interval ( const LinphoneCore core)

Return the avpf report interval in seconds.

Parameters
coreLinphoneCore object
Returns
The current AVPF report interval in seconds

◆ linphone_core_get_camera_sensor_rotation()

int linphone_core_get_camera_sensor_rotation ( LinphoneCore core)

Get the camera sensor rotation.

This is needed on some mobile platforms to get the number of degrees the camera sensor is rotated relative to the screen.

Parameters
coreThe linphone core related to the operation
Returns
The camera sensor rotation in degrees (0 to 360) or -1 if it could not be retrieved

◆ linphone_core_get_capture_device()

const char* linphone_core_get_capture_device ( LinphoneCore core)

Gets the name of the currently assigned sound device for capture.

Parameters
coreLinphoneCore object
Returns
The name of the currently assigned sound device for capture.

◆ linphone_core_get_current_preview_video_definition()

LinphoneVideoDefinition* linphone_core_get_current_preview_video_definition ( const LinphoneCore core)

Get the effective video definition provided by the camera for the captured video.

When preview is disabled or not yet started this function returns a 0x0 video definition.

Parameters
coreLinphoneCore object
Returns
The captured LinphoneVideoDefinition.
See also
linphone_core_set_preview_video_definition()

◆ linphone_core_get_current_preview_video_size()

MS2_DEPRECATED MSVideoSize linphone_core_get_current_preview_video_size ( const LinphoneCore core)

Returns the effective video size for the captured video as provided by the camera.

When preview is disabled or not yet started, this function returns a zeroed video size.

See also
linphone_core_set_preview_video_size()
Parameters
corethe core
Returns
a #MSVideoSize
Deprecated:
28/03/2017 Use linphone_core_get_current_preview_video_definition() instead.

◆ linphone_core_get_default_video_display_filter()

const char* linphone_core_get_default_video_display_filter ( LinphoneCore core)

Get the name of the default mediastreamer2 filter used for rendering video on the current platform.

This is for advanced users of the library, mainly to expose mediastreamer video filter name and status.

Parameters
coreLinphoneCore object
Returns
The default video display filter.

◆ linphone_core_get_device_rotation()

int linphone_core_get_device_rotation ( LinphoneCore core)

Gets the current device orientation.

Parameters
coreLinphoneCore object
Returns
The current device orientation
See also
linphone_core_set_device_rotation()

◆ linphone_core_get_disable_record_on_mute()

bool_t linphone_core_get_disable_record_on_mute ( LinphoneCore core)

Get whether the microphone will be completely deactivated when muted.

Please refer to linphone_core_set_disable_record_on_mute().

Parameters
coreLinphoneCore object
Returns
True if you wish to entirely stop the audio recording when muting the microphone.

◆ linphone_core_get_dns_set_by_app()

bool_t linphone_core_get_dns_set_by_app ( LinphoneCore core)

Tells if the DNS was set by an application.

Parameters
coreLinphoneCore object.
Returns
TRUE if DNS was set by app, FALSE otherwise.

◆ linphone_core_get_download_bandwidth()

int linphone_core_get_download_bandwidth ( const LinphoneCore core)

Retrieve the maximum available download bandwidth.

This value was set by linphone_core_set_download_bandwidth().

Parameters
corethe LinphoneCore object
Returns
the download bandiwdth in kbits/s, 0 for infinite

◆ linphone_core_get_download_ptime()

int linphone_core_get_download_ptime ( LinphoneCore core)

Get audio packetization time linphone expects to receive from peer.

A value of zero means that ptime is not specified.

Parameters
corethe LinphoneCore
Returns
the download packetization time set

◆ linphone_core_get_echo_canceller_filter_name()

const char* linphone_core_get_echo_canceller_filter_name ( const LinphoneCore core)

Get the name of the mediastreamer2 filter used for echo cancelling.

Parameters
coreLinphoneCore object
Returns
The name of the mediastreamer2 filter used for echo cancelling.

◆ linphone_core_get_media_device()

const char* linphone_core_get_media_device ( LinphoneCore core)

Gets the name of the currently assigned sound device for media.

Parameters
coreLinphoneCore object
Returns
The name of the currently assigned sound device for capture.

◆ linphone_core_get_media_encryption()

LinphoneMediaEncryption linphone_core_get_media_encryption ( const LinphoneCore core)

Get the media encryption policy being used for RTP packets.

Parameters
coreLinphoneCore object.
Returns
The LinphoneMediaEncryption policy being used.

◆ linphone_core_get_media_level()

MS2_DEPRECATED int linphone_core_get_media_level ( LinphoneCore core)

Get sound media level in 0-100 scale.

Deprecated:
20/12/2018

◆ linphone_core_get_mic_gain_db()

float linphone_core_get_mic_gain_db ( LinphoneCore core)

Get microphone gain in db.

Parameters
coreLinphoneCore object
Returns
The current microphone gain

◆ linphone_core_get_native_preview_window_id()

void* linphone_core_get_native_preview_window_id ( LinphoneCore core)

Get the native window handle of the video preview window.

see linphone_core_set_native_video_window_id() for details about window_id

There is a special case for Qt : linphone_core_get_native_preview_window_id() wreturns a #QQuickFramebufferObject::Renderer and creates one if it doesn't exist. This object must be returned by your QQuickFramebufferObject::createRenderer() overload for Qt. Note : Qt blocks GUI thread when calling createRenderer(), so it is safe to call linphone functions there if needed.

Parameters
coreLinphoneCore object
Returns
The native window handle of the video preview window.

◆ linphone_core_get_native_video_window_id()

void* linphone_core_get_native_video_window_id ( const LinphoneCore core)

Get the native window handle of the video window.

see linphone_core_set_native_video_window_id for details about window_id

There is a special case for Qt : linphone_core_get_native_video_window_id() returns a #QQuickFramebufferObject::Renderer and creates one if it doesn't exist. This object must be returned by your QQuickFramebufferObject::createRenderer() overload for Qt. Note : Qt blocks GUI thread when calling createRenderer(), so it is safe to call linphone functions there if needed.

Parameters
coreLinphoneCore object
Returns
The native window handle of the video window.

◆ linphone_core_get_network_simulator_params()

const OrtpNetworkSimulatorParams* linphone_core_get_network_simulator_params ( const LinphoneCore core)

Get the previously set network simulation parameters.

See also
linphone_core_set_network_simulator_params()
Returns
a #OrtpNetworkSimulatorParams structure.

◆ linphone_core_get_nortp_timeout()

int linphone_core_get_nortp_timeout ( const LinphoneCore core)

Gets the value of the no-rtp timeout.

When no RTP or RTCP packets have been received for a while LinphoneCore will consider the call is broken (remote end crashed or disconnected from the network), and thus will terminate the call. The no-rtp timeout is the duration above which the call is considered broken.

Parameters
coreLinphoneCore object
Returns
The value of the no-rtp timeout in seconds

◆ linphone_core_get_payload_type()

LinphonePayloadType* linphone_core_get_payload_type ( LinphoneCore core,
const char *  type,
int  rate,
int  channels 
)

Get payload type from mime type and clock rate.

This function searches in audio and video codecs for the given payload type name and clockrate.

Parameters
coreLinphoneCore object
typepayload mime type (I.E SPEEX, PCMU, VP8)
ratecan be LINPHONE_FIND_PAYLOAD_IGNORE_RATE
channelsnumber of channels, can be LINPHONE_FIND_PAYLOAD_IGNORE_CHANNELS
Returns
Returns NULL if not found. If a LinphonePayloadType is returned, it must be released with linphone_payload_type_unref() after using it.
Warning
The returned payload type is allocated as a floating reference i.e. the reference counter is initialized to 0.

◆ linphone_core_get_payload_type_bitrate()

MS2_DEPRECATED int linphone_core_get_payload_type_bitrate ( LinphoneCore core,
const OrtpPayloadType *  pt 
)

Get the bitrate explicitely set with linphone_core_set_payload_type_bitrate().

Parameters
corethe LinphoneCore object
ptthe payload type to modify.
Returns
bitrate the IP bitrate in kbit/s, or -1 if an error occured.
Deprecated:
31/03/2017 Use linphone_payload_type_get_bitrate().

◆ linphone_core_get_payload_type_number()

MS2_DEPRECATED int linphone_core_get_payload_type_number ( LinphoneCore core,
const OrtpPayloadType *  pt 
)

Returns the payload type number assigned for this codec.

Deprecated:
13/02/2017 Use linphone_payload_type_get_number() instead

◆ linphone_core_get_play_file()

const char* linphone_core_get_play_file ( const LinphoneCore core)

Get the wav file that is played when putting somebody on hold, or when files are used instead of soundcards (see linphone_core_set_use_files()).

The file is a 16 bit linear wav file.

Parameters
coreLinphoneCore object
Returns
The path to the file that is played when putting somebody on hold.

◆ linphone_core_get_play_level()

MS2_DEPRECATED int linphone_core_get_play_level ( LinphoneCore core)

Get playback sound level in 0-100 scale.

Deprecated:
20/12/2016

◆ linphone_core_get_playback_device()

const char* linphone_core_get_playback_device ( LinphoneCore core)

Gets the name of the currently assigned sound device for playback.

Parameters
coreLinphoneCore object
Returns
The name of the currently assigned sound device for playback.

◆ linphone_core_get_playback_gain_db()

float linphone_core_get_playback_gain_db ( LinphoneCore core)

Get playback gain in db before entering sound card.

Parameters
coreLinphoneCore object
Returns
The current playback gain

◆ linphone_core_get_preferred_framerate()

float linphone_core_get_preferred_framerate ( LinphoneCore core)

Returns the preferred video framerate, previously set by linphone_core_set_preferred_framerate().

Parameters
corethe linphone core
Returns
frame rate in number of frames per seconds.

◆ linphone_core_get_preferred_video_definition()

const LinphoneVideoDefinition* linphone_core_get_preferred_video_definition ( const LinphoneCore core)

Get the preferred video definition for the stream that is captured and sent to the remote party.

Parameters
coreLinphoneCore object
Returns
The preferred LinphoneVideoDefinition

◆ linphone_core_get_preferred_video_size()

MS2_DEPRECATED MSVideoSize linphone_core_get_preferred_video_size ( const LinphoneCore core)

Returns the current preferred video size for sending.

Deprecated:
28/03/2017 Use linphone_core_get_preferred_video_definition() instead.

◆ linphone_core_get_preview_video_definition()

const LinphoneVideoDefinition* linphone_core_get_preview_video_definition ( const LinphoneCore core)

Get the definition of the captured video.

Parameters
coreLinphoneCore object
Returns
The captured LinphoneVideoDefinition if it was previously set by linphone_core_set_preview_video_definition(), otherwise a 0x0 LinphoneVideoDefinition.
See also
linphone_core_set_preview_video_definition()

◆ linphone_core_get_preview_video_size()

MS2_DEPRECATED MSVideoSize linphone_core_get_preview_video_size ( const LinphoneCore core)

Returns video size for the captured video if it was previously set by linphone_core_set_preview_video_size(), otherwise returns a 0,0 size.

See also
linphone_core_set_preview_video_size()
Parameters
corethe core
Returns
a #MSVideoSize
Deprecated:
28/03/2017 Use linphone_core_get_preview_video_definition() instead.

◆ linphone_core_get_rec_level()

MS2_DEPRECATED int linphone_core_get_rec_level ( LinphoneCore core)

Get sound capture level in 0-100 scale.

Deprecated:
20/12/2016

◆ linphone_core_get_record_file()

const char* linphone_core_get_record_file ( const LinphoneCore core)

Get the wav file where incoming stream is recorded, when files are used instead of soundcards (see linphone_core_set_use_files()).

This feature is different from call recording (linphone_call_params_set_record_file()) The file is a 16 bit linear wav file.

Parameters
coreLinphoneCore object
Returns
The path to the file where incoming stream is recorded.

◆ linphone_core_get_remote_ringback_tone()

const char* linphone_core_get_remote_ringback_tone ( const LinphoneCore core)

Get the ring back tone played to far end during incoming calls.

Parameters
coreLinphoneCore object
Returns
the path to the remote ring back tone to be played.

◆ linphone_core_get_ring()

const char* linphone_core_get_ring ( const LinphoneCore core)

Returns the path to the wav file used for ringing.

Parameters
coreLinphoneCore object
Returns
The path to the wav file used for ringing.

◆ linphone_core_get_ring_during_incoming_early_media()

bool_t linphone_core_get_ring_during_incoming_early_media ( const LinphoneCore core)

Tells whether the ring play is enabled during an incoming early media call.

Parameters
coreLinphoneCore object

◆ linphone_core_get_ring_level()

MS2_DEPRECATED int linphone_core_get_ring_level ( LinphoneCore core)

Get ring sound level in 0-100 scale.

Deprecated:
20/12/2016

◆ linphone_core_get_ringback()

const char* linphone_core_get_ringback ( const LinphoneCore core)

Returns the path to the wav file used for ringing back.

Parameters
coreLinphoneCore object
Returns
The path to the wav file used for ringing back.

◆ linphone_core_get_ringer_device()

const char* linphone_core_get_ringer_device ( LinphoneCore core)

Gets the name of the currently assigned sound device for ringing.

Parameters
coreLinphoneCore object
Returns
The name of the currently assigned sound device for ringing.

◆ linphone_core_get_session_expires_enabled()

bool_t linphone_core_get_session_expires_enabled ( const LinphoneCore core)

Check if the Session Timers feature is enabled.

Parameters
coreLinphoneCore object
Deprecated:
16/12/2021 Use linphone_core_session_expires_enabled() instead.

◆ linphone_core_get_session_expires_min_value()

int linphone_core_get_session_expires_min_value ( const LinphoneCore core)

Returns the session expires min value, 90 by default.

Parameters
coreLinphoneCore object

◆ linphone_core_get_session_expires_refresher_value()

LinphoneSessionExpiresRefresher linphone_core_get_session_expires_refresher_value ( const LinphoneCore core)

Returns the session expires refresher value.

Parameters
coreLinphoneCore object

◆ linphone_core_get_session_expires_value()

int linphone_core_get_session_expires_value ( const LinphoneCore core)

Returns the session expires value.

Parameters
coreLinphoneCore object

◆ linphone_core_get_sip_transport_timeout()

int linphone_core_get_sip_transport_timeout ( LinphoneCore core)

Get the SIP transport timeout.

Parameters
coreLinphoneCore object.
Returns
The SIP transport timeout in milliseconds.

◆ linphone_core_get_sound_devices()

MS2_DEPRECATED const char** linphone_core_get_sound_devices ( LinphoneCore core)

Gets the list of the available sound devices.

Parameters
coreLinphoneCore object
Returns
An unmodifiable array of strings contanining the names of the available sound devices that is NULL terminated
Deprecated:
12/10/2017 use linphone_core_get_sound_devices_list instead

◆ linphone_core_get_sound_devices_list()

bctbx_list_t* linphone_core_get_sound_devices_list ( const LinphoneCore core)

Gets the list of the available sound devices.

Parameters
coreLinphoneCore object
Returns
An unmodifiable array of strings contanining the names of the available sound devices that is NULL terminated.
Deprecated:
10/04/2021 Use linphone_core_get_audio_devices() instead.

◆ linphone_core_get_static_picture()

const char* linphone_core_get_static_picture ( LinphoneCore core)

Get the path to the image file streamed when "Static picture" is set as the video device.

Parameters
coreLinphoneCore object.
Returns
The path to the image file streamed when "Static picture" is set as the video device.

◆ linphone_core_get_static_picture_fps()

float linphone_core_get_static_picture_fps ( LinphoneCore core)

Get the frame rate for static picture.

Parameters
coreLinphoneCore object.
Returns
The frame rate used for static picture.

◆ linphone_core_get_supported_file_formats()

MS2_DEPRECATED const char** linphone_core_get_supported_file_formats ( LinphoneCore core)

Returns a null terminated table of strings containing the file format extension supported for call recording.

Parameters
corethe core
Returns
the supported formats, typically 'wav' and 'mkv'
Deprecated:
12/10/2017 use linphone_core_get_supported_file_formats_list instead

◆ linphone_core_get_supported_file_formats_list()

bctbx_list_t* linphone_core_get_supported_file_formats_list ( LinphoneCore core)

Returns a null terminated table of strings containing the file format extension supported for call recording.

Parameters
corethe core
Returns
The supported formats, typically 'wav' and 'mkv'.

◆ linphone_core_get_supported_media_encryptions()

const bctbx_list_t* linphone_core_get_supported_media_encryptions ( LinphoneCore lc)

Get list of supported media descriptions.

Parameters
coreLinphoneCore object.
Returns
list of supported media encryptions as intptr_t.

◆ linphone_core_get_supported_video_sizes()

MS2_DEPRECATED const MSVideoSizeDef* linphone_core_get_supported_video_sizes ( LinphoneCore core)

Returns the zero terminated table of supported video resolutions.

Deprecated:
28/03/2017 Use linphone_factory_get_supported_video_definitions() instead.

◆ linphone_core_get_text_codecs()

MS2_DEPRECATED const bctbx_list_t* linphone_core_get_text_codecs ( const LinphoneCore core)

Returns the list of available text codecs.

Parameters
coreThe LinphoneCore object
Returns
A list of OrtpPayloadType.

This list is unmodifiable. The ->data field of the bctbx_list_t points a PayloadType structure holding the codec information. It is possible to make copy of the list with bctbx_list_copy() in order to modify it (such as the order of codecs).

Deprecated:
31/03/2017 Use linphone_core_get_text_payload_types() instead.

◆ linphone_core_get_text_payload_types()

bctbx_list_t* linphone_core_get_text_payload_types ( LinphoneCore core)

Return the list of the available text payload types.

Parameters
coreThe core.
Returns
A freshly allocated list of the available payload types. The list must be destroyed with bctbx_list_free() after usage. The elements of the list haven't to be unref.

◆ linphone_core_get_upload_bandwidth()

int linphone_core_get_upload_bandwidth ( const LinphoneCore core)

Retrieve the maximum available upload bandwidth.

This value was set by linphone_core_set_upload_bandwidth().

Parameters
corethe LinphoneCore object
Returns
the upload bandiwdth in kbits/s, 0 for infinite

◆ linphone_core_get_upload_ptime()

int linphone_core_get_upload_ptime ( LinphoneCore core)

Set audio packetization time linphone will send (in absence of requirement from peer) A value of 0 stands for the current codec default packetization time.

Parameters
corethe LinphoneCore
Returns
the upload packetization time set

◆ linphone_core_get_use_files()

bool_t linphone_core_get_use_files ( LinphoneCore core)

Gets whether linphone is currently streaming audio from and to files, rather than using the soundcard.

Parameters
coreLinphoneCore object
Returns
A boolean value representing whether linphone is streaming audio from and to files or not.

◆ linphone_core_get_use_info_for_dtmf()

bool_t linphone_core_get_use_info_for_dtmf ( LinphoneCore core)

Indicates whether SIP INFO is used to send digits.

Parameters
coreLinphoneCore object
Returns
A boolean value telling whether SIP INFO is used to send digits

◆ linphone_core_get_use_rfc2833_for_dtmf()

bool_t linphone_core_get_use_rfc2833_for_dtmf ( LinphoneCore core)

Indicates whether RFC2833 is used to send digits.

Parameters
coreLinphoneCore object
Returns
A boolean value telling whether RFC2833 is used to send digits

◆ linphone_core_get_video_activation_policy()

LinphoneVideoActivationPolicy* linphone_core_get_video_activation_policy ( const LinphoneCore core)

Get the default policy for video.

See linphone_core_set_video_activation_policy() for more details.

Parameters
coreLinphoneCore object
Returns
The video policy being used

◆ linphone_core_get_video_codecs()

MS2_DEPRECATED const bctbx_list_t* linphone_core_get_video_codecs ( const LinphoneCore core)

Returns the list of available video codecs.

Parameters
coreThe LinphoneCore object
Returns
A list of #OrtpPayloadType.

This list is unmodifiable. The ->data field of the bctbx_list_t points a PayloadType structure holding the codec information. It is possible to make copy of the list with bctbx_list_copy() in order to modify it (such as the order of codecs).

Deprecated:
31/03/2017 Use linphone_core_get_video_payload_types() instead.

◆ linphone_core_get_video_device()

const char* linphone_core_get_video_device ( const LinphoneCore core)

Returns the name of the currently active video device.

Parameters
coreLinphoneCore object
Returns
The name of the currently active video device.

◆ linphone_core_get_video_devices()

MS2_DEPRECATED const char** linphone_core_get_video_devices ( const LinphoneCore core)

Gets the list of the available video capture devices.

Parameters
coreLinphoneCore object
Returns
An unmodifiable array of strings contanining the names of the available video capture devices that is NULL terminated
Deprecated:
12/10/2017 use linphone_core_get_video_devices_list instead

◆ linphone_core_get_video_devices_list()

bctbx_list_t* linphone_core_get_video_devices_list ( const LinphoneCore core)

Gets the list of the available video capture devices.

Parameters
coreLinphoneCore object
Returns
An unmodifiable array of strings contanining the names of the available video capture devices that is NULL terminated.

◆ linphone_core_get_video_display_filter()

const char* linphone_core_get_video_display_filter ( LinphoneCore core)

Get the name of the mediastreamer2 filter used for rendering video.

Parameters
coreLinphoneCore object
Returns
The currently selected video display filter.

◆ linphone_core_get_video_jittcomp()

int linphone_core_get_video_jittcomp ( LinphoneCore core)

Returns the nominal video jitter buffer size in milliseconds.

Parameters
coreLinphoneCore object
Returns
The nominal video jitter buffer size in milliseconds

◆ linphone_core_get_video_multicast_addr()

const char* linphone_core_get_video_multicast_addr ( const LinphoneCore core)

Use to get multicast address to be used for video stream.

Parameters
coreLinphoneCore
Returns
an ipv4/6 multicast address, or default value.

◆ linphone_core_get_video_multicast_ttl()

int linphone_core_get_video_multicast_ttl ( const LinphoneCore core)

Use to get multicast ttl to be used for video stream.

Parameters
coreLinphoneCore
Returns
a time to leave value

◆ linphone_core_get_video_payload_types()

bctbx_list_t* linphone_core_get_video_payload_types ( LinphoneCore core)

Return the list of the available video payload types.

Parameters
coreThe core.
Returns
A freshly allocated list of the available payload types. The list must be destroyed with bctbx_list_free() after usage. The elements of the list haven't to be unref.

◆ linphone_core_get_video_policy()

MS2_DEPRECATED const LinphoneVideoPolicy* linphone_core_get_video_policy ( const LinphoneCore core)

Get the default policy for video.

See linphone_core_set_video_policy() for more details.

Parameters
coreLinphoneCore object
Returns
The video policy being used
Deprecated:
19/04/2017 Use linphone_video_activation_policy_get_automatically_accept instead

◆ linphone_core_get_video_preset()

const char* linphone_core_get_video_preset ( const LinphoneCore core)

Get the video preset used for video calls.

Parameters
coreLinphoneCore object
Returns
The name of the video preset used for video calls (can be NULL if the default video preset is used).

◆ linphone_core_get_zrtp_status()

LinphoneZrtpPeerStatus linphone_core_get_zrtp_status ( LinphoneCore core,
const char *  addr 
)

Get the zrtp sas validation status for a peer uri.

Once the SAS has been validated or rejected, the status will never return to Unknown (unless you delete your cache)

Parameters
coreLinphoneCore object.
addrthe peer uri
Returns
- LinphoneZrtpPeerStatusUnknown: this uri is not present in cache OR during calls with the active device, SAS never was validated or rejected
  • LinphoneZrtpPeerStatusValid: the active device status is set to valid
  • LinphoneZrtpPeerStatusInvalid: the active peer device status is set to invalid

◆ linphone_core_is_capability_negotiation_reinvite_enabled()

bool_t linphone_core_is_capability_negotiation_reinvite_enabled ( const LinphoneCore core)

Check if the capability negotiation (RFC5939) reINVITE is enabled or not.

Parameters
coreLinphoneCore object.
Returns
TRUE if capability negotiation reINVITE is enabled; FALSE otherwise.
Deprecated:
16/12/2021 Use linphone_core_capability_negotiation_reinvite_enabled() instead.

◆ linphone_core_is_media_encryption_mandatory()

bool_t linphone_core_is_media_encryption_mandatory ( LinphoneCore core)

Check if the configured media encryption is mandatory or not.

Parameters
coreLinphoneCore object.
Returns
TRUE if media encryption is mandatory; FALSE otherwise.

◆ linphone_core_is_media_encryption_supported()

bool_t linphone_core_is_media_encryption_supported ( LinphoneCore core,
LinphoneMediaEncryption  menc 
)

Check if media encryption is supported.

Parameters
coreLinphoneCore object.
mencThe media encryption policy to be used.
Returns
TRUE if the media encryption is supported, FALSE otherwise

◆ linphone_core_is_media_filter_supported()

bool_t linphone_core_is_media_filter_supported ( LinphoneCore core,
const char *  filtername 
)

Checks if the given media filter is loaded and usable.

This is for advanced users of the library, mainly to expose mediastreamer video filter status.

Parameters
coreLinphoneCore object
filternamethe filter name
Returns
TRUE if the filter is loaded and usable, FALSE otherwise

◆ linphone_core_is_native_ringing_enabled()

bool_t linphone_core_is_native_ringing_enabled ( const LinphoneCore core)

Returns whether the native ringing is enabled or not.

Parameters
coreLinphoneCore object
Returns
True if we use the native ringing, false otherwise
Deprecated:
16/12/2021 Use linphone_core_native_ringing_enabled() instead.

◆ linphone_core_is_zero_rtp_port_for_stream_inactive_enabled()

bool_t linphone_core_is_zero_rtp_port_for_stream_inactive_enabled ( const LinphoneCore lc)

Check if RTP port is set to 0 when a stream is inactive.

Parameters
coreLinphoneCore object.
Returns
TRUE if the RTP port is set to 0 if the stream direction is inactive; FALSE otherwise.
Deprecated:
16/12/2021 Use linphone_core_zero_rtp_port_for_stream_inactive_enabled() instead.

◆ linphone_core_mic_enabled()

bool_t linphone_core_mic_enabled ( LinphoneCore core)

Tells whether the microphone is enabled.

Parameters
coreLinphoneCore object
Returns
TRUE if the microphone is enabled, FALSE if disabled.

◆ linphone_core_native_ringing_enabled()

bool_t linphone_core_native_ringing_enabled ( const LinphoneCore core)

Returns whether the native ringing is enabled or not.

Parameters
coreLinphoneCore object
Returns
True if we use the native ringing, false otherwise

◆ linphone_core_payload_type_enabled()

MS2_DEPRECATED bool_t linphone_core_payload_type_enabled ( const LinphoneCore core,
const OrtpPayloadType *  pt 
)

Tells whether the specified payload type is enabled.

Parameters
coreLinphoneCore object.
ptThe payload type to check.
Returns
TRUE if the payload type is enabled, FALSE if disabled.
Deprecated:
31/03/2017 Use linphone_payload_type_enabled() instead.

◆ linphone_core_payload_type_is_vbr()

MS2_DEPRECATED bool_t linphone_core_payload_type_is_vbr ( const LinphoneCore core,
const OrtpPayloadType *  pt 
)

Tells whether the specified payload type represents a variable bitrate codec.

Parameters
coreLinphoneCore object.
ptThe payload type to check.
Returns
TRUE if the payload type represents a VBR codec, FALSE if disabled.
Deprecated:
31/03/2017 Use linphone_payload_type_is_vbr() instead.

◆ linphone_core_play_dtmf()

void linphone_core_play_dtmf ( LinphoneCore core,
char  dtmf,
int  duration_ms 
)

Plays a dtmf sound to the local user.

Parameters
coreLinphoneCore object
dtmfDTMF to play ['0'..'16'] | '#' | '#'
duration_msDuration in ms, -1 means play until next further call to linphone_core_stop_dtmf()

◆ linphone_core_preview_ogl_render()

void linphone_core_preview_ogl_render ( const LinphoneCore core)

Call generic OpenGL render for a given core.

Parameters
coreThe core.

◆ linphone_core_qrcode_video_preview_enabled()

bool_t linphone_core_qrcode_video_preview_enabled ( const LinphoneCore core)

Tells whether QRCode is enabled in the preview.

Parameters
coreLinphoneCore object
Returns
A boolean value telling whether QRCode is enabled in the preview.

◆ linphone_core_realtime_text_enabled()

bool_t linphone_core_realtime_text_enabled ( LinphoneCore core)

Gets if realtime text is enabled or not.

Parameters
coreLinphoneCore object
Returns
TRUE if realtime text is enabled, FALSE otherwise

◆ linphone_core_realtime_text_get_keepalive_interval()

unsigned int linphone_core_realtime_text_get_keepalive_interval ( const LinphoneCore core)

Gets keep alive interval of real time text.

Parameters
coreLinphoneCore object
Returns
keep alive interval of real time text.

◆ linphone_core_reload_sound_devices()

void linphone_core_reload_sound_devices ( LinphoneCore core)

Update detection of sound devices.

Use this function when the application is notified of USB plug events, so that list of available hardwares for sound playback and capture is updated.

Parameters
coreLinphoneCore object.

◆ linphone_core_reload_video_devices()

void linphone_core_reload_video_devices ( LinphoneCore core)

Update detection of camera devices.

Use this function when the application is notified of USB plug events, so that list of available hardwares for video capture is updated.

Parameters
coreLinphoneCore object.

◆ linphone_core_retransmission_on_nack_enabled()

bool_t linphone_core_retransmission_on_nack_enabled ( LinphoneCore core)

Tells whether NACK context is enabled or not.

Parameters
coreLinphoneCore object
Returns
A boolean value telling whether NACK context is enabled or not

◆ linphone_core_rtp_bundle_enabled()

bool_t linphone_core_rtp_bundle_enabled ( const LinphoneCore core)

Returns whether RTP bundle mode (also known as Media Multiplexing) is enabled.

See https://tools.ietf.org/html/draft-ietf-mmusic-sdp-bundle-negotiation-54 for more information.

Parameters
corethe LinphoneCore
Returns
a boolean indicating the enablement of rtp bundle mode.

◆ linphone_core_self_view_enabled()

bool_t linphone_core_self_view_enabled ( const LinphoneCore core)

Tells whether video self view during call is enabled or not.

Parameters
coreLinphoneCore object
Returns
A boolean value telling whether self view is enabled
See also
linphone_core_enable_self_view() for details.

◆ linphone_core_send_dtmf()

MS2_DEPRECATED void linphone_core_send_dtmf ( LinphoneCore core,
char  dtmf 
)

Send the specified dtmf.

This function only works during calls. The dtmf is automatically played to the user.

Parameters
coreThe LinphoneCore object
dtmfThe dtmf name specified as a char, such as '0', '#' etc...
Deprecated:

23/11/2015 Use linphone_call_send_dtmf() instead.

◆ linphone_core_session_expires_enabled()

bool_t linphone_core_session_expires_enabled ( const LinphoneCore core)

Check if the Session Timers feature is enabled.

Parameters
coreLinphoneCore object

◆ linphone_core_set_adaptive_rate_algorithm()

void linphone_core_set_adaptive_rate_algorithm ( LinphoneCore core,
const char *  algorithm 
)

Sets adaptive rate algorithm.

It will be used for each new calls starting from now. Calls already started will not be updated.

Parameters
corethe core
algorithmthe adaptive rate control algorithm. Currently two values are supported: 'advanced', which is the default value, or 'basic'.

◆ linphone_core_set_audio_codecs()

MS2_DEPRECATED LinphoneStatus linphone_core_set_audio_codecs ( LinphoneCore core,
bctbx_list_t *  codecs 
)

Sets the list of audio codecs.

Parameters
coreThe LinphoneCore object
codecsThe new list of codecs. The list is taken by the LinphoneCore, thus the application should not free it.
Returns
0
Deprecated:

31/03/2017 Use linphone_core_set_audio_payload_types() instead.

◆ linphone_core_set_audio_jittcomp()

void linphone_core_set_audio_jittcomp ( LinphoneCore core,
int  milliseconds 
)

Sets the nominal audio jitter buffer size in milliseconds.

The value takes effect immediately for all running and pending calls, if any. A value of 0 disables the jitter buffer.

Parameters
corethe LinphoneCore object
millisecondsthe audio jitter buffer size to set in milliseconds

◆ linphone_core_set_audio_multicast_addr()

LinphoneStatus linphone_core_set_audio_multicast_addr ( LinphoneCore core,
const char *  ip 
)

Use to set multicast address to be used for audio stream.

Parameters
coreLinphoneCore
ipan ipv4/6 multicast address.
Returns
0 in case of success

◆ linphone_core_set_audio_multicast_ttl()

LinphoneStatus linphone_core_set_audio_multicast_ttl ( LinphoneCore core,
int  ttl 
)

Use to set multicast ttl to be used for audio stream.

Parameters
coreLinphoneCore
ttlvalue or -1 if not used. [0..255] default value is 1
Returns
0 in case of success

◆ linphone_core_set_audio_payload_types()

void linphone_core_set_audio_payload_types ( LinphoneCore core,
const bctbx_list_t *  payload_types 
)

Redefine the list of the available payload types.

Parameters
coreThe core.
payload_typesThe new list of payload types. The core does not take ownership on it.

◆ linphone_core_set_audio_port_range()

void linphone_core_set_audio_port_range ( LinphoneCore core,
int  min_port,
int  max_port 
)

Sets the UDP port range from which to randomly select the port used for audio streaming.

Parameters
coreLinphoneCore object
min_portThe lower bound of the audio port range to use
max_portThe upper bound of the audio port range to use

◆ linphone_core_set_avpf_mode()

void linphone_core_set_avpf_mode ( LinphoneCore core,
LinphoneAVPFMode  mode 
)

Enable RTCP feedback (also known as RTP/AVPF profile).

Setting LinphoneAVPFDefault is equivalent to LinphoneAVPFDisabled. This setting can be overriden per LinphoneProxyConfig with linphone_proxy_config_set_avpf_mode(). The value set here is used for calls placed or received out of any proxy configured, or if the proxy config is configured with LinphoneAVPFDefault.

Parameters
coreLinphoneCore object
modeThe AVPF mode to use.

◆ linphone_core_set_avpf_rr_interval()

void linphone_core_set_avpf_rr_interval ( LinphoneCore core,
int  interval 
)

Set the avpf report interval in seconds.

This value can be overriden by the proxy config using linphone_proxy_config_set_avpf_rr_interval().

Parameters
coreLinphoneCore object
intervalThe report interval in seconds

◆ linphone_core_set_capture_device()

LinphoneStatus linphone_core_set_capture_device ( LinphoneCore core,
const char *  devid 
)

Sets the sound device used for capture.

Parameters
coreLinphoneCore object
devidThe device name as returned by linphone_core_get_sound_devices()
Returns
0

◆ linphone_core_set_device_rotation()

void linphone_core_set_device_rotation ( LinphoneCore core,
int  rotation 
)

Tells the core the device current orientation.

This can be used by capture filters on mobile devices to select between portrait/landscape mode and to produce properly oriented images. The exact meaning of the value in rotation if left to each device specific implementations. IOS supported values are 0 for UIInterfaceOrientationPortrait and 270 for UIInterfaceOrientationLandscapeRight.

Parameters
coreLinphoneCore object
rotationThe orientation to use

◆ linphone_core_set_disable_record_on_mute()

void linphone_core_set_disable_record_on_mute ( LinphoneCore core,
bool_t  disable 
)

Calling this method with disable=true will cause the microhone to be completely deactivated when muted, when given possible by the implementation on the platform on which liblinphone is running.

Otherwise, sound recording remains active but silence is sent instead of recorded audio. Playback sound will be briefly interrupted while the audio is reconfigured. Currently only implemented for IOS, it will also disable Apple's microphone recording indicator when microphone is muted.

Parameters
coreLinphoneCore object
disableTrue if you wish to entirely stop the audio recording when muting the microphone.

◆ linphone_core_set_dns_servers()

void linphone_core_set_dns_servers ( LinphoneCore core,
const bctbx_list_t *  servers 
)

Forces liblinphone to use the supplied list of dns servers, instead of system's ones.

Parameters
coreLinphoneCore object.
serversA list of strings containing the IP addresses of DNS servers to be used. Setting to NULL restores default behaviour, which is to use the DNS server list provided by the system. The list is copied internally.

◆ linphone_core_set_dns_servers_app()

void linphone_core_set_dns_servers_app ( LinphoneCore core,
const bctbx_list_t *  servers 
)

Forces liblinphone to use the supplied list of dns servers, instead of system's ones and set dns_set_by_app at true or false according to value of servers list.

Parameters
coreLinphoneCore object.
serversA list of strings containing the IP addresses of DNS servers to be used. Setting to NULL restores default behaviour, which is to use the DNS server list provided by the system. The list is copied internally.

◆ linphone_core_set_download_bandwidth()

void linphone_core_set_download_bandwidth ( LinphoneCore core,
int  bandwidth 
)

Sets maximum available download bandwidth This is IP bandwidth, in kbit/s.

This information is used signaled to other parties during calls (within SDP messages) so that the remote end can have sufficient knowledge to properly configure its audio & video codec output bitrate to not overflow available bandwidth.

Parameters
corethe LinphoneCore object
bandwidththe bandwidth in kbits/s, 0 for infinite

◆ linphone_core_set_download_ptime()

void linphone_core_set_download_ptime ( LinphoneCore core,
int  ptime 
)

Set audio packetization time linphone expects to receive from peer.

A value of zero means that ptime is not specified.

Parameters
corethe LinphoneCore
ptimethe download packetization time to set

◆ linphone_core_set_echo_canceller_filter_name()

void linphone_core_set_echo_canceller_filter_name ( LinphoneCore core,
const char *  filtername 
)

Set the name of the mediastreamer2 filter to be used for echo cancelling.

This is for advanced users of the library.

Parameters
coreLinphoneCore object
filternameThe name of the mediastreamer2 filter to be used for echo cancelling.

◆ linphone_core_set_enable_sip_update()

void linphone_core_set_enable_sip_update ( const LinphoneCore core,
int  value 
)

Enable or disable the UPDATE method support.

Parameters
coreLinphoneCore object
valueEnable or disable it

◆ linphone_core_set_expected_bandwidth()

void linphone_core_set_expected_bandwidth ( LinphoneCore core,
int  bandwidth 
)

Sets expected available upload bandwidth This is IP bandwidth, in kbit/s.

This information is used by liblinphone together with remote side available bandwidth signaled in SDP messages to properly configure audio & video codec's output bitrate.

Parameters
corethe LinphoneCore object
bandwidththe bandwidth in kbits/s, 0 for infinite

◆ linphone_core_set_media_device()

LinphoneStatus linphone_core_set_media_device ( LinphoneCore core,
const char *  devid 
)

Sets the sound device used for media.

Parameters
coreLinphoneCore object
devidThe device name as returned by linphone_core_get_sound_devices()
Returns
0

◆ linphone_core_set_media_encryption()

LinphoneStatus linphone_core_set_media_encryption ( LinphoneCore core,
LinphoneMediaEncryption  menc 
)

Choose the media encryption policy to be used for RTP packets.

Parameters
coreLinphoneCore object.
mencThe media encryption policy to be used.
Returns
0 if successful, any other value otherwise.

◆ linphone_core_set_media_encryption_mandatory()

void linphone_core_set_media_encryption_mandatory ( LinphoneCore core,
bool_t  mandatory 
)

Define whether the configured media encryption is mandatory, if it is and the negotation cannot result in the desired media encryption then the call will fail.

If not an INVITE will be resent with encryption disabled.

Parameters
coreLinphoneCore object.
mandatoryTRUE to set it mandatory; FALSE otherwise.

◆ linphone_core_set_media_level()

MS2_DEPRECATED void linphone_core_set_media_level ( LinphoneCore core,
int  level 
)

Set sound media level in 0-100 scale.

Deprecated:

12/12/2018

◆ linphone_core_set_mic_gain_db()

void linphone_core_set_mic_gain_db ( LinphoneCore core,
float  level 
)

Allow to control microphone level: gain in db.

Parameters
coreLinphoneCore object
levelThe new microphone level

◆ linphone_core_set_mtu()

void linphone_core_set_mtu ( LinphoneCore core,
int  mtu 
)

Sets the maximum transmission unit size in bytes.

This information is useful for sending RTP packets. Default value is 1500.

Parameters
coreLinphoneCore object
mtuThe MTU in bytes

◆ linphone_core_set_native_preview_window_id()

void linphone_core_set_native_preview_window_id ( LinphoneCore core,
void *  window_id 
)

Set the native window id where the preview video (local camera) is to be displayed.

This has to be used in conjonction with linphone_core_use_preview_window(). see linphone_core_set_native_video_window_id() for general details about window_id

On Android : #org.linphone.mediastream.video.capture.CaptureTextureView is used for linphone_core_set_native_preview_window_id(). It is inherited from #TextureView and takes care of rotating the captured image from the camera and scale it to keep it's ratio.

Parameters
coreLinphoneCore object
window_idThe native window id where the preview video is to be displayed.

◆ linphone_core_set_native_ringing_enabled()

void linphone_core_set_native_ringing_enabled ( LinphoneCore core,
bool_t  enable 
)

Sets whether to use the native ringing (Android only).

Parameters
coreLinphoneCore object
enableTrue to enable native ringing, false otherwise
Deprecated:
16/12/2021 Use linphone_core_enable_native_ringing() instead.

◆ linphone_core_set_native_video_window_id()

void linphone_core_set_native_video_window_id ( LinphoneCore core,
void *  window_id 
)

Set the native video window id where the video is to be displayed.

On Desktop platforms(MacOS, Linux, Windows), the display filter is "MSOGL" by default. That means : If window_id is not set or set to LINPHONE_VIDEO_DISPLAY_NONE, then the core will not create its own window, unless the special id LINPHONE_VIDEO_DISPLAY_AUTO is given. This is currently only supported for Linux X11 (#Window type), Windows UWP (#SwapChainPanel type) and Windows (#HWND type).

The CSharp Wrapper on Windows for UWP takes directly a #SwapChainPanel without Marshalling. On other platforms, window_id is a #MSOglContextInfo defined in msogl.h of mediastreamer2 There is a special case for Qt : The "MSQOGL" filter must be selected by using linphone_core_set_video_display_filter. Setting window id is only used to stop rendering by passing LINPHONE_VIDEO_DISPLAY_NONE. linphone_core_get_native_preview_window_id() returns a #QQuickFramebufferObject::Renderer and creates one if it doesn't exist. This object must be returned by your QQuickFramebufferObject::createRenderer() overload for Qt.

On mobile operating systems, LINPHONE_VIDEO_DISPLAY_AUTO is not supported and window_id depends of the platform : iOS : It is a #UIView. Android : It is a #TextureView.

Parameters
coreLinphoneCore object
window_idThe native window id where the remote video is to be displayed.

◆ linphone_core_set_network_simulator_params()

LinphoneStatus linphone_core_set_network_simulator_params ( LinphoneCore core,
const OrtpNetworkSimulatorParams *  params 
)

Set the network simulator parameters.

Liblinphone has the capabability of simulating the effects of a network (latency, lost packets, jitter, max bandwidth). Please refer to the oRTP documentation for the meaning of the parameters of the OrtpNetworkSimulatorParams structure. This function has effect for future calls, but not for currently running calls, though this behavior may be changed in future versions.

Warning
Due to design of network simulation in oRTP, simulation is applied independently for audio and video stream. This means for example that a bandwidth limit of 250kbit/s will have no effect on an audio stream running at 40kbit/s while a videostream targetting 400kbit/s will be highly affected.
Parameters
corethe LinphoneCore
paramsthe parameters used for the network simulation.
Returns
0 if successful, -1 otherwise.

◆ linphone_core_set_nortp_timeout()

void linphone_core_set_nortp_timeout ( LinphoneCore core,
int  seconds 
)

Sets the no-rtp timeout value in seconds.

Parameters
coreLinphoneCore object
secondsThe no-rtp timeout value to use in seconds
See also
linphone_core_get_nortp_timeout() for details.

◆ linphone_core_set_payload_type_bitrate()

MS2_DEPRECATED void linphone_core_set_payload_type_bitrate ( LinphoneCore core,
OrtpPayloadType *  pt,
int  bitrate 
)

Set an explicit bitrate (IP bitrate, not codec bitrate) for a given codec, in kbit/s.

Parameters
corethe LinphoneCore object
ptthe payload type to modify.
bitratethe IP bitrate in kbit/s.
Deprecated:
31/03/2017 Use linphone_payload_type_set_normal_bitrate() instead.

◆ linphone_core_set_payload_type_number()

MS2_DEPRECATED void linphone_core_set_payload_type_number ( LinphoneCore core,
OrtpPayloadType *  pt,
int  number 
)

Force a number for a payload type.

The LinphoneCore does payload type number assignment automatically. THis function is to be used mainly for tests, in order to override the automatic assignment mechanism.

Deprecated:
13/02/2017 Use linphone_payload_type_set_number() instead

◆ linphone_core_set_play_file()

void linphone_core_set_play_file ( LinphoneCore core,
const char *  file 
)

Sets a wav file to be played when putting somebody on hold, or when files are used instead of soundcards (see linphone_core_set_use_files()).

The file must be a 16 bit linear wav file.

Parameters
coreLinphoneCore object
fileThe path to the file to be played when putting somebody on hold.

◆ linphone_core_set_play_level()

MS2_DEPRECATED void linphone_core_set_play_level ( LinphoneCore core,
int  level 
)

Set sound playback level in 0-100 scale.

Deprecated:

20/12/2016

◆ linphone_core_set_playback_device()

LinphoneStatus linphone_core_set_playback_device ( LinphoneCore core,
const char *  devid 
)

Sets the sound device used for playback.

Parameters
coreLinphoneCore object
devidThe device name as returned by linphone_core_get_sound_devices()
Returns
0

◆ linphone_core_set_playback_gain_db()

void linphone_core_set_playback_gain_db ( LinphoneCore core,
float  level 
)

Allow to control play level before entering sound card: gain in db.

Parameters
coreLinphoneCore object
levelThe new play level

◆ linphone_core_set_preferred_framerate()

void linphone_core_set_preferred_framerate ( LinphoneCore core,
float  fps 
)

Set the preferred frame rate for video.

Based on the available bandwidth constraints and network conditions, the video encoder remains free to lower the framerate. There is no warranty that the preferred frame rate be the actual framerate. used during a call. Default value is 0, which means "use encoder's default fps value".

Parameters
corethe LinphoneCore
fpsthe target frame rate in number of frames per seconds.

◆ linphone_core_set_preferred_video_definition()

void linphone_core_set_preferred_video_definition ( LinphoneCore core,
LinphoneVideoDefinition video_definition 
)

Set the preferred video definition for the stream that is captured and sent to the remote party.

All standard video definitions are accepted on the receive path.

Parameters
coreLinphoneCore object
video_definitionLinphoneVideoDefinition object

◆ linphone_core_set_preferred_video_definition_by_name()

void linphone_core_set_preferred_video_definition_by_name ( LinphoneCore core,
const char *  name 
)

Sets the preferred video definition by its name.

Call linphone_factory_get_supported_video_definitions() to have a list of supported video definitions.

Parameters
coreThe LinphoneCore object
nameThe name of the definition to set

◆ linphone_core_set_preferred_video_size()

MS2_DEPRECATED void linphone_core_set_preferred_video_size ( LinphoneCore core,
MSVideoSize  vsize 
)

Sets the preferred video size.

This applies only to the stream that is captured and sent to the remote party, since we accept all standard video size on the receive path.

Deprecated:
28/03/2017 Use linphone_core_set_preferred_video_definition() instead.

◆ linphone_core_set_preferred_video_size_by_name()

MS2_DEPRECATED void linphone_core_set_preferred_video_size_by_name ( LinphoneCore core,
const char *  name 
)

Sets the preferred video size by its name.

This is identical to linphone_core_set_preferred_video_size() except that it takes the name of the video resolution as input. Video resolution names are: qcif, svga, cif, vga, 4cif, svga ...

Deprecated:
28/03/2017 Use linphone_core_set_preferred_video_definition_by_name() instead

◆ linphone_core_set_preview_video_definition()

void linphone_core_set_preview_video_definition ( LinphoneCore core,
LinphoneVideoDefinition video_definition 
)

Set the video definition for the captured (preview) video.

This method is for advanced usage where a video capture must be set independently of the definition of the stream actually sent through the call. This allows for example to have the preview window in High Definition even if due to bandwidth constraint the sent video definition is small. Using this feature increases the CPU consumption, since a rescaling will be done internally.

Parameters
coreLinphoneCore object
video_definitionLinphoneVideoDefinition object

◆ linphone_core_set_preview_video_definition_by_name()

void linphone_core_set_preview_video_definition_by_name ( LinphoneCore core,
const char *  name 
)
Parameters
coreThe LinphoneCore object
nameThe name of the definition to set

◆ linphone_core_set_preview_video_size()

MS2_DEPRECATED void linphone_core_set_preview_video_size ( LinphoneCore core,
MSVideoSize  vsize 
)

Sets the video size for the captured (preview) video.

This method is for advanced usage where a video capture must be set independently of the size of the stream actually sent through the call. This allows for example to have the preview window with HD resolution even if due to bandwidth constraint the sent video size is small. Using this feature increases the CPU consumption, since a rescaling will be done internally.

Parameters
corethe linphone core
vsizethe video resolution choosed for capuring and previewing. It can be (0,0) to not request any specific preview size and let the core optimize the processing.
Deprecated:
28/03/2017 Use linphone_core_set_preview_video_definition() instead.

◆ linphone_core_set_preview_video_size_by_name()

MS2_DEPRECATED void linphone_core_set_preview_video_size_by_name ( LinphoneCore core,
const char *  name 
)

Sets the preview video size by its name.

See linphone_core_set_preview_video_size() for more information about this feature.

Video resolution names are: qcif, svga, cif, vga, 4cif, svga ...

Deprecated:
28/03/2017 Use linphone_core_set_preview_video_definition_by_name() instead

◆ linphone_core_set_qrcode_decode_rect()

void linphone_core_set_qrcode_decode_rect ( LinphoneCore core,
const int  x,
const int  y,
const int  w,
const int  h 
)

Set the rectangle where the decoder will search a QRCode.

Parameters
coreLinphoneCore* object
xaxis
yaxis
wwidth
hheight

◆ linphone_core_set_rec_level()

MS2_DEPRECATED void linphone_core_set_rec_level ( LinphoneCore core,
int  level 
)

Set sound capture level in 0-100 scale.

Deprecated:

20/12/2016

◆ linphone_core_set_record_file()

void linphone_core_set_record_file ( LinphoneCore core,
const char *  file 
)

Sets a wav file where incoming stream is to be recorded, when files are used instead of soundcards (see linphone_core_set_use_files()).

This feature is different from call recording (linphone_call_params_set_record_file()) The file will be a 16 bit linear wav file.

Parameters
coreLinphoneCore object
fileThe path to the file where incoming stream is to be recorded.

◆ linphone_core_set_remote_ringback_tone()

void linphone_core_set_remote_ringback_tone ( LinphoneCore core,
const char *  ring 
)

Specify a ring back tone to be played to far end during incoming calls.

Parameters
coreLinphoneCore object
ringThe path to the remote ring back tone to be played.

◆ linphone_core_set_ring()

void linphone_core_set_ring ( LinphoneCore core,
const char *  path 
)

Sets the path to a wav file used for ringing.

The file must be a wav 16bit linear. If null, ringing is disable unless #linphone_core_get_use_native_ringing() is enabled, in which case we use the device ringtone.

Parameters
coreLinphoneCore object
pathThe path to a wav file to be used for ringing, null to disable or use device ringing depending on #linphone_core_get_use_native_ringing().

◆ linphone_core_set_ring_during_incoming_early_media()

void linphone_core_set_ring_during_incoming_early_media ( LinphoneCore core,
bool_t  enable 
)

Enable or disable the ring play during an incoming early media call.

Parameters
coreLinphoneCore object
enableA boolean value telling whether to enable ringing during an incoming early media call.

◆ linphone_core_set_ring_level()

MS2_DEPRECATED void linphone_core_set_ring_level ( LinphoneCore core,
int  level 
)

Set sound ring level in 0-100 scale.

Deprecated:
20/12/2016

◆ linphone_core_set_ringback()

void linphone_core_set_ringback ( LinphoneCore core,
const char *  path 
)

Sets the path to a wav file used for ringing back.

Ringback means the ring that is heard when it's ringing at the remote party. The file must be a wav 16bit linear.

Parameters
coreLinphoneCore object
pathThe path to a wav file to be used for ringing back.

◆ linphone_core_set_ringer_device()

LinphoneStatus linphone_core_set_ringer_device ( LinphoneCore core,
const char *  devid 
)

Sets the sound device used for ringing.

Parameters
coreLinphoneCore object
devidThe device name as returned by linphone_core_get_sound_devices()
Returns
0

◆ linphone_core_set_session_expires_enabled()

void linphone_core_set_session_expires_enabled ( const LinphoneCore core,
bool_t  enabled 
)

Enable the Session Timers support.

Parameters
coreLinphoneCore object
enabledEnable or disable it
Deprecated:
16/12/2021 Use linphone_core_enable_session_expires() instead.

◆ linphone_core_set_session_expires_min_value()

void linphone_core_set_session_expires_min_value ( const LinphoneCore core,
int  min 
)

Sets the session expires minSE value, forced to a minimum of 90 by default.

Parameters
coreLinphoneCore object
expireThe minSE value

◆ linphone_core_set_session_expires_refresher_value()

void linphone_core_set_session_expires_refresher_value ( const LinphoneCore core,
LinphoneSessionExpiresRefresher  refresher 
)

Sets the session expires refresher value.

Parameters
coreLinphoneCore object
refresherThe LinphoneSessionExpiresRefresher configuration value

◆ linphone_core_set_session_expires_value()

void linphone_core_set_session_expires_value ( const LinphoneCore core,
int  expires 
)

Sets the session expires value, 0 by default.

Parameters
coreLinphoneCore object
expireThe session expires value

◆ linphone_core_set_sip_transport_timeout()

void linphone_core_set_sip_transport_timeout ( LinphoneCore core,
int  timeout_ms 
)

Set the SIP transport timeout.

Parameters
coreLinphoneCore object.
timeout_msThe SIP transport timeout in milliseconds.

◆ linphone_core_set_static_picture()

LinphoneStatus linphone_core_set_static_picture ( LinphoneCore core,
const char *  path 
)

Set the path to the image file to stream when "Static picture" is set as the video device.

Parameters
coreLinphoneCore object.
pathThe path to the image file to use.

◆ linphone_core_set_static_picture_fps()

LinphoneStatus linphone_core_set_static_picture_fps ( LinphoneCore core,
float  fps 
)

Set the frame rate for static picture.

Parameters
coreLinphoneCore object.
fpsThe new frame rate to use for static picture.

◆ linphone_core_set_supported_media_encryptions()

void linphone_core_set_supported_media_encryptions ( LinphoneCore lc,
const bctbx_list_t *  encs 
)

Sets the supported media encryptions.

Parameters
coreLinphoneCore object.
enc_listThe supported media encryptions. Elements of the list are pointers to the values of enum LinphoneMediaEncryption.

◆ linphone_core_set_text_codecs()

MS2_DEPRECATED LinphoneStatus linphone_core_set_text_codecs ( LinphoneCore core,
bctbx_list_t *  codecs 
)

Sets the list of text codecs.

Parameters
coreThe LinphoneCore object
codecsThe new list of codecs. The list is taken by the LinphoneCore, thus the application should not free it.
Returns
0
Deprecated:

31/03/2017 Use linphone_core_set_text_payload_types() instead.

◆ linphone_core_set_text_payload_types()

void linphone_core_set_text_payload_types ( LinphoneCore core,
const bctbx_list_t *  payload_types 
)

Redefine the list of the available payload types.

Parameters
coreThe core.
payload_typesThe new list of payload types. The core does not take ownership on it.

◆ linphone_core_set_text_port_range()

void linphone_core_set_text_port_range ( LinphoneCore core,
int  min_port,
int  max_port 
)

Sets the UDP port range from which to randomly select the port used for text streaming.

Parameters
coreLinphoneCore object
min_portThe lower bound of the text port range to use
max_portThe upper bound of the text port range to use

◆ linphone_core_set_tone()

void linphone_core_set_tone ( LinphoneCore core,
LinphoneToneID  tone_id,
const char *  audiofile 
)

Assign an audio file to be played as a specific tone id.

This function typically allows to customize telephony tones per country.

Parameters
corethe core
tone_idthe #LinphoneToneId
audiofilea wav file to be played or NULL to disable it.

◆ linphone_core_set_upload_bandwidth()

void linphone_core_set_upload_bandwidth ( LinphoneCore core,
int  bandwidth 
)

Sets maximum available upload bandwidth This is IP bandwidth, in kbit/s.

This information is used by liblinphone together with remote side available bandwidth signaled in SDP messages to properly configure audio & video codec's output bitrate.

Parameters
corethe LinphoneCore object
bandwidththe bandwidth in kbits/s, 0 for infinite

◆ linphone_core_set_upload_ptime()

void linphone_core_set_upload_ptime ( LinphoneCore core,
int  ptime 
)

Set audio packetization time linphone will send (in absence of requirement from peer) A value of 0 stands for the current codec default packetization time.

Parameters
corethe LinphoneCore
ptimethe upload packetization time to set

◆ linphone_core_set_use_files()

void linphone_core_set_use_files ( LinphoneCore core,
bool_t  yesno 
)

Ask the core to stream audio from and to files, instead of using the soundcard.

Parameters
coreLinphoneCore object
yesnoA boolean value asking to stream audio from and to files or not.

◆ linphone_core_set_use_info_for_dtmf()

void linphone_core_set_use_info_for_dtmf ( LinphoneCore core,
bool_t  use_info 
)

Sets whether SIP INFO is to be used to send digits.

Parameters
coreLinphoneCore object
use_infoA boolean value telling whether to use SIP INFO to send digits

◆ linphone_core_set_use_rfc2833_for_dtmf()

void linphone_core_set_use_rfc2833_for_dtmf ( LinphoneCore core,
bool_t  use_rfc2833 
)

Sets whether RFC2833 is to be used to send digits.

Parameters
coreLinphoneCore object
use_rfc2833A boolean value telling whether to use RFC2833 to send digits

◆ linphone_core_set_video_activation_policy()

void linphone_core_set_video_activation_policy ( LinphoneCore core,
const LinphoneVideoActivationPolicy policy 
)

Sets the default policy for video.

This policy defines whether:

  • video shall be initiated by default for outgoing calls
  • video shall be accepted by default for incoming calls
Parameters
corethe LinphoneCore object
policyThe LinphoneVideoActivationPolicy to use

◆ linphone_core_set_video_codecs()

MS2_DEPRECATED LinphoneStatus linphone_core_set_video_codecs ( LinphoneCore core,
bctbx_list_t *  codecs 
)

Sets the list of video codecs.

Parameters
coreThe LinphoneCore object
codecsThe new list of codecs. The list is taken by the LinphoneCore, thus the application should not free it.
Returns
0
Deprecated:

31/03/2017 Use linphone_core_set_video_payload_types() instead.

◆ linphone_core_set_video_device()

LinphoneStatus linphone_core_set_video_device ( LinphoneCore core,
const char *  id 
)

Sets the active video device.

Parameters
coreLinphoneCore object
idThe name of the video device to use as returned by linphone_core_get_video_devices()

◆ linphone_core_set_video_display_filter()

void linphone_core_set_video_display_filter ( LinphoneCore core,
const char *  filter_name 
)

Set the name of the mediastreamer2 filter to be used for rendering video.

This is for advanced users of the library, mainly to workaround hardware/driver bugs.

Parameters
corethe LinphoneCore
filter_namethe filter name to use or NULL to use default.

◆ linphone_core_set_video_jittcomp()

void linphone_core_set_video_jittcomp ( LinphoneCore core,
int  milliseconds 
)

Sets the nominal video jitter buffer size in milliseconds.

The value takes effect immediately for all running and pending calls, if any. A value of 0 disables the jitter buffer.

Parameters
corethe LinphoneCore
millisecondsthe jitter buffer size in milliseconds

◆ linphone_core_set_video_multicast_addr()

LinphoneStatus linphone_core_set_video_multicast_addr ( LinphoneCore core,
const char *  ip 
)

Use to set multicast address to be used for video stream.

Parameters
coreLinphoneCore
ipan ipv4/6 multicast address.
Returns
0 in case of success

◆ linphone_core_set_video_multicast_ttl()

LinphoneStatus linphone_core_set_video_multicast_ttl ( LinphoneCore core,
int  ttl 
)

Use to set multicast ttl to be used for video stream.

Parameters
coreLinphoneCore
ttlvalue or -1 if not used. [0..255] default value is 1
Returns
0 in case of success

◆ linphone_core_set_video_payload_types()

void linphone_core_set_video_payload_types ( LinphoneCore core,
const bctbx_list_t *  payload_types 
)

Redefine the list of the available video payload types.

Parameters
coreThe core.
payload_typesThe new list of codecs. The core does not take ownership on it.

◆ linphone_core_set_video_policy()

MS2_DEPRECATED void linphone_core_set_video_policy ( LinphoneCore core,
const LinphoneVideoPolicy policy 
)

Sets the default policy for video.

This policy defines whether:

  • video shall be initiated by default for outgoing calls
  • video shall be accepter by default for incoming calls
Parameters
coreLinphoneCore object
policyThe video policy to use
Deprecated:
19/04/2017 Use linphone_video_activation_policy_set_automatically_accept instead

◆ linphone_core_set_video_port_range()

void linphone_core_set_video_port_range ( LinphoneCore core,
int  min_port,
int  max_port 
)

Sets the UDP port range from which to randomly select the port used for video streaming.

Parameters
coreLinphoneCore object
min_portThe lower bound of the video port range to use
max_portThe upper bound of the video port range to use

◆ linphone_core_set_video_preset()

void linphone_core_set_video_preset ( LinphoneCore core,
const char *  preset 
)

Set the video preset to be used for video calls.

Parameters
coreLinphoneCore object
presetThe name of the video preset to be used (can be NULL to use the default video preset).

◆ linphone_core_sound_device_can_capture()

MS2_DEPRECATED bool_t linphone_core_sound_device_can_capture ( LinphoneCore core,
const char *  device 
)

Tells whether a specified sound device can capture sound.

Parameters
coreLinphoneCore object
devicethe device name as returned by linphone_core_get_sound_devices()
Returns
A boolean value telling whether the specified sound device can capture sound
Deprecated:
08/07/2020 use LinphoneAudioDevice API instead()

◆ linphone_core_sound_device_can_playback()

MS2_DEPRECATED bool_t linphone_core_sound_device_can_playback ( LinphoneCore core,
const char *  device 
)

Tells whether a specified sound device can play sound.

Parameters
coreLinphoneCore object
devicethe device name as returned by linphone_core_get_sound_devices()
Returns
A boolean value telling whether the specified sound device can play sound
Deprecated:
08/07/2020 use LinphoneAudioDevice API instead()

◆ linphone_core_stop_dtmf()

void linphone_core_stop_dtmf ( LinphoneCore core)

Stops playing a dtmf started by linphone_core_play_dtmf().

Parameters
coreLinphoneCore object

◆ linphone_core_stop_ringing()

void linphone_core_stop_ringing ( LinphoneCore core)

Whenever the liblinphone is playing a ring to advertise an incoming call or ringback of an outgoing call, this function stops the ringing.

Typical use is to stop ringing when the user requests to ignore the call.

Parameters
coreLinphoneCore object

◆ linphone_core_tcap_lines_merging_enabled()

bool_t linphone_core_tcap_lines_merging_enabled ( const LinphoneCore core)

Check if tcap lines are going to the merged if the capability negotiation (RFC5939) is supported or not.

Parameters
coreLinphoneCore object.
Returns
TRUE if tcap lines with consecutive indexes are going to be merged; FALSE otherwise.

◆ linphone_core_use_preview_window()

void linphone_core_use_preview_window ( LinphoneCore core,
bool_t  yesno 
)

Tells the core to use a separate window for local camera preview video, instead of inserting local view within the remote video window.

Parameters
coreLinphoneCore object.
yesnoTRUE to use a separate window, FALSE to insert the preview in the remote video window.

◆ linphone_core_video_adaptive_jittcomp_enabled()

bool_t linphone_core_video_adaptive_jittcomp_enabled ( LinphoneCore core)

Tells whether the video adaptive jitter compensation is enabled.

Parameters
coreLinphoneCore object
Returns
TRUE if the video adaptive jitter compensation is enabled, FALSE otherwise.

◆ linphone_core_video_capture_enabled()

bool_t linphone_core_video_capture_enabled ( LinphoneCore core)

Tells whether video capture is enabled.

Parameters
coreLinphoneCore object.
Returns
TRUE if video capture is enabled, FALSE if disabled.

◆ linphone_core_video_display_enabled()

bool_t linphone_core_video_display_enabled ( LinphoneCore core)

Tells whether video display is enabled.

Parameters
coreLinphoneCore object.
Returns
TRUE if video display is enabled, FALSE if disabled.

◆ linphone_core_video_enabled()

bool_t linphone_core_video_enabled ( LinphoneCore core)

Returns TRUE if either capture or display is enabled, FALSE otherwise.

same as ( linphone_core_video_capture_enabled() | linphone_core_video_display_enabled() )

Parameters
corethe LinphoneCore
Returns
TRUE if either capture or display is enabled, FALSE otherwise.

◆ linphone_core_video_multicast_enabled()

bool_t linphone_core_video_multicast_enabled ( const LinphoneCore core)

Use to get multicast state of video stream.

Parameters
coreLinphoneCore
Returns
TRUE if subsequent calls will propose multicast ip set by linphone_core_set_video_multicast_addr()

◆ linphone_core_video_preview_enabled()

bool_t linphone_core_video_preview_enabled ( const LinphoneCore core)

Tells whether video preview is enabled.

Parameters
coreLinphoneCore object
Returns
A boolean value telling whether video preview is enabled

◆ linphone_core_zero_rtp_port_for_stream_inactive_enabled()

bool_t linphone_core_zero_rtp_port_for_stream_inactive_enabled ( const LinphoneCore lc)

Check if RTP port is set to 0 when a stream is inactive.

Parameters
coreLinphoneCore object.
Returns
TRUE if the RTP port is set to 0 if the stream direction is inactive; FALSE otherwise.

◆ linphone_media_encryption_from_string()

int linphone_media_encryption_from_string ( const char *  value)

Convert string to enum member.

Parameters
astring representation of the LinphoneMediaEncryption to convert
Returns
integer value of the media_encryption in enum LinphoneMediaEncryption or -1 if it is not found

◆ linphone_media_encryption_to_string()

const char* linphone_media_encryption_to_string ( LinphoneMediaEncryption  media_encryption)

Convert enum member to string.

Parameters
media_encryptionthe LinphoneMediaEncryption to convert
Returns
a string representation of the LinphoneMediaEncryption

◆ linphone_payload_type_clone()

LinphonePayloadType* linphone_payload_type_clone ( const LinphonePayloadType orig)

Instantiates a new payload type with values from source.

Parameters
[in]sourceThe LinphonePayloadType object to be cloned.
Returns
The newly created LinphonePayloadType object.

◆ linphone_payload_type_enable()

int linphone_payload_type_enable ( LinphonePayloadType payload_type,
bool_t  enabled 
)

Enable/disable a payload type.

Parameters
payload_typeThe payload type to enable/disable.
enabledSet TRUE for enabling and FALSE for disabling.
Returns
0 for success, -1 for failure.

◆ linphone_payload_type_enabled()

bool_t linphone_payload_type_enabled ( const LinphonePayloadType payload_type)

Check whether a palyoad type is enabled.

Parameters
payload_typethe LinphonePayloadType object
Returns
TRUE if enabled, FALSE if disabled.

◆ linphone_payload_type_get_channels()

int linphone_payload_type_get_channels ( const LinphonePayloadType payload_type)

Get the number of channels.

Parameters
payload_typethe LinphonePayloadType object
Returns
The number of channels.

◆ linphone_payload_type_get_clock_rate()

int linphone_payload_type_get_clock_rate ( const LinphonePayloadType payload_type)

Get the clock rate of a payload type.

Parameters
payload_typethe LinphonePayloadType object
Returns
The clock rate in Hz.

◆ linphone_payload_type_get_description()

char* linphone_payload_type_get_description ( const LinphonePayloadType payload_type)

Return a string describing a payload type.

The format of the string is <mime_type>/<clock_rate>/<channels>.

Parameters
payload_typethe LinphonePayloadType object
Returns
The description of the payload type. Must be release after use.

◆ linphone_payload_type_get_encoder_description()

const char* linphone_payload_type_get_encoder_description ( const LinphonePayloadType payload_type)

Get a description of the encoder used to provide a payload type.

Parameters
payload_typethe LinphonePayloadType object
Returns
The description of the encoder. Can be NULL if the payload type is not supported by Mediastreamer2.

◆ linphone_payload_type_get_mime_type()

const char* linphone_payload_type_get_mime_type ( const LinphonePayloadType payload_type)

Get the mime type.

Parameters
payload_typethe LinphonePayloadType object
Returns
The mime type.

◆ linphone_payload_type_get_normal_bitrate()

int linphone_payload_type_get_normal_bitrate ( const LinphonePayloadType payload_type)

Get the normal bitrate in bits/s.

Parameters
payload_typethe LinphonePayloadType object
Returns
The normal bitrate in bits/s or -1 if an error has occured.

◆ linphone_payload_type_get_number()

int linphone_payload_type_get_number ( const LinphonePayloadType payload_type)

Returns the payload type number assigned for this codec.

Parameters
payload_typethe LinphonePayloadType object
Returns
The number of the payload type.

◆ linphone_payload_type_get_recv_fmtp()

const char* linphone_payload_type_get_recv_fmtp ( const LinphonePayloadType payload_type)

Get the format parameters for incoming streams.

Parameters
payload_typethe LinphonePayloadType object
Returns
The format parameters as string.

◆ linphone_payload_type_get_send_fmtp()

const char* linphone_payload_type_get_send_fmtp ( const LinphonePayloadType payload_type)

Get the format parameters for outgoing streams.

Parameters
payload_typethe LinphonePayloadType object
Returns
The format parameters as string.

◆ linphone_payload_type_get_type()

int linphone_payload_type_get_type ( const LinphonePayloadType payload_type)

Get the type of a payload type.

Parameters
payload_typeThe payload type.
Returns
The type of the payload e.g. PAYLOAD_AUDIO_CONTINUOUS or PAYLOAD_VIDEO.

◆ linphone_payload_type_is_usable()

bool_t linphone_payload_type_is_usable ( const LinphonePayloadType payload_type)

Check whether the payload is usable according the bandwidth targets set in the core.

Parameters
payload_typethe LinphonePayloadType object
Returns
TRUE if the payload type is usable.

◆ linphone_payload_type_is_vbr()

bool_t linphone_payload_type_is_vbr ( const LinphonePayloadType payload_type)

Tells whether the specified payload type represents a variable bitrate codec.

Parameters
payload_typethe LinphonePayloadType object
Returns
TRUE if the payload type represents a VBR codec, FALSE instead.

◆ linphone_payload_type_ref()

LinphonePayloadType* linphone_payload_type_ref ( LinphonePayloadType payload_type)

Take a reference on a LinphonePayloadType.

Parameters
payload_typethe LinphonePayloadType object
Returns
the same LinphonePayloadType object

◆ linphone_payload_type_set_normal_bitrate()

void linphone_payload_type_set_normal_bitrate ( LinphonePayloadType payload_type,
int  bitrate 
)

Change the normal bitrate of a payload type.

Parameters
payload_typethe LinphonePayloadType object
bitrateThe new bitrate in kbits/s.

◆ linphone_payload_type_set_number()

void linphone_payload_type_set_number ( LinphonePayloadType payload_type,
int  number 
)

Force a number for a payload type.

The LinphoneCore does payload type number assignment automatically. This function is mainly to be used for tests, in order to override the automatic assignment mechanism.

Parameters
payload_typethe LinphonePayloadType object
numberThe number to assign to the payload type.

◆ linphone_payload_type_set_recv_fmtp()

void linphone_payload_type_set_recv_fmtp ( LinphonePayloadType payload_type,
const char *  recv_fmtp 
)

Set the format parameters for incoming streams.

Parameters
payload_typethe LinphonePayloadType object
recv_fmtpThe new format parameters as string. The string will be copied.

◆ linphone_payload_type_set_send_fmtp()

void linphone_payload_type_set_send_fmtp ( LinphonePayloadType payload_type,
const char *  send_fmtp 
)

Set the format parameters for outgoing streams.

Parameters
payload_typethe LinphonePayloadType object
send_fmtpThe new format parameters as string. The string will be copied.

◆ linphone_payload_type_unref()

void linphone_payload_type_unref ( LinphonePayloadType payload_type)

Release a reference on a LinphonePayloadType.

Parameters
payload_typethe LinphonePayloadType object

◆ linphone_video_activation_policy_get_automatically_accept()

bool_t linphone_video_activation_policy_get_automatically_accept ( const LinphoneVideoActivationPolicy policy)

Gets the value for the automatically accept video policy.

Parameters
policythe LinphoneVideoActivationPolicy object
Returns
whether or not to automatically accept video requests is enabled

◆ linphone_video_activation_policy_get_automatically_initiate()

bool_t linphone_video_activation_policy_get_automatically_initiate ( const LinphoneVideoActivationPolicy policy)

Gets the value for the automatically initiate video policy.

Parameters
policythe LinphoneVideoActivationPolicy object
Returns
whether or not to automatically initiate video calls is enabled

◆ linphone_video_activation_policy_get_user_data()

void* linphone_video_activation_policy_get_user_data ( const LinphoneVideoActivationPolicy policy)

Gets the user data in the LinphoneVideoActivationPolicy object.

Parameters
policythe LinphoneVideoActivationPolicy
Returns
the user data

◆ linphone_video_activation_policy_ref()

LinphoneVideoActivationPolicy* linphone_video_activation_policy_ref ( LinphoneVideoActivationPolicy policy)

Increment refcount.

Parameters
policyLinphoneVideoActivationPolicy object
Returns
the same LinphoneVideoActivationPolicy object

◆ linphone_video_activation_policy_set_automatically_accept()

void linphone_video_activation_policy_set_automatically_accept ( LinphoneVideoActivationPolicy policy,
bool_t  enable 
)

Sets the value for the automatically accept video policy.

Parameters
policythe LinphoneVideoActivationPolicy object
enablewhether or not to enable automatically accept video requests

◆ linphone_video_activation_policy_set_automatically_initiate()

void linphone_video_activation_policy_set_automatically_initiate ( LinphoneVideoActivationPolicy policy,
bool_t  enable 
)

Sets the value for the automatically initiate video policy.

Parameters
policythe LinphoneVideoActivationPolicy object
enablewhether or not to enable automatically initiate video calls

◆ linphone_video_activation_policy_set_user_data()

void linphone_video_activation_policy_set_user_data ( LinphoneVideoActivationPolicy policy,
void *  user_data 
)

Sets the user data in the LinphoneVideoActivationPolicy object.

Parameters
policythe LinphoneVideoActivationPolicy object
user_datathe user data

◆ linphone_video_activation_policy_unref()

void linphone_video_activation_policy_unref ( LinphoneVideoActivationPolicy policy)

Decrement refcount and possibly free the object.

Parameters
policyLinphoneVideoActivationPolicy object

◆ linphone_video_definition_clone()

LinphoneVideoDefinition* linphone_video_definition_clone ( const LinphoneVideoDefinition video_definition)

Clone a video definition.

Parameters
video_definitionLinphoneVideoDefinition object to be cloned
Returns
The new clone of the video definition

◆ linphone_video_definition_equals()

bool_t linphone_video_definition_equals ( const LinphoneVideoDefinition video_definition1,
const LinphoneVideoDefinition video_definition2 
)

Tells whether two LinphoneVideoDefinition objects are equal (the widths and the heights are the same but can be switched).

Parameters
video_definition1LinphoneVideoDefinition object
video_definition2LinphoneVideoDefinition object
Returns
A boolean value telling whether the two LinphoneVideoDefinition objects are equal.

◆ linphone_video_definition_get_height()

unsigned int linphone_video_definition_get_height ( const LinphoneVideoDefinition video_definition)

Get the height of the video definition.

Parameters
video_definitionLinphoneVideoDefinition object
Returns
The height of the video definition

◆ linphone_video_definition_get_name()

const char* linphone_video_definition_get_name ( const LinphoneVideoDefinition video_definition)

Get the name of the video definition.

Parameters
video_definitionLinphoneVideoDefinition object
Returns
The name of the video definition

◆ linphone_video_definition_get_user_data()

void* linphone_video_definition_get_user_data ( const LinphoneVideoDefinition video_definition)

Retrieve the user pointer associated with the video definition.

Parameters
video_definitionLinphoneVideoDefinition object.
Returns
The user pointer associated with the video definition.

◆ linphone_video_definition_get_width()

unsigned int linphone_video_definition_get_width ( const LinphoneVideoDefinition video_definition)

Get the width of the video definition.

Parameters
video_definitionLinphoneVideoDefinition object
Returns
The width of the video definition

◆ linphone_video_definition_is_undefined()

bool_t linphone_video_definition_is_undefined ( const LinphoneVideoDefinition video_definition)

Tells whether a LinphoneVideoDefinition is undefined.

Parameters
video_definitionLinphoneVideoDefinition object
Returns
A boolean value telling whether the LinphoneVideoDefinition is undefined.

◆ linphone_video_definition_ref()

LinphoneVideoDefinition* linphone_video_definition_ref ( LinphoneVideoDefinition video_definition)

Acquire a reference to the video definition.

Parameters
video_definitionLinphoneVideoDefinition object.
Returns
The same LinphoneVideoDefinition object.

◆ linphone_video_definition_set_definition()

void linphone_video_definition_set_definition ( LinphoneVideoDefinition video_definition,
unsigned int  width,
unsigned int  height 
)

Set the width and the height of the video definition.

Parameters
video_definitionLinphoneVideoDefinition object
widthThe width of the video definition
heightThe height of the video definition

◆ linphone_video_definition_set_height()

void linphone_video_definition_set_height ( LinphoneVideoDefinition video_definition,
unsigned int  height 
)

Set the height of the video definition.

Parameters
video_definitionLinphoneVideoDefinition object
heightThe height of the video definition

◆ linphone_video_definition_set_name()

void linphone_video_definition_set_name ( LinphoneVideoDefinition video_definition,
const char *  name 
)

Set the name of the video definition.

Parameters
video_definitionLinphoneVideoDefinition object
nameThe name of the video definition

◆ linphone_video_definition_set_user_data()

void linphone_video_definition_set_user_data ( LinphoneVideoDefinition video_definition,
void *  user_data 
)

Assign a user pointer to the video definition.

Parameters
video_definitionLinphoneVideoDefinition object.
user_dataThe user pointer to associate with the video definition.

◆ linphone_video_definition_set_width()

void linphone_video_definition_set_width ( LinphoneVideoDefinition video_definition,
unsigned int  width 
)

Set the width of the video definition.

Parameters
video_definitionLinphoneVideoDefinition object
widthThe width of the video definition

◆ linphone_video_definition_strict_equals()

bool_t linphone_video_definition_strict_equals ( const LinphoneVideoDefinition video_definition1,
const LinphoneVideoDefinition video_definition2 
)

Tells whether two LinphoneVideoDefinition objects are strictly equal (the widths are the same and the heights are the same).

Parameters
video_definition1LinphoneVideoDefinition object
video_definition2LinphoneVideoDefinition object
Returns
A boolean value telling whether the two LinphoneVideoDefinition objects are strictly equal.

◆ linphone_video_definition_unref()

void linphone_video_definition_unref ( LinphoneVideoDefinition video_definition)

Release reference to the video definition.

Parameters
video_definitionLinphoneVideoDefinition object.