Liblinphone  3.11.1
Data Structures | Macros | Typedefs | Enumerations | Functions
Controlling media parameters

Data Structures

struct  _LinphoneVideoPolicy
 

Macros

#define LINPHONE_FIND_PAYLOAD_IGNORE_RATE   -1
 
#define LINPHONE_FIND_PAYLOAD_IGNORE_CHANNELS   -1
 
#define LINPHONE_VIDEO_DISPLAY_AUTO   (void*)((unsigned long) 0)
 
#define LINPHONE_VIDEO_DISPLAY_NONE   (void*)((unsigned long) -1)
 

Typedefs

typedef enum _LinphoneAVPFMode LinphoneAVPFMode
 
typedef enum _LinphoneMediaEncryption LinphoneMediaEncryption
 
typedef PayloadType LinphonePayloadType
 
typedef struct _LinphoneVideoPolicy LinphoneVideoPolicy
 

Enumerations

enum  _LinphoneAVPFMode {
  LinphoneAVPFDefault = -1,
  LinphoneAVPFDisabled,
  LinphoneAVPFEnabled
}
 
enum  _LinphoneMediaEncryption {
  LinphoneMediaEncryptionNone,
  LinphoneMediaEncryptionSRTP,
  LinphoneMediaEncryptionZRTP,
  LinphoneMediaEncryptionDTLS
}
 

Functions

void * linphone_call_get_native_video_window_id (const LinphoneCall *call)
 
void linphone_call_set_native_video_window_id (LinphoneCall *call, void *id)
 
void linphone_call_enable_echo_cancellation (LinphoneCall *call, bool_t val)
 
bool_t linphone_call_echo_cancellation_enabled (LinphoneCall *lc)
 
void linphone_call_enable_echo_limiter (LinphoneCall *call, bool_t val)
 
bool_t linphone_call_echo_limiter_enabled (const LinphoneCall *call)
 
void linphone_call_params_enable_audio_multicast (LinphoneCallParams *params, bool_t yesno)
 
bool_t linphone_call_params_audio_multicast_enabled (const LinphoneCallParams *params)
 
void linphone_call_params_enable_video_multicast (LinphoneCallParams *params, bool_t yesno)
 
bool_t linphone_call_params_video_multicast_enabled (const LinphoneCallParams *params)
 
int linphone_call_params_enable_realtime_text (LinphoneCallParams *params, bool_t yesno)
 
bool_t linphone_call_params_realtime_text_enabled (const LinphoneCallParams *params)
 
void linphone_call_params_add_custom_sdp_attribute (LinphoneCallParams *params, const char *attribute_name, const char *attribute_value)
 
void linphone_call_params_add_custom_sdp_media_attribute (LinphoneCallParams *params, LinphoneStreamType type, const char *attribute_name, const char *attribute_value)
 
const char * linphone_call_params_get_custom_sdp_attribute (const LinphoneCallParams *params, const char *attribute_name)
 
const char * linphone_call_params_get_custom_sdp_media_attribute (const LinphoneCallParams *params, LinphoneStreamType type, const char *attribute_name)
 
void linphone_call_params_clear_custom_sdp_attributes (LinphoneCallParams *params)
 
void linphone_call_params_clear_custom_sdp_media_attributes (LinphoneCallParams *params, LinphoneStreamType type)
 
LINPHONE_DEPRECATED void linphone_core_send_dtmf (LinphoneCore *lc, char dtmf)
 
void linphone_core_set_download_bandwidth (LinphoneCore *lc, int bw)
 
void linphone_core_set_upload_bandwidth (LinphoneCore *lc, int bw)
 
int linphone_core_get_download_bandwidth (const LinphoneCore *lc)
 
int linphone_core_get_upload_bandwidth (const LinphoneCore *lc)
 
void linphone_core_enable_adaptive_rate_control (LinphoneCore *lc, bool_t enabled)
 
bool_t linphone_core_adaptive_rate_control_enabled (const LinphoneCore *lc)
 
void linphone_core_set_adaptive_rate_algorithm (LinphoneCore *lc, const char *algorithm)
 
const char * linphone_core_get_adaptive_rate_algorithm (const LinphoneCore *lc)
 
void linphone_core_set_download_ptime (LinphoneCore *lc, int ptime)
 
int linphone_core_get_download_ptime (LinphoneCore *lc)
 
void linphone_core_set_upload_ptime (LinphoneCore *lc, int ptime)
 
int linphone_core_get_upload_ptime (LinphoneCore *lc)
 
void linphone_core_set_sip_transport_timeout (LinphoneCore *lc, int timeout_ms)
 
int linphone_core_get_sip_transport_timeout (LinphoneCore *lc)
 
void linphone_core_enable_dns_srv (LinphoneCore *lc, bool_t enable)
 
bool_t linphone_core_dns_srv_enabled (const LinphoneCore *lc)
 
void linphone_core_enable_dns_search (LinphoneCore *lc, bool_t enable)
 
bool_t linphone_core_dns_search_enabled (const LinphoneCore *lc)
 
void linphone_core_set_dns_servers (LinphoneCore *lc, const bctbx_list_t *servers)
 
const bctbx_list_t * linphone_core_get_audio_codecs (const LinphoneCore *lc)
 
int linphone_core_set_audio_codecs (LinphoneCore *lc, bctbx_list_t *codecs)
 
const bctbx_list_t * linphone_core_get_video_codecs (const LinphoneCore *lc)
 
int linphone_core_set_video_codecs (LinphoneCore *lc, bctbx_list_t *codecs)
 
const bctbx_list_t * linphone_core_get_text_codecs (const LinphoneCore *lc)
 
bool_t linphone_core_payload_type_enabled (LinphoneCore *lc, const LinphonePayloadType *pt)
 
bool_t linphone_core_payload_type_is_vbr (LinphoneCore *lc, const LinphonePayloadType *pt)
 
void linphone_core_set_payload_type_bitrate (LinphoneCore *lc, LinphonePayloadType *pt, int bitrate)
 
int linphone_core_get_payload_type_bitrate (LinphoneCore *lc, const LinphonePayloadType *pt)
 
int linphone_core_enable_payload_type (LinphoneCore *lc, LinphonePayloadType *pt, bool_t enable)
 
LinphonePayloadTypelinphone_core_find_payload_type (LinphoneCore *lc, const char *type, int rate, int channels)
 
int linphone_core_get_payload_type_number (LinphoneCore *lc, const PayloadType *pt)
 
void linphone_core_set_payload_type_number (LinphoneCore *lc, PayloadType *pt, int number)
 
bool_t linphone_core_check_payload_type_usability (LinphoneCore *lc, const PayloadType *pt)
 
void linphone_core_enable_audio_adaptive_jittcomp (LinphoneCore *lc, bool_t enable)
 
