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/misc.h | 99 +++++++++++++++++++++++++++++-------------------- 1 files changed, 58 insertions(+), 41 deletions(-) diff --git a/Shared.IOS.HDLLinphoneSDK/Shared.IOS.HDLLinphoneSDK/Library/linphone.framework/Headers/misc.h b/Shared.IOS.HDLLinphoneSDK/Shared.IOS.HDLLinphoneSDK/Library/linphone.framework/Headers/misc.h old mode 100644 new mode 100755 index 9b25b60..26dc587 --- a/Shared.IOS.HDLLinphoneSDK/Shared.IOS.HDLLinphoneSDK/Library/linphone.framework/Headers/misc.h +++ b/Shared.IOS.HDLLinphoneSDK/Shared.IOS.HDLLinphoneSDK/Library/linphone.framework/Headers/misc.h @@ -60,21 +60,26 @@ /** * Function returning a human readable value for LinphoneStreamType. * @ingroup initializing + * @param type the #LinphoneStreamType + * @return a string representation of the #LinphoneStreamType @notnil **/ -LINPHONE_PUBLIC const char *linphone_stream_type_to_string(const LinphoneStreamType); +LINPHONE_PUBLIC const char *linphone_stream_type_to_string(const LinphoneStreamType type); /** * Human readable version of the #LinphoneRegistrationState - * @param cs sate + * @param state #LinphoneRegistrationState the value for which we want a string representation + * @return a string representation of the #LinphoneRegistrationState @notnil * @ingroup proxies */ -LINPHONE_PUBLIC const char *linphone_registration_state_to_string(LinphoneRegistrationState cs); +LINPHONE_PUBLIC const char *linphone_registration_state_to_string(LinphoneRegistrationState state); /** * Convert enum member to string. + * @param media_encryption the #LinphoneMediaEncryption to convert + * @return a string representation of the #LinphoneMediaEncryption @notnil * @ingroup media_parameters **/ -LINPHONE_PUBLIC const char *linphone_media_encryption_to_string(LinphoneMediaEncryption menc); +LINPHONE_PUBLIC const char *linphone_media_encryption_to_string(LinphoneMediaEncryption media_encryption); LINPHONE_PUBLIC const char* linphone_privacy_to_string(LinphonePrivacy privacy); @@ -91,55 +96,53 @@ LINPHONE_PUBLIC const char *linphone_call_state_to_string(LinphoneCallState cs); /** - * Converts a _LinphoneConfiguringState enum to a string. + * Converts a #LinphoneConfiguringState enum to a string. + * @param state #LinphoneConfiguringState the value for which we want a string representation + * @return a string representation of the #LinphoneConfiguringState @notnil * @ingroup misc **/ -LINPHONE_PUBLIC const char *linphone_configuring_state_to_string(LinphoneConfiguringState cs); +LINPHONE_PUBLIC const char *linphone_configuring_state_to_string(LinphoneConfiguringState state); /** * Returns a #LinphoneChatMessageState as a string. + * @param state #LinphoneChatMessageState the value for which we want a string representation + * @return a string representation of the #LinphoneChatMessageState @notnil */ LINPHONE_PUBLIC const char* linphone_chat_message_state_to_string(const LinphoneChatMessageState state); /** * Converts a #LinphoneReason enum to a string. - * @param[in] err A #LinphoneReason - * @return The string representation of the specified #LinphoneReason + * @param error A #LinphoneReason + * @return The string representation of the specified #LinphoneReason @notnil * @ingroup misc **/ -LINPHONE_PUBLIC const char *linphone_reason_to_string(LinphoneReason err); - -/** - * Return humain readable presence status - * @param ss - * @deprecated Use #LinphonePresenceModel, #LinphonePresenceActivity and linphone_presence_activity_to_string() instead. - * @donotwrap - */ -LINPHONE_PUBLIC LINPHONE_DEPRECATED const char *linphone_online_status_to_string(LinphoneOnlineStatus ss); +LINPHONE_PUBLIC const char *linphone_reason_to_string(LinphoneReason error); /** * Convert a string into #LinphoneTunnelMode enum - * @param string String to convert + * @param string String to convert @maybenil * @return An #LinphoneTunnelMode enum. If the passed string is NULL or * does not match with any mode, the #LinphoneTunnelModeDisable is returned. */ LINPHONE_PUBLIC LinphoneTunnelMode linphone_tunnel_mode_from_string(const char *string); /** - * Convert a tunnel mode enum into string - * @param mode Enum to convert - * @return "disable", "enable" or "auto" + * Convert a #LinphoneTunnelMode enum into string + * @param mode #LinphoneTunnelMode to convert + * @return "disable", "enable" or "auto" @notnil */ LINPHONE_PUBLIC const char *linphone_tunnel_mode_to_string(LinphoneTunnelMode mode); /** * Check whether Matroksa format is supported by the player - * @return TRUE if it is supported + * @return TRUE if it is supported, FALSE otherwise */ LINPHONE_PUBLIC bool_t linphone_local_player_matroska_supported(void); /** * Converts a #LinphoneTransportType enum to a lowercase string. + * @param transport a #LinphoneTransportType to convert to string + * @return the string representation of the #LinphoneTransportType @notnil * @ingroup misc **/ LINPHONE_PUBLIC const char* linphone_transport_to_string(LinphoneTransportType transport); @@ -147,29 +150,30 @@ /** * Converts a lowercase string to a #LinphoneTransportType enum. * @ingroup misc - * @return Transport matching input, or #LinphoneTransportUdp if nothing is found + * @param transport the transport to parse. @notnil + * @return #LinphoneTransportType matching input, or #LinphoneTransportUdp if nothing is found **/ LINPHONE_PUBLIC LinphoneTransportType linphone_transport_parse(const char* transport); /** * Check whether an error code is in Retry-After field. -* @param[in] err An error code +* @param error An error code * @return TRUE if it is in Retry-After field * @ingroup misc **/ -LINPHONE_PUBLIC bool_t linphone_error_code_is_retry_after(int err); +LINPHONE_PUBLIC bool_t linphone_error_code_is_retry_after(int error); /** * Converts an error code to a LinphoneReason. - * @param[in] err An error code + * @param error An error code * @return The #LinphoneReason corresponding to the specified error code * @ingroup misc **/ -LINPHONE_PUBLIC LinphoneReason linphone_error_code_to_reason(int err); +LINPHONE_PUBLIC LinphoneReason linphone_error_code_to_reason(int error); /** * Converts a #LinphoneReason to an error code. - * @param[in] reason A #LinphoneReason + * @param reason A #LinphoneReason * @return The error code corresponding to the specified #LinphoneReason * @ingroup misc */ @@ -177,37 +181,38 @@ /** * Increment refcount. - * @param[in] range #LinphoneRange object + * @param range #LinphoneRange object @notnil + * @return the same #LinphoneRange object @notnil * @ingroup misc **/ LINPHONE_PUBLIC LinphoneRange *linphone_range_ref(LinphoneRange *range); /** * Decrement refcount and possibly free the object. - * @param[in] range #LinphoneRange object + * @param range #LinphoneRange object @notnil * @ingroup misc **/ LINPHONE_PUBLIC void linphone_range_unref(LinphoneRange *range); /** * Gets the user data in the #LinphoneRange object - * @param[in] range the #LinphoneRange - * @return the user data + * @param range the #LinphoneRange @notnil + * @return the user data. @maybenil * @ingroup misc */ LINPHONE_PUBLIC void *linphone_range_get_user_data(const LinphoneRange *range); /** * Sets the user data in the #LinphoneRange object - * @param[in] range the #LinphoneRange object - * @param[in] data the user data + * @param range the #LinphoneRange object @notnil + * @param user_data the user data @maybenil * @ingroup misc */ -LINPHONE_PUBLIC void linphone_range_set_user_data(LinphoneRange *range, void *data); +LINPHONE_PUBLIC void linphone_range_set_user_data(LinphoneRange *range, void *user_data); /** * Gets the lower value of the range - * @param[in] range a #LinphoneRange + * @param range a #LinphoneRange @notnil * @return The lower value * @ingroup misc */ @@ -215,7 +220,7 @@ /** * Gets the higher value of the range - * @param[in] range a #LinphoneRange + * @param range a #LinphoneRange @notnil * @return The higher value * @ingroup misc */ @@ -223,20 +228,32 @@ /** * Sets the lower value of the range - * @param[in] range a #LinphoneRange - * @param[in] min the value to set + * @param range a #LinphoneRange @notnil + * @param min the value to set * @ingroup misc */ LINPHONE_PUBLIC void linphone_range_set_min(LinphoneRange *range, int min); /** * Sets the higher value of the range - * @param[in] range a #LinphoneRange - * @param[in] max the value to set + * @param range a #LinphoneRange @notnil + * @param max the value to set * @ingroup misc */ LINPHONE_PUBLIC void linphone_range_set_max(LinphoneRange *range, int max); +/************ */ +/* DEPRECATED */ +/* ********** */ + +/** + * Return humain readable presence status + * @param status + * @deprecated 03/02/2017 Use #LinphonePresenceModel, #LinphonePresenceActivity and linphone_presence_activity_to_string() instead. + * @donotwrap + */ +LINPHONE_PUBLIC LINPHONE_DEPRECATED const char *linphone_online_status_to_string(LinphoneOnlineStatus status); + #ifdef __cplusplus } -- Gitblit v1.8.0