From 6a99d9bf65aa5878cb409945ed2bdbdcb916d047 Mon Sep 17 00:00:00 2001 From: chenqiyang <1406175257@qq.com> Date: 星期五, 02 九月 2022 14:56:40 +0800 Subject: [PATCH] 更新linphone sdk --- Shared.IOS.HDLLinphoneSDK/Shared.IOS.HDLLinphoneSDK/Library/linphone.framework/Headers/call_log.h | 169 ++++++++++++++++++++++++-------------------------------- 1 files changed, 72 insertions(+), 97 deletions(-) diff --git a/Shared.IOS.HDLLinphoneSDK/Shared.IOS.HDLLinphoneSDK/Library/linphone.framework/Headers/call_log.h b/Shared.IOS.HDLLinphoneSDK/Shared.IOS.HDLLinphoneSDK/Library/linphone.framework/Headers/call_log.h old mode 100644 new mode 100755 index df9d4dd..bbc9702 --- a/Shared.IOS.HDLLinphoneSDK/Shared.IOS.HDLLinphoneSDK/Library/linphone.framework/Headers/call_log.h +++ b/Shared.IOS.HDLLinphoneSDK/Shared.IOS.HDLLinphoneSDK/Library/linphone.framework/Headers/call_log.h @@ -38,46 +38,46 @@ /** * Get the call ID used by the call. - * @param[in] cl #LinphoneCallLog object - * @return The call ID used by the call as a string. + * @param call_log #LinphoneCallLog object @notnil + * @return The call ID used by the call as a string. @notnil **/ -LINPHONE_PUBLIC const char * linphone_call_log_get_call_id(const LinphoneCallLog *cl); +LINPHONE_PUBLIC const char * linphone_call_log_get_call_id(const LinphoneCallLog *call_log); /** * Get the direction of the call. - * @param[in] cl #LinphoneCallLog object - * @return The direction of the call. + * @param call_log #LinphoneCallLog object @notnil + * @return The #LinphoneCallDir of the call. **/ -LINPHONE_PUBLIC LinphoneCallDir linphone_call_log_get_dir(const LinphoneCallLog *cl); +LINPHONE_PUBLIC LinphoneCallDir linphone_call_log_get_dir(const LinphoneCallLog *call_log); /** * Get the duration of the call since connected. - * @param[in] cl #LinphoneCallLog object + * @param call_log #LinphoneCallLog object @notnil * @return The duration of the call in seconds. **/ -LINPHONE_PUBLIC int linphone_call_log_get_duration(const LinphoneCallLog *cl); +LINPHONE_PUBLIC int linphone_call_log_get_duration(const LinphoneCallLog *call_log); /** * Get the origin address (ie from) of the call. - * @param[in] cl #LinphoneCallLog object - * @return The origin address (ie from) of the call. + * @param call_log #LinphoneCallLog object @notnil + * @return The origin #LinphoneAddress (ie from) of the call. @notnil **/ -LINPHONE_PUBLIC const LinphoneAddress * linphone_call_log_get_from_address(const LinphoneCallLog *cl); +LINPHONE_PUBLIC const LinphoneAddress * linphone_call_log_get_from_address(const LinphoneCallLog *call_log); /** * Get the RTP statistics computed locally regarding the call. - * @param[in] cl #LinphoneCallLog object + * @param call_log #LinphoneCallLog object @notnil * @return The RTP statistics that have been computed locally for the call. * @donotwrap **/ -LINPHONE_PUBLIC const rtp_stats_t * linphone_call_log_get_local_stats(const LinphoneCallLog *cl); +LINPHONE_PUBLIC const rtp_stats_t * linphone_call_log_get_local_stats(const LinphoneCallLog *call_log); /** * Get the overall quality indication of the call. - * @param[in] cl #LinphoneCallLog object + * @param call_log #LinphoneCallLog object @notnil * @return The overall quality indication of the call. **/ -LINPHONE_PUBLIC float linphone_call_log_get_quality(const LinphoneCallLog *cl); +LINPHONE_PUBLIC float linphone_call_log_get_quality(const LinphoneCallLog *call_log); /** * Get the persistent reference key associated to the call log. @@ -85,54 +85,54 @@ * The reference key can be for example an id to an external database. * It is stored in the config file, thus can survive to process exits/restarts. * - * @param[in] cl #LinphoneCallLog object - * @return The reference key string that has been associated to the call log, or NULL if none has been associated. + * @param call_log #LinphoneCallLog object @notnil + * @return The reference key string that has been associated to the call log, or NULL if none has been associated. @maybenil **/ -LINPHONE_PUBLIC const char * linphone_call_log_get_ref_key(const LinphoneCallLog *cl); +LINPHONE_PUBLIC const char * linphone_call_log_get_ref_key(const LinphoneCallLog *call_log); /** * Get the local address (that is from or to depending on call direction) - * @param[in] cl LinphoneCallLog object - * @return The local address of the call + * @param call_log LinphoneCallLog object @notnil + * @return The local #LinphoneAddress of the call @notnil */ -LINPHONE_PUBLIC const LinphoneAddress *linphone_call_log_get_local_address(const LinphoneCallLog *cl); +LINPHONE_PUBLIC const LinphoneAddress *linphone_call_log_get_local_address(const LinphoneCallLog *call_log); /** * Get the remote address (that is from or to depending on call direction). - * @param[in] cl #LinphoneCallLog object - * @return The remote address of the call. + * @param call_log #LinphoneCallLog object @notnil + * @return The remote #LinphoneAddress of the call. @notnil **/ -LINPHONE_PUBLIC const LinphoneAddress * linphone_call_log_get_remote_address(const LinphoneCallLog *cl); +LINPHONE_PUBLIC const LinphoneAddress * linphone_call_log_get_remote_address(const LinphoneCallLog *call_log); /** * Get the RTP statistics computed by the remote end and sent back via RTCP. * @note Not implemented yet. - * @param[in] cl #LinphoneCallLog object + * @param call_log #LinphoneCallLog object @notnil * @return The RTP statistics that have been computed by the remote end for the call. * @donotwrap **/ -LINPHONE_PUBLIC const rtp_stats_t * linphone_call_log_get_remote_stats(const LinphoneCallLog *cl); +LINPHONE_PUBLIC const rtp_stats_t * linphone_call_log_get_remote_stats(const LinphoneCallLog *call_log); /** * Get the start date of the call. - * @param[in] cl #LinphoneCallLog object + * @param call_log #LinphoneCallLog object @notnil * @return The date of the beginning of the call. **/ -LINPHONE_PUBLIC time_t linphone_call_log_get_start_date(const LinphoneCallLog *cl); +LINPHONE_PUBLIC time_t linphone_call_log_get_start_date(const LinphoneCallLog *call_log); /** * Get the status of the call. - * @param[in] cl #LinphoneCallLog object - * @return The status of the call. + * @param call_log #LinphoneCallLog object @notnil + * @return The #LinphoneCallStatus of the call. **/ -LINPHONE_PUBLIC LinphoneCallStatus linphone_call_log_get_status(const LinphoneCallLog *cl); +LINPHONE_PUBLIC LinphoneCallStatus linphone_call_log_get_status(const LinphoneCallLog *call_log); /** * Get the destination address (ie to) of the call. - * @param[in] cl #LinphoneCallLog object - * @return The destination address (ie to) of the call. + * @param call_log #LinphoneCallLog object @notnil + * @return The destination #LinphoneAddress (ie to) of the call. @notnil **/ -LINPHONE_PUBLIC const LinphoneAddress * linphone_call_log_get_to_address(const LinphoneCallLog *cl); +LINPHONE_PUBLIC const LinphoneAddress * linphone_call_log_get_to_address(const LinphoneCallLog *call_log); /** * Associate a persistent reference key to the call log. @@ -140,39 +140,39 @@ * The reference key can be for example an id to an external database. * It is stored in the config file, thus can survive to process exits/restarts. * - * @param[in] cl #LinphoneCallLog object - * @param[in] refkey The reference key string to associate to the call log. + * @param call_log #LinphoneCallLog object @notnil + * @param refkey The reference key string to associate to the call log. @maybenil **/ -LINPHONE_PUBLIC void linphone_call_log_set_ref_key(LinphoneCallLog *cl, const char *refkey); +LINPHONE_PUBLIC void linphone_call_log_set_ref_key(LinphoneCallLog *call_log, const char *refkey); /** * Tell whether video was enabled at the end of the call or not. - * @param[in] cl #LinphoneCallLog object + * @param call_log #LinphoneCallLog object @notnil * @return A boolean value telling whether video was enabled at the end of the call. **/ -LINPHONE_PUBLIC bool_t linphone_call_log_video_enabled(const LinphoneCallLog *cl); +LINPHONE_PUBLIC bool_t linphone_call_log_video_enabled(const LinphoneCallLog *call_log); /** * Get a human readable string describing the call. * @note: the returned string must be freed by the application (use ms_free()). - * @param[in] cl #LinphoneCallLog object - * @return A human readable string describing the call. + * @param call_log #LinphoneCallLog object @notnil + * @return A human readable string describing the call. @notnil **/ -LINPHONE_PUBLIC char * linphone_call_log_to_str(const LinphoneCallLog *cl); +LINPHONE_PUBLIC char * linphone_call_log_to_str(const LinphoneCallLog *call_log); /** * Tells whether that call was a call to a conference server - * @param[in] cl #LinphoneCallLog object - * @return TRUE if the call was a call to a conference server + * @param call_log #LinphoneCallLog object @notnil + * @return TRUE if the call was a call to a conference server, FALSE otherwise. */ -LINPHONE_PUBLIC bool_t linphone_call_log_was_conference(const LinphoneCallLog *cl); +LINPHONE_PUBLIC bool_t linphone_call_log_was_conference(const LinphoneCallLog *call_log); /** * When the call was failed, return an object describing the failure. - * @param[in] cl #LinphoneCallLog object - * @return information about the error encountered by the call associated with this call log. + * @param call_log #LinphoneCallLog object @notnil + * @return #LinphoneErrorInfo about the error encountered by the call associated with this call log or NULL. @maybenil **/ -LINPHONE_PUBLIC const LinphoneErrorInfo *linphone_call_log_get_error_info(const LinphoneCallLog *cl); +LINPHONE_PUBLIC const LinphoneErrorInfo *linphone_call_log_get_error_info(const LinphoneCallLog *call_log); /******************************************************************************* @@ -181,72 +181,47 @@ /** * Get the user data associated with the call log. - * @param[in] cl #LinphoneCallLog object - * @return The user data associated with the call log. + * @param call_log #LinphoneCallLog object @notnil + * @return The user data associated with the call log. @maybenil **/ -LINPHONE_PUBLIC void *linphone_call_log_get_user_data(const LinphoneCallLog *cl); +LINPHONE_PUBLIC void *linphone_call_log_get_user_data(const LinphoneCallLog *call_log); /** * Assign a user data to the call log. - * @param[in] cl #LinphoneCallLog object - * @param[in] ud The user data to associate with the call log. + * @param call_log #LinphoneCallLog object @notnil + * @param user_data The user data to associate with the call log. @maybenil **/ -LINPHONE_PUBLIC void linphone_call_log_set_user_data(LinphoneCallLog *cl, void *ud); +LINPHONE_PUBLIC void linphone_call_log_set_user_data(LinphoneCallLog *call_log, void *user_data); /** * Acquire a reference to the call log. - * @param[in] cl #LinphoneCallLog object - * @return The same #LinphoneCallLog object + * @param call_log #LinphoneCallLog object @notnil + * @return The same #LinphoneCallLog object @notnil **/ -LINPHONE_PUBLIC LinphoneCallLog * linphone_call_log_ref(LinphoneCallLog *cl); +LINPHONE_PUBLIC LinphoneCallLog * linphone_call_log_ref(LinphoneCallLog *call_log); /** * Release a reference to the call log. - * @param[in] cl #LinphoneCallLog object + * @param call_log #LinphoneCallLog object @notnil **/ -LINPHONE_PUBLIC void linphone_call_log_unref(LinphoneCallLog *cl); +LINPHONE_PUBLIC void linphone_call_log_unref(LinphoneCallLog *call_log); /** - * Creates a fake LinphoneCallLog. - * @param[in] lc LinphoneCore object - * @param[in] from LinphoneAddress of caller - * @param[in] to LinphoneAddress of callee - * @param[in] dir LinphoneCallDir of call - * @param[in] duration call length in seconds - * @param[in] start_time timestamp of call start time - * @param[in] connected_time timestamp of call connection - * @param[in] status LinphoneCallStatus of call - * @param[in] video_enabled whether video was enabled or not for this call - * @param[in] quality call quality - * @return LinphoneCallLog object + * Creates a fake #LinphoneCallLog. + * @param core #LinphoneCore object @notnil + * @param from #LinphoneAddress of caller @notnil + * @param to #LinphoneAddress of callee @notnil + * @param dir #LinphoneCallDir of call + * @param duration call length in seconds + * @param start_time timestamp of call start time + * @param connected_time timestamp of call connection + * @param status #LinphoneCallStatus of call + * @param video_enabled whether video was enabled or not for this call + * @param quality call quality + * @return a #LinphoneCallLog object @notnil **/ -LINPHONE_PUBLIC LinphoneCallLog *linphone_core_create_call_log(LinphoneCore *lc, LinphoneAddress *from, LinphoneAddress *to, LinphoneCallDir dir, +LINPHONE_PUBLIC LinphoneCallLog *linphone_core_create_call_log(LinphoneCore *core, LinphoneAddress *from, LinphoneAddress *to, LinphoneCallDir dir, int duration, time_t start_time, time_t connected_time, LinphoneCallStatus status, bool_t video_enabled, float quality); - - -/******************************************************************************* - * DEPRECATED * - ******************************************************************************/ - -/** @deprecated Use linphone_call_log_get_from_address() instead. */ -#define linphone_call_log_get_from(cl) linphone_call_log_get_from_address(cl) - -/** @deprecated Use linphone_call_log_get_to_address() instead. */ -#define linphone_call_log_get_to(cl) linphone_call_log_get_to_address(cl) - -/** @deprecated Use linphone_call_log_set_user_data() instead. */ -#define linphone_call_log_set_user_pointer(cl, ud) linphone_call_log_set_user_data(cl, ud) - -/** @deprecated Use linphone_call_log_get_user_data() instead. */ -#define linphone_call_log_get_user_pointer(cl) linphone_call_log_get_user_data(cl) - -/** - * Destroy a LinphoneCallLog. - * @param cl #LinphoneCallLog object - * @deprecated Use linphone_call_log_unref() instead. - * @donotwrap - */ -LINPHONE_PUBLIC LINPHONE_DEPRECATED void linphone_call_log_destroy(LinphoneCallLog *cl); /** * @} -- Gitblit v1.8.0