bool_t linphone_core_audio_adaptive_jittcomp_enabled (LinphoneCore *lc)
 
int linphone_core_get_audio_jittcomp (LinphoneCore *lc)
 
void linphone_core_set_audio_jittcomp (LinphoneCore *lc, int milliseconds)
 
void linphone_core_enable_video_adaptive_jittcomp (LinphoneCore *lc, bool_t enable)
 
bool_t linphone_core_video_adaptive_jittcomp_enabled (LinphoneCore *lc)
 
int linphone_core_get_video_jittcomp (LinphoneCore *lc)
 
void linphone_core_set_video_jittcomp (LinphoneCore *lc, int milliseconds)
 
int linphone_core_get_nortp_timeout (const LinphoneCore *lc)
 
void linphone_core_set_audio_port_range (LinphoneCore *lc, int min_port, int max_port)
 
void linphone_core_set_video_port_range (LinphoneCore *lc, int min_port, int max_port)
 
void linphone_core_set_text_port_range (LinphoneCore *lc, int min_port, int max_port)
 
void linphone_core_set_nortp_timeout (LinphoneCore *lc, int seconds)
 
void linphone_core_set_use_info_for_dtmf (LinphoneCore *lc, bool_t use_info)
 
bool_t linphone_core_get_use_info_for_dtmf (LinphoneCore *lc)
 
void linphone_core_set_use_rfc2833_for_dtmf (LinphoneCore *lc, bool_t use_rfc2833)
 
bool_t linphone_core_get_use_rfc2833_for_dtmf (LinphoneCore *lc)
 
const char ** linphone_core_get_sound_devices (LinphoneCore *lc)
 
void linphone_core_reload_sound_devices (LinphoneCore *lc)
 
bool_t linphone_core_sound_device_can_capture (LinphoneCore *lc, const char *device)
 
bool_t linphone_core_sound_device_can_playback (LinphoneCore *lc, const char *device)
 
LINPHONE_DEPRECATED int linphone_core_get_ring_level (LinphoneCore *lc)
 
LINPHONE_DEPRECATED int linphone_core_get_play_level (LinphoneCore *lc)
 
LINPHONE_DEPRECATED int linphone_core_get_rec_level (LinphoneCore *lc)
 
LINPHONE_DEPRECATED void linphone_core_set_ring_level (LinphoneCore *lc, int level)
 
LINPHONE_DEPRECATED void linphone_core_set_play_level (LinphoneCore *lc, int level)
 
LINPHONE_DEPRECATED void linphone_core_set_rec_level (LinphoneCore *lc, int level)
 
void linphone_core_set_mic_gain_db (LinphoneCore *lc, float level)
 
float linphone_core_get_mic_gain_db (LinphoneCore *lc)
 
void linphone_core_set_playback_gain_db (LinphoneCore *lc, float level)
 
float linphone_core_get_playback_gain_db (LinphoneCore *lc)
 
const char * linphone_core_get_ringer_device (LinphoneCore *lc)
 
const char * linphone_core_get_playback_device (LinphoneCore *lc)
 
const char * linphone_core_get_capture_device (LinphoneCore *lc)
 
int linphone_core_set_ringer_device (LinphoneCore *lc, const char *devid)
 
int linphone_core_set_playback_device (LinphoneCore *lc, const char *devid)
 
int linphone_core_set_capture_device (LinphoneCore *lc, const char *devid)
 
void linphone_core_stop_ringing (LinphoneCore *lc)
 
void linphone_core_set_ring (LinphoneCore *lc, const char *path)
 
const char * linphone_core_get_ring (const LinphoneCore *lc)
 
void linphone_core_set_ringback (LinphoneCore *lc, const char *path)
 
const char * linphone_core_get_ringback (const LinphoneCore *lc)
 
void linphone_core_set_remote_ringback_tone (LinphoneCore *lc, const char *ring)
 
const char * linphone_core_get_remote_ringback_tone (const LinphoneCore *lc)
 
void linphone_core_set_ring_during_incoming_early_media (LinphoneCore *lc, bool_t enable)
 
void linphone_core_enable_echo_cancellation (LinphoneCore *lc, bool_t val)
 
bool_t linphone_core_echo_cancellation_enabled (LinphoneCore *lc)
 
void linphone_core_enable_echo_limiter (LinphoneCore *lc, bool_t val)
 
bool_t linphone_core_echo_limiter_enabled (const LinphoneCore *lc)
 
void linphone_core_enable_mic (LinphoneCore *lc, bool_t enable)
 
bool_t linphone_core_mic_enabled (LinphoneCore *lc)
 
LINPHONE_DEPRECATED void linphone_core_enable_video (LinphoneCore *lc, bool_t vcap_enabled, bool_t display_enabled)
 
bool_t linphone_core_video_enabled (LinphoneCore *lc)
 
void linphone_core_enable_video_capture (LinphoneCore *lc, bool_t enable)
 
void linphone_core_enable_video_display (LinphoneCore *lc, bool_t enable)
 
void linphone_core_enable_video_source_reuse (LinphoneCore *lc, bool_t enable)
 
bool_t linphone_core_video_capture_enabled (LinphoneCore *lc)
 
bool_t linphone_core_video_display_enabled (LinphoneCore *lc)
 
void linphone_core_set_video_policy (LinphoneCore *lc, const LinphoneVideoPolicy *policy)
 
const LinphoneVideoPolicylinphone_core_get_video_policy (const LinphoneCore *lc)
 
const MSVideoSizeDeflinphone_core_get_supported_video_sizes (LinphoneCore *lc)
 
void linphone_core_set_preferred_video_size (LinphoneCore *lc, MSVideoSize vsize)
 
void linphone_core_set_preview_video_size (LinphoneCore *lc, MSVideoSize vsize)
 
void linphone_core_set_preview_video_size_by_name (LinphoneCore *lc, const char *name)
 
MSVideoSize linphone_core_get_preview_video_size (const LinphoneCore *lc)
 
MSVideoSize linphone_core_get_current_preview_video_size (const LinphoneCore *lc)
 
MSVideoSize linphone_core_get_preferred_video_size (const LinphoneCore *lc)
 
void linphone_core_set_preferred_video_size_by_name (LinphoneCore *lc, const char *name)
 
void linphone_core_set_preferred_framerate (LinphoneCore *lc, float fps)
 
float linphone_core_get_preferred_framerate (LinphoneCore *lc)
 
void linphone_core_enable_video_preview (LinphoneCore *lc, bool_t val)
 
bool_t linphone_core_video_preview_enabled (const LinphoneCore *lc)
 
void linphone_core_enable_self_view (LinphoneCore *lc, bool_t val)
 
bool_t linphone_core_self_view_enabled (const LinphoneCore *lc)
 
