From 53a34317a5d5309594cfb61de933679cdb637366 Mon Sep 17 00:00:00 2001 From: Ghislain MARY Date: Fri, 29 Aug 2014 11:44:21 +0200 Subject: [PATCH] Some API and documentation change for automatic wrapper generation. --- coreapi/linphonecore.c | 17 +++++++++++++---- coreapi/linphonecore.h | 23 +++++++++++++++++++++-- 2 files changed, 34 insertions(+), 6 deletions(-) diff --git a/coreapi/linphonecore.c b/coreapi/linphonecore.c index e05737040..a926bee08 100644 --- a/coreapi/linphonecore.c +++ b/coreapi/linphonecore.c @@ -3016,7 +3016,7 @@ int linphone_core_transfer_call_to_another(LinphoneCore *lc, LinphoneCall *call, return result; } -bool_t linphone_core_inc_invite_pending(LinphoneCore*lc){ +bool_t linphone_core_is_incoming_invite_pending(LinphoneCore*lc){ LinphoneCall *call = linphone_core_get_current_call(lc); if(call != NULL) { @@ -5473,16 +5473,22 @@ float linphone_core_get_preferred_framerate(LinphoneCore *lc){ /** * Ask the core to stream audio from and to files, instead of using the soundcard. + * @ingroup media_parameters + * @param[in] lc LinphoneCore object + * @param[in] yesno A boolean value asking to stream audio from and to files or not. **/ -void linphone_core_use_files(LinphoneCore *lc, bool_t yesno){ +void linphone_core_set_use_files(LinphoneCore *lc, bool_t yesno){ lc->use_files=yesno; } /** * Sets a wav file to be played when putting somebody on hold, - * or when files are used instead of soundcards (see linphone_core_use_files()). + * or when files are used instead of soundcards (see linphone_core_set_use_files()). * * The file must be a 16 bit linear wav file. + * @ingroup media_parameters + * @param[in] lc LinphoneCore object + * @param[in] file The path to the file to be played when putting somebody on hold. **/ void linphone_core_set_play_file(LinphoneCore *lc, const char *file){ LinphoneCall *call=linphone_core_get_current_call(lc); @@ -5500,10 +5506,13 @@ void linphone_core_set_play_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_use_files()). + * 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. + * @ingroup media_parameters + * @param[in] lc LinphoneCore object + * @param[in] file The path to the file where incoming stream is to be recorded. **/ void linphone_core_set_record_file(LinphoneCore *lc, const char *file){ LinphoneCall *call=linphone_core_get_current_call(lc); diff --git a/coreapi/linphonecore.h b/coreapi/linphonecore.h index 5f5a16db4..cb3b173ee 100644 --- a/coreapi/linphonecore.h +++ b/coreapi/linphonecore.h @@ -770,7 +770,15 @@ LINPHONE_PUBLIC void linphone_call_set_user_data(LinphoneCall *call, void *ud); LINPHONE_PUBLIC LinphoneCore *linphone_call_get_core(const LinphoneCall *call); LINPHONE_PUBLIC LinphoneCallState linphone_call_get_state(const LinphoneCall *call); LINPHONE_PUBLIC bool_t linphone_call_asked_to_autoanswer(LinphoneCall *call); + +/** + * Get the remote address of the current call. + * @param[in] lc LinphoneCore object. + * @return The remote address of the current call or NULL if there is no current call. + * @ingroup call_control + */ LINPHONE_PUBLIC const LinphoneAddress * linphone_core_get_current_call_remote_address(LinphoneCore *lc); + LINPHONE_PUBLIC const LinphoneAddress * linphone_call_get_remote_address(const LinphoneCall *call); LINPHONE_PUBLIC char *linphone_call_get_remote_address_as_string(const LinphoneCall *call); LINPHONE_PUBLIC LinphoneCallDir linphone_call_get_dir(const LinphoneCall *call); @@ -1903,7 +1911,16 @@ LINPHONE_PUBLIC int linphone_core_transfer_call_to_another(LinphoneCore *lc, Lin LINPHONE_PUBLIC LinphoneCall * linphone_core_start_refered_call(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params); -LINPHONE_PUBLIC bool_t linphone_core_inc_invite_pending(LinphoneCore*lc); +/** @deprecated Use linphone_core_is_incoming_invite_pending() instead. */ +#define linphone_core_inc_invite_pending(lc) linphone_core_is_incoming_invite_pending(lc) + +/** + * Tells whether there is an incoming invite pending. + * @ingroup call_control + * @param[in] lc LinphoneCore object + * @return A boolean telling whether an incoming invite is pending or not. + */ +LINPHONE_PUBLIC bool_t linphone_core_is_incoming_invite_pending(LinphoneCore*lc); LINPHONE_PUBLIC bool_t linphone_core_in_call(const LinphoneCore *lc); @@ -2636,8 +2653,10 @@ LINPHONE_PUBLIC int linphone_core_get_camera_sensor_rotation(LinphoneCore *lc); /* start or stop streaming video in case of embedded window */ void linphone_core_show_video(LinphoneCore *lc, bool_t show); +/** @deprecated Use linphone_core_set_use_files() instead. */ +#define linphone_core_use_files(lc, yesno) linphone_core_set_use_files(lc, yesno) /*play/record support: use files instead of soundcard*/ -LINPHONE_PUBLIC void linphone_core_use_files(LinphoneCore *lc, bool_t yesno); +LINPHONE_PUBLIC void linphone_core_set_use_files(LinphoneCore *lc, bool_t yesno); LINPHONE_PUBLIC void linphone_core_set_play_file(LinphoneCore *lc, const char *file); LINPHONE_PUBLIC void linphone_core_set_record_file(LinphoneCore *lc, const char *file);