void linphone_core_reload_video_devices (LinphoneCore *lc)
 
const char ** linphone_core_get_video_devices (const LinphoneCore *lc)
 
int linphone_core_set_video_device (LinphoneCore *lc, const char *id)
 
const char * linphone_core_get_video_device (const LinphoneCore *lc)
 
int linphone_core_set_static_picture (LinphoneCore *lc, const char *path)
 
const char * linphone_core_get_static_picture (LinphoneCore *lc)
 
int linphone_core_set_static_picture_fps (LinphoneCore *lc, float fps)
 
float linphone_core_get_static_picture_fps (LinphoneCore *lc)
 
void * linphone_core_get_native_video_window_id (const LinphoneCore *lc)
 
void linphone_core_set_native_video_window_id (LinphoneCore *lc, void *id)
 
void * linphone_core_get_native_preview_window_id (const LinphoneCore *lc)
 
void linphone_core_set_native_preview_window_id (LinphoneCore *lc, void *id)
 
void linphone_core_use_preview_window (LinphoneCore *lc, bool_t yesno)
 
int linphone_core_get_device_rotation (LinphoneCore *lc)
 
void linphone_core_set_device_rotation (LinphoneCore *lc, int rotation)
 
void linphone_core_set_use_files (LinphoneCore *lc, bool_t yesno)
 
bool_t linphone_core_get_use_files (LinphoneCore *lc)
 
const char * linphone_core_get_play_file (const LinphoneCore *lc)
 
void linphone_core_set_play_file (LinphoneCore *lc, const char *file)
 
const char * linphone_core_get_record_file (const LinphoneCore *lc)
 
void linphone_core_set_record_file (LinphoneCore *lc, const char *file)
 
void linphone_core_play_dtmf (LinphoneCore *lc, char dtmf, int duration_ms)
 
void linphone_core_stop_dtmf (LinphoneCore *lc)
 
void linphone_core_set_mtu (LinphoneCore *lc, int mtu)
 
int linphone_core_set_media_encryption (LinphoneCore *lc, LinphoneMediaEncryption menc)
 
LinphoneMediaEncryption linphone_core_get_media_encryption (LinphoneCore *lc)
 
bool_t linphone_core_is_media_encryption_mandatory (LinphoneCore *lc)
 
void linphone_core_set_media_encryption_mandatory (LinphoneCore *lc, bool_t m)
 
const char * linphone_core_get_video_display_filter (LinphoneCore *lc)
 
void linphone_core_set_video_display_filter (LinphoneCore *lc, const char *filtername)
 
const char ** linphone_core_get_supported_file_formats (LinphoneCore *core)
 
void linphone_core_set_avpf_mode (LinphoneCore *lc, LinphoneAVPFMode mode)
 
LinphoneAVPFMode linphone_core_get_avpf_mode (const LinphoneCore *lc)
 
void linphone_core_set_avpf_rr_interval (LinphoneCore *lc, int interval)
 
int linphone_core_get_avpf_rr_interval (const LinphoneCore *lc)
 
int linphone_core_set_audio_multicast_addr (LinphoneCore *core, const char *ip)
 
int linphone_core_set_video_multicast_addr (LinphoneCore *lc, const char *ip)
 
const char * linphone_core_get_audio_multicast_addr (const LinphoneCore *core)
 
const char * linphone_core_get_video_multicast_addr (const LinphoneCore *core)
 
int linphone_core_set_audio_multicast_ttl (LinphoneCore *core, int ttl)
 
int linphone_core_set_video_multicast_ttl (LinphoneCore *lc, int ttl)
 
int linphone_core_get_audio_multicast_ttl (const LinphoneCore *core)
 
int linphone_core_get_video_multicast_ttl (const LinphoneCore *core)
 
void linphone_core_enable_audio_multicast (LinphoneCore *core, bool_t yesno)
 
bool_t linphone_core_audio_multicast_enabled (const LinphoneCore *core)
 
void linphone_core_enable_video_multicast (LinphoneCore *core, bool_t yesno)
 
bool_t linphone_core_video_multicast_enabled (const LinphoneCore *core)
 
int linphone_core_set_network_simulator_params (LinphoneCore *lc, const OrtpNetworkSimulatorParams *params)
 
const OrtpNetworkSimulatorParams * linphone_core_get_network_simulator_params (const LinphoneCore *lc)
 
void linphone_core_set_video_preset (LinphoneCore *lc, const char *preset)
 
const char * linphone_core_get_video_preset (const LinphoneCore *lc)
 
bool_t linphone_core_realtime_text_enabled (LinphoneCore *lc)
 
const char * linphone_media_encryption_to_string (LinphoneMediaEncryption menc)
 
int linphone_payload_type_get_type (const LinphonePayloadType *pt)
 
int linphone_payload_type_get_normal_bitrate (const LinphonePayloadType *pt)
 
const char * linphone_payload_type_get_mime_type (const LinphonePayloadType *pt)
 
int linphone_payload_type_get_channels (const LinphonePayloadType *pt)
 

Detailed Description

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

Macro Definition Documentation

§ LINPHONE_FIND_PAYLOAD_IGNORE_CHANNELS

#define LINPHONE_FIND_PAYLOAD_IGNORE_CHANNELS   -1

Wildcard value used by linphone_core_find_payload_type to ignore channel in search algorithm

§ LINPHONE_FIND_PAYLOAD_IGNORE_RATE

#define LINPHONE_FIND_PAYLOAD_IGNORE_RATE   -1

Wildcard value used by linphone_core_find_payload_type to ignore rate in search algorithm

§ LINPHONE_VIDEO_DISPLAY_AUTO

#define LINPHONE_VIDEO_DISPLAY_AUTO   (void*)((unsigned long) 0)

For MacOS, Linux, Windows: core will create its own window

§ LINPHONE_VIDEO_DISPLAY_NONE

#define LINPHONE_VIDEO_DISPLAY_NONE   (void*)((unsigned long) -1)

For MacOS, Linux, Windows: do nothing

Typedef Documentation

§ LinphoneAVPFMode

Enum describing RTP AVPF activation modes.

§ LinphoneMediaEncryption

Enum describing type of media encryption types.

§ LinphonePayloadType

typedef PayloadType LinphonePayloadType

Object representing an RTP payload type.

§ LinphoneVideoPolicy

Structure describing policy regarding video streams establishments.

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

§ _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

Function Documentation

§ linphone_call_echo_cancellation_enabled()

bool_t linphone_call_echo_cancellation_enabled ( LinphoneCall lc)

Returns TRUE if echo cancellation is enabled.

§ linphone_call_echo_limiter_enabled()

bool_t linphone_call_echo_limiter_enabled ( const LinphoneCall call)

Returns TRUE if echo limiter is enabled.

§ linphone_call_enable_echo_cancellation()

void linphone_call_enable_echo_cancellation ( LinphoneCall call,
bool_t  val 
)

Enables or disable echo cancellation for this call

Parameters
call
val

§ linphone_call_enable_echo_limiter()

void linphone_call_enable_echo_limiter ( LinphoneCall call,
bool_t  val 
)

Enables or disable echo limiter for this call

Parameters
call
val

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

§ 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
[in]paramsThe LinphoneCallParams to add a custom SDP attribute to.
[in]attribute_nameThe name of the attribute to add.
[in]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
[in]paramsThe LinphoneCallParams to add a custom SDP attribute to.
[in]typeThe type of the stream to add a custom SDP attribute to.
[in]attribute_nameThe name of the attribute to add.
[in]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_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
[in]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
[in]paramsThe LinphoneCallParams to clear the custom SDP attributes from.
[in]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_realtime_text()

int 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

§ 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_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
[in]paramsThe LinphoneCallParams to get the custom SDP attribute from.
[in]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
[in]paramsThe LinphoneCallParams to get the custom SDP attribute from.
[in]typeThe type of the stream to add a custom SDP attribute to.
[in]attribute_nameThe name of the attribute to get.
Returns
The content value of the attribute or NULL if not found.

§ 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_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 *  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.

§ linphone_core_adaptive_rate_control_enabled()

bool_t linphone_core_adaptive_rate_control_enabled ( const LinphoneCore lc)

Returns whether adaptive rate control is enabled.

See also
linphone_core_enable_adaptive_rate_control()

§ linphone_core_audio_adaptive_jittcomp_enabled()

bool_t linphone_core_audio_adaptive_jittcomp_enabled ( LinphoneCore lc)

Tells whether the audio adaptive jitter compensation is enabled.

Parameters
[in]lcLinphoneCore 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_check_payload_type_usability()

bool_t linphone_core_check_payload_type_usability ( LinphoneCore lc,
const PayloadType *  pt 
)

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

§ linphone_core_dns_search_enabled()

bool_t linphone_core_dns_search_enabled ( const LinphoneCore lc)

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

Parameters
[in]lcLinphoneCore 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 lc)

Tells whether DNS SRV resolution is enabled.

Parameters
[in]lcLinphoneCore object.
Returns
TRUE if DNS SRV resolution is enabled, FALSE if disabled.

§ linphone_core_echo_cancellation_enabled()

bool_t linphone_core_echo_cancellation_enabled ( LinphoneCore lc)

Returns TRUE if echo cancellation is enabled.

Parameters
[in]lcLinphoneCore 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 lc)

Tells whether echo limiter is enabled.

Parameters
[in]lcLinphoneCore 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 lc,
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.

§ linphone_core_enable_audio_adaptive_jittcomp()

void linphone_core_enable_audio_adaptive_jittcomp ( LinphoneCore lc,
bool_t  enable 
)

Enable or disable the audio adaptive jitter compensation.

Parameters
[in]lcLinphoneCore object
[in]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_dns_search()

void linphone_core_enable_dns_search ( LinphoneCore lc,
bool_t  enable 
)

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

Parameters
[in]lcLinphoneCore object.
[in]enableTRUE to enable DNS search, FALSE to disable it.

§ linphone_core_enable_dns_srv()

void linphone_core_enable_dns_srv ( LinphoneCore lc,
bool_t  enable 
)

Enable or disable DNS SRV resolution.

Parameters
[in]lcLinphoneCore object.
[in]enableTRUE to enable DNS SRV resolution, FALSE to disable it.

§ linphone_core_enable_echo_cancellation()

void linphone_core_enable_echo_cancellation ( LinphoneCore lc,
bool_t  val 
)

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
[in]lcLinphoneCore object
[in]valA boolean value telling whether echo cancellation is to be enabled or disabled.

§ linphone_core_enable_echo_limiter()

void linphone_core_enable_echo_limiter ( LinphoneCore lc,
bool_t  val 
)

Enables or disable echo limiter.

Parameters
[in]lcLinphoneCore object.
[in]valTRUE to enable echo limiter, FALSE to disable it.

§ linphone_core_enable_mic()

void linphone_core_enable_mic ( LinphoneCore lc,
bool_t  enable 
)

Enable or disable the microphone.

Parameters
[in]lcLinphoneCore object
[in]enableTRUE to enable the microphone, FALSE to disable it.

§ linphone_core_enable_payload_type()

int linphone_core_enable_payload_type ( LinphoneCore lc,
LinphonePayloadType pt,
bool_t  enable 
)

Enable or disable the use of the specified payload type.

Parameters
[in]lcLinphoneCore object.
[in]ptThe LinphonePayloadType to enable or disable. It can be retrieved using linphone_core_find_payload_type
[in]enableTRUE to enable the payload type, FALSE to disable it.
Returns
0 if successful, any other value otherwise.

§ linphone_core_enable_self_view()

void linphone_core_enable_self_view ( LinphoneCore lc,
bool_t  val 
)

Enables or disable self view during calls.

Parameters
[in]lcLinphoneCore object
[in]valA 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_video()

LINPHONE_DEPRECATED void linphone_core_enable_video ( LinphoneCore lc,
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
lcThe LinphoneCore object
vcap_enabledindicates whether video capture is enabled
display_enabledindicates whether video display should be shown
Deprecated:
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 lc,
bool_t  enable 
)

Enable or disable the video adaptive jitter compensation.

Parameters
[in]lcLinphoneCore object
[in]enableTRUE to enable the video adaptive jitter compensation, FALSE to disable it.

§ linphone_core_enable_video_capture()

void linphone_core_enable_video_capture ( LinphoneCore lc,
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
[in]lcLinphoneCore object.
[in]enableTRUE to enable video capture, FALSE to disable it.

§ linphone_core_enable_video_display()

void linphone_core_enable_video_display ( LinphoneCore lc,
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
[in]lcLinphoneCore object.
[in]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 lc,
bool_t  val 
)

Controls video preview enablement.

Parameters
[in]lcLinphoneCore object
[in]valA 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 lc,
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
[in]lcLinphoneCore object
[in]enableTRUE to enable video source reuse. FALSE to disable it for subsequent calls.

§ linphone_core_find_payload_type()

LinphonePayloadType* linphone_core_find_payload_type ( LinphoneCore lc,
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
lcLinphoneCore 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.

§ linphone_core_get_adaptive_rate_algorithm()

const char* linphone_core_get_adaptive_rate_algorithm ( const LinphoneCore lc)

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

See also
linphone_core_set_adaptive_rate_algorithm()

§ linphone_core_get_audio_codecs()

const bctbx_list_t* linphone_core_get_audio_codecs ( const LinphoneCore lc)

Returns the list of available audio codecs.

Parameters
[in]lcThe LinphoneCore object
Returns
A list of LinphonePayloadType objects.

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

§ linphone_core_get_audio_jittcomp()

int linphone_core_get_audio_jittcomp ( LinphoneCore lc)

Returns the nominal audio jitter buffer size in milliseconds.

Parameters
[in]lcLinphoneCore 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_avpf_mode()

LinphoneAVPFMode linphone_core_get_avpf_mode ( const LinphoneCore lc)

Return AVPF enablement. See linphone_core_set_avpf_mode() .

Parameters
[in]lcLinphoneCore object
Returns
The current AVPF mode

§ linphone_core_get_avpf_rr_interval()

int linphone_core_get_avpf_rr_interval ( const LinphoneCore lc)

Return the avpf report interval in seconds.

Parameters
[in]lcLinphoneCore object
Returns
The current AVPF report interval in seconds

§ linphone_core_get_capture_device()

const char* linphone_core_get_capture_device ( LinphoneCore lc)

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

Parameters
[in]lcLinphoneCore object
Returns
The name of the currently assigned sound device for capture

§ linphone_core_get_current_preview_video_size()

MSVideoSize linphone_core_get_current_preview_video_size ( const LinphoneCore lc)

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
lcthe core
Returns
a MSVideoSize

§ linphone_core_get_device_rotation()

int linphone_core_get_device_rotation ( LinphoneCore lc)

Gets the current device orientation.

Parameters
[in]lcLinphoneCore object
Returns
The current device orientation
See also
linphone_core_set_device_rotation()

§ linphone_core_get_download_bandwidth()

int linphone_core_get_download_bandwidth ( const LinphoneCore lc)

Retrieve the maximum available download bandwidth. This value was set by linphone_core_set_download_bandwidth().

§ linphone_core_get_download_ptime()

int linphone_core_get_download_ptime ( LinphoneCore lc)

Get audio packetization time linphone expects to receive from peer. A value of zero means that ptime is not specified.

§ linphone_core_get_media_encryption()

LinphoneMediaEncryption linphone_core_get_media_encryption ( LinphoneCore lc)

Get the media encryption policy being used for RTP packets.

Parameters
[in]lcLinphoneCore object.
Returns
The media encryption policy being used.

§ linphone_core_get_mic_gain_db()

float linphone_core_get_mic_gain_db ( LinphoneCore lc)

Get microphone gain in db.

Parameters
[in]lcLinphoneCore object
Returns
The current microphone gain

§ linphone_core_get_native_preview_window_id()

void* linphone_core_get_native_preview_window_id ( const LinphoneCore lc)

Get the native window handle of the video preview window.

Parameters
[in]lcLinphoneCore 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 lc)

Get the native window handle of the video window.

Parameters
[in]lcLinphoneCore 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 lc)

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 lc)

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
[in]lcLinphoneCore object
Returns
The value of the no-rtp timeout in seconds

§ linphone_core_get_payload_type_bitrate()

int linphone_core_get_payload_type_bitrate ( LinphoneCore lc,
const LinphonePayloadType pt 
)

Get the bitrate explicitely set with linphone_core_set_payload_type_bitrate().

Parameters
[in]lcthe LinphoneCore object
[in]ptthe LinphonePayloadType to modify.
Returns
bitrate the IP bitrate in kbit/s, or -1 if an error occured.

§ linphone_core_get_payload_type_number()

int linphone_core_get_payload_type_number ( LinphoneCore lc,
const PayloadType *  pt 
)

Returns the payload type number assigned for this codec.

§ linphone_core_get_play_file()

const char* linphone_core_get_play_file ( const LinphoneCore lc)

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
[in]lcLinphoneCore object
Returns
The path to the file that is played when putting somebody on hold.

§ linphone_core_get_play_level()

LINPHONE_DEPRECATED int linphone_core_get_play_level ( LinphoneCore lc)

Get playback sound level in 0-100 scale.

Deprecated:

§ linphone_core_get_playback_device()

const char* linphone_core_get_playback_device ( LinphoneCore lc)

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

Parameters
[in]lcLinphoneCore 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 lc)

Get playback gain in db before entering sound card.

Parameters
[in]lcLinphoneCore object
Returns
The current playback gain

§ linphone_core_get_preferred_framerate()

float linphone_core_get_preferred_framerate ( LinphoneCore lc)

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

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

§ linphone_core_get_preferred_video_size()

MSVideoSize linphone_core_get_preferred_video_size ( const LinphoneCore lc)

Returns the current preferred video size for sending.

§ linphone_core_get_preview_video_size()

MSVideoSize linphone_core_get_preview_video_size ( const LinphoneCore lc)

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
lcthe core
Returns
a MSVideoSize

§ linphone_core_get_rec_level()

LINPHONE_DEPRECATED int linphone_core_get_rec_level ( LinphoneCore lc)

Get sound capture level in 0-100 scale.

Deprecated:

§ linphone_core_get_record_file()

const char* linphone_core_get_record_file ( const LinphoneCore lc)

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
[in]lcLinphoneCore 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 lc)

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

Parameters
[in]lcLinphoneCore object

§ linphone_core_get_ring()

const char* linphone_core_get_ring ( const LinphoneCore lc)

Returns the path to the wav file used for ringing.

Parameters
[in]lcLinphoneCore object
Returns
The path to the wav file used for ringing

§ linphone_core_get_ring_level()

LINPHONE_DEPRECATED int linphone_core_get_ring_level ( LinphoneCore lc)

Get ring sound level in 0-100 scale.

Deprecated:

§ linphone_core_get_ringback()

const char* linphone_core_get_ringback ( const LinphoneCore lc)

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

Parameters
[in]lcLinphoneCore 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 lc)

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

Parameters
[in]lcLinphoneCore object
Returns
The name of the currently assigned sound device for ringing

§ linphone_core_get_sip_transport_timeout()

int linphone_core_get_sip_transport_timeout ( LinphoneCore lc)

Get the SIP transport timeout.

Parameters
[in]lcLinphoneCore object.
Returns
The SIP transport timeout in milliseconds.

§ linphone_core_get_sound_devices()

const char** linphone_core_get_sound_devices ( LinphoneCore lc)

Gets the list of the available sound devices.

Parameters
[in]lcLinphoneCore object
Returns
An unmodifiable array of strings contanining the names of the available sound devices that is NULL terminated

§ linphone_core_get_static_picture()

const char* linphone_core_get_static_picture ( LinphoneCore lc)

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

Parameters
[in]lcLinphoneCore 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 lc)

Get the frame rate for static picture

Parameters
[in]lcLinphoneCore object.
Returns
The frame rate used for static picture.

§ linphone_core_get_supported_file_formats()

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'

§ linphone_core_get_supported_video_sizes()

const MSVideoSizeDef* linphone_core_get_supported_video_sizes ( LinphoneCore lc)

Returns the zero terminated table of supported video resolutions.

§ linphone_core_get_text_codecs()

const bctbx_list_t* linphone_core_get_text_codecs ( const LinphoneCore lc)

Returns the list of available text codecs.

Parameters
[in]lcThe LinphoneCore object
Returns
A list of LinphonePayloadType objects.

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

§ linphone_core_get_upload_bandwidth()

int linphone_core_get_upload_bandwidth ( const LinphoneCore lc)

Retrieve the maximum available upload bandwidth. This value was set by linphone_core_set_upload_bandwidth().

§ linphone_core_get_upload_ptime()

int linphone_core_get_upload_ptime ( LinphoneCore lc)

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.

§ linphone_core_get_use_files()

bool_t linphone_core_get_use_files ( LinphoneCore lc)

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

Parameters
[in]lcLinphoneCore 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 lc)

Indicates whether SIP INFO is used to send digits.

Parameters
[in]lcLinphoneCore 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 lc)

Indicates whether RFC2833 is used to send digits.

Parameters
[in]lcLinphoneCore object
Returns
A boolean value telling whether RFC2833 is used to send digits

§ linphone_core_get_video_codecs()

const bctbx_list_t* linphone_core_get_video_codecs ( const LinphoneCore lc)

Returns the list of available video codecs.

Parameters
[in]lcThe LinphoneCore object
Returns
A list of LinphonePayloadType objects.

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

§ linphone_core_get_video_device()

const char* linphone_core_get_video_device ( const LinphoneCore lc)

Returns the name of the currently active video device.

Parameters
[in]lcLinphoneCore object
Returns
The name of the currently active video device

§ linphone_core_get_video_devices()

const char** linphone_core_get_video_devices ( const LinphoneCore lc)

Gets the list of the available video capture devices.

Parameters
[in]lcLinphoneCore 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 lc)

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

§ linphone_core_get_video_jittcomp()

int linphone_core_get_video_jittcomp ( LinphoneCore lc)

Returns the nominal video jitter buffer size in milliseconds.

Parameters
[in]lcLinphoneCore 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_policy()

const LinphoneVideoPolicy* linphone_core_get_video_policy ( const LinphoneCore lc)

Get the default policy for video. See linphone_core_set_video_policy() for more details.

Parameters
[in]lcLinphoneCore object
Returns
The video policy being used

§ linphone_core_get_video_preset()

const char* linphone_core_get_video_preset ( const LinphoneCore lc)

Get the video preset used for video calls.

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

§ linphone_core_is_media_encryption_mandatory()

bool_t linphone_core_is_media_encryption_mandatory ( LinphoneCore lc)

Get behaviour when encryption parameters negociation fails on outgoing call.

Parameters
[in]lcLinphoneCore object.
Returns
TRUE means the call will fail; FALSE means an INVITE will be resent with encryption disabled.

§ linphone_core_mic_enabled()

bool_t linphone_core_mic_enabled ( LinphoneCore lc)

Tells whether the microphone is enabled.

Parameters
[in]lcLinphoneCore object
Returns
TRUE if the microphone is enabled, FALSE if disabled.

§ linphone_core_payload_type_enabled()

bool_t linphone_core_payload_type_enabled ( LinphoneCore lc,
const LinphonePayloadType pt 
)

Tells whether the specified payload type is enabled.

Parameters
[in]lcLinphoneCore object.
[in]ptThe LinphonePayloadType we want to know is enabled or not.
Returns
TRUE if the payload type is enabled, FALSE if disabled.

§ linphone_core_payload_type_is_vbr()

bool_t linphone_core_payload_type_is_vbr ( LinphoneCore lc,
const LinphonePayloadType pt 
)

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

Parameters
[in]lcLinphoneCore object.
[in]ptThe LinphonePayloadType we want to know
Returns
TRUE if the payload type represents a VBR codec, FALSE if disabled.

§ linphone_core_play_dtmf()

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

Plays a dtmf sound to the local user.

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

§ linphone_core_realtime_text_enabled()

bool_t linphone_core_realtime_text_enabled ( LinphoneCore lc)

Gets if realtime text is enabled or not

Parameters
[in]lcLinphoneCore object
Returns
true if realtime text is enabled, false otherwise

§ linphone_core_reload_sound_devices()

void linphone_core_reload_sound_devices ( LinphoneCore lc)

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
[in]lcLinphoneCore object.

§ linphone_core_reload_video_devices()

void linphone_core_reload_video_devices ( LinphoneCore lc)

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
[in]lcLinphoneCore object.

§ linphone_core_self_view_enabled()

bool_t linphone_core_self_view_enabled ( const LinphoneCore lc)

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

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

§ linphone_core_send_dtmf()

LINPHONE_DEPRECATED void linphone_core_send_dtmf ( LinphoneCore lc,
char  dtmf 
)

Send the specified dtmf.

Deprecated:
Use linphone_call_send_dtmf instead. This function only works during calls. The dtmf is automatically played to the user.
Parameters
lcThe LinphoneCore object
dtmfThe dtmf name specified as a char, such as '0', '#' etc...

§ linphone_core_set_adaptive_rate_algorithm()

void linphone_core_set_adaptive_rate_algorithm ( LinphoneCore lc,
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
lcthe core
algorithmthe adaptive rate control algorithm. Currently two values are supported: 'advanced', which is the default value, or 'basic'.

§ linphone_core_set_audio_codecs()

int linphone_core_set_audio_codecs ( LinphoneCore lc,
bctbx_list_t *  codecs 
)

Sets the list of audio codecs.

Parameters
[in]lcThe LinphoneCore object
[in]codecsA list of LinphonePayloadType objects.
Returns
0 The list is taken by the LinphoneCore thus the application should not free it. This list is made of struct PayloadType describing the codec parameters.

§ linphone_core_set_audio_jittcomp()

void linphone_core_set_audio_jittcomp ( LinphoneCore lc,
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.

§ linphone_core_set_audio_multicast_addr()

int 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()

int 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_port_range()

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

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

Parameters
[in]lcLinphoneCore object
[in]min_portThe lower bound of the audio port range to use
[in]max_portThe upper bound of the audio port range to use

§ linphone_core_set_avpf_mode()

void linphone_core_set_avpf_mode ( LinphoneCore lc,
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
[in]lcLinphoneCore object
[in]modeThe AVPF mode to use.

§ linphone_core_set_avpf_rr_interval()

void linphone_core_set_avpf_rr_interval ( LinphoneCore lc,
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
[in]lcLinphoneCore object
[in]intervalThe report interval in seconds

§ linphone_core_set_capture_device()

int linphone_core_set_capture_device ( LinphoneCore lc,
const char *  devid 
)

Sets the sound device used for capture.

Parameters
[in]lcLinphoneCore object
[in]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 lc,
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
[in]lcLinphoneCore object
[in]rotationThe orientation to use

§ linphone_core_set_dns_servers()

void linphone_core_set_dns_servers ( LinphoneCore lc,
const bctbx_list_t *  servers 
)

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

Parameters
[in]lcLinphoneCore object.
[in]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 lc,
int  bw 
)

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
lcthe LinphoneCore object
bwthe bandwidth in kbits/s, 0 for infinite

§ linphone_core_set_download_ptime()

void linphone_core_set_download_ptime ( LinphoneCore lc,
int  ptime 
)

Set audio packetization time linphone expects to receive from peer. A value of zero means that ptime is not specified.

§ linphone_core_set_media_encryption()

int linphone_core_set_media_encryption ( LinphoneCore lc,
LinphoneMediaEncryption  menc 
)

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

Parameters
[in]lcLinphoneCore object.
[in]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 lc,
bool_t  m 
)

Define behaviour when encryption parameters negociation fails on outgoing call.

Parameters
[in]lcLinphoneCore object.
[in]mIf set to TRUE call will fail; if set to FALSE will resend an INVITE with encryption disabled.

§ linphone_core_set_mic_gain_db()

void linphone_core_set_mic_gain_db ( LinphoneCore lc,
float  level 
)

Allow to control microphone level: gain in db.

Parameters
[in]lcLinphoneCore object
[in]levelThe new microphone level

§ linphone_core_set_mtu()

void linphone_core_set_mtu ( LinphoneCore lc,
int  mtu 
)

Sets the maximum transmission unit size in bytes. This information is useful for sending RTP packets. Default value is 1500.

Parameters
[in]lcLinphoneCore object
[in]mtuThe MTU in bytes

§ linphone_core_set_native_preview_window_id()

void linphone_core_set_native_preview_window_id ( LinphoneCore lc,
void *  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(). MacOS, Linux, Windows: if not set or zero the core will create its own window, unless the special id -1 is given.

Parameters
[in]lcLinphoneCore object
[in]idThe native window id where the preview video is to be displayed

§ linphone_core_set_native_video_window_id()

void linphone_core_set_native_video_window_id ( LinphoneCore lc,
void *  id 
)

Set the native video window id where the video is to be displayed. For MacOS, Linux, Windows: if not set or LINPHONE_VIDEO_DISPLAY_AUTO the core will create its own window, unless the special id LINPHONE_VIDEO_DISPLAY_NONE is given.

§ linphone_core_set_network_simulator_params()

int linphone_core_set_network_simulator_params ( LinphoneCore lc,
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
lcthe 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 lc,
int  seconds 
)

Sets the no-rtp timeout value in seconds.

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

§ linphone_core_set_payload_type_bitrate()

void linphone_core_set_payload_type_bitrate ( LinphoneCore lc,
LinphonePayloadType pt,
int  bitrate 
)

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

Parameters
[in]lcthe LinphoneCore object
[in]ptthe LinphonePayloadType to modify.
[in]bitratethe IP bitrate in kbit/s.

§ linphone_core_set_payload_type_number()

void linphone_core_set_payload_type_number ( LinphoneCore lc,
PayloadType *  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.

§ linphone_core_set_play_file()

void linphone_core_set_play_file ( LinphoneCore lc,
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
[in]lcLinphoneCore object
[in]fileThe path to the file to be played when putting somebody on hold.

§ linphone_core_set_play_level()

LINPHONE_DEPRECATED void linphone_core_set_play_level ( LinphoneCore lc,
int  level 
)

Set sound playback level in 0-100 scale.

Deprecated:

§ linphone_core_set_playback_device()

int linphone_core_set_playback_device ( LinphoneCore lc,
const char *  devid 
)

Sets the sound device used for playback.

Parameters
[in]lcLinphoneCore object
[in]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 lc,
float  level 
)

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

Parameters
[in]lcLinphoneCore object
[in]levelThe new play level

§ linphone_core_set_preferred_framerate()

void linphone_core_set_preferred_framerate ( LinphoneCore lc,
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
lcthe LinphoneCore
fpsthe target frame rate in number of frames per seconds.

§ linphone_core_set_preferred_video_size()

void linphone_core_set_preferred_video_size ( LinphoneCore lc,
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.

§ linphone_core_set_preferred_video_size_by_name()

void linphone_core_set_preferred_video_size_by_name ( LinphoneCore lc,
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 ...

§ linphone_core_set_preview_video_size()

void linphone_core_set_preview_video_size ( LinphoneCore lc,
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
lcthe 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.

§ linphone_core_set_preview_video_size_by_name()

void linphone_core_set_preview_video_size_by_name ( LinphoneCore lc,
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 ...

§ linphone_core_set_rec_level()

LINPHONE_DEPRECATED void linphone_core_set_rec_level ( LinphoneCore lc,
int  level 
)

Set sound capture level in 0-100 scale.

Deprecated:

§ linphone_core_set_record_file()

void linphone_core_set_record_file ( LinphoneCore lc,
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
[in]lcLinphoneCore object
[in]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 lc,
const char *  ring 
)

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

Parameters
[in]lcLinphoneCore object
[in]ringThe path to the ring back tone to be played.

§ linphone_core_set_ring()

void linphone_core_set_ring ( LinphoneCore lc,
const char *  path 
)

Sets the path to a wav file used for ringing. The file must be a wav 16bit linear. Local ring is disabled if null.

Parameters
[in]lcLinphoneCore object
[in]pathThe path to a wav file to be used for ringing

§ linphone_core_set_ring_during_incoming_early_media()

void linphone_core_set_ring_during_incoming_early_media ( LinphoneCore lc,
bool_t  enable 
)

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

Parameters
[in]lcLinphoneCore object
[in]enableA boolean value telling whether to enable ringing during an incoming early media call.

§ linphone_core_set_ring_level()

LINPHONE_DEPRECATED void linphone_core_set_ring_level ( LinphoneCore lc,
int  level 
)

Set sound ring level in 0-100 scale.

Deprecated:

§ linphone_core_set_ringback()

void linphone_core_set_ringback ( LinphoneCore lc,
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
[in]lcLinphoneCore object
[in]pathThe path to a wav file to be used for ringing back

§ linphone_core_set_ringer_device()

int linphone_core_set_ringer_device ( LinphoneCore lc,
const char *  devid 
)

Sets the sound device used for ringing.

Parameters
[in]lcLinphoneCore object
[in]devidThe device name as returned by linphone_core_get_sound_devices()
Returns
0

§ linphone_core_set_sip_transport_timeout()

void linphone_core_set_sip_transport_timeout ( LinphoneCore lc,
int  timeout_ms 
)

Set the SIP transport timeout.

Parameters
[in]lcLinphoneCore object.
[in]timeout_msThe SIP transport timeout in milliseconds.

§ linphone_core_set_static_picture()

int linphone_core_set_static_picture ( LinphoneCore lc,
const char *  path 
)

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

Parameters
[in]lcLinphoneCore object.
[in]pathThe path to the image file to use.

§ linphone_core_set_static_picture_fps()

int linphone_core_set_static_picture_fps ( LinphoneCore lc,
float  fps 
)

Set the frame rate for static picture.

Parameters
[in]lcLinphoneCore object.
[in]fpsThe new frame rate to use for static picture.

§ linphone_core_set_text_port_range()

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

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

Parameters
[in]lcLinphoneCore object
[in]min_portThe lower bound of the text port range to use
[in]max_portThe upper bound of the text port range to use

§ linphone_core_set_upload_bandwidth()

void linphone_core_set_upload_bandwidth ( LinphoneCore lc,
int  bw 
)

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
lcthe LinphoneCore object
bwthe bandwidth in kbits/s, 0 for infinite

§ linphone_core_set_upload_ptime()

void linphone_core_set_upload_ptime ( LinphoneCore lc,
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.

§ linphone_core_set_use_files()

void linphone_core_set_use_files ( LinphoneCore lc,
bool_t  yesno 
)

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

Parameters
[in]lcLinphoneCore object
[in]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 lc,
bool_t  use_info 
)

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

Parameters
[in]lcLinphoneCore object
[in]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 lc,
bool_t  use_rfc2833 
)

Sets whether RFC2833 is to be used to send digits.

Parameters
[in]lcLinphoneCore object
[in]use_rfc2833A boolean value telling whether to use RFC2833 to send digits

§ linphone_core_set_video_codecs()

int linphone_core_set_video_codecs ( LinphoneCore lc,
bctbx_list_t *  codecs 
)

Sets the list of video codecs.

Parameters
[in]lcThe LinphoneCore object
[in]codecsA list of LinphonePayloadType objects.
Returns
0

The list is taken by the LinphoneCore thus the application should not free it. This list is made of struct PayloadType describing the codec parameters.

§ linphone_core_set_video_device()

int linphone_core_set_video_device ( LinphoneCore lc,
const char *  id 
)

Sets the active video device.

Parameters
[in]lcLinphoneCore 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 lc,
const char *  filtername 
)

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.

§ linphone_core_set_video_jittcomp()

void linphone_core_set_video_jittcomp ( LinphoneCore lc,
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.

§ linphone_core_set_video_multicast_addr()

int linphone_core_set_video_multicast_addr ( LinphoneCore lc,
const char *  ip 
)

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

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

§ linphone_core_set_video_multicast_ttl()

int linphone_core_set_video_multicast_ttl ( LinphoneCore lc,
int  ttl 
)

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

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

§ linphone_core_set_video_policy()

void linphone_core_set_video_policy ( LinphoneCore lc,
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
    [in]lcLinphoneCore object
    [in]policyThe video policy to use

§ linphone_core_set_video_port_range()

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

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

Parameters
[in]lcLinphoneCore object
[in]min_portThe lower bound of the video port range to use
[in]max_portThe upper bound of the video port range to use

§ linphone_core_set_video_preset()

void linphone_core_set_video_preset ( LinphoneCore lc,
const char *  preset 
)

Set the video preset to be used for video calls.

Parameters
[in]lcLinphoneCore object
[in]presetThe name of the video preset to be used (can be NULL to use the default video preset).

§ linphone_core_sound_device_can_capture()

bool_t linphone_core_sound_device_can_capture ( LinphoneCore lc,
const char *  device 
)

Tells whether a specified sound device can capture sound.

Parameters
[in]lcLinphoneCore object
[in]devicethe device name as returned by linphone_core_get_sound_devices()
Returns
A boolean value telling whether the specified sound device can capture sound

§ linphone_core_sound_device_can_playback()

bool_t linphone_core_sound_device_can_playback ( LinphoneCore lc,
const char *  device 
)

Tells whether a specified sound device can play sound.

Parameters
[in]lcLinphoneCore object
[in]devicethe device name as returned by linphone_core_get_sound_devices()
Returns
A boolean value telling whether the specified sound device can play sound

§ linphone_core_stop_dtmf()

void linphone_core_stop_dtmf ( LinphoneCore lc)

Stops playing a dtmf started by linphone_core_play_dtmf().

Parameters
[in]lcLinphoneCore object

§ linphone_core_stop_ringing()

void linphone_core_stop_ringing ( LinphoneCore lc)

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
[in]lcLinphoneCore object

§ linphone_core_use_preview_window()

void linphone_core_use_preview_window ( LinphoneCore lc,
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
[in]lcLinphoneCore object.
[in]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 lc)

Tells whether the video adaptive jitter compensation is enabled.

Parameters
[in]lcLinphoneCore 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 lc)

Tells whether video capture is enabled.

Parameters
[in]lcLinphoneCore object.
Returns
TRUE if video capture is enabled, FALSE if disabled.

§ linphone_core_video_display_enabled()

bool_t linphone_core_video_display_enabled ( LinphoneCore lc)

Tells whether video display is enabled.

Parameters
[in]lcLinphoneCore object.
Returns
TRUE if video display is enabled, FALSE if disabled.

§ linphone_core_video_enabled()

bool_t linphone_core_video_enabled ( LinphoneCore lc)

Returns TRUE if either capture or display is enabled, FALSE otherwise. same as ( linphone_core_video_capture_enabled | linphone_core_video_display_enabled )

§ 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 lc)

Tells whether video preview is enabled.

Parameters
[in]lcLinphoneCore object
Returns
A boolean value telling whether video preview is enabled

§ linphone_media_encryption_to_string()

const char* linphone_media_encryption_to_string ( LinphoneMediaEncryption  menc)

Convert enum member to string.

§ linphone_payload_type_get_channels()

int linphone_payload_type_get_channels ( const LinphonePayloadType pt)

Get the number of channels.

Parameters
[in]ptLinphonePayloadType object
Returns
The number of channels.

§ linphone_payload_type_get_mime_type()

const char* linphone_payload_type_get_mime_type ( const LinphonePayloadType pt)

Get the mime type.

Parameters
[in]ptLinphonePayloadType object
Returns
The mime type.

§ linphone_payload_type_get_normal_bitrate()

int linphone_payload_type_get_normal_bitrate ( const LinphonePayloadType pt)

Get the normal bitrate in bits/s.

Parameters
[in]ptLinphonePayloadType object
Returns
The normal bitrate in bits/s.

§ linphone_payload_type_get_type()

int linphone_payload_type_get_type ( const LinphonePayloadType pt)

Get the type of payload.

Parameters
[in]ptLinphonePayloadType object
Returns
The type of payload.