@brief Enumeration for the application control result.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@see app_control_enable_app_started_result_event()
@brief Enumeration for application component type.
@details A component is an application considered as a part of a package.
The application component type indicates what type of
a component an application is in a package.
@since_tizen 4.0
@see PACKAGE_INFO_PROP_APP_COMPONENT_TYPE
@see app_info_get_app_component_type()
@ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
@brief Enumerations of the discovery state of Bluetooth device.
@since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
@ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
@brief Enumerations of the Bluetooth LE packet type.
@since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
@ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_MODULE
@brief Enumerations for the types of profiles related with audio.
@since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
@deprecated Deprecated since 5.0.
@ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
@brief Enumerations for the data channel type.
@since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
@remarks Deprecated, because of no usecase and supported devices.
@ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
@brief The structure type containing data received from the HID Host.
@since_tizen @if WEARABLE 3.0 @endif
@ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
@brief The structure type containing the HID keyboard event information.
@details If you want to know more detail values, refer to http://www.usb.org/developers/hidpage/ and see "HID Usage Tables"
@since_tizen @if WEARABLE 3.0 @endif
@ingroup CAPI_NETWORK_BLUETOOTH_PAN_PANU_MODULE
@brief Enumerations for the types of PAN (Personal Area Networking) service.
@since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
@ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
@brief Rfcomm connection data used for exchanging data between Bluetooth devices.
@since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
@brief Enumeration for the alarm time unit type of an event, such as minutes, hours, days, and so on.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @elseif TV 4.0 @endif
@brief Enumeration for weekdays.
@details Same value as UCalendarDaysOfWeek in ICU.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @elseif TV 4.0 @endif
@brief Enumeration for the color tone, which provides the impression of looking through a tinted glass.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@brief Enumeration for the scene mode.
@details The mode of operation can be in daylight, night, or back-light.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@brief Enumeration for the camera pixel format.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@remarks If #CAMERA_PIXEL_FORMAT_INVZ is set, the type of display should be #CAMERA_DISPLAY_TYPE_NONE. \n
Otherwise, camera_start_preview() will return #CAMERA_ERROR_INVALID_OPERATION. (Since 5.0)
@brief Enumeration for cellular pdn type.
@since_tizen 3.0
@remarks Use #CONNECTION_CELLULAR_PDN_TYPE_IPV4_IPV6 instead of
CONNECTION_CELLULAR_PDN_TYPE_IPV4_IPv6.
@brief Enumeration for contacts number type.
@details The number can be made with a set of values by specifying one or more values.
Example : CTS_NUM_TYPE_HOME|CTS_NUM_TYPE_VOICE
Exceptionally, CTS_NUM_TYPE_CUSTOM is exclusive.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif
@brief The structure type to contain the set of callback functions for handling the response events
of the key-value structured data control.
@since_tizen 2.3
@see data_control_map_get_response_cb()
@see data_control_map_set_response_cb()
@see data_control_map_add_response_cb()
@see data_control_map_remove_response_cb()
@brief The structure type to contain the set of callback functions for handling the request events
from the key-value structured data control consumer.
@since_tizen 2.3
@brief The structure type to contain the set of callback functions for handling the request events
of SQL-friendly interface based data control.
@since_tizen 2.3
@brief The structure type to contain the set of callback functions for handling the response events of the SQL-friendly interface based data control.
@since_tizen 2.3
@brief Enumeration for battery property information.
@since_tizen 3.0
@remarks If the fuel gauge hardware does not provide average current or average voltage,
CURRENT_AVERAGE/VOLTAGE_AVERAGE can be substituted by CURRENT_NOW/VOLTAGE_NOW, respectively.
@addtogroup CAPI_SYSTEM_DEVICE_DISPLAY_MODULE
@{
/
/**
@brief Enumeration for the available display states.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@remarks #DISPLAY_STATE_SCREEN_DIM may be ignored if the DIM state is disabled on the platform.
@brief Enumeration for feedback interface of the system pre-defined patterns.
@details Each feedback pattern can have separate media files of each types.
But depending on vendor design, pattern may not have any type of file.
@since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
@brief Authenticator's supported method to communicate to FIDO user device.
@remarks Refer to FIDO UAF Registry document for more details.
@since_tizen 3.0
@deprecated Deprecated since 6.5.
@brief Enumeration for the return values of media packet finalize call back functions.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@see media_packet_finalize_cb()
@brief Enumeration for the key codes.
If keycode & 0xff000000 == 0x01000000 then this key code is directly encoded 24-bit UCS character.
The UCS value is keycode & 0x00ffffff.
@details Defines the list of keys supported by the system.
Note that certain keys may not be available on all devices.
@since_tizen @if MOBILE 2.4 @else 3.0 @endif
@brief Enumeration for the key masks.
The key masks indicate which modifier keys is pressed down during the keyboard hit.
The special #IME_KEY_MASK_RELEASED indicates the key release event.
@since_tizen @if MOBILE 2.4 @else 3.0 @endif
@brief Enumeration for Wi-Fi Association Status code, provided by the supplicant.
@details The Wi-Fi Standard Reference : Status codes (IEEE 802.11-2007, 7.3.1.9, Table 7-23).
@since_tizen 5.0
@brief Enumeration for Wi-Fi security type.
@details The following security modes are used in infrastructure and ad-hoc mode.
For now all EAP security mechanisms are provided only in infrastructure mode.
@brief Enumeration for connectivities which can be held in a resource.
@remarks IOTCON_CONNECTIVITY_PREFER_UDP and IOTCON_CONNECTIVITY_PREFER_TCP should be mutually exclusive.
@remarks IOTCON_CONNECTIVITY_IPV4_ONLY and IOTCON_CONNECTIVITY_IPV6_ONLY should be mutually exclusive.
@since_tizen 3.0
@brief The structure type containing the set of callback functions for handling jobs.
@details It is one of the input parameter of the job_scheduler_service_add() function.
@since_tizen 4.0
@see job_scheduler_service_add()
@see job_service_start_cb()
@see job_service_stop_cb()
@deprecated Deprecated since 3.0
@brief Enumeration for the location service accessibility state.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@brief Enumerations for voice key status change.
@details When the voice key is pressed, the "pressed" state is reported.
If the voice key gets released within the timeout value for tap events,
the voice key status value will be reported as "released after tap".
Otherwise, "released after push" will be reported.
@since_tizen 6.0
@ingroup CAPI_MEDIA_CONTENT_MODULE
@deprecated Deprecated since 5.0.
@brief Enumeration for the storage type.
@details This information is used to establish where the folder is.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@ingroup CAPI_MEDIA_CONTENT_MODULE
@brief Enumeration for the media file format.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@remarks Since 4.0, #MEDIA_CONTENT_TYPE_OTHERS is related to the following feature:\n
%http://tizen.org/feature/content.scanning.others\n
If this feature is not supported on the device, #MEDIA_CONTENT_TYPE_OTHERS type file is not scanned.
@brief Enumeration of media codec support type.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@remarks If this codec is to be used as an encoder or decoder, the codec flag must be set to #MEDIACODEC_ENCODER or
#MEDIACODEC_DECODER. If user doesn't set optional flag, default flags will be set to #MEDIACODEC_SUPPORT_TYPE_SW.
@brief Types of hardware resources to be used for NNFWs. Note that if the affinity (nnn) is not supported by the driver or hardware, it is ignored.
@since_tizen 5.5
@brief Types of NNFWs.
@details To check if a nnfw-type is supported in a system, an application may call the API, ml_check_nnfw_availability().
@since_tizen 5.5
@brief Callbacks for src input events.
@details A set of callbacks that can be installed on the appsrc with ml_pipeline_src_set_event_cb().
@since_tizen 6.5
@brief Enumeration for rotation direction attribute.
@details Set one of rotation direction, which are:\n
#MV_BARCODE_DETECT_ATTR_ROTATION_CLOCKWISE - clockwise rotation,\n
#MV_BARCODE_DETECT_ATTR_ROTATION_COUNTER_CLOCKWISE - counter clockwise rotation,\n
#MV_BARCODE_DETECT_ATTR_ROTATION_ALL - clockwise and counter clockwise rotation iteratively.\n
@brief Enumeration for inference backend.
#MV_INFERENCE_BACKEND_OPENCV An open source computer vision and machine learning
software library.
(https://opencv.org/about/)
#MV_INFERENCE_BACKEND_TFLITE Google-introduced open source inference engine for embedded systems,
which runs Tensorflow Lite model.
(https://www.tensorflow.org/lite/guide/get_started)
#MV_INFERENCE_BACKEND_ARMNN ARM-introduced open source inference engine for CPUs, GPUs and NPUs, which
enables efficient translation of existing neural network frameworks
such as TensorFlow, TensorFlow Lite and Caffes, allowing them to
run efficiently without modification on Embedded hardware.
(https://developer.arm.com/ip-products/processors/machine-learning/arm-nn)
#MV_INFERENCE_BACKEND_MLAPI Samsung-introduced open source ML single API framework of NNStreamer, which
runs various NN models via tensor filters of NNStreamer.
(https://github.com/nnstreamer/nnstreamer)
#MV_INFERENCE_BACKEND_ONE Samsung-introduced open source inference engine called On-device Neural Engine, which
performs inference of a given NN model on various devices such as CPU, GPU, DSP and NPU.
(https://github.com/Samsung/ONE)
@brief Enumeration for display type.
@since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
@details In case of using #PLAYER_DISPLAY_TYPE_OVERLAY_SYNC_UI, the video is rendering in full scale in the rendering area.\n
To change the video rendering position, use UI API functions like ecore_wl2_subsurface_exported_surface_move(),
ecore_wl2_subsurface_exported_surface_resize(), ecore_wl2_subsurface_exported_surface_transform_set(),
ecore_wl2_subsurface_exported_surface_show() and ecore_wl2_subsurface_exported_surface_commit().\n
player_set_display_mode(), player_set_display_rotation() and player_set_display_roi_area() cannot be used and
#PLAYER_ERROR_NOT_AVAILABLE is returned if they are used.\n
Exported shell handle must be obtained by ecore_wl2_subsurface_exported_surface_handle_get() from Ecore_Wl2_Subsurface.\n
Then the exported shell handle should be set with player_set_display().\n
To render the first video buffer, commit by ecore_wl2_window_commit() after player_prepare() of Ecore_Wl2_Subsurface.\n
Always commit with ecore_wl2_window_commit() with parent surface when the UI changes and the video needs to be synchronized.
@brief Enumeration for lock type.
@details Each enum ensures that the suitable device is on until all the lock requests have been released or after a timeout.
@brief Enumeration for reference orientations of sensor data
@details The sensor's physical orientation may differ from what applications are aware of,
in cases that the device has a rotated screen, physically or logically.
For example, a watch device may have right hand mode, which logically rotates
the display 180 degrees.
Applications may not be aware of such situations, thus they may receives
sensor data inverted in X and Y directions.
With #SENSOR_AXIS_DISPLAY_ORIENTED option, applications can get data that
are properly aligned with the orientation of which they are aware.@n
By default, #SENSOR_AXIS_DISPLAY_ORIENTED is used.
If you need to use the data that are not affected by display orientations,
#SENSOR_AXIS_DEVICE_ORIENTED needs to be set.
@since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
@brief Sensor data event delivered via sensor_event_cb().
@details A sensor data is delivered as a structure, which contains the accuracy of the data,
the time when the data was observed, and the data array.
The data array is a fixed size @c float array, and the number of data fields
stored in the array varies with the sensor type.
For example, #SENSOR_ACCELEROMETER reports 3-dimensional data,
#sensor_event_s::value_count is thus set to 3.@n
Note that, even if the data values are @c float, in some cases,
it may contain one or more categorical data as in #sensor_proximity_e.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@see #sensor_pedometer_state_e
@see #sensor_sleep_state_e
@brief Enumeration for heart-rate monitor batch sensor state.
@details In its #sensor_event_s, #SENSOR_HRM_BATCH reports the user's
heart-rate monitor state as one of the followings.
@since_tizen 5.5
@brief Enumeration for pause policies of sensor listeners
@details To be power-efficient, you can set the policy of how to pause and resume
a sensor listener regarding the system status.
By default, #SENSOR_PAUSE_ALL is used to obtain the maximum power efficiency.
@since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
@brief Enumeration for pedestrian state.
@details In its #sensor_event_s, #SENSOR_HUMAN_PEDOMETER reports the user's
pedestrian state as one of the followings.
@since_tizen 3.0
@brief Enumeration for proximity sensor events.
@details In its #sensor_event_s, #SENSOR_PROXIMITY reports the existence of
nearby objects in front of the sensor as one of the followings.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@brief Enumeration for data attributes can be contained in #sensor_recorder_data_h.
@since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
@see sensor_recorder_data_get_int()
@see sensor_recorder_data_get_double()
@brief Enumeration for intervals between data records.
@details Some sensor types including #SENSOR_HRM may not fit to continuous monitoring and recording.
To reduce the battery use for recording such sensors, recording interval between each
sensor data is chosen. For example, an application set the interval of 1 hour,
the platform tries to retrieve the sensor data only once per hour, thus it will be more
battery efficient than to listen the sensor data continuously.@n
If the application does not set the interval explicitly, the default value is chosen.
The default values are differ from sensor to sensor.
@since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
@remarks If more than one applications set different intervals, the shortest value is chosen.
@brief Enumeration for option parameters for sensor recording.
@details None, one, or more option parameters can be set to #sensor_recorder_option_h,
then applications can request to record a specific sensor with the parameters via
sensor_recorder_start().
If a parameter is not supported for the specified sensor type, it will be ignored.
@since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
@brief Enumeration for filtering and aggregation parameters for querying sensor records.
@details None, one, or more query parameters can be set to #sensor_recorder_query_h,
to specify the data to be retrieved via sensor_recorder_read().
If a necessary parameter is not set, the default value is chosen.
@since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
@brief Enumeration for sleep state.
@details In its #sensor_event_s, #SENSOR_HUMAN_SLEEP_MONITOR reports the user's
sleep state as one of the followings.
@since_tizen 3.0
@brief The structure type containing the set of callback functions for handling application events.
@details It is one of the input parameters of the service_app_efl_main() function.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@see service_app_main()
@see service_app_create_cb()
@see service_app_terminate_cb()
@see service_app_control_cb()
@brief Enumeration for shortcut types.
@details Basically, two types of shortcuts are defined.
Every homescreen developer should support these types of shortcuts.
Or return, a proper errno to figure out why the application failed to add a shortcut.
#LAUNCH_BY_APP is used for adding a package itself as a shortcut.
#LAUNCH_BY_URI is used for adding a shortcut for "uri" data.
@since_tizen 2.3
@brief Enumeration for sound behavior.
@since_tizen 3.0
@remarks These values can be combined with bitwise 'or'.
@see sound_manager_get_current_playback_focus()
@see sound_manager_get_current_recording_focus()
@brief Enumeration for network connection period type.
@details Last received/sent mean counting data from the first connection of each interface.
@since_tizen 4.0
@brief A structure for the STT engine functions.
@details This structure contains essential callback functions for operating STT engine.
@since_tizen 3.0
@remarks These functions are mandatory for operating STT engine. Therefore, all functions MUST be implemented.
@brief A structure for the TTS engine functions.
@details This structure contains essential callback functions for operating TTS engine.
@since_tizen 3.0
@remarks These functions are mandatory for operating TTS engine. Therefore, all functions MUST be implemented.
@brief The structure type containing the set of callback functions for handling application lifecycle events.
@details It is one of the input parameters of the ui_app_main() function.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@see ui_app_main()
@see app_create_cb()
@see app_pause_cb()
@see app_resume_cb()
@see app_terminate_cb()
@see app_control_cb()
@brief A structure for the VC engine functions.
@details This structure contains essential callback functions for operating VC engine.
@since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
@remarks You must register all callbacks except optional callbacks for operating VC engine.\n
The following callbacks are optional callbacks : \n
@brief Wi-Fi Direct buffer structure to store information of connected peer.
@since_tizen 2.3
@remarks You can use APIs for wifi-direct display function instead of is_miracast_device value
which is deprecated since 2.4.
@see wifi_direct_connected_peer_cb()
@brief Wi-Fi Direct buffer structure to store result of peer discovery.
@since_tizen 2.3
@remarks You can use APIs for Wi-Fi Direct display function instead of is_miracast_device value
which is deprecated since 2.4.
@see wifi_direct_discovered_peer_cb()
@see wifi_direct_get_peer_info()
@see wifi_direct_get_connecting_peer_info()
@brief Enumeration for Wi-Fi Association Status code, provided by the supplicant.
@details The Wi-Fi Standard Reference : Status codes (IEEE 802.11-2007, 7.3.1.9, Table 7-23).
@since_tizen 5.0
@brief Enumeration for Wi-Fi security type.
@details The following security modes are used in infrastructure and ad-hoc mode.
For now all EAP security mechanisms are provided only in infrastructure mode.
@brief Enumeration for YACA DH parameters taken from RFC 5114.
It's meant to be passed or returned as a @a key_bit_len param
in appropriate functions when dealing with DH and wanting to
use RFC 5114 values.
@since_tizen 3.0
@brief Enumeration for YACA key lengths.
It is possible to use arbitrary integer instead,
this enum values are placed here to avoid magic numbers.
@since_tizen 3.0
@brief Enumeration for YACA elliptic curve types with their bit lengths.
It's meant to be passed or returned as a @a key_bit_len param
in appropriate functions when dealing with elliptic curves.
@since_tizen 3.0
@brief Called when another application sends a launch request to the application.
@details Before calling app_control_cb() function, this callback function is called.
@since_tizen 5.5
@remarks After this callback function returns, the handle of the app_control is released.
Therefore, if you want to use the handle after returning this callback function, you MUST copy it by using app_control_clone() function.
@remarks The @a action must not be deallocated by the application. The platform frees the string when the app_control action handle is removed.
@brief Called when another application sends a launch request to the application.
@details When the application is launched, this callback function is called after the main loop of the application starts up.
The passed app_control handle describes the launch request and contains the information about why the application is launched.
If the launch request is sent to the application in the running or pause state,
this callback function can be called again to notify that the application has been asked to launch.
The application could be explicitly launched by the user from the application launcher or be launched to perform the specific operation by another application.
The application is responsible for handling each launch request and responding appropriately.
Using the App Control API, the application can get information about what is to be performed.
If the application is launched from the application launcher or explicitly launched by another application,
the passed app_control handle may include only the default operation (#APP_CONTROL_OPERATION_DEFAULT) without any data.
For more information, see The @ref CAPI_APP_CONTROL_MODULE API description.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@remarks After this callback returns, the handle of the app_control is freed.
Therefore, if you want to use the handle after returning this callback, you MUST copy it by using app_control_clone() API.
@paramin app_control The handle to the app_control
@paramin user_data The user data passed from the callback registration function
@see ui_app_main()
@see #ui_app_lifecycle_callback_s
@see @ref CAPI_APP_CONTROL_MODULE API
@brief Called when the result of the launch request is delivered.
@details Following error codes can be delivered: \n
#APP_CONTROL_ERROR_NONE, \n
#APP_CONTROL_ERROR_APP_NOT_FOUND, \n
#APP_CONTROL_ERROR_PERMISSION_DENIED, \n
#APP_CONTROL_ERROR_INVALID_PARAMETER, \n
#APP_CONTROL_ERROR_LAUNCH_REJECTED
@brief Called when the application starts.
@details The callback function is called before the main loop of the application starts.
In this callback, you can initialize application resources like window creation, data structure, and so on.
After this callback function returns @c true, the main loop starts up and app_control_cb() is subsequently called.
If this callback function returns @c false, the main loop doesn't start and app_terminate_cb() is subsequently called.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin user_data The user data passed from the callback registration function
@return @c true on success,
otherwise @c false
@pre ui_app_main() will invoke this callback function.
@see ui_app_main()
@see #ui_app_lifecycle_callback_s
@brief The system event callback function.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@remarks If the given @a event_info has #APP_SUSPENDED_STATE_WILL_ENTER value,
the application should not call any asynchronous operations in this callback.
After the callback returns, process of the application will be changed to suspended
state immediately. Thus, asynchronous operations may work incorrectly. (since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif)
@paramin event_info The system event information
@paramin user_data The user data passed from the add event handler function
@see ui_app_add_event_handler
@see app_event_info_h
@brief The event handler that returned from add event handler function to handle.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@see app_event_type_e
@see ui_app_add_event_handler
@see ui_app_remove_event_handler
@see app_event_info_h
@brief Called for each application category in app_info_foreach_category().
@since_tizen 4.0
@remarks @a category will be freed when the application information handle is destroyed
using app_info_destroy()
@paramin category The name of the category
@paramin user_data The user data passed to app_info_foreach_category()
@return @c true to continue with the next iteration of the loop, \n
otherwise @c false to break out of the loop
@pre app_info_foreach_category() will invoke this callback.
@see app_info_foreach_category()
@brief Called to get the application information once for each installed application.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin app_info The application information of each installed application
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, \n
otherwise @c false to break out of the loop
@pre app_manager_foreach_app_info() will invoke this callback.
@see app_manager_foreach_app_info()
@brief Called to get application metadata in app_info_foreach_metadata().
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin metadata_key The key of the metadata
@paramin metadata_value The value of the metadata
@paramin user_data The user data passed to app_info_foreach_metadata()
@return @c true to continue with the next iteration of the loop, \n
otherwise @c false to break out of the loop
@pre app_info_foreach_metadata() will invoke this callback.
@see app_info_foreach_metadata()
@brief Called for each application resource control in app_info_foreach_res_control().
@since_tizen 6.5
@remarks @a res_type, @a min_res_version, @a max_res_version, and @a auto_close are managed by the platform and will be released after the callback exits.
@paramin res_type The resource type
@paramin min_res_version The minimum version of the resource package to use
@paramin max_res_version The maximum version of the resource package to use
@paramin auto_close The value of auto close
@paramin user_data The user data passed to app_info_foreach_res_control()
@return @c true to continue with the next iteration of the loop, \n
otherwise @c false to break out of the loop
@pre app_info_foreach_res_control() will invoke this callback.
@see app_info_foreach_res_control()
@brief Called to get the application context once for each running application.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin app_context The application context of each running application
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, \n
otherwise @c false to break out of the loop
@pre app_manager_foreach_app_context() will invoke this callback.
@see app_manager_foreach_app_context()
@brief Called when an application is launched or terminated.
@since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
@remarks Please don't try to free the handle of app_context, because it is managed by the framework.
@paramin app_context The application context of the application launched or terminated
@paramin event The application context event
@paramin user_data The user data passed from the foreach function
@pre This function is called when an application gets launched or terminated, after you register this callback using app_manager_set_app_context_event_cb().
@see app_manager_set_app_context_event_cb()
@see app_manager_unset_app_context_event_cb()
@brief Called to get the application information once for each installed application.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin app_info The application information of each installed application
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, \n
otherwise @c false to break out of the loop
@pre app_manager_foreach_app_info() will invoke this callback.
@see app_manager_foreach_app_info()
@brief Called when the application is completely obscured by another application and becomes invisible.
@details The application is not terminated and still running in the paused state.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin user_data The user data passed from the callback registration function
@see ui_app_main()
@see #ui_app_lifecycle_callback_s
@brief Called when the application becomes visible.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin user_data The user data passed from the callback registration function
@see ui_app_main()
@see #ui_app_lifecycle_callback_s
@brief Called when the application's main loop exits.
@details You should release the application's resources in this function.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin user_data The user data passed from the callback registration function
@see ui_app_main()
@see #ui_app_lifecycle_callback_s
@brief Called when the status of an advertisement to a service is changed.
@since_tizen 4.0
@paramin adv_service The service whose status has changed;
the handle to the same object for which the callback was set
@paramin status The status of the service
@paramin reason The reason of the state change
@paramin user_data The user data passed from the callback registration function
@pre The callback must be registered using asp_advert_set_status_cb().\n
asp_advert_start_advertising() and asp_change_service_state() invoke this callback.
@see asp_advert_set_status_changed_cb()
@see asp_advert_unset_status_changed_cb()
@see asp_advert_start_advertising()
@brief Called when the Application Service Platform (ASP) Service is found.
@since_tizen 4.0
@remarks @a service_mac, @a instance_name and @a service_info are valid only in the callback.
To use outside the callback, make a copy.
@paramin error_code The error code. \n
#ASP_ERROR_NONE Successful\n
#ASP_ERROR_OUT_OF_MEMORY Out of memory\n
#ASP_ERROR_OPERATION_FAILED Operation failed\n
@paramin seek_service The seek service which found the current result;
the handle to the same object for which the search was started
@paramin service_mac The P2P device address of the device which provides the service;
NULL if not available
@paramin adv_id The service advertisement ID defined by remote P2P device
@paramin config_method The preferred Wi-Fi Simple Config (WSC) configuration method
@paramin instance_name The advertised service name defined by the remote P2P device;
NULL if not available
@paramin service_info The advertised service information defined by the remote P2P device;
NULL if not available
@paramin info_size The advertised service information payload size;
if the information is not available, this is set to -1
@paramin status The status of the service
@paramin user_data The user data passed from the callback registration function
@pre The callback must be registered using asp_seek_set_search_result_cb().\n
asp_seek_start() must be called to invoke this callback.
@see asp_seek_set_search_result_cb()
@see asp_seek_unset_search_result_cb()
@see asp_seek_start()
@brief Called when the Application Service Platform (ASP) has to provide
a PIN value or collect a PIN value.
@since_tizen 4.0
@remarks @a config_pin is valid only in the callback.
To use outside the callback, make a copy.
@paramin error_code The error code.\n
#ASP_ERROR_NONE Successful\n
#ASP_ERROR_OUT_OF_MEMORY Out of memory\n
#ASP_ERROR_OPERATION_FAILED Operation failed\n
@paramin session The session for which the request is made;
the handle to the same object for which the callback was set
@paramin get_pin (@c true = instruct the user to enter the PIN,
@c false = display the PIN provided in the @a config_pin parameter)
@paramin config_pin The WSC PIN value used for setting up; ignored if @a get_pin is @c true
@paramin user_data The user data passed from the callback registration function
@pre The callback must be registered using asp_session_set_config_request_cb().\n
asp_session_connect() must be called to invoke this callback.
@see asp_session_set_request_cb()
@see asp_session_connect()
@brief Called when the Application Service Platform (ASP) reports progress on group formation.
@since_tizen 4.0
@remarks @a deferred_resp is valid only in the callback.
To use outside the callback, make a copy.
@paramin error_code The error code.\n
#ASP_ERROR_NONE Successful\n
#ASP_ERROR_OUT_OF_MEMORY Out of memory\n
#ASP_ERROR_OPERATION_FAILED Operation failed\n
@paramin session The session for which progress is reported;
the handle to the same object for which the callback was set
@paramin status The connection progress status
@paramin deferred_resp The service-specific data payload up to 144 bytes
@paramin resp_size The service-specific data payload size(up to 144)
@paramin user_data The user data passed from the callback registration function
@pre The callback must be registered using asp_session_set_connect_status_cb()
@see asp_session_set_connect_status_cb()
@brief Called when the Application Service Platform (ASP) reports the status of the network port on the local and remote end of the ASP session.
@since_tizen 4.0
@remarks @a ip_address is valid only in the callback.
To use outside the callback, make a copy.
@paramin error_code The error code.\n
#ASP_ERROR_NONE Successful\n
#ASP_ERROR_OUT_OF_MEMORY Out of memory\n
#ASP_ERROR_OPERATION_FAILED Operation failed\n
@paramin session Application Service Platform session descriptor handle
@paramin ip_address The IP address for the port, local or remote
@paramin port The port number
@paramin proto The IANA protocol number
@paramin status The port status
@paramin user_data The user data passed from the callback registration function
@pre The callback must be registered using asp_session_set_port_status_cb()
@see asp_session_set_port_status_cb()
@brief Called when a remote device is attempting to initiate an ASP session.
@since_tizen 4.0
@remarks @a network_config_pin, @a device_name and @a info are valid only in the callback.
To use outside the callback, make a copy.
@paramin error_code The error code.\n
#ASP_ERROR_NONE Successful\n
#ASP_ERROR_OUT_OF_MEMORY Out of memory\n
#ASP_ERROR_OPERATION_FAILED Operation failed\n
@paramin adv_service Service descriptor handle provided by the asp_advert_create()
it is the "original" object not created specifically for the callback
@paramin session The session for which the request is made;
the handle to the same object for which the callback was set
@paramin device_name Device name of the remote peer
@paramin info The service-specific data payload (up to 144 bytes);
NULL if not available
@paramin info_size The service-specific data payload size (up to 144)
@paramin get_network_config_pin (@c true = requires WSC PIN to be entered by
the asp_session_confirm(),
@c false = does not require PIN)
@paramin network_config_pin The WSC PIN value to be displayed; NULL if not available
@paramin user_data The user data passed from the callback registration function
@pre The callback must be registered using asp_session_set_request_cb().
@see asp_session_set_request_cb()
@brief Called when the Application Service Platform (ASP) reports the state and status of an ASP session.
@since_tizen 4.0
@remarks @a additional_info is valid only in the callback.
To use outside the callback, make a copy.
@paramin error_code The error code.\n
#ASP_ERROR_NONE Successful\n
#ASP_ERROR_OUT_OF_MEMORY Out of memory\n
#ASP_ERROR_OPERATION_FAILED Operation failed\n
@paramin session The session for which status is reported;
the handle to the same object for which the callback was set
@paramin state The session state
@paramin additional_info Additional information related to the SessionStatus event
@paramin user_data The user data passed from the callback registration function
@pre The callback must be registered using asp_session_set_status_cb()
@see asp_session_set_status_cb()
@ingroup CAPI_CONTENT_MEDIA_AUDIO_META_MODULE
@brief The structure type for the Audio metadata handle.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@brief Called when receiving the authentication information.
@since_tizen 5.5
@remarks @a ah should not be freed and can be used only in the callback.
@remarks @a auth_info should not be freed and can be used only in the callback.
@paramin ah The autofill handle
@paramin auth_info The autofill authentication information handle
@paramin user_data The user data passed from the callback function
@see autofill_auth_info_set_received_cb()
@brief Called when the connection status is changed.
@since_tizen 5.5
@remarks @a ah should not be freed and can be used only in the callback.
@paramin ah The autofill handle
@paramin status The connection status
@paramin user_data The user data passed from the callback function
@see autofill_connect()
@brief Called when receiving the error information.
@since_tizen 5.5
@remarks @a ah should not be freed and can be used only in the callback.
@remarks @a error_info should not be freed and can be used only in the callback.
@paramin ah The autofill handle
@paramin error_info The autofill error information handle
@paramin user_data The user data passed from the callback function
@see autofill_error_info_set_received_cb()
@brief Called for each autofill fill response group information in fill response.
@since_tizen 5.5
@remarks @a item should not be freed and can be used only in the callback.
@paramin item The autofill fill response group handle
@paramin user_data The user data to be passed to the callback function
@return @c true to continue with the next iteration of the loop,
otherwise @c false to break out of the loop
@pre autofill_fill_response_foreach_group() will invoke this callback.
@see autofill_fill_response_foreach_group()
@brief Called for each autofill fill response information in fill response group.
@since_tizen 5.5
@remarks @a item should not be freed and can be used only in the callback.
@paramin item The autofill fill response item handle
@paramin user_data The user data to be passed to the callback function
@return @c true to continue with the next iteration of the loop,
otherwise @c false to break out of the loop
@pre autofill_fill_response_group_foreach_item() will invoke this callback.
@see autofill_view_info_foreach_item()
@brief Called when receiving autofill fill response data.
@since_tizen 5.5
@remarks @a ah should not be freed and can be used only in the callback.
@remarks @a fill_response_h should not be freed and can be used only in the callback.
@paramin ah The autofill handle
@paramin fill_response_h The autofill fill response handle
@paramin user_data The user data to be passed to the callback function
@see autofill_fill_response_set_received_cb()
@brief Called for each autofill information in view info.
@since_tizen 5.5
@remarks @a item should not be freed and can be used only in the callback.
@paramin item The autofill item handle
@paramin user_data The user data to be passed to the callback function
@return @c true to continue with the next iteration of the loop,
otherwise @c false to break out of the loop
@pre autofill_view_info_foreach_item() will invoke this callback.
@see autofill_view_info_foreach_item()
@brief Called for each autofill service information.
@since_tizen 5.5
@remarks @a app_id should not be freed and can be used only in the callback.
@paramin app_id The autofill service app ID
@paramin user_data The user data to be passed to the callback function
@return @c true to continue with the next iteration of the loop,
otherwise @c false to break out of the loop
@pre autofill_manager_foreach_autofill_service() will invoke this callback.
@see autofill_manager_foreach_autofill_service()
@brief Called when the connection status is changed.
@since_tizen 5.5
@remarks @a amh should not be freed and can be used only in the callback.
@paramin amh The autofill manager handle
@paramin status The connection status
@paramin user_data The user data passed from the callback function
@see autofill_manager_connect()
@brief Called for each autofill information in save view info.
@since_tizen 5.5
@remarks @a item should not be freed and can be used only in the callback.
@paramin item The autofill item handle
@paramin user_data The user data to be passed to the callback function
@return @c true to continue with the next iteration of the loop,
otherwise @c false to break out of the loop
@pre autofill_view_info_foreach_item() will invoke this callback.
@see autofill_view_info_foreach_item()
@brief Called when receiving authentication information request.
@since_tizen 5.5
@remarks @a vi should not be freed and can be used only in the callback.
@paramin context_id The autofill context identification value of an associated autofill client handle
@paramin vi The autofill view info handle
@paramin user_data The user data passed from the callback function
@see autofill_service_set_auth_info_requested_cb()
@brief Called when receiving the cancellation of autofill request.
@since_tizen 5.5
@remarks @a vi should not be freed and can be used only in the callback.
@paramin context_id The autofill context identification value of an associated autofill client handle
@paramin vi The autofill view info handle
@paramin user_data The user data passed from the callback function
@see autofill_service_set_cancel_fill_requested_cb()
@brief Called when receiving commit request.
@since_tizen 5.5
@remarks @a vi should not be freed and can be used only in the callback.
@paramin context_id The autofill context identification value of an associated autofill client handle
@paramin vi The autofill save view info handle
@paramin user_data The user data passed from the callback function
@see autofill_service_set_committed_cb()
@brief Called when receiving fill request.
@since_tizen 5.5
@remarks @a vi should not be freed and can be used only in the callback.
@paramin context_id The autofill context identification value of an associated autofill client handle
@paramin vi The autofill view info handle
@paramin user_data The user data passed from the callback function
@see autofill_service_set_fill_requested_cb()
@brief Called when receiving terminate request.
@since_tizen 5.5
@paramin user_data The user data passed from the callback function
@see autofill_service_set_terminate_received_cb()
@brief Called when the badge information is changed.
@since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
@paramin action The type of the change. Refer #badge_action
@paramin app_id The name of the application
@paramin count The count of the badge
@paramin user_data The user data passed from the callback register function
@pre badge_register_changed_cb() will invoke this callback.
@see badge_unregister_changed_cb()
@brief Callback function for getting result of badge_foreach().
@since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
@paramin app_id The id of the application
@paramin count The count of the badge
@paramin user_data The user data passed from the badge_foreach()
@return true to continue with the next iteration of the loop, false to break out of the loop
@pre badge_foreach() will invoke this callback.
@see badge_foreach()
@ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
@brief Called when the state of device discovery changes.
@since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
@ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
@brief Called when the Bluetooth adapter state changes.
@since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
@ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
@brief Called every second until the visibility mode is changed to #BT_ADAPTER_VISIBILITY_MODE_NON_DISCOVERABLE.
@since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
@ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
@brief The handle to control Bluetooth LE advertising.
@since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
@ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
@brief Called when the connection state is changed.
@since_tizen 3.0
@paramin connected The state to be changed. true means connected state, Otherwise, false.
@paramin remote_address The remote address
@paramin user_data The user data passed from the callback registration function
@see bt_avrcp_control_initialize()
@see bt_avrcp_control_deinitialize()
@ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
@brief Called when the equalizer state is changed by the remote control device.
@since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
@ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
@brief Called when the Song Play status mode is changed by the remote target device.
@since_tizen 3.0
@paramin play_state The song play status
@paramin user_data The user data passed from the callback registration function
@see bt_avrcp_set_play_status_changed_cb()
@see bt_avrcp_unset_play_status_changed_cb()
@ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
@brief Called when the Song position mode is changed by the remote target device.
@since_tizen 3.0
@paramin position Playback position in milliseconds. When position is 0 it means the track is starting and when it's greater than or equal to track's duration the track has ended.
@paramin user_data The user data passed from the callback registration function
@see bt_avrcp_set_position_changed_cb()
@see bt_avrcp_unset_position_changed_cb()
@ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
@brief Called when the repeat mode is changed by the remote control device.
@since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
@ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
@brief Called when the scan mode is changed by the remote control device.
@since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
@ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
@brief Called when the shuffle mode is changed by the remote control device.
@since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
@ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
@brief Called when the Song metadata information is changed by the remote target device.
@since_tizen 3.0
@paramin track The song metadata information
@paramin user_data The user data passed from the callback registration function
@see bt_avrcp_set_track_info_changed_cb()
@see bt_avrcp_unset_track_info_changed_cb()
@ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
@brief Called when the process of creating bond finishes.
@since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
@ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
@brief Called when you get connected profiles repeatedly.
@since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
@ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
@brief Called when the process of service search finishes.
@since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
@ingroup CAPI_NETWORK_BLUETOOTH_GATT_CLIENT_MODULE
@brief Called when a value of a watched characteristic's GATT handle has been changed.
@since_tizen 2.3.1
@ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE
@brief Called when the remote device enables or disables the Notification/Indication for particular characteristics.
@deprecated Deprecated since 5.0.
@ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
@brief Called when the connection is established.
@since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
@remarks Deprecated, because of no usecase and supported devices.
@deprecated Deprecated since 5.0.
@ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
@brief Called when the you receive the data.
@since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
@remarks Deprecated, because of no usecase and supported devices.
@deprecated Deprecated since 5.0.
@ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
@brief Called when the connection is disconnected.
@since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
@remarks Deprecated, because of no usecase and supported devices.
@ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
@brief Called when the Bluetooth HID Device connection state changes.
@details The following error codes can be delivered: \n
#BT_ERROR_NONE \n
#BT_ERROR_OPERATION_FAILED \n
@since_tizen @if WEARABLE 3.0 @endif
@ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
@brief Called when the HID Device receives data from the HID Host.
@details The following error codes can be delivered: \n
#BT_ERROR_NONE \n
#BT_ERROR_OPERATION_FAILED \n
@since_tizen @if WEARABLE 3.0 @endif
@ingroup CAPI_NETWORK_BLUETOOTH_IPSP_MODULE
@brief Called when the IPSP connection state changes.
@since_tizen 4.0
@paramin result The result of the connection or disconnection request
@paramin connected The connection status: (@c true = connected, @c false = disconnected)
@paramin remote_address Address of remote device
@paramin iface_name The network interface name for IPv6 network interface
@paramin user_data The user data passed from the callback registration function
@see bt_ipsp_connect()
@see bt_ipsp_disconnect()
@ingroup CAPI_NETWORK_BLUETOOTH_IPSP_MODULE
@brief Called when the IPSP initialization state changes.
@since_tizen 4.0
@paramin result The result of the initialization or deinitialization request
@paramin ipsp_initialized The initialized state: (@c true = initialized, @c false = deinitialized)
@paramin user_data The user data passed from the initialization request function
@see bt_ipsp_initialize()
@see bt_ipsp_deinitialize()
@ingroup CAPI_NETWORK_BLUETOOTH_OPP_CLIENT_MODULE
@brief Called when OPP server responds to the push request.
@since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
@WEARABLE_ONLY
@ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
@brief Called when PBAP is Connected or Disconnected.
@details The following error codes can be delivered: \n
#BT_ERROR_NONE \n
#BT_ERROR_AUTH_REJECTED \n
#BT_ERROR_AUTHORIZATION_REJECTED \n
#BT_ERROR_SERVICE_NOT_FOUND \n
#BT_ERROR_TIMED_OUT \n
#BT_ERROR_OPERATION_FAILED \n
@since_tizen 3.0
@WEARABLE_ONLY
@ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
@brief Called when PBAP List vCards completes.
@details The following error codes can be delivered: \n
#BT_ERROR_NONE \n
#BT_ERROR_OPERATION_FAILED \n
@since_tizen 3.0
@WEARABLE_ONLY
@ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
@brief Called when PBAP Phonebook Pull completes.
@details The received phone book file will be saved in the platform downloads folder. \n
The following error codes can be delivered: \n
#BT_ERROR_NONE \n
#BT_ERROR_OPERATION_FAILED \n
@since_tizen 3.0
@WEARABLE_ONLY
@ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
@brief Called when PBAP Phonebook size calculation completes.
@details The following error codes can be delivered: \n
#BT_ERROR_NONE \n
#BT_ERROR_OPERATION_FAILED \n
@since_tizen 3.0
@brief Called for every key-value pair.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin key The key of key-value pair
@paramin type The type of bundle
@paramin kv The handle of key-value pair
@paramin user_data The user data
@see bundle_foreach()
@brief Called when a designated view changes.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @elseif TV 4.0 @endif
@paramin view_uri The view URI
@paramin user_data The user data passed from the callback registration function
@see calendar_db_add_changed_cb()
@brief Called when an alarm is alerted.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @elseif TV 4.0 @endif
@paramin param Value string like id=value&time=value&tick=value&unit=value&type=value
@paramin user_data The user data passed from the callback registration function
@see calendar_reminder_add_cb()
@brief Called to get a record handle of
\ref CAPI_SOCIAL_CALENDAR_SVC_VIEW_MODULE_calendar_event or \ref CAPI_SOCIAL_CALENDAR_SVC_VIEW_MODULE_calendar_todo.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @elseif TV 4.0 @endif
@paramin record The record handle (\ref CAPI_SOCIAL_CALENDAR_SVC_VIEW_MODULE_calendar_event or \ref CAPI_SOCIAL_CALENDAR_SVC_VIEW_MODULE_calendar_todo)
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop,
otherwise @c false to break out of the loop
@pre calendar_vcalendar_parse_to_calendar_foreach() will invoke this callback.
@see calendar_vcalendar_parse_to_calendar_foreach()
@see calendar_record_get_uri_p()
@brief Called when the HDR capture process is updated.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin percent The progress percentage of HDR capture
@paramin user_data The user data passed from the callback registration function
@pre camera_start_capture() will invoke this callback if you register it using camera_attr_set_hdr_capture_progress_cb().
@see camera_attr_get_hdr_mode()
@see camera_attr_set_hdr_capture_progress_cb()
@see camera_attr_unset_hdr_capture_progress_cb()
@see camera_attr_is_supported_hdr_capture()
@brief Called to get each supported auto-focus mode.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin mode The supported auto-focus mode
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
@pre camera_attr_foreach_supported_af_mode() will invoke this callback.
@see camera_attr_foreach_supported_af_mode()
@brief Called to get each supported effect mode.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin effect The supported effect mode
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
@pre camera_attr_foreach_supported_effect() will invoke this callback.
@see camera_attr_foreach_supported_effect()
@brief Called to get each supported exposure mode.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin mode The supported exposure mode
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
@pre camera_attr_foreach_supported_exposure_mode() will invoke this callback.
@see camera_attr_foreach_supported_exposure_mode()
@see #camera_attr_exposure_mode_e
@brief Called to get each supported flash mode.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin mode The supported flash mode
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
@pre camera_attr_foreach_supported_flash_mode() will invoke this callback.
@see camera_attr_foreach_supported_flash_mode()
@brief Called to get each supported FPS mode.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin fps The supported FPS mode
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
@pre camera_attr_foreach_supported_fps() will invoke this callback.
@see camera_attr_foreach_supported_fps()
@brief Called to get each supported ISO mode.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin iso The supported ISO mode
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
@pre camera_attr_foreach_supported_iso() will invoke this callback.
@see camera_attr_foreach_supported_iso()
@brief Called to get each supported PTZ (Pan Tilt Zoom) type.
@since_tizen 3.0
@paramin type The supported ptz type
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, \n @c false to break out of the loop
@pre camera_attr_foreach_supported_ptz_mode() will invoke this callback.
@see camera_attr_foreach_supported_ptz_mode()
@brief Called to get each supported scene mode.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin mode The supported scene mode
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
@pre camera_attr_foreach_supported_scene_mode() will invoke this callback.
@see camera_attr_foreach_supported_scene_mode()
@see #camera_attr_scene_mode_e
@brief Called to get each supported stream flip mode.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin flip The supported stream flip mode
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, \n @c false to break out of the loop
@pre camera_attr_foreach_supported_stream_flip() will invoke this callback.
@see camera_attr_foreach_supported_stream_flip()
@brief Called to get each supported stream rotation mode.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin rotation The supported stream rotation mode
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, \n @c false to break out of the loop
@pre camera_attr_foreach_supported_stream_rotation() will invoke this callback.
@see camera_attr_foreach_supported_stream_rotation()
@brief Called to get each supported theater mode.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin mode The supported theater mode
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, \n @c false to break out of the loop
@pre camera_attr_foreach_supported_theater_mode() will invoke this callback.
@see camera_attr_foreach_supported_theater_mode()
@brief Called to get each supported white balance.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin wb The supported white balance mode
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
@pre camera_attr_foreach_supported_whitebalance() will invoke this callback.
@see camera_attr_foreach_supported_whitebalance()
@see #camera_attr_whitebalance_e
@brief Called to get information about image data taken by the camera once per frame while capturing.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@brief Called when the camera device state is changed.
@since_tizen 3.0
@paramin device The hardware camera type
@paramin state The state of the camera device
@paramin user_data The user data passed from the callback registration function
@see camera_add_device_state_changed_cb()
@brief Called when a face is detected in the preview frame.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin faces The detected face array
@paramin count The length of the array
@paramin user_data The user data passed from the callback registration function
@see camera_start_face_detection()
@brief Called when the camera focus state is changed.
@details When the camera auto focus completes or a change to the focus state occurs,
this callback is invoked. \n \n
Changes of focus state are as follows: \n
#CAMERA_FOCUS_STATE_RELEASED -> start focusing -> #CAMERA_FOCUS_STATE_ONGOING -> working ->
#CAMERA_FOCUS_STATE_FOCUSED or #CAMERA_FOCUS_STATE_FAILED.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@brief Called when the camera interrupt is started by policy.
@since_tizen 4.0
@remarks This callback is called before interrupt handling is started.
@paramin policy The policy that is interrupting the camera
@paramin state The current state of the camera
@paramin user_data The user data passed from the callback registration function
@see camera_set_interrupt_started_cb()
@brief Called when the camera is interrupted by policy.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@remarks This callback is called after interrupt handling is completed.
@paramin policy The policy that interrupted the camera
@paramin previous The previous state of the camera
@paramin current The current state of the camera
@paramin user_data The user data passed from the callback registration function
@see camera_set_interrupted_cb()
@brief Called to register for notifications about delivering media packet when every preview frame is displayed.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@brief Called to register for notifications about delivering a copy of the new preview frame when every preview frame is displayed.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@brief Called when the camera state is changed.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin previous The previous state of the camera
@paramin current The current state of the camera
@paramin by_policy If @c true the state is changed by policy, otherwise @c false
@paramin user_data The user data passed from the callback registration function
@pre camera_start_preview(), camera_start_capture() or camera_stop_preview()
will invoke this callback if you register this callback using camera_set_state_changed_cb().
@see camera_set_state_changed_cb()
@brief Called once for the pixel format of each supported capture format.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin format The supported pixel format
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
@pre camera_foreach_supported_capture_format() will invoke this callback.
@see camera_foreach_supported_capture_format()
@brief Called once for each supported capture resolution.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin width The capture resolution width
@paramin height The capture resolution height
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
@pre camera_foreach_supported_capture_resolution() will invoke this callback.
@see camera_foreach_supported_capture_resolution()
@brief Called once for the pixel format of each supported preview format.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin format The supported preview data format
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
@pre camera_foreach_supported_preview_format() will invoke this callback.
@see camera_foreach_supported_preview_format()
@brief Called once for each supported preview resolution.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin width The preview image width
@paramin height The preview image height
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
@pre camera_foreach_supported_preview_resolution() will invoke this callback.
@see camera_foreach_supported_preview_resolution()
@brief Event callback signature for receiving changed event of clipboard items.
@since_tizen 4.0
@paramin cbhm_handle The clipboard handle
@remarks @a cbhm_handle is the same handle as the one used in the cbhm_item_changed_callback_add() call with which the callback was added
@paramin item_count The number of clipboard items
@paramin user_data User data to be passed to the given event callback function
@return #CBHM_ERROR_NONE on success,
otherwise a negative error value
@retval #CBHM_ERROR_NONE Successful
@see cbhm_item_selected_callback_add()
@brief Event callback signature of receiving monitored event of clipboard.
@since_tizen 4.0
@paramin cbhm_handle Clipboard handle
@paramin active_state Clipboard is active if @c true, inactive otherwise
@paramin user_data User data to be passed to the given event callback function
@see cbhm_monitor_callback_add()
@see cbhm_monitor_callback_remove()
@brief Event callback signature of selecting a clipboard item.
@since_tizen 3.0
@paramin cbhm_handle Clipboard handle
@paramin user_data User data to be passed to the given event callback function
@return This is reserved
@see cbhm_item_selected_callback_add()
@brief Event callback signature of receiving data from clipboard.
@since_tizen 3.0
@paramin Clipboard handle
@paramout buf Buffer for receiving data
@paramin len The length of buffer
@paramin user_data User data to be passed to the given event callback function
@return This is reserved
@see cbhm_item_selected_callback_add()
@brief Called when the connection is accepted or rejected.
@since_tizen 6.5
@paramin service_name The name of service \n
The @a service_name can be used only in the callback. To use outside, make a copy.
@paramin peer_info The Cion peer information handle \n
The @a peer_info can be used only in the callback. To use outside, make a copy.
@paramin result The handle for connection result \n
The @a result can be used only in the callback. To use outside, make a copy.
@paramin user_data The user data
@see cion_client_add_connection_result_cb()
@see #cion_peer_info_h
@see #cion_connection_result_h
@brief Called when the connection is disconnected.
@since_tizen 6.5
@paramin service_name The name of service \n
The @a service_name can be used only in the callback. To use outside, make a copy.
@paramin peer_info The cion peer information handle \n
The @a peer_info can be used only in the callback. To use outside, make a copy.
@paramin user_data The user data
@see cion_client_add_disconnected_cb()
@see #cion_peer_info_h
@brief Called after sending payload asynchronously.
@since_tizen 6.5
@paramin result The result of sending payload \n
The @a result can be used only in the callback. To use outside, make a copy.
@paramin user_data The user data
@see cion_client_send_payload_async()
@see #cion_payload_async_result_h
@brief Called when the payload is received.
@since_tizen 6.5
@paramin service_name The name of service \n
The @a service_name is the name of connected service that sent the payload.
The @a service_name can be used only in the callback. To use outside, make a copy.
@paramin peer_info The Cion peer information handle \n
The @a peer_info can be used only in the callback. To use outside, make a copy.
@paramin payload The received payload \n
The @a payload can be used only in the callback. \n
The @a payload should not be released.
@paramin status The status of transfer
@paramin user_data The user data
@see cion_client_add_payload_received_cb()
@see #cion_peer_info_h
@see #cion_payload_h
@see #cion_payload_transfer_status_e
@brief Called when the server is discovered.
@since_tizen 6.5
@paramin service_name The name of service \n
The @a service_name can be used only in the callback. To use outside, make a copy.
@paramin peer_info The Cion peer information handle \n
The @a peer_info can be used only in the callback. To use outside, make a copy.
@paramin user_data The user data
@see cion_client_try_discovery()
@see #cion_peer_info_h
@brief Called when a peer joins a topic.
@since_tizen 6.5
@paramin topic_name The name of topic \n
The @a topic_name can be used only in the callback. To use outside, make a copy.
@paramin peer_info The Cion peer information handle \n
The @a peer_info can be used only in the callback. To use outside, make a copy.
@paramin user_data The user data
@see cion_group_add_joined_cb()
@see #cion_peer_info_h
@brief Called when a peer leaves a topic.
@since_tizen 6.5
@paramin topic_name The name of topic \n
The @a topic_name can be used only in the callback. To use outside, make a copy.
@paramin peer_info The Cion peer information handle \n
The @a peer_info can be used only in the callback. To use outside, make a copy.
@paramin user_data The user data
@see cion_group_add_left_cb()
@see #cion_peer_info_h
@brief Called when the payload is received.
@since_tizen 6.5
@paramin topic_name The name of topic \n
The @a topic_name can be used only in the callback. To use outside, make a copy.
@paramin peer_info The Cion peer information handle \n
The @a peer_info can be used only in the callback. To use outside, make a copy.
@paramin payload The received payload \n
The @a payload can be used only in the callback. \n
The @a payload should not be released.
@paramin user_data The user data
@see cion_group_add_payload_received_cb()
@see #cion_peer_info_h
@see #cion_payload_h
@brief Called to get the connected peer information.
@since_tizen 6.5
@paramin peer_info The Cion peer information handle \n
The @a peer_info can be used only in the callback. To use outside, make a copy.
@paramin user_data The user data
@return @c true to continue with the next iteration of the loop, otherwise @c false to break out of the loop.
@see cion_server_foreach_connected_peer_info()
@see #cion_peer_info_h
@brief Called when a connection is requested.
@since_tizen 6.5
@paramin service_name The name of service \n
The @a service_name can be used only in the callback. To use outside, make a copy.
@paramin peer_info The Cion peer information handle \n
The @a peer_info can be used only in the callback. To use outside, make a copy.
@paramin user_data The user data
@see cion_server_listen()
@see #cion_peer_info_h
@brief Called when the connection is accepted or rejected.
@since_tizen 6.5
@paramin service_name The name of service \n
The @a service_name can be used only in the callback. To use outside, make a copy.
@paramin peer_info The Cion peer information handle \n
The @a peer_info can be used only in the callback. To use outside, make a copy.
@paramin result The handle for connection result \n
The @a result can be used only in the callback. To use outside, make a copy.
@paramin user_data The user data
@see cion_server_add_connection_result_cb()
@see #cion_peer_info_h
@see #cion_connection_result_h
@brief Called when data is received.
@since_tizen 6.5
@remarks The server should return reply by setting @a return_data and @a return_data_size.
@paramin service_name The name of service \n
The @a service_name can be used only in the callback. To use outside, make a copy.
@paramin peer_info The Cion peer information handle \n
The @a peer_info can be used only in the callback. To use outside, make a copy.
@paramin data The data \n
The @a peer_info can be used only in the callback. To use outside, make a copy.
@paramin data_size The size of data
@paramout return_data The data to return
@paramout return_data_size The size of return data
@paramin user_data The user data
@see cion_server_set_data_received_cb()
@see #cion_peer_info_h
@brief Called when a peer disconnects.
@since_tizen 6.5
@paramin service_name The name of service \n
The @a service_name can be used only in the callback. To use outside, make a copy.
@paramin peer_info The Cion peer information handle \n
The @a peer_info can be used only in the callback. To use outside, make a copy.
@paramin user_data The user data
@see cion_server_add_disconnected_cb()
@see #cion_peer_info_h
@brief Called after sending payload asynchronously.
@since_tizen 6.5
@paramin result The result of sending payload \n
The @a result can be used only in the callback. To use outside, make a copy.
@paramin user_data The user data
@see cion_server_send_payload_async()
@see #cion_payload_async_result_h
@brief Called when payload is received.
@since_tizen 6.5
@paramin service_name The name of service \n
The @a service_name can be used only in the callback. To use outside, make a copy.
@paramin peer_info The Cion peer information handle \n
The @a peer_info can be used only in the callback. To use outside, make a copy.
@paramin payload The received payload \n
The @a payload can be used only in the callback. \n
The @a payload should not be released.
@paramin status The status of transfer
@paramin user_data The user data
@see cion_server_add_payload_received_cb()
@see #cion_peer_info_h
@see #cion_payload_h
@see #cion_payload_transfer_status_e
@brief Algorithm parameter list handle.
@since_tizen 3.0
@remarks Each parameter list must have at least one CKMC_PARAM_ALGO_TYPE parameter that identifies the algorithm.
See #ckmc_algo_type_e for available algorithms and additional parameters they support.
@see ckmc_generate_new_params()
@see ckmc_param_list_new()
@see ckmc_param_list_set_integer()
@see ckmc_param_list_set_buffer()
@see ckmc_param_list_get_integer()
@see ckmc_param_list_get_buffer()
@see ckmc_param_list_free()
@see #ckmc_algo_type_e
@see #ckmc_param_name_e
@brief Called when the address is changed.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@remarks @a ipv4_address @a ipv6_address should not be freed.
@a ipv4_address @a ipv6_address is available only in the callback.
To use outside the callback, make a copy.
@paramin ipv4_address The IP address for IPv4
@paramin ipv6_address The IP address for IPv6
@paramin user_data The user data passed from the callback registration function
@see connection_set_ip_address_changed_cb()
@see connection_unset_ip_address_changed_cb()
@see connection_set_proxy_address_changed_cb()
@see connection_unset_proxy_address_changed_cb()
@brief Called after connection_close_profile() is finished.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin result The result
@paramin user_data The user data passed from connection_close_profile()
@pre connection_close_profile() will invoke this callback function.
@see connection_close_profile()
@deprecated Deprecated since 4.0. Use connection_ethernet_cable_state_changed_cb() instead.
@brief Called when ethernet cable is plugged in/out.
@since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
@paramin state The state of ethernet cable
@paramin user_data The user data passed to callback registration function
@brief Called when ethernet cable is plugged in/out.
@since_tizen 4.0
@paramin state The state of ethernet cable
@paramin user_data The user data passed to callback registration function
@brief Called when the Internet state of the current connection is changed.
@since_tizen 5.5
@paramin state The Internet state of current connection
@paramin user_data The user data passed to callback registration function
@brief Called with an IPv6 address.
@since_tizen 4.0
@remarks If @a ipv6_address is needed outside the callback, a copy should be made. \n
@a ipv6_address will be freed automatically after the execution of this callback.
@paramin ipv6_address The IPv6 address
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, \n
@c false to break out of the loop
@pre connection_foreach_ipv6_address() will invoke this callback.
@see connection_foreach_ipv6_address()
@brief Called after connection_open_profile() is finished.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin result The result
@paramin user_data The user data passed from connection_open_profile()
@pre connection_open_profile() will invoke this callback function.
@see connection_open_profile()
@brief Called when the state of the profile is changed.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin state The state
@paramin user_data The user data passed from the callback registration function
@see connection_profile_set_state_changed_cb()
@see connection_profile_unset_state_changed_cb()
@brief Called after connection_reset_profile() is finished.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin result The result
@paramin user_data The user data passed from connection_reset_profile()
@pre connection_reset_profile() will invoke this callback function.
@see connection_reset_profile()
@brief Called when connection_set_default_cellular_service_profile_async() finishes.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin result The result
@paramin user_data The user data passed from connection_open_profile()
@pre connection_set_default_cellular_service_profile_async() will invoke this callback function.
@see connection_set_default_cellular_service_profile_async()
@brief Called when the state of the connection is changed.
@since_tizen 5.0
@paramin state The state
@paramin user_data The user data passed from the callback registration function
@see inm_connection_set_state_changed_cb()
@see inm_connection_unset_state_changed_cb()
@brief Called when the type of a connection is changed.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin type The type of the current network connection
@paramin user_data The user data passed from the callback registration function
@see connection_set_type_changed_cb()
@see connection_unset_type_changed_cb()
@brief Called when the designated view changes.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif
@paramin view_uri The view URI
@paramin user_data The user data passed from the callback registration function
@pre The callback must be registered using contacts_db_add_changed_cb().
@see contacts_db_add_changed_cb()
@brief Called when contacts-service server status changes.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif
@paramin status The current status of server
@paramin user_data The user data passed from the callback registration function
@pre This function requires an open connection to contacts service by contacts_connect().
@see contacts_db_add_status_changed_cb()
@brief Called when a designated view changes.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif
@paramin name_display_order The name display order setting value
@paramin user_data The user data passed from the callback registration function
@pre The callback must be registered using contacts_setting_add_name_display_order_changed_cb().
contacts_setting_set_name_display_order() must be called to invoke this callback.
@see contacts_setting_add_name_display_order_changed_cb()
@see contacts_setting_remove_name_display_order_changed_cb()
@brief Called when a designated view changes.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif
@paramin name_sorting_order The name sorting order setting value
@paramin user_data The user data passed from the callback registration function
@pre The callback must be registered using contacts_setting_add_name_sorting_order_changed_cb().
contacts_setting_set_name_sorting_order() must be called to invoke this callback.
@see contacts_setting_add_name_sorting_order_changed_cb()
@see contacts_setting_remove_name_sorting_order_changed_cb()
@brief Called whenever a contact is imported.
@since_tizen 3.0
@paramin total The number of contacts that will be imported
@paramin imported_cnt The number of already imported contacts
@paramin user_data The user data passed from the callback registration function
@return @c true to continue with the import of contacts
otherwise @c false to stop the import of contacts
@pre contacts_sim_import_all_contacts_by_sim_slot_no() will invoke this callback.
@see contacts_sim_import_all_contacts_by_sim_slot_no()
@brief Called to get a record handle of @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_contact.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif
@paramin record The record handle
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop,
otherwise @c false to break out of the loop
@pre contacts_vcard_parse_to_contact_foreach() will invoke this callback.
@see contacts_vcard_parse_to_contact_foreach()
@partner
@brief Called when scanning is cancelled by csr_cs_cancel_scanning().
@since_tizen 3.0
@remarks Only for asynchronous scan functions.
@remarks Called only once at the end of scanning by being cancelled.
@paramin user_data A pointer of a user data. It's provided by client when calling asynchronous scanning method
@see csr_cs_set_cancelled_cb()
@see csr_cs_cancel_scanning()
@see csr_cs_scan_files_async()
@see csr_cs_scan_dir_async()
@see csr_cs_scan_dirs_async()
@partner
@brief Called when scanning is finished successfully.
@since_tizen 3.0
@remarks Only for asynchronous scan functions.
@remarks Called only once at the end of scanning when success.
@paramin user_data A pointer of a user data. It's provided by client when calling asynchronous scanning method
@see csr_cs_set_completed_cb()
@see csr_cs_scan_files_async()
@see csr_cs_scan_dir_async()
@see csr_cs_scan_dirs_async()
@partner
@brief Called when each file scanning is done with malware.
@since_tizen 3.0
@remarks Only for asynchronous scan functions.
@remarks Called for each file or application which is detected malware.
@remarks @a malware will be released when a context is released using csr_cs_context_destroy().
@paramin malware The detected malware handle
@paramin user_data A pointer of a user data. It's provided by client when calling asynchronous scanning method
@see csr_cs_set_detected_cb()
@see csr_cs_scan_files_async()
@see csr_cs_scan_dir_async()
@see csr_cs_scan_dirs_async()
@partner
@brief Called when scanning is stopped with an error.
@details The following error codes can be delivered.\n
#CSR_ERROR_FILE_DO_NOT_EXIST,\n
#CSR_ERROR_SOCKET,\n
#CSR_ERROR_SERVER,\n
#CSR_ERROR_ENGINE_NOT_EXIST,\n
#CSR_ERROR_ENGINE_DISABLED,\n
#CSR_ERROR_ENGINE_NOT_ACTIVATED,\n
#CSR_ERROR_ENGINE_PERMISSION,\n
#CSR_ERROR_ENGINE_INTERNAL
@since_tizen 3.0
@remarks Only for asynchronous scan functions.
@remarks Called only once at the end of scanning when failed with error.
@paramin error_code Error code of #csr_error_e defined in csr-error.h
@paramin user_data A pointer of a user data. It's provided by client when calling asynchronous scanning method
@see csr_cs_set_error_cb()
@see csr_cs_scan_files_async()
@see csr_cs_scan_dir_async()
@see csr_cs_scan_dirs_async()
@partner
@brief Called when each file scanning is done without malware.
@since_tizen 3.0
@remarks Only for asynchronous scan functions.
@remarks Called for each file or application which is not detected malware.
@paramin file_path A path of the file scanned. It would be package path if it's in application
@paramin user_data A pointer of a user data. It's provided by client when calling asynchronous scanning method
@see csr_cs_set_file_scanned_cb()
@see csr_cs_scan_files_async()
@see csr_cs_scan_dir_async()
@see csr_cs_scan_dirs_async()
@brief Called when the consumer receives the result of the data change callback adding operation.
@details The following error codes can be delivered: \n
#DATA_CONTROL_ERROR_NONE, \n
#DATA_CONTROL_ERROR_OUT_OF_MEMORY, \n
#DATA_CONTROL_ERROR_IO_ERROR, \n
#DATA_CONTROL_ERROR_PERMISSION_DENIED, \n
#DATA_CONTROL_ERROR_MAX_EXCEEDED
@since_tizen 3.0
@remarks #DATA_CONTROL_ERROR_PERMISSION_DENIED will be returned when the provider denies to add the callback.
@paramin provider The provider handle. @a provider is valid only inside this function \n
@a provider should not be destroyed.
@paramin result Add data change callback result
@paramin callback_id Added callback ID
@paramin user_data The user data passed from the add function
@pre The callback must be registered using data_control_add_data_change_cb().
@see data_control_add_data_change_cb()
@brief Called when received data changed notification from provider application.
@since_tizen 3.0
@paramin provider The provider handle. @a provider is valid only inside this function \n
@a provider should not be destroyed.
@paramin type Changed data type
@paramin data Data from provider, intended to contain information about changed data \n
@a data is valid only inside this function \n
To use outside the callback, make a copy. @a data should not be freed
@paramin user_data The user data passed from the add function
@pre The callback must be registered using data_control_add_data_change_cb(). \n
data_control_provider_send_data_change_noti() must be called to invoke this callback.
@see data_control_add_data_change_cb()
@see data_control_provider_send_data_change_noti()
@brief Called when the result value list is received from the key-value structured data control provider.
@since_tizen 2.3
@remarks You must release @a result_value_list using free() after it is used. Note that @a result_value_list is an array of char *. Its length is @a result_value_count. You should release all the elements in the @a result_value_list array and @a result_value_list itself like the following code.
@brief Called when a consumer requests a data change callback addition.
@details The callback decides - through the return value - whether a consumer application should be allowed to add a data change callback. \n
If it returns true, it means the application should be allowed to do so, if it returns false, it means it should be denied.
@brief Called when a response is received for a delete operation from an application using the SQL-friendly interface based data control.
@since_tizen 2.3
@brief Called when a response is received for an insert operation from an application using the SQL-friendly interface based data control.
@since_tizen 2.3
@brief Called when a response is received for a select operation from an application using the SQL-friendly interface based data control.
@since_tizen 2.3
@brief Called when a response is received for an update operation from an application using the SQL-friendly interface based data control.
@since_tizen 2.3
@brief Called when a device status is changed.
@details Each device callback has a different output param type. \n
So you need to check below output param before using this function. \n
callback enum output type \n
DEVICE_CALLBACK_BATTERY_CAPACITY int \n
DEVICE_CALLBACK_BATTERY_LEVEL int \n
DEVICE_CALLBACK_BATTERY_CHARGING bool \n
DEVICE_CALLBACK_DISPLAY_STATE int \n
DEVICE_CALLBACK_FLASH_BRIGHTNESS int
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@remarks DEVICE_CALLBACK_FLASH_BRIGHTNESS callback invoked when user set flash brightness by using device_flash_set_brightness(). It does not work by camera flash operation. To register DEVICE_CALLBACK_FLASH_BRIGHTNESS callback, you need to declare the LED privilege (%http://tizen.org/privilege/led).
@paramout type The device type to monitor
@paramout value The changed value
@paramout user_data The user data passed from the callback registration function
@brief The device policy manager handle
@details The device policy manager handle is an abstraction of the
logical connection between the device policy manager and
it's client. The device policy manager handle must be
created by using dpm_manager_create() before attempting to
use almost any of the device policy APIs, and it should
be freed when interaction with the device policy manager
is no longer required.
To release the handle, use dpm_manager_destroy().
@since_tizen 3.0
@see dpm_manager_create()
@see dpm_manager_destroy()
@brief Request callback fired when someone requests diagnostics data.
@since_tizen 6.5
@remarks @a data should be released with diagnostics_data_destroy().
@brief Called when a DNSSD service is found.
@details remote_service is valid only when service_state is
#DNSSD_SERVICE_STATE_AVAILABLE or #DNSSD_SERVICE_STATE_UNAVAILABLE.
In case of service_state #DNSSD_SERVICE_STATE_UNAVAILABLE, application
can only use dnssd_service_get_type() and dnssd_service_get_name().
Other get functions can only be used when service_state is
#DNSSD_SERVICE_STATE_AVAILABLE.
@since_tizen 3.0
@paramin service_state The DNSSD service state of remote service
@paramin remote_service The DNSSD remote service handle
@paramin user_data The user data passed from the request function
@see dnssd_start_browsing_service()
@brief Called when the registration of DNSSD service is finished.
@since_tizen 3.0
@paramin result The result of registration.\n
#DNSSD_ERROR_NONE Successful\n
#DNSSD_ERROR_NAME_CONFLICT Name Conflict\n
#DNSSD_ERROR_ALREADY_REGISTERED Already Registered
@paramin local_service The DNSSD local service handle
@paramin user_data The user data passed from the request function
@see dnssd_register_local_service()
@brief Called when a policy is changed.
@since_tizen 3.0
@paramin name The name of the policy
@paramin state The current state of the policy
@paramin user_data The user data passed from dpm_add_policy_changed_cb
@see dpm_add_policy_changed_cb()
@see dpm_remove_policy_changed_cb()
@brief Called when a zone raises a signal.
@since_tizen 3.0
@paramin name The zone name
@paramin object The object name triggered the signal
@paramin user_data The user data passed from dpm_add_signal_cb
@see dpm_add_signal_cb()
@see dpm_remove_signal_cb()
@brief Called to get all the name of created zones.
@since_tizen 3.0
@paramin name The zone name
@paramin user_data The user data passed from dpm_zone_foreach_name()
@return true to continue with the next iteration of the loop, otherwise false to break out out the loop
@see dpm_zone_foreach_name()
@brief Called when the process of sending an email finishes.
@details You can check whether sending an email succeeds using this function.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif
@paramin email The handle to the email message
@paramin result The result of email message sending \n
#EMAIL_SENDING_FAILED or #EMAIL_SENDING_SUCCEEDED
@paramin user_data The user data passed from the callback registration function
@pre email_send_message() will invoke this callback if you register this callback using email_set_message_sent_cb().
@see email_send_message()
@see email_set_message_sent_cb()
@see email_unset_message_sent_cb()
@brief Called when External Output Manager (EOM) module sends output
attribute changing notification.
@since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
@paramin output_id The output id which is connected output
@paramin user_data The pointer of user data which is passed to
eom_attribute_changed_cb() function
@see eom_set_attribute_changed_cb()
@see eom_unset_attribute_changed_cb()
@brief Called when External Output Manager (EOM) module sends output
mode changing notification.
@since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
@paramin output_id The output id which is connected output
@paramin user_data The pointer of user data which is passed to
eom_mode_changed_cb() function
@see eom_set_mode_changed_cb()
@see eom_unset_mode_changed_cb()
@brief Called when External Output Manager (EOM) module sends output
connection notification.
@since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
@paramin output_id The output id which is connected output
@paramin user_data The pointer of user data which is passed to
eom_output_added_cb() function
@see eom_set_output_added_cb()
@see eom_unset_output_added_cb()
@brief Called when External Output Manager (EOM) module sends output
disconnection notification.
@since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
@paramin output_id The output id which is connected output
@paramin user_data The pointer of user data which is passed to
eom_output_removed_cb() function
@see eom_set_output_removed_cb()
@see eom_unset_output_removed_cb()
@ingroup CAPI_CONTENT_MEDIA_FILTER_MODULE
@brief The structure type for the Media filter handle.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@brief Called when the some event occurs in geofence and place such as add, update, etc..
@details The events of public geofence is also received if there are public geofences.
@since_tizen 2.4
@remarks The value of place_id or geofence_id is -1 when the place ID or geofence ID is not assigned.
@paramin place_id The place ID
@paramin geofence_id The specified geofence ID
@paramin error The error code for the particular action
@paramin manage The result code for the particular place and geofence management
@paramin user_data The user data passed from callback registration function
@pre geofence_manager_start() will invoke this callback if you register this callback using geofence_manager_set_geofence_event_cb()
@see geofence_manage_e
@see geofence_manager_start()
@see geofence_manager_set_geofence_event_cb()
@brief Called when the fence list is requested.
@since_tizen 2.4
@paramin geofence_id The geofence ID
@paramin fence The fence handle
@paramin fence_index The index number of the fences in the list
@paramin fence_cnt The total number of fences that exists for the requester
@paramin user_data The user data passed from callback registration function
@return @c true to continue iterating,
otherwise @c false
@pre geofence_manager_foreach_geofence_list() and geofence_manager_foreach_place_geofence_list() will invoke this callback if you specify this callback using geofence_manager_foreach_geofence_list().
@see geofence_manager_foreach_geofence_list()
@see geofence_manager_foreach_place_geofence_list()
@see geofence_manager_add_fence()
@brief Called when the place list is requested.
@since_tizen 2.4
@paramin place_id The current place ID
@paramin place_name The current place name
@paramin place_index The index number of the places in the list
@paramin place_cnt The total number of places that exists for the requester
@paramin user_data The user data passed from callback registration function
@return @c true to continue iterating,
otherwise @c false
@pre geofence_manager_foreach_place_list() will invoke this callback if you specify this callback using geofence_manager_foreach_place_list().
@see geofence_manager_foreach_place_list()
@see geofence_manager_add_place()
@brief Called when a proximity state of device is changed.
@since_tizen 3.0
@paramin geofence_id The specified geofence ID
@paramin state The proximity state
@paramin provider The proximity provider
@paramin user_data The user data passed from callback registration function
@pre geofence_manager_start() will invoke this callback if you register this callback using geofence_manager_set_geofence_proximity_state_changed_cb().
@see geofence_proximity_state_e
@see geofence_proximity_provider_e
@see geofence_manager_start()
@see geofence_manager_set_geofence_proximity_state_changed_cb()
@brief Called when a device enters or exits the given geofence.
@since_tizen 2.4
@paramin geofence_id The specified geofence ID
@paramin state The geofence state
@paramin user_data The user data passed from callback registration function
@pre geofence_manager_start() will invoke this callback if you register this callback using geofence_manager_set_geofence_state_changed_cb().
@see geofence_state_e
@see geofence_manager_start()
@see geofence_manager_set_geofence_state_changed_cb()
@brief Called once for each satellite in range.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin azimuth The azimuth of the satellite (degrees)
@paramin elevation The elevation of the satellite (meters)
@paramin prn The PRN of the satellite
@paramin snr The SNR of the satellite dB
@paramin is_active The flag signaling if satellite is in use
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, \n
@c false to break out of the loop
@pre gps_status_foreach_satellites_in_view() will invoke this callback.
@pre gps_status_foreach_last_satellites_in_view() will invoke this callback.
@see gps_status_foreach_satellites_in_view()
@brief Called at defined interval with updated satellite information.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramout num_of_active The last number of active satellites
@paramout num_of_inview The last number of satellites in view
@paramout timestamp The last timestamp (time when measurement took place or @c 0 if valid)
@paramin user_data The user data passed from the call registration function
@pre location_manager_start() will invoke this callback if you register this callback using location_manager_set_position_updated_cb().
@see location_manager_start()
@see location_manager_set_position_updated_cb()
@brief Called when the HTTP transaction is aborted.
@details Following error codes can be delivered. \n
#HTTP_ERROR_OPERATION_FAILED, \n
#HTTP_ERROR_COULDNT_RESOLVE_HOST, \n
#HTTP_ERROR_COULDNT_CONNECT, \n
#HTTP_ERROR_OPERATION_TIMEDOUT, \n
#HTTP_ERROR_SSL_CONNECT_ERROR.
@since_tizen 3.0
@paramin http_transaction The HTTP transaction handle
@paramin error The error code about aborted reason
@paramin user_data The user data
@see http_transaction_set_aborted_cb()
@brief Called when the HTTP response is received.
@since_tizen 3.0
@paramin http_transaction The HTTP transaction handle
@paramin body Response information of HTTP Transaction
@paramin size Size in bytes of each element to be written
@paramin count Number of elements, each one with a size of size bytes
@paramin user_data The user data
@see http_transaction_set_received_body_cb()
@brief Called when the HTTP transaction is completed.
@since_tizen 3.0
@paramin http_transaction The HTTP transaction handle
@paramin user_data The user data
@see http_transaction_set_completed_cb()
@brief Called when the HTTP header is received.
@since_tizen 3.0
@remarks The @a header should be released using free(). \n
The @a header is available until @a http_transaction is released.
@paramin http_transaction The HTTP transaction handle
@paramin header The header information of HTTP Transaction
@paramin header_len The length of the HTTP Transaction header
@paramin user_data The user data
@see http_transaction_set_received_header_cb()
@brief Called to notify when the content body of the response message is being downloaded or uploaded.
@since_tizen 3.0
@paramin http_transaction The HTTP transaction handle
@paramin download_total The total length of the data (in bytes) to download
@paramin download_now The current length of the downloaded data (in bytes)
@paramin upload_total The total length of the data (in bytes) to upload
@paramin upload_now The current length of the uploaded data (in bytes)
@paramin user_data The user data
@see http_transaction_set_progress_cb()
@brief Called when the HTTP ready to write event is received.
@since_tizen 3.0
@paramin http_transaction The HTTP transaction handle
@paramin recommended_chunk_size Recommended chunk length(bytes) of the HTTP transaction
@paramin user_data The user data
@see http_transaction_set_uploaded_cb()
@ingroup CAPI_CONTENT_MEDIA_IMAGE_META_MODULE
@brief The structure type for the Image metadata handle.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@ingroup CAPI_MEDIA_IMAGE_UTIL_ENCODE_DECODE_MODULE
@deprecated Deprecated since 5.5.
@brief Called when Image-util decoding is finished just before returning the output.
@since_tizen 3.0
@ingroup CAPI_MEDIA_IMAGE_UTIL_ENCODE_DECODE_MODULE
@deprecated Deprecated since 5.5. Use image_util_encode_run_async_to_file() or image_util_encode_run_async_to_buffer() instead.
@brief Called when Image-util encoding is finished just before returning the output.
@since_tizen 3.0
@ingroup CAPI_MEDIA_IMAGE_UTIL_ENCODE_DECODE_MODULE
@brief Called when image encoding is finished just after storing the output to the buffer.
@since_tizen 5.5
@ingroup CAPI_MEDIA_IMAGE_UTIL_ENCODE_DECODE_MODULE
@brief Called when image encoding is finished just after storing the output to the file.
@since_tizen 5.5
@ingroup CAPI_MEDIA_IMAGE_UTIL_TRANSFORM_MODULE
@brief Called when transform is finished just before returning the output.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@brief Called when an associated text input UI control requests the input panel to set the @c Return key label.
The input panel can show text or image on the @c Return button according to the @c Return key action.
@brief Called when the IP is found on a local network.
@since_tizen 5.5
@remarks @a ip should not be freed. @a ip is available only in the callback.
To use outside the callback, make a copy.
@paramin found @c true if IP is found, @c false if ip IP not found
@paramin ip The IP address found on a local network
@paramin user_data The user data passed from the callback registration function
@see inm_arp_request_start()
@see inm_arp_request_stop()
@brief Called when the cellular state is changed.
@since_tizen 5.0
@paramin state The cellular state
@paramin user_data The user data passed from the callback registration function
@see inm_set_cellular_state_changed_cb()
@see inm_unset_cellular_state_changed_cb()
@brief Called when the channel interference is updated.
@since_tizen 5.0
@paramin freq The frequency of wireless network
@paramin channel_intf The current channel interference
@paramin user_data The user data passed from the callback registration function
@see inm_set_channel_interference_cb()
@see inm_unset_channel_interference_cb()
@brief Called when the TCP congestion level is updated.
@since_tizen 5.0
@paramin level The current TCP congestion level
@paramin user_data The user data passed from the callback registration function
@see inm_set_congestion_level_cb()
@see inm_unset_congestion_level_cb()
@brief Called when the DNS lookup result is received.
@since_tizen 5.5
@paramin found @c true if DNS lookup succeeded, @c false
if DNS lookup failed
@paramin user_data The user data passed from the callback registration function
@see inm_default_dns_lookup_check()
@brief Called when the gateway IP is found on a local network
by sending ARP packets.
@since_tizen 5.5
@remarks @a gateway_ip should not be freed. @a gateway_ip is available
only in the callback. To use outside the callback, make a copy.
@paramin found @c true if gateway IP address is found, @c false
if gateway IP address isn't found after timeout
@paramin gateway_ip The gateway IP address found on a local network
@paramin user_data The user data passed from the callback registration function
@see inm_default_gateway_start_checking()
@see inm_default_gateway_stop_checking()
@brief Called when the Ethernet cable state is changed.
@since_tizen 5.0
@paramin state The Ethernet cable state
@paramin user_data The user data passed from the callback registration function
@see inm_set_ethernet_cable_state_changed_cb()
@see inm_unset_ethernet_cable_state_changed_cb()
@brief Called when the ethernet state is changed.
@since_tizen 5.0
@paramin state The ethernet state
@paramin user_data The user data passed from the callback registration function
@see inm_set_ethernet_state_changed_cb()
@see inm_unset_ethernet_state_changed_cb()
@brief Called when the IP conflict state is changed.
@since_tizen 5.0
@remarks @a if_name and @a ip should not be freed. @a if_name and @a ip is available only in the callback. To use
outside the callback, make a copy.
@paramin if_name The destination interface name causing conflict
@paramin ip The local IP address causing conflict
@paramin state The current state
@paramin user_data The user data passed from the callback registration function
@see inm_set_ip_conflict_cb()
@see inm_unset_ip_conflict_cb()
@brief Called with handle of the link address.
@since_tizen 5.5
@remarks If @a address is needed outside the callback, a copy should be
made. @a address will be freed automatically after the execution
of this callback.
@paramin address The link address handle
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, \n
@c false to break out of the loop
@pre inm_link_foreach_address() will invoke this callback.
@see inm_link_foreach_address().
@brief Called with a link handle.
@since_tizen 5.5
@remarks If @a link is needed outside the callback, a copy should be
made. @a link will be freed automatically after the execution
of this callback.
@paramin link The link handle
@paramin user_data The user data passed from foreach function
@return @c true to continue with the next iteration of the loop,
@c false to break out of the loop
@see inm_foreach_link()
@see inm_link_clone()
@brief Called with handle of the link route table.
@since_tizen 5.0
@remarks If @a route is needed outside the callback, a copy should be
made. @a route will be freed automatically after the execution
of this callback.
@paramin route The link route handle
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, \n
@c false to break out of the loop
@pre inm_link_foreach_route() will invoke this callback.
@see inm_link_foreach_route().
@brief Called when the URL responds to HTTP GET generated by curl.
@since_tizen 5.5
@remarks @a url should not be freed. @a url is available only in the callback.
To use outside the callback, make a copy.
@paramin result The enumeration value to describe the result.
@paramin url The URL responses to HTTP GET generated by curl
@paramin user_data The user data passed from the callback registration function
@see inm_reachable_urls_start_checking()
@see inm_reachable_urls_stop_checking()
@see inm_reachable_urls_is_check_running()
@brief Called when the retry TX rate is updated.
@since_tizen 5.0
@paramin rate The current TCP TX retry rate
@paramin user_data The user data passed from the callback registration function
@see inm_set_retry_tx_rate_cb()
@see inm_unset_retry_tx_rate_cb()
@brief Called with VSIE data and length of VSIE.
@since_tizen 5.0
@remarks If @a vsie is needed outside the callback, a copy should be
made. @a vsie will be freed automatically after the execution
of this callback.
@paramin vsie The vendor specific data
@paramin length The length of vendor specific data
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, \n
@c false to break out of the loop
@pre inm_wifi_ap_foreach_vsie() will invoke this callback.
@see inm_wifi_ap_foreach_vsie().
@brief Called for each found access point.
@since_tizen 5.0
@remarks @a ap should not be freed. @a ap is valid only in this function.
In order to use @a ap outside this function, you must copy the ap with inm_connection_clone().
@paramin ap The access point handle
@paramin user_data The user data passed from the request function
@return @c true to continue with the next iteration of the loop, \n
otherwise @c false to break out of the loop
@pre inm_wifi_foreach_found_ap() will invoke this callback.
@see inm_wifi_foreach_found_ap()
@brief Called when the Wi-Fi Module state is changed.
@since_tizen 5.0
@paramin state The Wi-Fi Module state
@paramin user_data The user data passed from the callback registration function
@see inm_set_wifi_module_state_changed_cb()
@see inm_unset_wifi_module_state_changed_cb()
@brief Called when the scanning state is changed.
@since_tizen 5.0
@paramin state The wifi scanning state
@paramin user_data The user data passed from the callback registration function
@see inm_wifi_set_scan_state_changed_cb()
@see inm_wifi_unset_scan_state_changed_cb()
@brief Called when the Wi-Fi state is changed.
@since_tizen 5.0
@paramin state The Wi-Fi state
@paramin user_data The user data passed from the callback registration function
@see inm_set_wifi_state_changed_cb()
@see inm_unset_wifi_state_changed_cb()
@brief Specifies the type of function passed to iotcon_attributes_foreach().
@since_tizen 3.0
@paramin attributes The attributes handle
@paramin key The key
@paramin user_data The user data to pass to the function
@return @c true to continue with the next iteration of the loop,
otherwise @c false to break out of the loop
#IOTCON_FUNC_CONTINUE and #IOTCON_FUNC_STOP are more friendly values for the return
@pre iotcon_attributes_foreach() will invoke this callback function.
@see iotcon_attributes_foreach()
@brief The attributes handle.
@details @a iotcon_attributes_h is an opaque data structure to have attribute value map.
Attribute value map consists of a key and a value.
Datatype of the key is string and the value should be one of them #IOTCON_TYPE_INT,
#IOTCON_TYPE_BOOL, #IOTCON_TYPE_DOUBLE, #IOTCON_TYPE_STR, #IOTCON_TYPE_NULL,
#IOTCON_TYPE_LIST and #IOTCON_TYPE_ATTRIBUTES.
@since_tizen 3.0
@brief Specifies the type of function passed to iotcon_representation_foreach_children().
@since_tizen 3.0
@paramin child The child Representation handle
@paramin user_data The user data to pass to the function
@return @c true to continue with the next iteration of the loop,
otherwise @c false to break out of the loop
#IOTCON_FUNC_CONTINUE and #IOTCON_FUNC_STOP are more friendly values for the return
@pre iotcon_representation_foreach_children() will invoke this callback function.
@see iotcon_representation_foreach_children()
@brief Specifies the type of function passed to iotcon_find_device_info().
@details The @a result could be one of #iotcon_error_e.
@since_tizen 3.0
@paramin device_info The device information from remote server
@paramin result The result code (@c 0 on success, otherwise a negative error value)
@paramin user_data The user data to pass to the function
@return @c true to continue to find device information,
otherwise @c false to stop \n
#IOTCON_FUNC_CONTINUE and #IOTCON_FUNC_STOP are more friendly values for the return
@pre iotcon_find_device_info() will invoke this callback function.
@see iotcon_find_device_info()
@see iotcon_device_info_get_property()
@brief Specifies the type of function passed to iotcon_find_resource().
@details Called when a resource is found from the remote server. \n
The @a resource completes its life cycle in the function.
If you want to send requests(GET, PUT, POST, DELETE, and OBSERVE) on the @a resource,
you must clone the @a resource using iotcon_remote_resource_clone(). \n
The @a result could be one of #iotcon_error_e.
@since_tizen 3.0
@paramin resource The handle of resource which is found
@paramin result The result code (Lesser than 0 on fail, otherwise a response result value)
@paramin user_data The user data to pass to the function
@return @c true to continue to find resource,
otherwise @c false to stop \n
#IOTCON_FUNC_CONTINUE and #IOTCON_FUNC_STOP are more friendly values for the return
@pre The callback must be registered using iotcon_find_resource()
@see iotcon_find_resource()
@brief Specifies the type of function passed to iotcon_add_generated_pin_cb().
@details When a provisioning tool calls the function for registering this device, it is called, immediately.
@since_tizen 3.0
@paramin pin The pin number which is generated automatically
@paramin user_data The user data to pass to the function
@pre The callback must be registered using iotcon_add_generated_pin_cb()
@see iotcon_add_generated_pin_cb()
@see iotcon_remove_generated_pin_cb()
@brief Specifies the type of function passed to iotcon_list_foreach_attributes().
@since_tizen 3.0
@paramin pos The number of the attributes value (0 being the first)
@paramin value The attributes value
@paramin user_data The user data to pass to the function
@return @c true to continue with the next iteration of the loop,
otherwise @c false to break out of the loop
#IOTCON_FUNC_CONTINUE and #IOTCON_FUNC_STOP are more friendly values for the return
@pre iotcon_list_foreach_attributes() will invoke this callback function.
@see iotcon_list_foreach_attributes()
@brief Specifies the type of function passed to iotcon_list_foreach_bool().
@since_tizen 3.0
@paramin pos The number of the boolean value (0 being the first)
@paramin value The boolean value
@paramin user_data The user data to pass to the function
@return @c true to continue with the next iteration of the loop,
otherwise @c false to break out of the loop
#IOTCON_FUNC_CONTINUE and #IOTCON_FUNC_STOP are more friendly values for the return
@pre iotcon_list_foreach_bool() will invoke this callback function.
@see iotcon_list_foreach_bool()
@brief Specifies the type of function passed to iotcon_list_foreach_byte_str().
@since_tizen 3.0
@paramin pos The number of the string value (0 being the first)
@paramin value The byte string value
@paramin len The length of @a value
@paramin user_data The user data to pass to the function
@return @c true to continue with the next iteration of the loop,
otherwise @c false to break out of the loop
#IOTCON_FUNC_CONTINUE and #IOTCON_FUNC_STOP are more friendly values for the return
@pre iotcon_list_foreach_byte_str() will invoke this callback function.
@see iotcon_list_foreach_byte_str()
@brief Specifies the type of function passed to iotcon_list_foreach_double().
@since_tizen 3.0
@paramin pos The number of the double value (0 being the first)
@paramin value The double value
@paramin user_data The user data to pass to the function
@return @c true to continue with the next iteration of the loop,
otherwise @c false to break out of the loop
#IOTCON_FUNC_CONTINUE and #IOTCON_FUNC_STOP are more friendly values for the return
@pre iotcon_list_foreach_double() will invoke this callback function.
@see iotcon_list_foreach_double()
@brief Specifies the type of function passed to iotcon_list_foreach_int().
@since_tizen 3.0
@paramin pos The number of the integer value (0 being the first)
@paramin value The integer value
@paramin user_data The user data to pass to the function
@return @c true to continue with the next iteration of the loop,
otherwise @c false to break out of the loop
#IOTCON_FUNC_CONTINUE and #IOTCON_FUNC_STOP are more friendly values for the return
@pre iotcon_list_foreach_int() will invoke this callback function.
@see iotcon_list_foreach_int()
@brief Specifies the type of function passed to iotcon_list_foreach_list().
@since_tizen 3.0
@paramin pos The number of the list value (0 being the first)
@paramin value The list value
@paramin user_data The user data to pass to the function
@return @c true to continue with the next iteration of the loop,
otherwise @c false to break out of the loop
#IOTCON_FUNC_CONTINUE and #IOTCON_FUNC_STOP are more friendly values for the return
@pre iotcon_list_foreach_list() will invoke this callback function.
@see iotcon_list_foreach_list()
@brief Specifies the type of function passed to iotcon_list_foreach_str().
@since_tizen 3.0
@paramin pos The number of the string value (0 being the first)
@paramin value The string value
@paramin user_data The user data to pass to the function
@return @c true to continue with the next iteration of the loop,
otherwise @c false to break out of the loop
#IOTCON_FUNC_CONTINUE and #IOTCON_FUNC_STOP are more friendly values for the return
@pre iotcon_list_foreach_str() will invoke this callback function.
@see iotcon_list_foreach_str()
@brief The lite resource handle.
@details @a iotcon_lite_resource_h is an opaque data structure to represent registered resource by server.
A resource has host_address, uri_path, resource types, and internal handle.
If observable attribute of resource is true, client can observe this resource.
@since_tizen 3.0
@brief Specifies the type of function passed to iotcon_lite_resource_create().
@since_tizen 3.0
@paramin resource The handle of the lite resource
@paramin attributes The attributes of the lite resource
@paramin user_data The user data to pass to the function
@return @c true to accept post request,
otherwise @c false to reject it
@pre The callback must be registered using iotcon_lite_resource_create().
@see iotcon_lite_resource_create()
@brief Specifies the type of function passed to iotcon_options_foreach().
@since_tizen 3.0
@paramin id The information of the option
@paramin data The data of the option
@paramin user_data The user data to pass to the function
@return @c true to continue with the next iteration of the loop,
otherwise @c false to break out of the loop
#IOTCON_FUNC_CONTINUE and #IOTCON_FUNC_STOP are more friendly values for the return
@pre iotcon_options_foreach() will invoke this callback function.
@see iotcon_options_foreach()
@brief The options handle.
@details @a iotcon_options_h is an opaque data structure to have attribute value map which consists of a key and a value.
Datatype of key is an integer and value is string.
@since_tizen 3.0
@brief Specifies the type of function passed to iotcon_find_platform_info().
@details The @a result could be one of #iotcon_error_e.
@since_tizen 3.0
@paramin platform_info The platform information from remote server
@paramin result The result code (@c 0 on success, otherwise a negative error value)
@paramin user_data The user data to pass to the function
@return @c true to continue to find platform information,
otherwise @c false to stop \n
#IOTCON_FUNC_CONTINUE and #IOTCON_FUNC_STOP are more friendly values for the return
@pre iotcon_find_platform_info() will invoke this callback function.
@see iotcon_find_platform_info()
@see iotcon_platform_info_get_property()
@brief Specifies the type of function passed to iotcon_add_presence_cb().
@details Called when client receives presence events from the server.
The @a response handle contains presence information.
@since_tizen 3.0
@paramin presence The presence handle
@paramin err The error code(@c 0 on success, otherwise a negative error value)
@paramin response The presence response handle
@paramin user_data The user data to pass to the function
@pre The callback must be registered using iotcon_add_presence_cb().
@see iotcon_add_presence_cb()
@see iotcon_remove_presence_cb()
@see iotcon_presence_response_get_connectivity_type()
@see iotcon_presence_response_get_host_address()
@see iotcon_presence_response_get_resource_type()
@see iotcon_presence_response_get_result()
@see iotcon_presence_response_get_trigger()
@brief The presence response handle.
@details @a iotcon_presence_response_h is a handle of presence response subscription. \n
It is used to get the information of presence response from server.
@since_tizen 3.0
@brief Specifies the type of function passed to iotcon_query_foreach().
@since_tizen 3.0
@paramin key The key of the query
@paramin value The value of the query
@paramin user_data The user data to pass to the function
@return @c true to continue with the next iteration of the loop,
otherwise @c false to break out of the loop
#IOTCON_FUNC_CONTINUE and #IOTCON_FUNC_STOP are more friendly values for the return
@pre iotcon_query_foreach() will invoke this callback function.
@see iotcon_query_foreach()
@brief The query handle.
@details @a iotcon_query_h is an opaque data structure to have attribute value map which consists of key and value.
Datatype of both key and value are string.
@a iotcon_query_h also have length.
The length is total length of all keys and values of map.
The length should be less than or equal to 64.
@since_tizen 3.0
@brief Specifies the type of function passed to iotcon_remote_resource_start_caching().
@since_tizen 3.0
@paramin resource The handle of the remote resource
@paramin representation The handle of the representation
@paramin user_data The user data to pass to the function
@pre The callback must be registered using iotcon_remote_resource_start_caching()
@see iotcon_remote_resource_start_caching()
@see iotcon_remote_resource_stop_caching()
@brief The remote resource handle.
@details When Client is successful to find out resource from remote server, server's resource information is reorganized as @a iotcon_remote_resource_h by IoTCon.
Client can request CRUD to server by using this.
@a iotcon_remote_resource_h is an opaque data structure to have host_address, uri_path, resource types, interfaces, options and device id.
If observable attribute is true, remote resource is observable.
When you observe remote resource, observe_handle will be set.
@since_tizen 3.0
@brief Specifies the type of observe callback passed to iotcon_remote_resource_observe_register().
The @a err could be one of #iotcon_error_e. \n
The @a response is created by a server. Therefore, you can't get any values that the server didn't set.
@since_tizen 3.0
@paramin resource The handle of the remote resource
@paramin err The error code
@paramin sequence_number The sequence number of observe
@paramin response The handle of the response
@paramin user_data The user data passed from the callback registration function
@pre The callback must be registered using iotcon_remote_resource_observe_register()
@see iotcon_remote_resource_observe_register()
@see iotcon_remote_resource_observe_deregister()
@see iotcon_resource_notify()
@brief Specifies the type of response function.
@details The function passed to iotcon_remote_resource_get(), iotcon_remote_resource_put(),
iotcon_remote_resource_post(), iotcon_remote_resource_delete().\n
The @a err could be one of #iotcon_error_e.\n
The @a request_type could be one of #iotcon_request_type_e.\n
The @a response is created by a server. Therefore, you can't get any values that the server didn't set.
@since_tizen 3.0
@paramin resource The handle of the resource
@paramin err The error code
@paramin request_type The request type
@paramin response The handle of the response
@paramin user_data The user data passed from the callback registration function
@pre The callback must be registered using iotcon_remote_resource_get(), iotcon_remote_resource_put(), iotcon_remote_resource_post(), iotcon_remote_resource_delete().
@see iotcon_remote_resource_get()
@see iotcon_remote_resource_put()
@see iotcon_remote_resource_post()
@see iotcon_remote_resource_delete()
@brief Specifies the type of function passed to iotcon_remote_resource_start_monitoring().
@since_tizen 3.0
@paramin resource The handle of the remote resource
@paramin state The state of the remote resource
@paramin user_data The user data to pass to the function
@pre The callback must be registered using iotcon_remote_resource_start_monitoring()
@see iotcon_remote_resource_start_monitoring()
@see iotcon_remote_resource_stop_monitoring()
@brief The representation handle.
@details @a iotcon_representation_h is an opaque data structure to have uri_path, list of resource types and interfaces.
It could contain other representation as children.
@since_tizen 3.0
@brief The request handle.
@details @a iotcon_request_h is an opaque data structure to request to a particular resource.
@a iotcon_request_h is a data type of client's request which consists of header options, query, representation.
@since_tizen 3.0
@brief Specifies the type of function passed to iotcon_resource_create() and iotcon_resource_set_request_handler().
@details Called when server receives request from the client.
@since_tizen 3.0
@paramin resource The resource requested
@paramin request The request from client
@paramin user_data The user data to pass to the function
@pre The callback must be registered using iotcon_resource_create()
@see iotcon_resource_create()
@see iotcon_resource_set_request_handler()
@brief The resource handle.
@details @a iotcon_resource_h is an opaque data structure to represent registered resource by server.
A resource has host_address, uri_path, resource types, interfaces and internal handle.
If observable attribute of resource is true, client can observe this resource.
When client requests by CRUD functions, handler will be invoked if registered.
It could contain other resource as children.
@since_tizen 3.0
@brief Specifies the iface of function passed to iotcon_resource_interfaces_foreach().
@since_tizen 3.0
@remarks @a iface could be a value such as #IOTCON_INTERFACE_DEFAULT.
@paramin iface The value of the resource ifaces
@paramin user_data The user data to pass to the function
@return @c true to continue with the next iteration of the loop,
otherwise @c false to break out of the loop
#IOTCON_FUNC_CONTINUE and #IOTCON_FUNC_STOP are more friendly values for the return
@pre iotcon_resource_interfaces_foreach() will invoke this callback function.
@see iotcon_resource_interfaces_foreach()
@brief The resource interface handle.
@details @a iotcon_resource_interfaces_h is an opaque data structure to have list of resource interfaces. A resource interface is datatype of string.
@since_tizen 3.0
@brief Specifies the type of function passed to iotcon_resource_types_foreach().
@since_tizen 3.0
@paramin type The value of the resource types
@paramin user_data The user data to pass to the function
@return @c true to continue with the next iteration of the loop,
otherwise @c false to break out of the loop
#IOTCON_FUNC_CONTINUE and #IOTCON_FUNC_STOP are more friendly values for the return
@pre iotcon_resource_types_foreach() will invoke this callback function.
@see iotcon_resource_types_foreach()
@brief The resource types handle.
@details @a iotcon_resource_types_h is an opaque data structure to have list of resource types. A resource type is datatype of string.
@since_tizen 3.0
@brief The response handle.
@details @a iotcon_response_h is an opaque data structure to respond to client.
@a iotcon_response_h is a data type of server's response which consists of result, header options, query, representation.
@since_tizen 3.0
@brief Called to retrieve the job information.
@since_tizen 4.0
@remarks The @a job_info must not be deallocated by the application.
@paramin job_info The job_info handle
@paramin user_data The user data passed from the foreach function
@return @c true continue with the next iteration of the loop,
otherwise @c false to break out of the loop
@pre job_scheduler_foreach_job() will invoke this callback.
@see job_scheduler_foreach_job()
@brief Called when the job starts.
@since_tizen 4.0
@remarks The @a job_info MUST NOT be deallocated by the application.
The @a job_info is managed by the platform and is valid only in the callback.
@paramin job_info The job info handle
@paramin user_data The user data passed from the callback registration function
@see job_scheduler_service_add()
@see #job_service_callback_s
@brief Called when the job stops.
@since_tizen 4.0
@remarks The @a job_info MUST not be deallocated by the application.
The @a job_info is managed by the platform and is valid only in the callback.
@paramin job_info The job info handle
@paramin user_data The user data passed from the callback registration function
@see job_scheduler_service_add()
@see #job_service_callback_s
@brief Called when the batch interval is expired.
@since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
@paramin num_of_location The number of location batch data
@paramin user_data The user data passed from the callback registration function
@pre location_manager_start_batch() will invoke this callback if you register this callback using location_manager_set_location_batch_cb().
@see location_manager_start_batch()
@see location_manager_set_location_batch_cb()
@brief Gets iteratively to receive location batch data.
@since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
@paramin latitude The updated latitude -90.0 ~ 90.0 (degrees)
@paramin longitude The updated longitude -180.0 ~ 180.0 (degrees)
@paramin altitude The updated altitude (meters)
@paramin speed The updated speed (km/h)
@paramin direction The updated direction (in degrees from the north)
@paramin horizontal The horizontal accuracy (meters)
@paramin vertical The vertical accuracy (meters)
@paramin timestamp The timestamp (time when measurement took place or @c 0 if valid)
@paramin user_data The user data passed from the callback registration function
@return @c true to continue with the next iteration of the loop,
otherwise @c false to break out of the loop
@pre location_manager_foreach_location_batch() will invoke this callback.
@see location_manager_foreach_location_batch()
@brief Called once for each location bound.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin bounds The location bounds handle
@paramin user_data The user data passed from the callback registration function
@return @c true to continue with the next iteration of the loop,
otherwise @c false to break out of the loop
@pre location_manager_foreach_boundary() will invoke this callback.
@see location_manager_foreach_boundary()
@brief Called when the given boundary is entered or exited.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin state The boundary state
@paramin user_data The user data passed from the start function
@pre location_manager_start() will invoke this callback if you register this callback using location_bounds_set_state_changed_cb().
@see #location_boundary_state_e
@see location_manager_start()
@see location_bounds_set_state_changed_cb()
@brief Called at defined interval with updated location information.
@since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
@paramin latitude The updated latitude -90.0 ~ 90.0 (degrees)
@paramin longitude The updated longitude -180.0 ~ 180.0 (degrees)
@paramin altitude The updated altitude (meters)
@paramin speed The updated speed (km/h)
@paramin direction The updated direction (in degrees from the north)
@paramin horizontal_accuracy The horizontal accuracy (meters)
@paramin timestamp The timestamp (time when measurement took place or @c 0 if valid)
@paramin user_data The user data passed from the callback registration function
@pre location_manager_start() will invoke this callback if you register this callback using location_manager_set_position_updated_cb().
@see location_manager_start()
@see location_manager_set_distance_based_location_changed_cb()
@see location_manager_set_location_changed_cb()
@brief Called at defined interval with updated position information.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin latitude The updated latitude -90.0 ~ 90.0 (degrees)
@paramin longitude The updated longitude -180.0 ~ 180.0 (degrees)
@paramin altitude The updated altitude (meters)
@paramin timestamp The timestamp (time when measurement took place or @c 0 if valid)
@paramin user_data The user data passed from the call registration function
@pre location_manager_start() will invoke this callback if you register this callback using location_manager_set_position_updated_cb().
@see location_manager_start()
@see location_manager_set_position_updated_cb()
@brief Called when the state of location service is changed from enabled to disabled or vice versa.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin state The service state
@paramin user_data The user data passed from the callback registration function
@pre Either location_manager_start() or location_manager_stop() will invoke this callback if you register this callback using location_manager_set_service_state_changed_cb().
@see location_manager_start()
@see location_manager_stop()
@see location_manager_set_service_state_changed_cb()
@see #location_service_state_e
@brief Called when the state of location method is changed.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin method The method changed on setting
@paramin enable The setting value changed
@paramin user_data The user data passed from the callback registration function
@pre location_setting_changed_cb() will invoke this callback if you register this callback using location_manager_set_setting_changed_cb().
@see location_manager_set_setting_changed_cb()
@see location_manager_unset_setting_changed_cb()
@brief Called at defined interval with updated location information.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin error #LOCATIONS_ERROR_NONE Successful
@paramin latitude The updated latitude -90.0 ~ 90.0 (degrees)
@paramin longitude The updated longitude -180.0 ~ 180.0 (degrees)
@paramin altitude The updated altitude (meters)
@paramin timestamp The timestamp (time when measurement took place or @c 0 if valid)
@paramin speed The updated speed (km/h)
@paramin direction The updated direction (in degrees from the north)
@paramin climb The updated climb (km/h)
@paramin user_data The user data passed from the callback registration function
@pre location_manager_request_single_location() will invoke this callback.
@see location_manager_request_single_location()
@brief Called at defined interval with updated velocity information.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin speed The updated speed (km/h)
@paramin direction The updated direction (in degrees from the north)
@paramin climb The updated climb (km/h)
@paramin timestamp The timestamp (time when measurement took place or @c 0 if valid)
@paramin user_data The user data passed from the callback registration function
@pre location_manager_start() will invoke this callback if you register this callback using location_manager_set_velocity_updated_cb().
@see location_manager_start()
@see location_manager_set_velocity_updated_cb()
@brief Called when the user-defined zones are entered or exited.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin state The boundary state
@paramin latitude The updated latitude -90.0 ~ 90.0 (degrees)
@paramin longitude The updated longitude -180.0 ~ 180.0 (degrees)
@paramin altitude The updated altitude (meters)
@paramin timestamp The timestamp (time when measurement took place or @c 0 if valid)
@paramin user_data The user data passed from the callback registration function
@pre location_manager_start() will invoke this callback if you register this callback using location_manager_set_zone_changed_cb().
@see #location_boundary_state_e
@see location_manager_start()
@see location_manager_set_zone_changed_cb()
@brief Called when the multi-assistant service sends audio streaming.
@since_tizen 5.0
@remarks The @a buffer should not be released and can be used only in the callback. To use outside, make a copy.
@brief Called when the error is occurred.
@details The following error codes can be received: \n
#MA_ERROR_NONE: Success \n
#MA_ERROR_OUT_OF_MEMORY: Out of Memory \n
#MA_ERROR_IO_ERROR: I/O error \n
#MA_ERROR_INVALID_PARAMETER: Invalid parameter \n
#MA_ERROR_TIMED_OUT: No answer from service \n
#MA_ERROR_RECORDER_BUSY: Busy recorder \n
#MA_ERROR_PERMISSION_DENIED: Permission denied \n
#MA_ERROR_NOT_SUPPORTED: Multi-assistant NOT supported \n
#MA_ERROR_INVALID_STATE: Invalid state \n
#MA_ERROR_INVALID_LANGUAGE: Invalid language \n
#MA_ERROR_ENGINE_NOT_FOUND: No available engine \n
#MA_ERROR_OPERATION_FAILED: Operation failed \n
#MA_ERROR_SERVICE_RESET: Service daemon reset \n
#MA_ERROR_NOT_SUPPORTED_FEATURE: Not supported feature of current engine \n
@since_tizen 5.0
@brief Called when the default language is changed.
@since_tizen 5.0
@remarks The @a previous can be used only in the callback. To use outside, make a copy.
The @a current can be used only in the callback. To use outside, make a copy.
@brief Called when a wakeup engine specific command is retrieved.
@since_tizen 5.5
@remarks The @a command should not be released and can be used only in the callback. To use outside, make a copy.
@deprecated Deprecated since 5.5. Use mc_ability_support_updated_cb() instead.
@brief Called when the repeat ability of the media controller server is updated.
@since_tizen 5.0
@brief Called when the Server receives custom command from the client.
@details This callback is called when server receives custom command from client.
If you want to reply to the command, call mc_server_send_cmd_reply() function.
@since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
@brief Called when the Server receives search command from the client.
@details This callback is called when server receives search command from client.
If you want to reply to the command, call mc_server_send_cmd_reply() function.
@since_tizen 5.0
@deprecated Deprecated since 5.5. Use mc_ability_support_updated_cb() instead.
@brief Called when the shuffle ability support of the media controller server is updated.
@since_tizen 5.0
@ingroup CAPI_CONTENT_MEDIA_ALBUM_MODULE
@brief The structure type for the Media album handle.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@ingroup CAPI_CONTENT_MEDIA_BOOKMARK_MODULE
@brief Called for every bookmark in the obtained list of bookmarks.
@details Iterates over a bookmark list.
@ingroup CAPI_CONTENT_MEDIA_BOOKMARK_MODULE
@brief The structure type for the Media bookmark handle.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@ingroup CAPI_MEDIA_CONTENT_MODULE
@brief Called when the notification of the media DB change is subscribed.
@details The following error codes can be received: \n
#MEDIA_CONTENT_ERROR_NONE : Success \n
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@ingroup CAPI_CONTENT_MEDIA_FOLDER_MODULE
@brief The structure type for the Media folder handle.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@ingroup CAPI_CONTENT_MEDIA_INFO_MODULE
@brief Called for every available media info.
@details Iterates over a list of media info.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@brief Called when the media packet is disposed.
@details It will be invoked when media_packet_unref() is called, \n
and reference count is decreased to 0.
@since_tizen 6.5
@remarks The media packet handle should not be released in this callback. \n
It will be released by the framework after return.
@paramin packet The media packet handle
@paramin user_data The user data passed from the callback registration function
@pre It will be invoked when media packet is being destroyed.
@see media_packet_unref()
@see media_packet_new()
@see media_packet_new_alloc()
@see media_packet_new_from_tbm_surface()
@see media_packet_new_from_external_memory()
@ingroup CAPI_CONTENT_MEDIA_PLAYLIST_MODULE
@brief Called for every playlist in the obtained list of playlists.
@details Iterates over a playlist list.
@ingroup CAPI_CONTENT_MEDIA_PLAYLIST_MODULE
@brief The structure type for the Media playlist handle.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@ingroup CAPI_MEDIA_CONTENT_MODULE
@brief Called when the media scanning is finished.
@details The following error codes can be received: \n
#MEDIA_CONTENT_ERROR_NONE : Success \n
#MEDIA_CONTENT_ERROR_INVALID_PARAMETER : Invalid parameter \n
#MEDIA_CONTENT_ERROR_INVALID_OPERATION : Invalid operation \n
#MEDIA_CONTENT_ERROR_PERMISSION_DENIED : Permission denied \n
#MEDIA_CONTENT_ERROR_OUT_OF_MEMORY : Out of memory \n
#MEDIA_CONTENT_ERROR_DB_FAILED : DB Operation failed \n
#MEDIA_CONTENT_ERROR_DB_BUSY : DB Operation busy \n
#MEDIA_CONTENT_ERROR_NETWORK : Network fail \n
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@remarks The callback is called in a separate thread(not in the main loop).
@ingroup CAPI_CONTENT_MEDIA_STORAGE_MODULE
@deprecated Deprecated since 5.0.
@brief Called for every storage in the obtained list of storages.
@details Iterates over a media storage list.
@ingroup CAPI_CONTENT_MEDIA_STORAGE_MODULE
@deprecated Deprecated since 5.0.
@brief The structure type for the Media storage handle.
@since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
@brief Called when the custom source needs more data or has enough data.
@details This callback will be invoked when the buffer level drops below the threshold of max size
or no free space in custom source buffer.
@since_tizen 3.0
@remarks This callback can be applied only to #MEDIA_STREAMER_NODE_SRC_TYPE_CUSTOM source type node.\n
The @a src is the same object for which the callback was set.
@paramin src Media streamer source node handle
@paramin status Media streamer custom buffer status
@paramin user_data The user data passed from the callback registration function
@see media_streamer_src_set_buffer_status_cb()
@see media_streamer_node_get_param()
@see media_streamer_node_set_param()
@brief Called when error occurs in media streamer.
@since_tizen 3.0
@remarks Following error codes can be delivered.\n
#MEDIA_STREAMER_ERROR_INVALID_OPERATION,\n
#MEDIA_STREAMER_ERROR_FILE_NO_SPACE_ON_DEVICE,\n
#MEDIA_STREAMER_ERROR_NOT_SUPPORTED,\n
#MEDIA_STREAMER_ERROR_CONNECTION_FAILED,\n
#MEDIA_STREAMER_ERROR_RESOURCE_CONFLICT.\n
The @a streamer is the same object for which the callback was set.
@paramin streamer Media streamer handle
@paramin error The error that occurred in media steamer
@paramin user_data The user data passed from the code where
media_streamer_set_error_cb() was invoked
This data will be accessible from media_streamer_error_cb()
@pre Create media streamer handle by calling media_streamer_create().
@see media_streamer_set_error_cb()
@see media_streamer_unset_error_cb()
@brief Called when the media streamer is interrupted.
@since_tizen 3.0
@paramin code The interrupted error code
@paramin user_data The user data passed from the callback registration function
@see media_streamer_set_interrupted_cb()
@see media_streamer_unset_interrupted_cb()
@brief Called when a source pad of a media streamer node is ready to provide decoded data.
@since_tizen 6.0
@remarks The @a node is the same object for which the callback was set.\n
The @a src_pad_name and the @a media_type can be used only in the callback. To use outside, make a copy.
@paramin node Media streamer node handle
@paramin src_pad_name The source pad name that can give decoded data to another one
@paramin media_type The media type of the data from the given source pad such as 'video/x-raw', 'audio/x-raw', and so on
@paramin user_data The user data passed from the callback registration function
@see media_streamer_node_set_decoded_ready_cb()
@see media_streamer_node_link()
@see media_streamer_node_unset_decoded_ready_cb()
@brief Called when the seek operation is completed.
@since_tizen 3.0
@paramin user_data The user data passed from the callback registration function
@see media_streamer_set_play_position()
@brief Called when new data is available from custom sink.
@details This callback can be applied only to #MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM sink type node.
@since_tizen 3.0
@remarks The @a sink is the same object for which the callback was set.
@paramin sink Media streamer sink node handle
@paramin user_data The user data passed from the code where
media_streamer_sink_set_data_ready_cb() was invoked
This data will be accessible from media_streamer_sink_data_ready_cb()
@pre media_streamer_sink_set_data_ready_cb()
@see MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM
@see media_streamer_sink_set_data_ready_cb()
@see media_streamer_sink_unset_data_ready_cb()
@brief Called when the end-of-stream has been reached.
@details This callback can be applied only to #MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM sink type node.
@since_tizen 3.0
@remarks The @a sink is the same object for which the callback was set.
@paramin sink Media streamer sink node handle
@paramin user_data The user data passed from the code where
media_streamer_sink_set_eos_cb() was invoked
This data will be accessible from media_streamer_sink_eos_cb()
@pre media_streamer_sink_set_eos_cb()
@see MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM
@see media_streamer_sink_set_eos_cb()
@see media_streamer_sink_unset_eos_cb()
@brief Called when media streamer state is changed.
@since_tizen 3.0
@remarks The @a streamer is the same object for which the callback was set.
@paramin streamer Media streamer handle
@paramin previous_state The previous state of the media streamer
@paramin current_state The current state of media streamer
@paramin user_data The user data passed from the code where
media_streamer_set_state_changed_cb() was invoked
This data will be accessible from media_streamer_state_changed_cb()
@pre Create media streamer handle by calling media_streamer_create().
@see media_streamer_set_state_change_cb()
@see media_streamer_unset_state_change_cb()
@brief Called when the media streamer WebRTC node needs to send the message to the remote peer of the WebRTC connection.
@since_tizen 6.0
@remarks Two types will be delivered with @a message which is a JSON string.\n
One is for the remote session description and the other is for a new ICE candidate.\n
For the remote session description, @a message will be {"sdp":{"type":"offer or answer","sdp":"..."}}.\n
For the new ICE candidate, @a message will be {"ice":{"candidate":"..."}}.\n
The @a webrtc is the same object for which the callback was set.\n
The @a message can be used only in the callback. To use outside, make a copy.
@paramin webrtc Media streamer WebRTC node handle
@paramin message The message to be passed to the remote peer over the signaling channel
@paramin user_data The user data passed from the callback registration function
@see media_streamer_webrtc_node_set_message_cb()
@see media_streamer_webrtc_node_unset_message_cb()
@deprecated Deprecated since 5.0.
@ingroup CAPI_CONTENT_MEDIA_INFO_MODULE
@brief Called when creating a thumbnail image.
@details This callback is called for completion of generating the thumbnail image.
The following error codes can be delivered. \n
#MEDIA_CONTENT_ERROR_NONE, \n
#MEDIA_CONTENT_ERROR_INVALID_PARAMETER, \n
#MEDIA_CONTENT_ERROR_INVALID_OPERATION, \n
#MEDIA_CONTENT_ERROR_PERMISSION_DENIED, \n
#MEDIA_CONTENT_ERROR_DB_FAILED, \n
#MEDIA_CONTENT_ERROR_UNSUPPORTED_CONTENT
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@brief Called when the mediacodec needs more data or has enough data.
@details It is recommended that the application stops calling mediacodec_process_input() when #MEDIACODEC_ENOUGH_DATA
@since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
is invoked.
@paramin status The state of the buffer
@paramin user_data The user data passed from the callback registration function
@see mediacodec_set_buffer_status_cb()
@see mediacodec_unset_buffer_status_cb()
@brief Called when there is no data to decode/encode.
@details It will be invoked when the end-of-stream is reached.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin user_data The user data passed from the callback registration function
@pre It will be invoked when the eos event generate if you register this callback using mediacodec_set_eos_cb().
@see mediacodec_set_eos_cb()
@see mediacodec_unset_eos_cb()
@brief Called when the error has occurred.
@details It will be invoked when the error has occurred.
Following error codes can be delivered.
#MEDIACODEC_ERROR_INTERNAL,
#MEDIACODEC_ERROR_INVALID_STREAM,
#MEDIACODEC_ERROR_NOT_SUPPORTED_FORMAT,
#MEDIACODEC_ERROR_RESOURCE_CONFLICT
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin error The error code
@paramin user_data The user data passed from the callback registration function
@pre It will be invoked when the error has occurred if you register this callback using mediacodec_set_error_cb().
@see mediacodec_set_error_cb()
@see mediacodec_unset_error_cb()
@brief Called when the input buffer(packet) used up.
@details It will be invoked when mediacodec has used input buffer.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@remarks The @a packet should be released using media_packet_destroy().
@paramin packet The media packet handle
@paramin user_data The user data passed from the callback registration function
@pre It will be invoked when input buffer process completed if you register this callback using mediacodec_set_input_buffer_used_cb().
@see mediacodec_set_input_buffer_used_cb()
@see mediacodec_unset_input_buffer_used_cb()
@brief Called when the output buffer is available.
@details It will be invoked when mediacodec has output buffer.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@remarks The @a packet should be released using media_packet_destroy().
@paramin packet The media packet handle
@paramin user_data The user data passed from the callback registration function
@pre It will be invoked when mediacodec process completed(had output buffer) if you register this callback using mediacodec_set_fill_buffer_cb().
@see mediacodec_set_output_buffer_available_cb()
@see mediacodec_unset_output_buffer_available_cb()
@brief Called once for each supported codec types.
@since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
@paramin codec_type The codec type
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, @c false to break out of the loop.
@pre mediacodec_foreach_supported_codec() will invoke this callback.
@see mediacodec_foreach_supported_codec()
@brief Called when end of stream occurs in media demuxer.
@since_tizen 3.0
@paramin track_num The track_num which indicate eos for which track number occurred
@paramin user_data The user data passed from the code where
mediademuxer_set_eos_cb() was invoked
This data will be accessible from mediademuxer_eos_cb()
@pre Create media demuxer handle by calling mediademuxer_create() function.
@see mediademuxer_set_eos_cb()
@see mediademuxer_unset_eos_cb()
@brief Called when error occurs in media demuxer.
@details Following error codes can be delivered.
#MEDIADEMUXER_ERROR_INVALID_OPERATION,
#MEDIADEMUXER_ERROR_NOT_SUPPORTED,
#MEDIADEMUXER_ERROR_INVALID_PATH,
#MEDIADEMUXER_ERROR_RESOURCE_LIMIT,
#MEDIADEMUXER_ERROR_SEEK_FAILED,
#MEDIADEMUXER_ERROR_DRM_NOT_PERMITTED
@since_tizen 3.0
@paramin error The error that occurred in media demuxer
@paramin user_data The user data passed from the code where
mediademuxer_set_error_cb() was invoked
This data will be accessible from mediademuxer_error_cb()
@pre Create media demuxer handle by calling mediademuxer_create() function.
@see mediademuxer_set_error_cb()
@see mediademuxer_unset_error_cb()
@brief Called when end of stream occurs in media muxer.
@since_tizen 4.0
@paramin user_data The user data passed from the code where
mediamuxer_set_eos_cb() was invoked;\n
this data will be accessible from mediamuxer_eos_cb()
@pre Create media muxer handle by calling mediamuxer_create() function.
@see mediamuxer_set_eos_cb()
@see mediamuxer_unset_eos_cb()
@brief Called when error occurs in media muxer.
@details Following error codes can be delivered.
#MEDIAMUXER_ERROR_INVALID_OPERATION,
#MEDIAMUXER_ERROR_NOT_SUPPORTED,
#MEDIAMUXER_ERROR_INVALID_PATH,
#MEDIAMUXER_ERROR_RESOURCE_LIMIT
@since_tizen 3.0
@paramin error The error that occurred in media muxer
@paramin user_data The user data passed from the code where
mediamuxer_set_error_cb() was invoked
This data will be accessible from @a user_data mediamuxer_error_cb()
@pre Create media muxer handle by calling mediamuxer_create() function.
@see mediamuxer_set_error_cb()
@see mediamuxer_unset_error_cb()
@brief Called when a message is received.
@details The function is called when a message is received from the remote application.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@remarks @a message is automatically freed by framework when callback returned, you can keep @a message using bundle_dup() @n
@a remote_port will be set only if the remote application sends a message with its port information using message_port_send_message_with_local_port(), otherwise it is @c NULL @n
When message is sent from remote application by message_port_send_message_with_local_port() in bidirectional communication, trusted_remote_port is used to check whether remote port is trusted port or not
This callback is called only in the main thread.
@paramin local_port_id The local message port ID returned by message_port_register_local_port()
@paramin remote_app_id The ID of the remote application that sent this message
@paramin remote_port The name of the remote message port
@paramin trusted_remote_port If @c true, the remote port is a trusted port; otherwise if @c false, it is not
@paramin message The message passed from the remote application
@paramin user_data The user data passed from the register function
@pre Either message_port_send_message() or message_port_send_message_with_local_port() from the remote application will invoke this function if you register it using message_port_register_local_port()
@see message_port_register_local_port()
@see message_port_unregister_local_port()
@see message_port_send_message()
@see message_port_send_message_with_local_port()
@brief Called when a remote port is registered or unregistered.
@details The function is called when a remote port is registered or unregistered
from the remote application.
@since_tizen 4.0
@remarks @a remote_app_id and @a remote_port can be used until
message_port_remove_registration_event_cb() is called for the watcher which reported
the event.
@paramin remote_app_id The ID of the remote application that sent this message
@paramin remote_port The name of the remote message port
@paramin trusted_remote_port Indicates whether remote port is trusted
@paramin user_data The user data passed from the register function
@pre Called when a remote port is registered or unregistered if you add it using
message_port_add_registered_cb() or message_port_add_unregistered_cb() respectively.
@see message_port_add_registered_cb()
@see message_port_add_unregistered_cb()
@see message_port_remove_registration_event_cb()
@brief Called when a trusted message is received.
@details This function is called when a trusted message is received from the remote application.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@remarks You can keep @a message using bundle_dup(). @n
@a remote_port will be set only if the remote application sends a message with its port information using message_port_send_trusted_message_with_local_port(), otherwise it is @c NULL. @n
When message is sent from remote application by message_port_send_trusted_message_with_local_port() in bidirectional communication, trusted_remote_port is used to check whether remote port is trusted port or not.
This callback is called only in the main thread.
@paramin trusted_local_port_id The message port ID returned by message_port_register_trusted_local_port()
@paramin remote_app_id The ID of the remote application that sent this message
@paramin remote_port The name of the remote message port
@paramin trusted_remote_port If @c true, the remote port is a trusted port; otherwise if @c false, it is not
@paramin message The message passed from the remote application
@paramin user_data The user data passed from the register function
@pre Either message_port_send_trusted_message() or message_port_send_trusted_message_with_local_port() from the remote application will invoke this function if you register it using message_port_register_trusted_local_port().
@see message_port_register_trusted_local_port()
@see message_port_unregister_trusted_local_port()
@see message_port_send_trusted_message()
@see message_port_send_trusted_message_with_local_port()
@brief Callback to execute the custom-easy filter in NNStreamer pipelines.
@details Note that if ml_custom_easy_invoke_cb() returns negative error values, the constructed pipeline does not work properly anymore.
So developers should release the pipeline handle and recreate it again.
@since_tizen 6.0
@remarks The @a in can be used only in the callback. To use outside, make a copy.
@remarks The @a out can be used only in the callback. To use outside, make a copy.
@paramin in The handle of the tensor input (a single frame. tensor/tensors).
@paramout out The handle of the tensor output to be filled (a single frame. tensor/tensors).
@paramin,out user_data User application's private data.
@return @c 0 on success. @c 1 to ignore the input data. Otherwise a negative error value.
@brief A handle of a common element (i.e. All GstElement except AppSrc, AppSink, TensorSink, Selector and Valve) of an NNStreamer pipeline.
@since_tizen 6.0
@brief Callback for custom condition of tensor_if.
@since_tizen 6.5
@remarks The @a data can be used only in the callback. To use outside, make a copy.
@remarks The @a info can be used only in the callback. To use outside, make a copy.
@remarks The @a result can be used only in the callback and should not be released.
@paramin data The handle of the tensor output of the pipeline (a single frame. tensor/tensors). Number of tensors is determined by ml_tensors_info_get_count() with the handle 'info'. Note that the maximum number of tensors is 16 (#ML_TENSOR_SIZE_LIMIT).
@paramin info The handle of tensors information (cardinality, dimension, and type of given tensor/tensors).
@paramout result Result of the user-defined condition. 0 refers to FALSE and a non-zero value refers to TRUE. The application should set the result value for given data.
@paramin,out user_data User application's private data.
@return @c 0 on success. Otherwise a negative error value.
@brief Callback for sink element of NNStreamer pipelines (pipeline's output).
@details If an application wants to accept data outputs of an NNStreamer stream, use this callback to get data from the stream. Note that the buffer may be deallocated after the return and this is synchronously called. Thus, if you need the data afterwards, copy the data to another buffer and return fast. Do not spend too much time in the callback. It is recommended to use very small tensors at sinks.
@since_tizen 5.5
@remarks The @a data can be used only in the callback. To use outside, make a copy.
@remarks The @a info can be used only in the callback. To use outside, make a copy.
@paramin data The handle of the tensor output of the pipeline (a single frame. tensor/tensors). Number of tensors is determined by ml_tensors_info_get_count() with the handle 'info'. Note that the maximum number of tensors is 16 (#ML_TENSOR_SIZE_LIMIT).
@paramin info The handle of tensors information (cardinality, dimension, and type of given tensor/tensors).
@paramin,out user_data User application's private data.
@brief Callback for the change of pipeline state.
@details If an application wants to get the change of pipeline state, use this callback. This callback can be registered when constructing the pipeline using ml_pipeline_construct(). Do not spend too much time in the callback.
@since_tizen 5.5
@paramin state The new state of the pipeline.
@paramout user_data User application's private data.
@brief Called when barcode detection is completed.
@details If no barcode is detected then the method will be called, barcodes
and states will be equal to NULL, and @a number_of_barcodes - 0.
@brief The handle to the Media Vision API engine algorithms configuration.
@details Configuration is a dictionary consists of key and value pairs to
collect engine-specific settings and allow Media Vision module to
access them internally. Engine configuration provides developer by
the possibility to make computer vision algorithms work better
in particular conditions of API usage. To create engine
configuration handle mv_create_engine_config() function has to
be used. When configuration is not needed any more, it is required to
destroy it and release resources by mv_destroy_engine_config()
function.
@brief Called when faces are detected for the @a source.
@details This type callback can be invoked each time when
mv_face_detect() is called to process the results of face
detecting.
@brief Called when eye blink condition is recognized.
@details This type callback can be invoked each time when
mv_face_eye_condition_recognize() is called for @a face_location to
recognize eye-blink condition for the face at the @a source.\n
Usage example for this callback can be found in
mv_face_eye_condition_recognize() documentation.
@brief Called when facial expression is recognized.
@details This type callback can be invoked each time when
mv_face_facial_expression_recognize() is called for @a face_location to
recognize facial expression for the face at the @a source.\n
Usage example for this callback can be found in
mv_face_facial_expression_recognize() documentation.
@brief The handle to the model aggregating recognition face features.
@details This handle can be used for faces recognizing with
mv_face_recognize() function. Handle has to be created by
mv_face_recognition_model_create() and destroyed by
mv_face_recognition_model_destroy() functions. To use
recognition models effectively learning process has to be performed
before recognition. In other words, appropriate set of the face
image examples has to be collected with
mv_face_recognition_model_add() function before
mv_face_recognition_model_learn() function call, then
recognition can be performed with mv_face_recognize().
@brief Called when face determined by @a tracking_model is tracked.
@details This type callback can be invoked each time when
mv_face_track() is called to process the results of face
tracking.
@brief The handle to the model aggregating tracking face features.
@details This model can be used for face tracking with mv_face_track()
function. Handle has to be created by
mv_face_tracking_model_create() and destroyed by
mv_face_tracking_model_destroy() function. Tracking model can
be improved during tracking task and allows to track face more
accurately. So, you can create several tracking models independently
by default, then apply tracking task for each of them. After some
tracking these models will be different and each of them will be
more efficient for tracking of face for which was created.
@brief Called when image recognition results are received from mv_image_recognize().
@details This type of callback will be called after mv_image_recognize()
in order to process recognition result.
@brief Called when image tracking result received from mv_image_track()
@details Image tracking on a sequence of frames assumes calling
mv_image_track() function for each frame in the correct order.
This type of callback will be called after each mv_image_track()
call for processing result data.
/
/**
@brief Called when faces in @a source are detected.
@details This callback is invoked each time when
mv_inference_face_detect() is called to provide the results of
face detection.
@brief Called when facial landmarks in @a source are detected.
@details This type callback is invoked each time when
mv_inference_facial_landmark_detect() is called to provide
the results of the landmarks detection.
/
/**
@brief Called when @a source is classified.
@details This callback is invoked each time when
mv_inference_image_classify() is called to provide the results of
image classification.
/
/**
@brief Called when objects in @a source are detected.
@details This callback is invoked each time when
mv_inference_object_detect() is called to provide the results of
object detection.
@brief Called when poses in @a source are detected.
@details This type callback is invoked each time when
mv_inference_pose_landmark_detect() is called to provide
the results of the pose landmark detection.
@brief The handle to event trigger activation result.
@details Result is a handle to the output values which are specific for each event.
See the output values names in the event types descriptions located
in @ref CAPI_MEDIA_VISION_SURVEILLANCE_EVENT_TYPES documentation
section.
Result values can be gotten by mv_surveillance_get_result_value()
function one by one in order specified in the event description (
the same order of event value names is supported by
mv_surveillance_foreach_event_result_name() function).
This pointer will be destroyed when
mv_surveillance_event_occurred_cb() passed.
@brief Called to get the data of child item for each child of the group item.
@since_tizen 5.5
@remarks @a handle must not be released
@remarks @a handle can be used only in the callback.
@a handle will be freed after the callback exists.
@paramin handle The notification_ex item handle
@paramin user_data The user data
@return #NOTI_EX_ERROR_NONE On success, other value on failure
@retval #NOTI_EX_ERROR_NONE Success
@see #noti_ex_item_h
@see noti_ex_item_group_foreach_child()
@brief Called when a notification addition event is received.
@details If this callback is set to NULL in @a event_callbacks, addition events cannot be received.
@since_tizen 5.5
@paramin handle The manager handle \n
The @a handle is the same handle for which the callback was set
@paramin info The handle that contains event information \n
The @a info can be used only in the callback. To use outside, make a copy. \n
The @a info will be freed after the callback exits.
@paramin added_items The item handles to be added \n
Each item in @a added_items should be destroyed with using noti_ex_item_destroy(), then @a added_items should be released with free().
@paramin count The count of the item to be added
@paramin user_data The user data which was registered with callback
@see #noti_ex_manager_h
@see #noti_ex_event_info_h
@see #noti_ex_item_h
@see noti_ex_event_info_clone()
@see noti_ex_item_destroy()
@brief Called when a notification deletion event is received.
@details If this callback is set to NULL in @a event_callbacks, deletion events cannot be received.
@since_tizen 5.5
@paramin handle The manager handle \n
The @a handle is the same handle for which the callback was set
@paramin info The handle that contains event information \n
The @a info can be used only in the callback. To use outside, make a copy. \n
The @a info will be freed after the callback exits.
@paramin deleted_item The item handle to be deleted \n
The @a deleted_item must be released using noti_ex_item_destroy().
@paramin user_data The user data which was registered with callback
@see #noti_ex_manager_h
@see #noti_ex_event_info_h
@see #noti_ex_item_h
@see noti_ex_event_info_clone()
@see noti_ex_item_destroy()
@brief Called when an error event is received.
@details The errors are passed from noti_ex_reporter_send_error().
If this callback is set to NULL in @a event_callbacks, error events cannot be received.
@since_tizen 5.5
@paramin handle The manager handle \n
The @a handle is the same handle for which the callback was set
@paramin error The error type
@paramin request_id The id of the request that occurred error
@paramin user_data The user data which was registered with callback
@see #noti_ex_manager_h
@see #noti_ex_error_e
@brief Called when a notification update event is received.
@details If this callback is set to NULL in @a event_callbacks, update events cannot be received.
@since_tizen 5.5
@paramin handle The manager handle \n
The @a handle is the same handle for which the callback was set
@paramin info The handle that contains event information \n
The @a info can be used only in the callback. To use outside, make a copy. \n
The @a info will be freed after the callback exits.
@paramin updated_item The item handle to be updated \n
The @a updated_item must be released using noti_ex_item_destroy().
@paramin user_data The user data which was registered with callback
@see #noti_ex_manager_h
@see #noti_ex_event_info_h
@see #noti_ex_item_h
@see noti_ex_event_info_clone()
@see noti_ex_item_destroy()
@brief Called when the error event is received.
@details The errors are passed from noti_ex_manager_send_error().
If this callback is set to NULL in @a event_callbacks, error events cannot be received.
@since_tizen 5.5
@paramin handle The reporter handle \n
The @a handle is the same handle for which the callback was set
@paramin error The error type
@paramin request_id The id of the request that occurred error
@paramin user_data The user data which was registered with callback
@see #noti_ex_reporter_h
@see #noti_ex_error_e
@brief Called when the notification event is received.
@details If this callback is set to NULL in @a event_callbacks, notification events cannot be received.
@since_tizen 5.5
@paramin handle The reporter handle \n
The @a handle is the same handle for which the callback was set
@paramin info The handle that contains event information \n
The @a info can be used only in the callback. To use outside, make a copy. \n
The @a info will be freed after the callback exits.
@paramin items The target items of event \n
Each item in @a items must be released using noti_ex_item_destroy(), then @a items must be released using free().
@paramin count The count of @a items
@paramin user_data The user data which was registered with callback
@see #noti_ex_reporter_h
@see #noti_ex_event_info_h
@see #noti_ex_item_h
@see noti_ex_event_info_clone()
@see noti_ex_item_destroy()
@brief Called to get the application ID once for each installed package.
@since_tizen 2.3
@paramin comp_type The application component type
@paramin app_id The application ID.
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop,
otherwise @c false to break out of the loop
@pre package_info_foreach_app_from_package() will invoke this callback.
@see package_info_foreach_app_from_package()
@brief Called to get the certification information.
@since_tizen 2.3
@paramin handle The package info handle
@paramin cert_type The certificate type
@paramin cert_value The certificate value of corresponding certificate key \n
This value is base64 encoded data.
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop,
otherwise @c false to break out of the loop
@pre package_info_foreach_cert_info() will invoke this callback.
@see package_info_foreach_cert_info()
@brief Called when dependency information between packages is retrieved.
@since_tizen 5.5
@remarks @a from, @a to, @a type and @a required_version are managed by the platform and will be released after the callback exits.
@paramin from The ID of package that depends on another
@paramin to The ID of package that is required by another
@paramin type The type of dependency
@paramin required_version The required version
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop,
otherwise @c false to break out of the loop
@pre package_info_foreach_dependency_info() will invoke this callback.
@pre package_info_foreach_dependency_info_depends_on() will invoke this callback.
@see package_info_foreach_dependency_info()
@see package_info_foreach_dependency_info_depends_on()
@brief Called to get the privilege information.
@since_tizen 2.3
@paramin privilege_name the name of the privilege
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop,
otherwise @c false to break out of the loop
@pre package_info_foreach_privilege_info() will invoke this callback.
@see package_info_foreach_privilege_info()
@brief Called to get the allowed package information of resource package.
@since_tizen 6.5
@remarks @a allowed_package, @a privilege_handle are managed by the platform and will be released after the callback exits.
@paramin allowed_package The ID of allowed package
@paramin privilege_handle The privilege handle required by resource package
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop,
otherwise @c false to break out of the loop
@pre package_info_foreach_res_allowed_package() will invoke this callback.
@see package_info_foreach_res_allowed_package()
@brief Called for each update information of all packages.
@since_tizen 4.0
@remarks @a info should not be freed and can be used only in the callback.
@paramin info The package update information handle
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop,
otherwise @c false to break out of the loop
@pre package_info_updateinfo_foreach_info() will invoke this callback.
@see package_info_updateinfo_foreach_info()
@brief Called when the package is installed, uninstalled, or updated, and the progress of the request to the package manager changes.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin type The type of the package to be installed, uninstalled, or updated
@paramin package The name of the package to be installed, uninstalled, or updated
@paramin event_type The type of the request to the package manager
@paramin event_state The current state of the request to the package manager
@paramin progress The progress for the request that is being processed by the package manager \n
The range of progress is from @c 0 to @c 100
@paramin error The error code when the package manager failed to process the request
@paramin user_data The user data passed from package_manager_set_event_cb()
@see package_manager_set_event_cb()
@see package_manager_unset_event_cb()
@brief Called to retrieve all packages.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin package_info The package information
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop,
otherwise @c false to break out of the loop
@see package_manager_foreach_package_info()
@platform
@brief Called when the progress of the request to the package manager changes.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin id The ID of the request to the package manager
@paramin type The type of the package to install, uninstall or update
@paramin package The name of the package to install, uninstall or update
@paramin event_type The type of the request to the package manager
@paramin event_state The current state of the request to the package manager
@paramin progress The progress for the request that is being processed by the package manager \n
The range of progress is from @c 0 to @c 100.
@paramin error The error code when the package manager failed to process the request
@paramin user_data The user data passed from package_manager_request_set_event_cb()
@see package_manager_request_set_event_cb()
@see package_manager_request_unset_event_cb()
@platform
@brief Called when the progress of the request to the package resource share changes.
@since_tizen 6.5
@remarks The @a pkgid should not be released. The @a pkgid can be used only in the callback.
@remarks The @a handle should not be released. The @a handle can be used only in the callback.
@paramin req_id The ID of the request to the package manager
@paramin pkgid The package ID of resource owner
@paramin event_type The type of resource event
@paramin event_state The state of resource event
@paramin handle The handle which contains additional information of event
@paramin user_data The user data passed from package_manager_request_res_copy_with_cb(), package_manager_request_res_create_dir_with_cb(), package_manager_request_res_remove_with_cb()
@see package_manager_request_res_copy_with_cb()
@see package_manager_request_res_create_dir_with_cb()
@see package_manager_request_res_remove_with_cb()
@brief Called when the progress of the request to the package resource share changes.
@since_tizen 6.5
@remarks The @a pkgid should not be released. The @a pkgid can be used only in the callback.
@remarks The @a handle should not be released. The @a handle can be used only in the callback.
@paramin pkgid The package ID of resource owner
@paramin event_type The type of resource event
@paramin event_state The state of resource event
@paramin handle The handle which contains additional information of event
@paramin user_data The user data passed from package_manager_set_res_event_cb()
@see package_manager_set_res_event_cb()
@see package_manager_unset_event_cb()
@brief Called to retrieve all path state about resource event.
@since_tizen 6.5
@remarks The @a path should not be released. The @a path can be used only in the callback.
@paramin path The path handled by a resource event
@paramin state The state of the path
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop,
otherwise @c false to break out of the loop
@see package_manager_res_event_info_foreach_path()
@brief Called when the package size information is obtained.
@since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
@paramin package_id The package ID
@paramin size_info The pointer to the structure including the package size information
@paramin user_data The user data to be passed to the callback function
@platform
@brief Called when the total package size information is obtained.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin size_info The pointer to the structure including the package size information
@paramin user_data The user data to be passed to the callback function
@platform
@brief The GPIO interrupted callback called when the GPIO interrupt is triggered.
@details The following errors can be received: \n
#PERIPHERAL_ERROR_NONE Successful \n
#PERIPHERAL_ERROR_IO_ERROR I/O operation failed \n
#PERIPHERAL_ERROR_NO_DEVICE Device does not exist or is removed \n
#PERIPHERAL_ERROR_TRY_AGAIN Try again \n
#PERIPHERAL_ERROR_OUT_OF_MEMORY Memory allocation failed \n
#PERIPHERAL_ERROR_PERMISSION_DENIED Permission denied \n
#PERIPHERAL_ERROR_RESOURCE_BUSY Device is in use \n
#PERIPHERAL_ERROR_INVALID_PARAMETER Invalid parameter \n
#PERIPHERAL_ERROR_NOT_SUPPORTED Not supported \n
#PERIPHERAL_ERROR_UNKNOWN Unknown internal error \n
@since_tizen 4.0
@brief Called to notify the streaming variant information.
@details The adaptive streaming protocol(hls, mpeg dash) can support variant stream condition.
All the streaming variant information can be shared by calling player_foreach_adaptive_variant().
@since_tizen 4.0
@paramin bandwidth The bandwidth of the stream can be supportable, this is mandatory parameter
@paramin width The width of the stream, this is optional parameter
@paramin height The height of the stream, this is optional parameter
@paramin user_data The user data passed from the callback registration function
@see player_foreach_adaptive_variant()
@brief Called when the buffering percentage of the media playback is updated.
@details If the buffer is full, it will return 100%.
@since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
@paramin percent The percentage of buffering completed (0~100)
@paramin user_data The user data passed from the callback registration function
@see player_set_buffering_cb()
@see player_unset_buffering_cb()
@brief Called when the media player is completed.
@details It will be invoked when player has reached the end of the stream.
@since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
@paramin user_data The user data passed from the callback registration function
@pre It will be invoked when the playback is completed if you register this callback using player_set_completed_cb().
@see player_set_completed_cb()
@see player_unset_completed_cb()
@brief Called when an error occurs in the media player.
@details Following error codes can be delivered.
#PLAYER_ERROR_INVALID_OPERATION
#PLAYER_ERROR_INVALID_STATE
#PLAYER_ERROR_INVALID_URI
#PLAYER_ERROR_CONNECTION_FAILED
#PLAYER_ERROR_DRM_NOT_PERMITTED
#PLAYER_ERROR_FILE_NO_SPACE_ON_DEVICE
#PLAYER_ERROR_NOT_SUPPORTED_FILE
#PLAYER_ERROR_SEEK_FAILED
#PLAYER_ERROR_SERVICE_DISCONNECTED
#PLAYER_ERROR_NOT_SUPPORTED_AUDIO_CODEC (Since 4.0)
#PLAYER_ERROR_NOT_SUPPORTED_VIDEO_CODEC (Since 4.0)
#PLAYER_ERROR_NOT_SUPPORTED_SUBTITLE (Since 4.0)
@since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
@paramin error_code The error code
@paramin user_data The user data passed from the callback registration function
@see player_set_error_cb()
@see player_unset_error_cb()
@brief Called when the media player is interrupted.
@details If the code is #PLAYER_INTERRUPTED_BY_RESOURCE_CONFLICT,
the player state will be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, or #PLAYER_STATE_PAUSED.
Application should get exact state by calling player_get_state().
@since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
@paramin code The interrupted error code
@paramin user_data The user data passed from the callback registration function
@see player_set_interrupted_cb()
@see player_unset_interrupted_cb()
@see player_get_state()
@brief Called to register for notifications about delivering media packet when audio data is decoded.
@since_tizen 5.5
@remarks The @a packet should be released by calling media_packet_destroy(). \n
It is recommended to release it as soon as it is rendered, to avoid memory exhaustion.
@brief Called to register for notifications about delivering media packet when each video frame is decoded.
@since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
@remarks The UI update code must not be directly invoked.\n
@remarks The @a packet should be released using media_packet_destroy(). \n
If not, the decoder will fail due to having insufficient buffer space for the decoded frame.
@brief Called when the buffer level drops below the threshold of max size or no free space in buffer.
@since_tizen @if WEARABLE 3.0 @else 2.4 @endif
@remarks This function is used for media stream playback only.
@paramin status The buffer status
@paramin user_data The user data passed from the callback registration function
@see player_set_media_stream_buffer_status_cb()
@see player_set_media_stream_buffer_max_size()
@see player_set_media_stream_buffer_min_threshold()
@brief Called to notify the next push-buffer offset when seeking is occurred.
@details The next push-buffer should produce buffers from the new offset.
@since_tizen @if WEARABLE 3.0 @else 2.4 @endif
@remarks This function is used for media stream playback only.
@paramin offset The new byte position to seek
@paramin user_data The user data passed from the callback registration function
@brief Called when the media player is prepared.
@details It will be invoked when player has reached the begin of stream.
@since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
@paramin user_data The user data passed from the callback registration function
@pre player_prepare_async() will cause this callback.
@post The player state will be #PLAYER_STATE_READY.
@see player_prepare_async()
@brief Called when the seek operation is completed.
@since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
@paramin user_data The user data passed from the callback registration function
@see player_set_play_position()
@see player_set_play_position_nsec()
@brief Called when the subtitle is updated.
@since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
@remarks The @a text should not be released and it can be used only in the callback.
To use outside, make a copy.
@paramin duration The duration of the updated subtitle
@paramin text The text of the updated subtitle
@paramin user_data The user data passed from the callback registration function
@see player_set_subtitle_updated_cb()
@see player_unset_subtitle_updated_cb()
@brief Called to inform about the supported media format MIME type.
@details The supported media format can vary depending on the device capabilities.
@since_tizen 5.5
@paramin format The supportable media format MIME type
@paramin user_data The user data passed from the callback registration function
@return @c true to continue with the next iteration of the loop, otherwise @c false to break out of the loop
@see #media_format_mimetype_e
@see player_audio_offload_foreach_supported_format()
@brief Called when the video is captured.
@since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
@remarks The color space format of the captured image is #IMAGE_UTIL_COLORSPACE_RGB888.
@remarks The @a captured_data should not be released and it can be used only in the callback.
To use outside, make a copy.
@paramin captured_data The captured image buffer
@paramin width The width of the captured image
@paramin height The height of the captured image
@paramin size The size of the captured image
@paramin user_data The user data passed from the callback registration function
@see player_capture_video()
@brief Called to notify the video stream changed.
@details The video stream changing is detected just before rendering operation.
@since_tizen @if WEARABLE 3.0 @else 2.4 @endif
@paramin width The width of the captured image
@paramin height The height of the captured image
@paramin fps The frame per second of the video \n
It can be @c 0 if there is no video stream information.
@paramin bit_rate The video bit rate Hz \n
It can be an invalid value if there is no video stream information.
@paramin user_data The user data passed from the callback registration function
@see player_set_video_stream_changed_cb()
@ingroup CAPI_CONTENT_MEDIA_PLAYLIST_MODULE
@brief Called for every media info with playlist member ID in the obtained list of media info.
@details Iterates over playlist members.
@brief Gets called iteratively to notify you of coordinates of a polygon.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin coords The coordinates
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, \n
@c false to break out of the loop
@pre location_bounds_foreach_polygon_coords() will invoke this callback.
@see location_bounds_foreach_polygon_coords()
@brief Called when the given key's value in the preference changes.
@details When the @a key is added or removed, this callback function is skipped(only update can be handled).
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin key The name of the key in the preference
@paramin user_data The user data passed from the callback registration function
@pre This function is invoked when the value of the key is overwritten after you register this callback using preference_set_changed_cb().
@see preference_set_changed_cb()
@see preference_unset_changed_cb()
@see preference_set_boolean()
@see preference_set_int()
@see preference_set_string()
@see preference_set_double()
@brief Called to get key string, once for each key-value pair in the preference.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@remarks You should not free the @a key returned by this function.
@paramin key The key of the value added to the preference
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop,
otherwise @c false to break out of the loop
@pre preference_foreach_item() will invoke this callback function.
@see preference_foreach_item()
@brief Called to handle a notification.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin noti A handle of the notification containing its payload\n
The handle is available inside this callback only.
@paramin user_data The user data passed to this callback
@see push_service_connect()
@see push_service_get_notification_data()
@brief Called with the result of a registration/deregistration.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin result The registration/deregistration result
@paramin msg The result message from the push server,
otherwise @c NULL
@paramin user_data The user data passed to this callback
@see push_service_register()
@see push_service_deregister()
@brief Called when the registration state is refreshed.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@remarks This callback will be invoked when the registration state is refreshed. \n
If the registration or deregistration has succeeded, then this state callback must be called. \n
In addition, the state can be changed if the push server deregisters the application.
@paramin state The registration state
@paramin err The error message
@paramin user_data The user data passed to this callback
@see push_service_connect()
@brief Called when the radio is interrupted.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin code The interrupted error code
@paramin user_data The user data passed from the callback registration function
@see radio_set_interrupted_cb()
@see radio_unset_interrupted_cb()
@brief Called when the radio scan is completed.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin user_data The user data passed from the callback registration function
@pre It will be invoked when the scan is completed by registering this callback using radio_set_scan_completed_cb().
@see radio_scan_start()
@see radio_set_scan_completed_cb()
@see radio_unset_scan_completed_cb()
@brief Called when the radio scan is stopped.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin user_data The user data passed from the callback registration function
@pre It will be invoked when the scan is stopped by radio_scan_stop().
@see radio_scan_stop()
@brief Called when the scan information is updated.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin frequency The tuned radio frequency 87500 ~ 108000 (kHz)
@paramin user_data The user data passed from the callback registration function
@pre It will be invoked by radio_scan_start().
@see radio_scan_start()
@brief Called when the radio seek is completed.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin frequency The current frequency 87500 ~ 108000 (kHz)
@paramin user_data The user data passed from the callback registration function
@pre It will be invoked when the radio seek is completed by registering this callback using radio_seek_up() or radio_seek_down().
@see radio_seek_up()
@see radio_seek_down()
@brief Called when audio stream data was being delivered just before storing in the recorded file.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@remarks The callback function holds the same buffer that will be recorded. \n
So if the user changes the buffer, the result file will contain the buffer.
@remarks The callback is called via internal thread of Frameworks, therefore do not invoke UI API, recorder_unprepare(), recorder_commit() and recorder_cancel() in callback.
@paramin stream The audio stream data
@paramin size The size of the stream data
@paramin format The audio format
@paramin channel The number of the channel
@paramin timestamp The timestamp of the stream buffer (in msec)
@paramin user_data The user data passed from the callback registration function
@see recorder_set_audio_stream_cb()
@brief Called when the recorder device state is changed.
@since_tizen 3.0
@paramin type The recorder type
@paramin state The state of the recorder device
@paramin user_data The user data passed from the callback registration function
@see recorder_add_device_state_changed_cb()
@brief Called when the error occurred.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@remarks This callback informs about the critical error situation. \n
When being invoked, user should release the resource and terminate the application. \n
This error code will be reported.
#RECORDER_ERROR_DEVICE \n
#RECORDER_ERROR_INVALID_OPERATION \n
#RECORDER_ERROR_OUT_OF_MEMORY.
@paramin error The error code
@paramin current_state The current state of the recorder
@paramin user_data The user data passed from the callback registration function
@pre This callback function is invoked if you register this callback using recorder_set_error_cb().
@see recorder_set_error_cb()
@see recorder_unset_error_cb()
@brief Called when the recorder interrupt is started by a policy.
@since_tizen 4.0
@remarks This callback is called before interrupt handling is started.
@paramin policy The policy that is interrupting the recorder
@paramin state The current state of the recorder
@paramin user_data The user data passed from the callback registration function
@see recorder_set_interrupt_started_cb()
@brief Called when the recorder is interrupted by a policy.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@remarks This callback is called after interrupt handling is completed.
@paramin policy The policy that interrupted the recorder
@paramin previous The previous state of the recorder
@paramin current The current state of the recorder
@paramin user_data The user data passed from the callback registration function
@see recorder_set_interrupted_cb()
@brief Called when muxed stream data is delivered just before writing to the file.
@since_tizen 4.0
@remarks This callback receives the data that will be recorded, \n
but any changes to this data will not affect the recorded file. \n
The @a stream should not be freed and it's valid only in the callback. To use outside the callback, make a copy.
@paramin stream The muxed stream data
@paramin size The size of the stream data
@paramin offset The offset of the stream data
@paramin user_data The user data passed from the callback registration function
@see recorder_set_muxed_stream_cb()
@brief Called when limitation error occurs while recording.
@details The callback function is possible to receive three types of limits: time, size and no-space.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@remarks After being called, recording data is discarded and not written in the recording file. Also the state of recorder is not changed.
@paramin type The imitation type
@paramin user_data The user data passed from the callback registration function
@pre You have to register a callback using recorder_set_recording_limit_reached_cb().
@see recorder_set_recording_status_cb()
@see recorder_set_recording_limit_reached_cb()
@see recorder_unset_recording_limit_reached_cb()
@brief Called to indicate the recording status.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@remarks This callback function is repeatedly invoked during the #RECORDER_STATE_RECORDING state.
@paramin elapsed_time The time of the recording (milliseconds)
@paramin file_size The size of the recording file (KB)
@paramin user_data The user data passed from the callback registration function
@pre recorder_start() will invoke this callback if you register it using recorder_set_recording_status_cb().
@see recorder_set_recording_status_cb()
@see recorder_unset_recording_status_cb()
@see recorder_start()
@brief Called when the record state is changed.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin previous The previous state of the recorder
@paramin current The current state of the recorder
@paramin by_policy @c true if the state is changed by policy, otherwise @c false if the state is not changed
@paramin user_data The user data passed from the callback registration function
@pre This function is required to register a callback using recorder_set_state_changed_cb().
@see recorder_set_state_changed_cb()
@see recorder_prepare()
@see recorder_unprepare()
@see recorder_start()
@see recorder_pause()
@see recorder_commit()
@see recorder_cancel()
@brief Called iteratively to notify about the supported audio encoders.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin codec The codec of audio encoder
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
@pre recorder_foreach_supported_audio_encoder() will invoke this callback.
@see recorder_foreach_supported_audio_encoder()
@brief Called iteratively to notify about the supported file formats.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin format The format of recording files
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
@pre recorder_foreach_supported_file_format() will invoke this callback.
@see recorder_foreach_supported_file_format()
@brief Called iteratively to notify about the supported video encoders.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin codec The codec of video encoder
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
@pre recorder_foreach_supported_video_encoder() will invoke this callback.
@see recorder_foreach_supported_video_encoder()
@brief Called once for each supported video resolution.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin width The video image width
@paramin height The video image height
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
@pre recorder_foreach_supported_video_resolution() will invoke this callback.
@see recorder_foreach_supported_video_resolution()
@brief Called when each video frame is delivered before encoding, \n
and it will be encoded if the application returns @c true, otherwise dropped.
@since_tizen 6.0
@brief Called to receive the result of shortcut_add_to_home().
@since_tizen 2.3
@paramin ret The result value, it could be @c 0 if it succeeds to add a shortcut,
otherwise it returns an errno
@paramin user_data The callback data
@return int @c 0 if there is no error,
otherwise errno
@see shortcut_add_to_home()
@brief The structure type to represent a SQL result set.
@details This type can be used to enumerate through the result set of an SQL query.
@since_tizen 2.3
@brief Called when the proxy is connected.
@details The function is called when the proxy is connected with stub by port.
@since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
@paramin receiver The target stub app id
@paramin port_name The name of the port
@paramin port The rpc port handle for reading and writing
@paramin user_data The user data passed from the register function
@brief Called when the proxy is disconnected.
@details The function is called when the proxy is disconnected from stub.
@since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
@paramin receiver The target stub app id
@paramin port_name The name of the port
@paramin user_data The user data passed from the register function
@brief Called when the proxy received data.
@details The function is called when the proxy received data from stub.
@since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
@paramin receiver The target stub app id
@paramin port_name The name of the port
@paramin user_data The user data passed from the register function
@brief Called when the proxy is rejected.
@details The function is called when the proxy is rejected to connect stub.
@since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
@paramin receiver The target stub app id
@paramin port_name The name of the port
@paramin user_data The user data passed from the register function
@brief Called when the proxy is connected with stub.
@details The function is called when the proxy is connected with stub.
When a proxy connects to stub several times with new port,
you can handle each request by using @a instance.
@since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
@paramin sender The target proxy app id
@paramin instance The information of the request
@paramin user_data The user data passed from the register function
@brief Called when the proxy is disconnected from stub.
@details The function is called when the proxy is disconnected from stub.
When a proxy is disconnected, you can check the request
by using @a instance.
@since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
@paramin sender The target proxy app id
@paramin instance The information of the request
@paramin user_data The user data passed from the register function
@brief Called when the stub received data from proxy.
@details The function is called when the stub received data from stub.
When a stub received data from several ports, you can handle
each request by using @a instance. If the function returns non zero
value, the stub is disconnected.
@since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
@paramin sender The target proxy app id
@paramin instance The information of the request
@paramin port The rpc port handle for reading and writing
@paramin user_data The user data passed from the register function
@return @c zero to continue receive data with the sender,
otherwise @c nonzero to disconnect from the port
@brief Called when the accuracy of a sensor changes.
@details Sensors can be affected by the environment.
For example, #SENSOR_MAGNETIC is sensitive to any surrounding objects that can influence
electromagnetic fields. This function is called if the accuracy of the corresponding sensor is changed.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@deprecated Deprecated since 5.5. Use sensor_events_cb() instead.
@brief Called when a sensor event occurs.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@brief Sensor handle.
@details The handle for controlling a specific sensor can be retrieved using sensor_get_default_sensor().@n
The function returns the handle of the default sensor of a given type, and usually,
a device has one sensor for one type.
However, if the device supports multiple sensors of the same type,
sensor_get_sensor_list() function can be used to get the list of all the sensors of the type.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@brief Sensor listener handle.
@details For each #sensor_h, one or more sensor listeners can be created by using sensor_create_listener().
Then the sensor's data can observed asynchronously, can be read synchronously if available, via the listener.
Applications are also able to control the behavior of each sensor, for example,
update interval of sensor readings.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@brief Sensor provider handle.
@details One or more sensor providers can be created by using sensor_create_provider().
The sensor's data can be published to listeners, via the provider.
@since_tizen 4.0
@brief Called when the query results are retrieved.
@details One of the following errors can be delivered.\n
#SENSOR_ERROR_NONE, Successful\n
#SENSOR_ERROR_OPERATION_FAILED, Operation failed\n
#SENSOR_ERROR_NO_DATA, No data retrieved.
@since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
@brief Option handle to contain recording policies and parameters.
@details one or more sensor options can be created by using sensor_recorder_create_option().
@since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
@brief Query handle to contain filtering and aggregation parameters for recorded data.
@details one or more sensor options can be created by using sensor_recorder_create_query().
@since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
@brief Called when another application sends the launch request to the agent application.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin app_control The handle to the app_control
@paramin user_data The user data passed from the callback registration function
@see service_app_main()
@see #service_app_lifecycle_callback_s
@see @ref CAPI_APP_CONTROL_MODULE API
@brief Called at the start of the agent application.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin user_data The user data passed from the callback registration function
@return @c true on success,
otherwise @c false
@pre service_app_main() will invoke this callback function.
@see service_app_main()
@see #service_app_lifecycle_callback_s
@brief Called once after the main loop of the agent application exits.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin user_data The user data passed from the callback registration function
@see service_app_main()
@see #service_app_lifecycle_callback_s
@brief Called to receive the result of shortcut_get_list().
@since_tizen 2.4
@paramin package_name The name of package
@paramin icon The absolute path of an icon file for this shortcut
@paramin name The name of the created shortcut icon
@paramin extra_key The user data. A property of shortcut element in manifest file
@paramin extra_data The user data. A property of shortcut element in manifest file
@paramin user_data The callback user data
@return SHORTCUT_ERROR_NONE to continue with the next iteration of the loop, other error values to break out of the loop
@see shortcut_get_list()
@brief Called to the shortcut_remove_from_home() request.
@since_tizen 3.0
@paramin package_name The name of package
@paramin name The name of the created shortcut icon
@paramin sender_pid The process ID of who request shortcut_remove_from_home()
@paramin user_data The user data passed from the callback register function
@return The result of handling a shortcut remove request\n
This returns @c 0 if the remove_from_home request is handled successfully,
otherwise it returns a proper errno.
@see shortcut_set_remove_cb()
@brief Called to the add_to_home request.
@details The homescreen should define a callback as this type and implement the service code
for adding a new application shortcut.
@since_tizen 2.4
@paramin package_name The name of package
@paramin name The name of the created shortcut icon
@paramin type One of the three defined types
@paramin content_info The specific information for creating a new shortcut
@paramin icon The absolute path of an icon file for this shortcut
@paramin pid The process ID of who request add_to_home
@paramin period The Update period in seconds
@paramin allow_duplicate @c 1 if the shortcut can be duplicated,
otherwise a shortcut should exist only once
@paramin user_data The callback data
@return The result of handling a shortcut creation request\n
This returns @c 0 if the add_to_home request is handled successfully,
otherwise it returns a proper errno
@see shortcut_set_request_cb()
@brief Called when the connection state is changed.
@since_tizen 5.0
@remarks The @a client should not be released by the application and it is valid only in this function.\n
In order to use it outside this function, a user must copy the client with softap_client_clone().
@paramin client The client of which connection state is changed
@paramin opened @c true when connection is opened, otherwise false
@paramin user_data The user data passed from softap_set_client_connection_state_changed_cb()
@pre If you register callback function using softap_set_client_connection_state_changed_cb(), this will be invoked when the connection state is changed.
@see softap_set_client_connection_state_changed_cb()
@see softap_unset_client_connection_state_changed_cb()
@brief Called when you get the connected client repeatedly.
@since_tizen 5.0
@remarks The @a client should not be released by the application and it is valid only in this function.\n
In order to use the client outside this function, a user must copy the client with softap_client_clone().
@paramin client The connected client
@paramin user_data The user data passed from the request function
@return @c true to continue with the next iteration of the loop, \n @c false to break out of the loop
@pre softap_foreach_connected_clients() will invoke this callback.
@see softap_foreach_connected_clients()
@brief Called when the SoftAP is disabled.
@details The following error codes can be received: \n
#SOFTAP_ERROR_NONE: Success \n
#SOFTAP_ERROR_INVALID_PARAMETER: Invalid parameter \n
#SOFTAP_ERROR_OUT_OF_MEMORY: Out of memory \n
#SOFTAP_ERROR_OPERATION_FAILED: Operation failed \n
@since_tizen 5.0
@paramin result The result of disabling the SoftAP
@paramin cause The cause of disabling
@paramin user_data The user data passed from softap_set_disabled_cb()
@pre If you register callback function using softap_set_disabled_cb(), this will be invoked when the SoftAP is disabled.
@see softap_set_disabled_cb()
@see softap_unset_disabled_cb()
@brief Called when the SoftAP is enabled.
@details The following error codes can be received: \n
#SOFTAP_ERROR_NONE: Success \n
#SOFTAP_ERROR_NOT_PERMITTED: Operation not permitted \n
#SOFTAP_ERROR_INVALID_PARAMETER: Invalid parameter \n
#SOFTAP_ERROR_OUT_OF_MEMORY: Out of memory \n
#SOFTAP_ERROR_OPERATION_FAILED: Operation failed \n
#SOFTAP_ERROR_ALREADY_ENABLED: Already enabled \n
@since_tizen 5.0
@paramin result The result of enabling the SoftAP
@paramin is_requested Indicates whether this change is requested
@paramin user_data The user data passed from softap_set_enabled_cb()
@pre If you register callback function using softap_set_enabled_cb(), this will be invoked when the SoftAP is enabled.
@see softap_enable()
@see softap_unset_enabled_cb()
@brief Called when the passphrase is changed.
@since_tizen 5.0
@paramin user_data The user data passed from the register function
@see softap_set_passphrase_changed_cb()
@see softap_unset_passphrase_changed_cb()
@brief Called when the security type of SoftAP is changed.
@since_tizen 5.0
@paramin changed_type The changed security type
@paramin user_data The user data passed from the register function
@see softap_set_security_type_changed_cb()
@see softap_unset_security_type_changed_cb()
@brief Called when SoftAP settings are reloaded.
@details The following error codes can be received: \n
#SOFTAP_ERROR_NONE: Success \n
#SOFTAP_ERROR_NOT_PERMITTED: Operation not permitted \n
#SOFTAP_ERROR_INVALID_PARAMETER: Invalid parameter \n
#SOFTAP_ERROR_OUT_OF_MEMORY: Out of memory \n
#SOFTAP_ERROR_OPERATION_FAILED: Operation failed \n
@since_tizen 5.0
@paramin result The result of reloading the settings
@paramin user_data The user data passed from the request function
@pre softap_reload_settings() will invoke this callback.
@brief Called when the visibility of SSID is changed.
@since_tizen 5.0
@paramin changed_visible The changed visibility of SSID
@paramin user_data The user data passed from the register function
@see softap_set_ssid_visibility_changed_cb()
@see softap_unset_ssid_visibility_changed_cb()
@deprecated Deprecated since 4.0. Use sound_device_running_changed_cb() instead.
@brief Called when the state of a sound device was changed.
@since_tizen 3.0
@brief Called when the system volume has changed.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin type The sound type of the changed volume
@paramin volume The new volume value
@paramin user_data The user data passed from the callback registration function
@pre sound_manager_set_volume() will invoke this callback if you register it using sound_manager_add_volume_changed_cb().
@see sound_manager_add_volume_changed_cb()
@see sound_manager_remove_volume_changed_cb()
@brief Called when a service has become available or unavailable.
@since_tizen 3.0
@paramin state The state of found service
@paramin ssdp_service The SSDP remote service handle
@paramin user_data The user data passed from the request function
@see ssdp_start_browsing_service()
@brief Called when the registration of SSDP service is finished.
@since_tizen 3.0
@paramin result The result of registration
@paramin ssdp_local_service The SSDP local service handle
@paramin user_data The user data passed from the request function
@see ssdp_register_local_service()
@brief Called when getting all statistical information is finished.
@details One of the following errors is delivered as a result.
#STC_ERROR_NONE Successful \n
#STC_ERROR_INVALID_OPERATION No reply \n
#STC_ERROR_OPERATION_FAILED Operation failed \n
#STC_ERROR_PERMISSION_DENIED Access or permission denied
@since_tizen 5.5
@remarks @a info will be released by the platform after the callback exits.
@brief Called whenever there is available statistical information.
@details One of the following errors is delivered as a result.
#STC_ERROR_NONE Successful \n
#STC_ERROR_INVALID_OPERATION No reply \n
#STC_ERROR_OPERATION_FAILED Operation failed \n
#STC_ERROR_PERMISSION_DENIED Access or permission denied
@since_tizen 4.0
@brief Called when the state of a storage type changes.
@since_tizen 3.0
@paramin storage_id The unique storage ID
@paramin dev The type of the external storage device
@paramin state The state of the storage
@paramin fstype The type of the file system
@paramin fsuuid The uuid of the file system
@paramin mountpath The mount path of the file system
@paramin primary The primary partition
@paramin flags The flags for the storage status
@paramin user_data The user data
@pre storage_set_changed_cb() will invoke this callback function.
@see storage_set_changed_cb()
@see storage_unset_changed_cb()
@brief Called to get information once for each supported storage.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin storage_id The unique storage ID
@paramin type The type of the storage
@paramin state The current state of the storage
@paramin path The absolute path to the root directory of the storage
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, \n
otherwise @c false to break out of the loop
@pre storage_foreach_device_supported() will invoke this callback function.
@see storage_foreach_device_supported()
@brief Called when the state of storage changes.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin storage_id The unique storage ID
@paramin state The current state of the storage
@paramin user_data The user data passed from the foreach function
@pre storage_set_state_changed_cb() will invoke this callback function.
@see storage_set_state_changed_cb()
@see storage_unset_state_changed_cb()
@brief Called iteratively to notify about the buffer has been consumed.
@since_tizen 3.0
@remarks The user needs to release consumed buffer if buffer is allocated by user including media packet
@paramin buffer The consumed buffer that user pushed
@paramin user_data The user data passed
@see streamrecorder_set_buffer_consume_completed_cb() will invoke this callback.
@see streamrecorder_unset_buffer_consume_completed_cb()
@brief Called when the error occurred.
@since_tizen 3.0
@remarks This callback informs about the critical error situation. \n
When being invoked, user should release the resource and terminate the application. \n
This error code will be reported. \n
#STREAMRECORDER_ERROR_INVALID_OPERATION \n
#STREAMRECORDER_ERROR_OUT_OF_MEMORY
@paramin error The error code
@paramin current_state The current state of the streamrecorder
@paramin user_data The user data passed from the callback registration function
@pre This callback function is invoked if you register this callback using streamrecorder_set_error_cb().
@see streamrecorder_set_error_cb()
@see streamrecorder_unset_error_cb()
@brief Called when the streamrecorder gets some notifications.
@since_tizen 3.0
@paramin previous The previous state of the streamrecorder
@paramin current The current state of the streamrecorder
@paramin notification The notification type of the streamrecorder
@paramin user_data The user data passed from the callback registration function
@pre This function is required to register a callback using streamrecorder_set_notify_cb().
@see streamrecorder_set_notify_cb()
@see streamrecorder_prepare()
@see streamrecorder_unprepare()
@see streamrecorder_start()
@see streamrecorder_pause()
@see streamrecorder_commit()
@see streamrecorder_cancel()
@brief Called when limitation error occurs while recording.
@details The callback function is possible to receive three types of limits: time and size.
@since_tizen 3.0
@remarks After being called, recording data except present recorded data will be discarded and not written in the recording file. Also the state of streamrecorder is not changed.
@paramin type The imitation type
@paramin user_data The user data passed from the callback registration function
@pre You have to register a callback using streamrecorder_set_recording_limit_reached_cb().
@see streamrecorder_set_recording_status_cb()
@see streamrecorder_set_recording_limit_reached_cb()
@see streamrecorder_unset_recording_limit_reached_cb()
@brief Called to indicate the recording status.
@since_tizen 3.0
@remarks This callback function is repeatedly invoked during the #STREAMRECORDER_STATE_RECORDING state.
@paramin elapsed_time The time of the recording (milliseconds)
@paramin file_size The size of the recording file (KB)
@paramin user_data The user data passed from the callback registration function
@pre streamrecorder_start() will invoke this callback if you register it using streamrecorder_set_recording_status_cb().
@see streamrecorder_set_recording_status_cb()
@see streamrecorder_unset_recording_status_cb()
@see streamrecorder_start()
@brief Called iteratively to notify about the supported audio encoders.
@since_tizen 3.0
@paramin codec The codec of audio encoder
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
@pre streamrecorder_foreach_supported_audio_encoder() will invoke this callback.
@see streamrecorder_foreach_supported_audio_encoder()
@brief Called iteratively to notify about the supported file formats.
@since_tizen 3.0
@paramin format The format of recording files
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
@pre streamrecorder_foreach_supported_file_format() will invoke this callback.
@see streamrecorder_foreach_supported_file_format()
@brief Called iteratively to notify about the supported video encoders.
@since_tizen 3.0
@paramin codec The codec of video encoder
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
@pre streamrecorder_foreach_supported_video_encoder() will invoke this callback.
@see streamrecorder_foreach_supported_video_encoder()
@brief Called once for each supported video resolution.
@since_tizen 3.0
@paramin width The video image width
@paramin height The video image height
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
@pre streamrecorder_foreach_supported_video_resolution() will invoke this callback.
@see streamrecorder_foreach_supported_video_resolution()
@brief Called when the default language is changed.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin stt The STT handle
@paramin previous_language A previous language
@paramin current_language A current language
@paramin user_data The user data passed from the callback registration function
@see stt_set_default_language_changed_cb()
@brief Called when the engine is changed.
@since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
@remarks The language is specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code. For example, "ko_KR" for Korean, "en_US" for American English.
@paramin stt The STT handle
@paramin engine_id Engine ID
@paramin language The default language
@paramin support_silence Whether the silence detection is supported or not
@paramin need_credential The necessity of credential
@paramin user_data The user data passed from the callback registration function
@see stt_set_engine_changed_cb()
@brief Called when an error occurs.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin stt The STT handle
@paramin reason The error type (e.g. #STT_ERROR_OUT_OF_NETWORK, #STT_ERROR_IO_ERROR)
@paramin user_data The user data passed from the callback registration function
@pre An application registers this callback using stt_set_error_cb() to detect error.
@see stt_set_error_cb()
@see stt_unset_error_cb()
@brief Called when STT gets the recognition result from the engine.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@remarks After stt_stop() is called, silence is detected from recording, or partial result is occurred, this function is called.
@paramin stt The STT handle
@paramin event The result event
@paramin data Result texts
@paramin data_count Result text count
@paramin msg Engine message (e.g. #STT_RESULT_MESSAGE_NONE, #STT_RESULT_MESSAGE_ERROR_TOO_SHORT)
@paramin user_data The user data passed from the callback registration function
@pre stt_stop() will invoke this callback if you register it using stt_set_result_cb().
@post If this function is called and event is #STT_RESULT_EVENT_FINAL_RESULT, the STT state will be #STT_STATE_READY.
@see stt_stop()
@see stt_set_recognition_result_cb()
@see stt_unset_recognition_result_cb()
@brief Called when STT get the result time stamp in free partial type.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin stt The STT handle
@paramin index The result index
@paramin event The token event
@paramin text The result text
@paramin start_time The start time of result text
@paramin end_time The end time of result text
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop
otherwise @c false to break out of the loop
@pre stt_recognition_result_cb() should be called.
@see stt_recognition_result_cb()
@brief Called when STT engine detects the beginning or end of the speech.
@since_tizen 5.5
@paramin stt The STT handle
@paramin status The speech status
@paramin user_data The user data passed from the callback registration function
@see stt_set_speech_status_cb()
@brief Called when the state of STT is changed.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin stt The STT handle
@paramin previous A previous state
@paramin current A current state
@paramin user_data The user data passed from the callback registration function
@pre An application registers this callback using stt_set_state_changed_cb() to detect changing state.
@see stt_set_state_changed_cb()
@see stt_unset_state_changed_cb()
@brief Called to get the engine information.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin stt The STT handle
@paramin engine_id Engine ID
@paramin engine_name Engine name
@paramin user_data User data passed from the stt_setting_foreach_supported_engines()
@return @c true to continue with the next iteration of the loop,
otherwise @c false to break out of the loop
@pre stt_foreach_supported_engines() will invoke this callback.
@see stt_foreach_supported_engines()
@brief Called to retrieve the supported languages.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@remarks The language is specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code. For example, "ko_KR" for Korean, "en_US" for American English.
@paramin stt The STT handle
@paramin language The language
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop,
@c false to break out of the loop
@pre stt_foreach_supported_languages() will invoke this callback.
@see stt_foreach_supported_languages()
@brief Called when the engine service user sets audio recording type.
@since_tizen 5.5
@remarks The @a audio_type can be used only in the callback. To use outside, make a copy.
@paramin audio_type Current audio type (e.g. #STTE_AUDIO_ID_BLUETOOTH or #STTE_AUDIO_ID_WIFI)
@paramin user_data user_data The user data to be passed to the callback function
@return 0 on success, otherwise a negative error value.
@retval #VCE_ERROR_NONE Successful.
@retval #STTE_ERROR_INVALID_PARAMETER Invalid parameter
@retval #STTE_ERROR_OPERATION_FAILED Operation failure
@brief Called when the engine service user cancels to recognize the recording data.
@details This callback function is called by the engine service user to cancel to recognize the recording data.
Also, when starting the recorder is failed, this function is called.
@since_tizen 3.0
@remarks This callback function is mandatory and must be registered using stte_main().
@return @c 0 on success,
otherwise a negative error value
@retval #STTE_ERROR_NONE Successful.
@retval #STTE_ERROR_INVALID_STATE Invalid state.
@pre STT engine is in recognition processing or recording.
@see stte_start_cb()
@see stte_stop_cb()
@brief Called when the engine service user requests for STT engine to check whether the application agreed the usage of STT engine.
@details This callback function is called when the engine service user requests for STT engine to check the application's agreement about using the engine.
According to the need, the engine developer can provide some user interfaces to check the agreement.
@since_tizen 3.0
@remarks This callback function is mandatory and must be registered using stte_main().
If the STT engine developer wants not to check the agreement, the developer has need to return proper values as @a is_agreed in accordance with the intention. @c true if the developer regards that every application agreed the usage of the engine, @c false if the developer regards that every application disagreed.
NOTE that, however, there may be any legal issue unless the developer checks the agreement. Therefore, we suggest that the engine developers should provide a function to check the agreement.
@paramin appid The Application ID
@paramout is_agreed A variable for checking whether the application agreed to use STT engine or not.
@c true to agree,
@c false to disagree
@return @c 0 on success,
otherwise a negative error value
@retval #STTE_ERROR_NONE Successful
@retval #STTE_ERROR_INVALID_STATE Not initialized
@retval #STTE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature
@brief Called when the engine service user deinitializes STT engine
@details This callback function is called by the engine service user to request for STT engine to be deinitialized.
@since_tizen 3.0
@remarks This callback function is mandatory and must be registered using stte_main().
NOTE that the engine may be terminated automatically.
When this callback function is invoked, the release of resources is necessary.
@return @c 0 on success,
otherwise a negative error value
@retval #STTE_ERROR_NONE Successful
@retval #STTE_ERROR_INVALID_STATE Not initialized
@see stte_initialize_cb()
@brief Called when the engine service user gets the result time information(stamp).
@since_tizen 3.0
@remarks This callback function is mandatory and must be registered using stte_main().
In this function, the engine service user's callback function 'stte_result_time_cb()' is invoked repeatedly for sending the time information to the engine service user, and @a user_data must be transferred to 'stte_result_time_cb()'.
If 'stte_result_time_cb()' returns @c false, it should be stopped to call 'stte_result_time_cb()'.
@a time_info is transferred from stte_send_result(). The type of @a time_info is up to the STT engine developer.
@paramin time_info The time information
@paramin callback The callback function
@paramin user_data The user data which must be passed to the callback function 'stte_result_time_cb()'
@return @c 0 on success,
otherwise a negative error value
@retval #STTE_ERROR_NONE Successful
@retval #STTE_ERROR_INVALID_PARAMETER Invalid parameter
@retval #STTE_ERROR_INVALID_STATE Not initialized
@pre stte_send_result() will invoke this function.
@post This function invokes stte_result_time_cb() repeatedly for getting result time information.
@see stte_result_time_cb()
@brief Called when the engine service user gets the whole supported language list.
@since_tizen 3.0
@remarks This callback function is mandatory and must be registered using stte_main().
In this function, the engine service user's callback function 'stte_supported_language_cb()' is invoked repeatedly for getting all supported languages, and @a user_data must be transferred to 'stte_supported_language_cb()'.
If 'stte_supported_language_cb()' returns @c false, it should be stopped to call 'stte_supported_language_cb()'.
@paramin callback The callback function
@paramin user_data The user data which must be passed to the callback function 'stte_supported_language_cb()'
@return @c 0 on success,
otherwise a negative error value
@retval #STTE_ERROR_NONE Successful
@retval #STTE_ERROR_INVALID_PARAMETER Invalid parameter
@retval #STTE_ERROR_INVALID_STATE Not initialized
@post This callback function invokes stte_supported_language_cb() repeatedly for getting supported languages.
@see stte_supported_language_cb()
@brief Called when the engine service user requests the basic information of STT engine.
@since_tizen 3.0
@remarks This callback function is mandatory and must be registered using stte_main().
The allocated @a engine_uuid, @a engine_name, and @a engine_setting will be released internally.
In order to upload the engine at Tizen Appstore, both a service app and a ui app are necessary.
Therefore, @a engine_setting must be transferred to the engine service user.
@paramout engine_uuid UUID of engine
@paramout engine_name Name of engine
@paramout engine_setting The engine setting application(ui app)'s app ID
@paramout use_network A variable for checking whether the network is used or not
@return @c 0 on success,
otherwise a negative error code on failure
@retval #STTE_ERROR_NONE Successful
@retval #STTE_ERROR_INVALID_PARAMETER Invalid parameter
@retval #STTE_ERROR_OPERATION_FAILED Operation failure
@brief Called when the engine service user gets the proper recording format of STT engine.
@since_tizen 3.0
@remarks This callback function is mandatory and must be registered using stte_main().
The recording format is used for creating the recorder.
@paramout types The format used by the recorder
@paramout rate The sample rate used by the recorder
@paramout channels The number of channels used by the recorder
@return @c 0 on success,
otherwise a negative error value
@retval #STTE_ERROR_NONE Successful
@retval #STTE_ERROR_INVALID_STATE Not initialized
@brief Called when the engine service user initializes STT engine.
@details This callback function is called by the engine service user to request for STT engine to be started.
@since_tizen 3.0
@remarks This callback function is mandatory and must be registered using stte_main().
@return @c 0 on success,
otherwise a negative error value
@retval #STTE_ERROR_NONE Successful
@retval #STTE_ERROR_INVALID_PARAMETER Invalid parameter
@retval #STTE_ERROR_INVALID_STATE Already initialized
@retval #STTE_ERROR_OPERATION_FAILED Operation failure
@see stte_deinitialize_cb()
@brief Called when the engine service user checks whether the corresponding language is valid or not in STT engine.
@since_tizen 3.0
@remarks This callback function is mandatory and must be registered using stte_main().
@paramin language The language is specified as an ISO 3166 alpha-2 two letter country-code
followed by ISO 639-1 for the two-letter language code
For example, "ko_KR" for Korean, "en_US" for American English
@paramout is_valid A variable for checking whether the corresponding language is valid or not.
@c true to be valid,
@c false to be invalid
@return @c 0 on success,
otherwise a negative error value
@retval #STTE_ERROR_NONE Successful
@retval #STTE_ERROR_INVALID_PARAMETER Invalid parameter
@see stte_foreach_supported_langs_cb()
@brief Called when the engine service user checks whether STT engine needs the application's credential.
@since_tizen 3.0
@remarks This callback function is mandatory and must be registered using stte_main().
@return @c true if STT engine needs the application's credential,
otherwise @c false
@brief Called when STT engine provides the engine service user with the private data.
@details This callback function is called when the engine service user gets the private data from STT engine.
@since_tizen 3.0
@remarks This callback function is optional and is registered using stte_set_private_data_requested_cb().
@paramout key The key field of private data
@paramout data The data field of private data
@return @c 0 on success,
otherwise a negative error value
@retval #STTE_ERROR_NONE Successful
@retval #STTE_ERROR_INVALID_PARAMETER Invalid parameter
@retval #STTE_ERROR_OPERATION_FAILED Operation failure
@see stte_private_data_set_cb()
@see stte_set_private_data_requested_cb()
@brief Called when STT engine receives the private data from the engine service user.
@details This callback function is called when the engine service user sends the private data to STT engine.
@since_tizen 3.0
@remarks This callback function is optional and is registered using stte_set_private_data_set_cb().
@paramin key The key field of private data
@paramin data The data field of private data
@return @c 0 on success,
otherwise a negative error value
@retval #STTE_ERROR_NONE Successful
@retval #STTE_ERROR_INVALID_PARAMETER Invalid parameter
@retval #STTE_ERROR_OPERATION_FAILED Operation failure
@see stte_private_data_requested_cb()
@see stte_set_private_data_set_cb()
@brief Called when STT engine provides the time stamp of result to the engine service user.
@details This callback function is implemented by the engine service user. Therefore, the engine developer does NOT have to implement this callback function.
@since_tizen 3.0
@remarks This callback function is called in stte_foreach_result_time_cb() for adding time information.
@a user_data must be transferred from stte_foreach_result_time_cb().
@paramin index The result index
@paramin event The token event
@paramin text The result text
@paramin start_time The time started speaking the result text
@paramin end_time The time finished speaking the result text
@paramin user_data The user data passed from stte_foreach_result_time_cb()
@return @c true to continue with the next iteration of the loop
@c false to break out of the loop
@pre stte_send_result() should be called.
@see stte_send_result()
@see stte_foreach_result_time_cb()
@brief Called when the engine service user sets and sends the recording data for speech recognition.
@details This callback function is called by the engine service user to send the recording data to STT engine.
The engine receives the recording data and uses for speech recognition.
@since_tizen 3.0
@remarks This callback function is mandatory and must be registered using stte_main().
Also, this function should be returned immediately after recording data copy.
@paramin data The recording data
@paramin length The length of recording data
@return @c 0 on success,
otherwise a negative error value
@retval #STTE_ERROR_NONE Successful
@retval #STTE_ERROR_INVALID_PARAMETER Invalid parameter
@retval #STTE_ERROR_INVALID_STATE Invalid state
@retval #STTE_ERROR_OPERATION_FAILED Operation failure
@pre stte_start_cb() should succeed.
@post If the engine supports partial result, stte_send_result() should be invoked.
@see stte_start_cb()
@see stte_cancel_cb()
@see stte_stop_cb()
@brief Called when the engine service user sets the silence detection.
@since_tizen 3.0
@remarks This callback function is mandatory and must be registered using stte_main().
If the engine service user sets this option as 'TRUE', STT engine will detect the silence (EPD) and send the callback event about it.
@paramin is_set A variable for setting the silence detection.
@c true to detect the silence,
@c false not to detect the silence
@return @c 0 on success,
otherwise a negative error value
@retval #STTE_ERROR_NONE Successful
@retval #STTE_ERROR_INVALID_STATE Not initialized
@retval #STTE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature
@brief Called when the engine service user starts to recognize the recording data.
@since_tizen 3.0
@remarks This callback function is mandatory and must be registered using stte_main().
In this callback function, STT engine must transfer the recognition result and @a user_data to the engine service user using stte_send_result().
Also, if STT engine needs the application's credential, it sets the credential granted to the application.
@paramin language The language is specified as an ISO 3166 alpha-2 two letter country-code
followed by ISO 639-1 for the two-letter language code
For example, "ko_KR" for Korean, "en_US" for American English
@paramin type The recognition type. (e.g. #STTE_RECOGNITION_TYPE_FREE)
@paramin appid The Application ID
@paramin credential The credential granted to the application
@paramin user_data The user data to be passed to the callback function
@return @c 0 on success,
otherwise a negative error value
@retval #STTE_ERROR_NONE Successful
@retval #STTE_ERROR_INVALID_PARAMETER Invalid parameter
@retval #STTE_ERROR_INVALID_STATE Invalid state
@retval #STTE_ERROR_INVALID_LANGUAGE Invalid language
@retval #STTE_ERROR_OPERATION_FAILED Operation failure
@retval #STTE_ERROR_NETWORK_DOWN Out of network
@pre The engine is not in recognition processing.
@see stte_set_recording_data_cb()
@see stte_stop_cb()
@see stte_cancel_cb()
@see stte_need_app_credential_cb()
@brief Called when the engine service user stops to recognize the recording data.
@details This callback function is called by the engine service user to stop recording and to get the recognition result.
@since_tizen 3.0
@remarks This callback function is mandatory and must be registered using stte_main().
@return @c 0 on success,
otherwise a negative error value
@retval #STTE_ERROR_NONE Successful
@retval #STTE_ERROR_INVALID_STATE Invalid state
@retval #STTE_ERROR_OPERATION_FAILED Operation failure
@retval #STTE_ERROR_NETWORK_DOWN Out of network
@pre stte_start_cb() should succeed.
@post After processing of the engine, stte_send_result() must be called.
@see stte_start_cb()
@see stte_set_recording_data_cb()
@see stte_cancel_cb()
@see stte_send_result()
@brief Called when the engine service user checks whether STT engine supports the corresponding recognition type.
@since_tizen 3.0
@remarks This callback function is mandatory and must be registered using stte_main().
@paramin type The type for recognition (e.g. #STTE_RECOGNITION_TYPE_FREE)
@paramout is_supported A variable for checking whether STT engine supports the corresponding recognition type.
@c true to support recognition type,
@c false not to support recognition type
@return @c 0 on success,
otherwise a negative error value
@retval #STTE_ERROR_NONE Successful
@retval #STTE_ERROR_INVALID_PARAMETER Invalid parameter
@brief Called when the engine service user checks whether STT engine supports silence detection.
@since_tizen 3.0
@remarks This callback function is mandatory and must be registered using stte_main().
@return @c true to support silence detection,
@c false not to support silence detection
@see stte_set_silence_detection_cb()
@brief Called when STT engine informs the engine service user about whole supported language list.
@details This callback function is implemented by the engine service user. Therefore, the engine developer does NOT have to implement this callback function.
@since_tizen 3.0
@remarks This callback function is called in stte_foreach_supported_langs_cb() to inform the whole supported language list.
@a user_data must be transferred from stte_foreach_supported_langs_cb().
@paramin language The language is specified as an ISO 3166 alpha-2 two letter country-code
followed by ISO 639-1 for the two-letter language code
For example, "ko_KR" for Korean, "en_US" for American English
@paramin user_data The user data passed from stte_foreach_supported_langs_cb()
@return @c true to continue with the next iteration of the loop
@c false to break out of the loop
@pre stte_foreach_supported_langs_cb() will invoke this callback function.
@see stte_foreach_supported_langs_cb()
@brief Called when the system settings changes.
@since_tizen 2.3
@paramin key The key name of the system settings changed system settings
@paramin user_data The user data passed from the callback registration function
@pre system_settings_set_changed_cb() will invoke this callback function.
@see system_settings_set_changed_cb()
@see system_settings_unset_changed_cb()
@platform
@brief Called to get each string value from string typed list.
@since_tizen 3.0
@paramin index zero based number indicating index of node in a list
@paramin value value returned from the list
@paramin cb_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, otherwise false to break out of the loop
@ingroup CAPI_MEDIA_THUMBNAIL_UTIL_MODULE
@deprecated Deprecated since 5.0.
@brief Called when creating the thumbnail.
@details This callback is called for completion of generating the thumbnail.
The following error codes can be received: \n
#THUMBNAIL_UTIL_ERROR_NONE : Successful
#THUMBNAIL_UTIL_ERROR_INVALID_PARAMETER : Invalid parameter
#THUMBNAIL_UTIL_ERROR_PERMISSION_DENIED : Permission denied
@ingroup CAPI_MEDIA_THUMBNAIL_UTIL_MODULE
@deprecated Deprecated since 5.0.
@brief The structure type for the thumbnail info handle.
@since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
@brief Called when the default voice is changed.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin tts The TTS handle
@paramin previous_language The previous language
@paramin previous_voice_type The previous voice type
@paramin current_language The current language
@paramin current_voice_type The current voice type
@paramin user_data The user data passed from the callback registration function
@see tts_set_default_voice_changed_cb()
@brief Called when the engine is changed.
@since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
@paramin tts The TTS handle
@paramin engine_id Engine ID
@paramin language The default language specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code (for example, "ko_KR" for Korean, "en_US" for American English)
@paramin voice_type The default voice type
@paramin need_credential The necessity of credential
@paramin user_data The user data passed from the callback registration function
@see tts_set_engine_changed_cb()
@brief Called when an error occurs.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin tts The TTS handle
@paramin utt_id The utterance ID passed from the add text function
@paramin reason The error code
@paramin user_data The user data passed from the callback registration function
@pre An application registers this callback using tts_set_error_cb() to detect error.
@see tts_play()
@see tts_pause()
@see tts_stop()
@see tts_set_error_cb()
@see tts_unset_error_cb()
@brief Called when the option of screen reader is changed.
@since_tizen 6.5
@paramin tts The TTS handle
@paramin is_on The status of screen reader. If @a is_on is @c true, screen reader is turned on. If not, it is turned off.
@paramin user_data The user data passed from the callback registration function
@see tts_set_screen_reader_changed_cb()
@brief Called when the state of TTS is changed.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@details If the daemon must stop player because of changing engine and
the daemon must pause player because of other requests, this callback function is called.
@paramin tts The TTS handle
@paramin previous The previous state
@paramin current The current state
@paramin user_data The user data passed from the callback registration function
@pre An application registers this callback using tts_set_state_changed_cb() to detect changing state.
@see tts_set_state_changed_cb()
@see tts_unset_state_changed_cb()
@brief Called to retrieve the supported voice.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin tts The TTS handle
@paramin language Language specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code (for example, "ko_KR" for Korean, "en_US" for American English)
@paramin voice_type A voice type (e.g. #TTS_VOICE_TYPE_MALE, #TTS_VOICE_TYPE_FEMALE)
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop,
@c false to break out of the loop
@pre tts_foreach_supported_voices() will invoke this callback function.
@see tts_foreach_supported_voices()
@brief Called when utterance is finished.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin tts The TTS handle
@paramin utt_id The utterance ID passed from the add text function
@paramin user_data The user data passed from the callback registration function
@pre An application registers this callback using tts_set_utterance_completed_cb() to detect utterance completed.
@see tts_add_text()
@see tts_set_utterance_completed_cb()
@see tts_unset_utterance_completed_cb()
@brief Called when utterance has started.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin tts The TTS handle
@paramin utt_id The utterance ID passed from the add text function
@paramin user_data The user data passed from the callback registration function
@pre An application registers this callback using tts_set_utterance_started_cb() to detect utterance started.
@see tts_add_text()
@see tts_set_utterance_started_cb()
@see tts_unset_utterance_started_cb()
@brief Called when the engine service user cancels to synthesize a voice.
@since_tizen 3.0
@remarks This callback function is mandatory and must be registered using ttse_main().
@return @c 0 on success,
otherwise a negative error value
@retval #TTSE_ERROR_NONE Successful
@retval #TTSE_ERROR_INVALID_STATE Not initialized or not started synthesis
@pre The ttse_start_synthesis_cb() should be performed
@see ttse_start_synthesis_cb()
@brief Called when the engine service user requests for TTS engine to check whether the application agreed the usage of TTS engine.
@details This callback function is called when the engine service user requests for TTS engine to check the application's agreement about using the engine.
According to the need, the engine developer can provide some user interfaces to check the agreement.
@since_tizen 3.0
@remarks This callback function is mandatory and must be registered using ttse_main().
If the TTS engine developer wants not to check the agreement, the developer has need to return proper values as @a is_agreed in accordance with the intention. @c true if the developer regards that every application agreed the usage of the engine, @c false if the developer regards that every application disagreed.
NOTE that, however, there may be any legal issue unless the developer checks the agreement. Therefore, we suggest that the engine developers should provide a function to check the agreement.
@paramin appid The Application ID
@paramout is_agreed A variable for checking whether the application agreed to use TTS engine or not.
@c true to agree,
@c false to disagree
@return @c 0 on success,
otherwise a negative error value
@retval #TTSE_ERROR_NONE Successful
@retval #TTSE_ERROR_INVALID_STATE Not initialized
@retval #TTSE_ERROR_INVALID_PARAMETER Invalid parameter
@retval #TTSE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature
@brief Called when the engine service user deinitializes TTS engine.
@since_tizen 3.0
@remarks This callback function is mandatory and must be registered using ttse_main().
NOTE that the engine may be terminated automatically.
When this callback function is invoked, the release of resources is necessary.
@return @c 0 on success,
otherwise a negative error value
@retval #TTSE_ERROR_NONE Successful
@retval #TTSE_ERROR_INVALID_STATE Not initialized
@see ttse_initialize_cb()
@brief Called when the engine service user gets the whole supported voice list.
@since_tizen 3.0
@remarks This callback function is mandatory and must be registered using ttse_main().
In this function, the engine service user's callback function 'ttse_supported_voice_cb()' is invoked repeatedly for getting all supported voices, and @a user_data must be transferred to 'ttse_supported_voice_cb()'.
If 'ttse_supported_voice_cb()' returns @c false, it should be stopped to call 'ttse_supported_voice_cb()'.
@paramin callback The callback function
@paramin user_data The user data which must be passed to ttse_supported_voice_cb()
@return @c 0 on success,
otherwise a negative error value
@retval #TTSE_ERROR_NONE Successful
@retval #TTSE_ERROR_INVALID_PARAMETER Invalid parameter
@retval #TTSE_ERROR_INVALID_STATE Not initialized
@post This callback function invokes ttse_supported_voice_cb() repeatedly for getting all supported voices.
@see ttse_supported_voice_cb()
@brief Called when the engine service user requests the basic information of TTS engine.
@since_tizen 3.0
@remarks This callback function is mandatory and must be registered using ttse_main().
The allocated @a engine_uuid, @a engine_name, and @a engine_setting will be released internally.
In order to upload the engine at Tizen Appstore, both a service app and a ui app are necessary.
Therefore, @a engine_setting must be transferred to the engine service user.
@paramout engine_uuid UUID of engine
@paramout engine_name Name of engine
@paramout engine_setting The engine setting application(ui app)'s app ID
@paramout use_network The status for using network
@return @c 0 on success,
otherwise a negative error code on failure
@retval #TTSE_ERROR_NONE Successful
@retval #TTSE_ERROR_INVALID_PARAMETER Invalid parameter
@retval #TTSE_ERROR_OPERATION_FAILED Operation failure
@brief Called when the engine service user initializes TTS engine.
@since_tizen 3.0
@remarks This callback function is mandatory and must be registered using ttse_main().
@return @c 0 on success,
otherwise a negative error value
@retval #TTSE_ERROR_NONE Successful
@retval #TTSE_ERROR_INVALID_PARAMETER Invalid parameter
@retval #TTSE_ERROR_INVALID_STATE Already initialized
@retval #TTSE_ERROR_OPERATION_FAILED Operation failure
@retval #TTSE_ERROR_PERMISSION_DENIED Permission denied
@see ttse_deinitialize_cb()
@brief Called when the engine service user checks whether the voice is valid or not in TTS engine.
@since_tizen 3.0
@remarks This callback function is mandatory and must be registered using ttse_main().
@paramin language The language is specified as an ISO 3166 alpha-2 two-letter country code
followed by ISO 639-1 for the two-letter language code.
For example, "ko_KR" for Korean, "en_US" for American English
@paramin type The voice type
@paramout is_valid A variable for checking whether the corresponding voice is valid or not.
@c true to be valid,
@c false to be invalid
@return @c 0 on success,
otherwise a negative error value
@retval #TTSE_ERROR_NONE Successful
@retval #TTSE_ERROR_INVALID_PARAMETER Invalid parameter
@see ttse_foreach_supported_voices_cb()
@brief Called when the engine service user requests to load the corresponding voice type for the first time.
@since_tizen 3.0
@remarks This callback function is mandatory and must be registered using ttse_main().
@paramin language The language is specified as an ISO 3166 alpha-2 two-letter country code
followed by ISO 639-1 for the two-letter language code.
For example, "ko_KR" for Korean, "en_US" for American English
@paramin type The voice type
@return @c 0 on success,
otherwise a negative error value
@retval #TTSE_ERROR_NONE Successful
@retval #TTSE_ERROR_INVALID_PARAMETER Invalid parameter
@retval #TTSE_ERROR_INVALID_STATE Not initialized
@retval #TTSE_ERROR_OUT_OF_MEMORY Out of memory
@retval #TTSE_ERROR_INVALID_VOICE Invalid voice
@retval #TTSE_ERROR_OPERATION_FAILED Operation failure
@see ttse_unload_voice_cb()
@brief Called when the engine service user checks whether TTS engine needs the application's credential.
@since_tizen 3.0
@remarks This callback function is mandatory and must be registered using ttse_main().
@return @c true if TTS engine needs the application's credential,
otherwise @c false
@brief Called when TTS engine provides the engine service user with the private data.
@details This callback function is called when the engine service user gets the private data from TTS engine.
@since_tizen 3.0
@remarks This callback function is optional and is registered using ttse_set_private_data_requested_cb().
@paramout key The key field of private data
@paramout data The data field of private data
@return @c 0 on success,
otherwise a negative error value
@retval #TTSE_ERROR_NONE Successful
@retval #TTSE_ERROR_INVALID_PARAMETER Invalid parameter
@retval #TTSE_ERROR_OPERATION_FAILED Operation failure
@retval #TTSE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature
@see ttse_private_data_set_cb()
@see ttse_set_private_data_requested_cb()
@brief Called when TTS engine receives the private data from the engine service user.
@details This callback function is called when the engine service user sends the private data to TTS engine.
@since_tizen 3.0
@remarks This callback function is optional and is registered using ttse_set_private_data_set_cb().
@paramin key The key field of private data
@paramin data The data field of private data
@return @c 0 on success,
otherwise a negative error value
@retval #TTSE_ERROR_NONE Successful
@retval #TTSE_ERROR_INVALID_PARAMETER Invalid parameter
@retval #TTSE_ERROR_OPERATION_FAILED Operation failure
@retval #TTSE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature
@see ttse_private_data_requested_cb()
@see ttse_set_private_data_set_cb()
@brief Called when the engine service user sets the default pitch of TTS engine.
@since_tizen 3.0
@remarks This callback function is mandatory and must be registered using ttse_main().
@paramin pitch The default pitch
@return @c 0 on success,
otherwise a negative error value
@retval #TTSE_ERROR_NONE Successful
@retval #TTSE_ERROR_INVALID_PARAMETER Invalid parameter
@retval #TTSE_ERROR_INVALID_STATE Not initialized
@retval #TTSE_ERROR_OPERATION_FAILED Operation failure
@brief Called when the engine service user starts to synthesize a voice, asynchronously.
@since_tizen 3.0
@remarks This callback function is mandatory and must be registered using ttse_main().
In this callback function, TTS engine must transfer the synthesized result and @a user_data to the engine service user using ttse_send_result().
Also, if TTS engine needs the application's credential, it can set the credential granted to the application.
@paramin language The language is specified as an ISO 3166 alpha-2 two-letter country code
followed by ISO 639-1 for the two-letter language code.
For example, "ko_KR" for Korean, "en_US" for American English
@paramin type The voice type
@paramin text Texts
@paramin speed The speed of speaking
@paramin appid The Application ID
@paramin credential The credential granted to the application
@paramin user_data The user data which must be passed to ttse_send_result()
@return @c 0 on success,
otherwise a negative error value
@retval #TTSE_ERROR_NONE Successful
@retval #TTSE_ERROR_INVALID_PARAMETER Invalid parameter
@retval #TTSE_ERROR_INVALID_STATE Not initialized or already started synthesis
@retval #TTSE_ERROR_INVALID_VOICE Invalid voice
@retval #TTSE_ERROR_OPERATION_FAILED Operation failure
@retval #TTSE_ERROR_NETWORK_DOWN Out of network
@retval #TTSE_ERROR_PERMISSION_DENIED Permission denied
@post This function invokes ttse_send_result().
@see ttse_send_result()
@see ttse_cancel_synthesis_cb()
@see ttse_need_app_credential_cb()
@brief Called when TTS engine informs the engine service user about whole supported language and voice type list.
@details This callback function is implemented by the engine service user. Therefore, the engine developer does NOT have to implement this callback function.
@since_tizen 3.0
@remarks This callback function is called by ttse_foreach_supported_voices_cb() to inform the whole supported voice list.
@a user_data must be transferred from ttse_foreach_supported_voices_cb().
@paramin language The language is specified as an ISO 3166 alpha-2 two-letter country code
followed by ISO 639-1 for the two-letter language code.
For example, "ko_KR" for Korean, "en_US" for American English
@paramin type The voice type
@paramin user_data The user data passed from ttse_foreach_supported_voices_cb()
@return @c true to continue with the next iteration of the loop
@c false to break out of the loop
@pre ttse_foreach_supported_voices_cb() will invoke this callback function.
@see ttse_foreach_supported_voices_cb()
@brief Called when the engine service user requests to unload the corresponding voice type or to stop using voice.
@since_tizen 3.0
@remarks This callback function is mandatory and must be registered using ttse_main().
@paramin language The language is specified as an ISO 3166 alpha-2 two-letter country code
followed by ISO 639-1 for the two-letter language code.
For example, "ko_KR" for Korean, "en_US" for American English
@paramin type The voice type
@return @c 0 on success,
otherwise a negative error value
@retval #TTSE_ERROR_NONE Successful
@retval #TTSE_ERROR_INVALID_PARAMETER Invalid parameter
@retval #TTSE_ERROR_INVALID_STATE Not initialized
@retval #TTSE_ERROR_INVALID_VOICE Invalid voice
@retval #TTSE_ERROR_OPERATION_FAILED Operation failure
@see ttse_load_voice_cb()
@ingroup CAPI_USB_HOST_CONFIG_MODULE
@brief USB config handle.
@details This type represents USB device configuration. Device can have multiple configurations,
a configuration can have multiple interfaces. This handle can be obtained by
usb_host_device_get_config().
@since_tizen 3.0
@ingroup CAPI_USB_HOST_MODULE
@brief Context handle to USB host.
@details This structure represents usb_host session.
Using own session allows to use this API independently.
For example calling usb_host_destroy() will not destroy resources
that are being used by another user of the library.
@ingroup CAPI_USB_HOST_ENDPOINT_MODULE
@brief USB endpoint handle.
@details This type represents USB endpoint. This handle can be obtained by
usb_host_interface_get_endpoint().
@since_tizen 3.0
@ingroup CAPI_USB_HOST_HOTPLUG_MODULE
@brief Device connected/disconnected event handler.
@details The device handle should be unreffed with usb_host_unref_device()
when no longer needed.
@since_tizen 4.0
@paramin dev Device which was connected/disconnected
@paramin user_data User data pointer passed on callback registration
@ingroup CAPI_USB_HOST_HOTPLUG_MODULE
@brief USB hotplug callback handle.
@details This handle is used for managing registered hotplug callbacks.
@since_tizen 4.0
@ingroup CAPI_USB_HOST_INTERFACE_MODULE
@brief USB interface handle.
@details This type represents USB interface. An interface is a part of configuration and
can have multiple endpoints. This handle can be obtained by usb_host_config_get_interface().
@since_tizen 3.0
@ingroup CAPI_USB_HOST_ASYNC_MODULE
@brief USB asynchronous transfer handle.
@details This type represents an asynchronous USB transfer.
@since_tizen 5.0
@ingroup CAPI_USB_HOST_ASYNC_MODULE
@brief Called when asynchronous transfers finishes.
@since_tizen 5.0
@paramin transfer Transfer for which this callback was set
@paramin user_data User data pointer passed on callback registration
@brief Called when default language is changed.
@since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
@paramin previous Previous language
@paramin current Current language
@paramin user_data The user data passed from the callback registration function
@pre An application registers this callback to detect changing mode.
@see vc_set_current_language_changed_cb()
@brief Called when error occurred.
@since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
@paramin reason The error type (e.g. #VC_ERROR_OUT_OF_MEMORY, #VC_ERROR_TIMED_OUT)
@paramin user_data The user data passed from the callback registration function
@pre An application registers this callback to detect error.
@see vc_set_error_cb()
@brief Called when client gets the recognition result.
@since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
@remarks If the duplicated commands are recognized, the event(e.g. #VC_RESULT_EVENT_REJECTED) of command may be rejected
for selecting command as priority. If you set similar or same commands or the recognized results are multi-results,
vc_cmd_list has the multi commands.
@paramin event The result event (e.g. #VC_RESULT_EVENT_RESULT_SUCCESS, #VC_RESULT_EVENT_REJECTED)
@paramin vc_cmd_list The recognized command list
@paramin result The spoken text
@paramin user_data The user data passed from the callback registration function
@pre An application registers callback function.
@see vc_set_result_cb()
@brief Called when the state of voice control service is changed.
@since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
@paramin previous A previous state
@paramin current A current state
@paramin user_data The user data passed from the callback registration function
@pre An application registers this callback to detect changing service state.
@see vc_set_service_state_changed_cb()
@brief Called when the state of voice control client is changed.
@since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
@paramin previous A previous state
@paramin current A current state
@paramin user_data The user data passed from the callback registration function
@pre An application registers this callback to detect changing state.
@see vc_set_state_changed_cb()
@brief Called to retrieve supported language.
@since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
@paramin language A language is specified as an ISO 3166 alpha-2 two letter country-code
followed by ISO 639-1 for the two-letter language code.
For example, "ko_KR" for Korean, "en_US" for American English
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop,
@c false to break out of the loop
@pre The function will invoke this callback.
@brief Called when the client receives TTS streaming data from the VC engine service.
@since_tizen 5.5
@remarks The @a buffer must be released with free() by you when you no longer need it.
@paramin event The TTS event
@paramin buffer The TTS streaming data
@paramin len The length of the TTS streaming data
@paramin utt_id The utterance id
@paramin user_data The user data passed from the callback registration function
@pre The application registers the callback function using vc_tts_set_streaming_cb().
@see vc_tts_set_streaming_cb()
@brief Called when the client receives the TTS utterance status.
@since_tizen 5.5
@paramin utt_id The utterance id
@paramin status The new TTS utterance status (e.g. #VC_TTS_UTTERANCE_STARTED, #VC_TTS_UTTERANCE_COMPLETED, and so on)
@paramin user_data The user data passed from the callback registration function
@pre The application registers the callback function using vc_tts_set_utterance_status_cb().
@see vc_tts_set_utterance_status_cb()
@brief Called when the engine service user cancels the recognition process.
@since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
@return 0 on success, otherwise a negative error value.
@retval #VCE_ERROR_NONE Successful.
@retval #VCE_ERROR_INVALID_STATE Invalid state.
@pre vce_start_cb() is successful.
@see vce_start_cb()
@see vce_stop_cb()
@brief Called to retrieve the commands.
@since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
@remarks The @a command, @a param can be used only in the callback. To use outside, make a copy.
@paramin id command id
@paramin type command type
@paramin format command format
@paramin command command text
@paramin param parameter text
@paramin domain command domain
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, \n @c false to break out of the loop.
@pre vce_get_foreach_command() will invoke this callback.
@see vce_get_foreach_command()
@brief Called when the engine service user deinitializes VC engine.
@since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
@remarks This callback function is mandatory and must be registered using vce_main().
@return 0 on success, otherwise a negative error value
@retval #VCE_ERROR_NONE Successful
@retval #VCE_ERROR_INVALID_STATE Not initialized
@see vce_initialize_cb()
@brief Called when the engine service user retrieves all supported languages of VC engine.
@since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
@remarks This callback function is mandatory and must be registered using vce_main().
@paramin callback a callback function
@paramin user_data The user data to be passed to the callback function
@return 0 on success, otherwise a negative error value
@retval #VCE_ERROR_NONE Successful
@retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
@retval #VCE_ERROR_INVALID_STATE Not initialized
@post This function invokes vce_supported_language_cb() repeatedly for getting supported languages.
@brief Called when the engine service user requests the base information of VC engine.
@since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
@remarks This callback function is mandatory and must be registered using vce_main().
The @a engine_uuid is managed by the platform and will be released when this callback function is completed.
The @a engine_name is managed by the platform and will be released when this callback function is completed.
The @a engine_settings_app_id is managed by the platform and will be released when this callback function is completed.
The @a use_network is managed by the platform and will be released when this callback function is completed.
In order to upload the engine to Tizen Appstore, both the service app and the UI app (engine settings) are necessary.
Therefore, @a engine_settings_app_id should be set to the application ID of the UI application.
If there is no UI application, then @a engine_settings_app_id should be set to NULL.
@paramout engine_uuid The engine id
@paramout engine_name The engine name
@paramout engine_settings_app_id The ID of the engine settings application (the UI application)
@paramout use_network @c true to need network @c false not to need network.
@return @c 0 on success, otherwise a negative error code on failure
@retval #VCE_ERROR_NONE Successful
@retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
@retval #VCE_ERROR_OPERATION_FAILED Operation failure
@brief Called when the engine service user requests the recording format of VC engine.
@since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
@remarks This callback function is mandatory and must be registered using vce_main().
The @a audio_id can be used only in the callback. To use outside, make a copy.
The @a types is managed by the platform and will be released when this callback function is completed.
The @a rate is managed by the platform and will be released when this callback function is completed.
The @a channels is managed by the platform and will be released when this callback function is completed.
@paramin audio_id The audio device id. (e.g. #VCE_AUDIO_ID_BLUETOOTH or #VCE_AUDIO_ID_WIFI)
@paramout types The format used by the recorder.
@paramout rate The sample rate used by the recorder.
@paramout channels The number of channels used by the recorder.
@return 0 on success, otherwise a negative error value
@retval #VCE_ERROR_NONE Successful
@retval #VCE_ERROR_INVALID_PARAMETER Not initialized
@brief Called when the engine service user initializes Voice Control (VC) engine.
@since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
@remarks This callback function is mandatory and must be registered using vce_main().
@return 0 on success, otherwise a negative error value
@retval #VCE_ERROR_NONE Successful
@retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
@retval #VCE_ERROR_INVALID_STATE Already initialized
@retval #VCE_ERROR_OPERATION_FAILED Operation failed
@see vce_deinitialize_cb()
@brief Called when the engine service user checks whether a language is supported or not.
@since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
@remarks This callback function is mandatory and must be registered using vce_main().
The @a language can be used only in the callback. To use outside, make a copy.
@paramin language A language
@return @c true = supported, \n @c false = not supported.
@brief Called when the engine service user requests essential value from NLU result.
@since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
@remarks The @a key can be used only in the callback. To use outside, make a copy.
The @a value is managed by the platform and will be released when this callback function is completed.
@paramin key NLU base info key.
@paramout value NLU base info value.
@return 0 on success, otherwise a negative error value.
@retval #VCE_ERROR_NONE Successful.
@retval #VCE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature.
@brief Called when the engine service user requests private data between app and engine.
@since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
@remarks The @a key can be used only in the callback. To use outside, make a copy.
The @a data is managed by the platform and will be released when this callback function is completed.
@paramin key Private key.
@paramout data Private data.
@return 0 on success, otherwise a negative error value.
@retval #VCE_ERROR_NONE Successful.
@retval #VCE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature.
@brief Called when the engine service user sets private data between app and engine.
@since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
@remarks The @a key, @a data can be used only in the callback. To use outside, make a copy.
@paramin key Private key.
@paramin data Private data.
@return 0 on success, otherwise a negative error value.
@retval #VCE_ERROR_NONE Successful.
@retval #VCE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature.
@brief Called when the engine service user requests haptic event.
@since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
@remarks The @a event can be used only in the callback. To use outside, make a copy.
@paramin event Requested haptic event
@return 0 on success, otherwise a negative error value.
@retval #VCE_ERROR_NONE Successful.
@retval #VCE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature.
@brief Called when the engine service user requests list event.
@since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
@remarks The @a event can be used only in the callback. To use outside, make a copy.
@paramin event Requested list event
@return 0 on success, otherwise a negative error value.
@retval #VCE_ERROR_NONE Successful.
@retval #VCE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature.
@brief Called when the engine service user requests process text.
@since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
@remarks The @a text can be used only in the callback. To use outside, make a copy.
@paramin text Requested text
@return 0 on success, otherwise a negative error value.
@retval #VCE_ERROR_NONE Successful.
@retval #VCE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature.
@brief Called when the engine service user (voice control client) requests to send TTS feedback.
@since_tizen 5.0
@remarks The @a text and @a language can be used only in the callback. To use outside, make a copy.
@brief Called when the engine service user sets audio recording type.
@since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
@remarks The @a audio_type can be used only in the callback. To use outside, make a copy.
@paramin audio_type Current audio type (e.g. #VCE_AUDIO_ID_BLUETOOTH or #VCE_AUDIO_ID_WIFI)
@return 0 on success, otherwise a negative error value.
@retval #VCE_ERROR_NONE Successful.
@retval #VCE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature.
@brief Called when the engine service user sets command list before recognition.
@since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
@remarks This function should set commands via vcd_foreach_command().
The @a vc_command should not be released.
The @a vc_command can be used only in the callback. To use outside, make a copy.
@paramin vc_command command handle. The @a vc_command can be used only in the callback. To use outside, make a copy.
@return 0 on success, otherwise a negative error value
@retval #VCE_ERROR_NONE Successful
@retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
@retval #VCE_ERROR_INVALID_STATE Invalid state
@retval #VCE_ERROR_OPERATION_FAILED Operation failed
@retval #VCE_ERROR_NOT_SUPPORTED_FEATURE Not supported command type
@post vce_start_cb() is called after this function is successful.
@see vce_start_cb()
@see vcd_foreach_command()
@see vce_unset_commands()
@see vce_get_command_count()
@brief Called when the engine service user sets domain (agent or device type).
@since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
@remarks The @a domain can be used only in the callback. To use outside, make a copy.
@paramin domain Agent (e.g. "music", "news", etc) or device type (e.g. "tv", "mobile", etc) corresponding to the command
@return 0 on success, otherwise a negative error value.
@retval #VCE_ERROR_NONE Successful.
@retval #VCE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature
@brief Called when the engine service user sets language.
@since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
@remarks The @a language can be used only in the callback. To use outside, make a copy.
@paramin language A language.
@return 0 on success, otherwise a negative error value
@retval #VCE_ERROR_NONE Successful
@retval #VCE_ERROR_INVALID_LANGUAGE Invalid language
@retval #VCE_ERROR_INVALID_STATE Not initialized
@retval #VCE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature
@brief Called when the engine service user sets recording data for speech recognition from recorder.
@since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
@remarks This function should be returned immediately after recording data copy.
The @a data can be used only in the callback. To use outside, make a copy.
The @a speech_detected should not be released. This is managed by the platform.
@paramin data A recording data
@paramin length A length of recording data
@paramout speech_detected The status of speech (e.g. #VCE_SPEECH_DETECT_BEGIN or #VCE_SPEECH_DETECT_END). The @a speech_detected can be used only in the callback. To use outside, make a copy.
@return 0 on success, otherwise a negative error value
@retval #VCE_ERROR_NONE Successful
@retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
@retval #VCE_ERROR_INVALID_STATE Invalid state
@retval #VCE_ERROR_OPERATION_FAILED Operation failed
@pre vce_start_cb() is successful.
@see vce_start_cb()
@see vce_cancel_cb()
@see vce_stop_cb()
@brief Called when the engine service user sets app id which is want to ask server dialog.
@since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
@remarks The @a app_id and @a credential can be used only in the callback. To use outside, make a copy.
@paramin app_id App id which is to want to ask server dialog.
@paramin credential Credential key.
@return 0 on success, otherwise a negative error value.
@retval #VCE_ERROR_NONE Successful.
@retval #VCE_ERROR_PERMISSION_DENIED Permission denied.
@retval #VCE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature.
@brief Called when client gets the specific engine's request from the engine service user.
@since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
@remarks The @a engine_app_id is managed by the platform and will be released when this callback function is completed.
The @a event is managed by the platform and will be released when this callback function is completed.
The @a request is managed by the platform and will be released when this callback function is completed.
@brief Called when the engine service user starts recognition.
@since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
@remarks This callback function is mandatory and must be registered using vce_main().
@paramin stop_by_silence Silence detection option.
@c true to detect the silence,
@c false not to detect the silence
@return 0 on success, otherwise a negative error value
@retval #VCE_ERROR_NONE Successful
@retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
@retval #VCE_ERROR_INVALID_STATE Invalid state
@retval #VCE_ERROR_INVALID_LANGUAGE Invalid language
@retval #VCE_ERROR_OUT_OF_NETWORK Out of network
@retval #VCE_ERROR_OPERATION_FAILED Operation failed
@pre vcd_foreach_command() is successful.
@see vce_set_recording_data_cb()
@see vce_stop_cb()
@see vce_cancel_cb()
@brief Called when the engine service user stops to get the result of recognition.
@since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
@return 0 on success, otherwise a negative error value
@retval #VCE_ERROR_NONE Successful
@retval #VCE_ERROR_INVALID_STATE Invalid state
@retval #VCE_ERROR_OPERATION_FAILED Operation failed
@retval #VCE_ERROR_OUT_OF_NETWORK Out of network
@pre vce_set_recording_data_cb() is successful.
@see vce_start_cb()
@see vce_set_recording_data_cb()
@see vce_send_result()
@see vce_cancel_cb()
@brief Called when VC engine informs the engine service user about whole supported languages.
@details This callback function is implemented by the engine service user. Therefore, the engine developer does NOT have to implement this callback function.
@since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
@remarks This callback function is called by vce_foreach_supported_languages_cb() to retrieve the whole supported language list.
The @a user_data must be transferred from vce_foreach_supported_languages_cb().
The @a language can be used only in the callback. To use outside, make a copy.
@paramin language A language is specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code \n
For example, "ko_KR" for Korean, "en_US" for American English.
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop \n @c false to break out of the loop
@pre vce_foreach_supported_languages_cb() will invoke this callback.
@see vce_foreach_supported_languages_cb()
@brief Called when the engine service user requests TTS audio format.
@since_tizen 5.0
@remarks The @a rate, @a channel, and @a audio_type should not be released.
The @a rate, @a channel, and @a audio_type are managed by the platform and will be released after the audio format is transferred to the VC client.
@brief Called when the engine service user unsets command list for reset.
@since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
@return 0 on success, otherwise a negative error value
@retval #VCE_ERROR_NONE Successful
@retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
@retval #VCE_ERROR_INVALID_STATE Invalid state
@retval #VCE_ERROR_OPERATION_FAILED Operation failed
@retval #VCE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature
@see vce_set_commands_cb()
@ingroup CAPI_CONTENT_MEDIA_VIDEO_META_MODULE
@brief The structure type for the Video metadata handle.
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@brief The VPN interface handle.
@details This handle can be obtained by calling vpnsvc_init() and destroyed by calling vpnsvc_deinit().
@since_tizen 3.0
@see vpnsvc_init()
@see vpnsvc_deinit()
@brief Called when a WAV file has finished playing.
@details This callback is not invoked by calling wav_player_stop().
@since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@paramin id The completed wav player ID
@paramin user_data The user data passed from the callback registration function
@see wav_player_start_new()
@brief Called when the data channel is created to the connection by the remote peer.
@since_tizen 6.5
@remarks The @a webrtc is the same object for which the callback was set.\n
The @a webrtc should not be released.\n
The @a channel should not be released.
@paramin webrtc WebRTC handle
@paramin channel WebRTC data channel handle
@paramin user_data The user data passed from the callback registration function
@see webrtc_data_channel_set_open_cb()
@see webrtc_data_channel_unset_open_cb()
@see webrtc_data_channel_set_message_cb()
@see webrtc_data_channel_unset_message_cb()
@see webrtc_data_channel_set_error_cb()
@see webrtc_data_channel_unset_error_cb()
@see webrtc_data_channel_set_close_cb()
@see webrtc_data_channel_unset_close_cb()
@brief Called when the data channel has closed down.
@since_tizen 6.5
@remarks The @a channel is the same object for which the callback was set.\n
The @a channel should not be released.
@paramin channel WebRTC data channel handle
@paramin user_data The user data passed from the callback registration function
@see webrtc_create_data_channel()
@see webrtc_destroy_data_channel()
@see webrtc_data_channel_set_close_cb()
@see webrtc_data_channel_unset_close_cb()
@brief Called when an error occurs on the data channel.
@details The following error codes can be received:\n
#WEBRTC_ERROR_INVALID_OPERATION\n
#WEBRTC_ERROR_STREAM_FAILED\n
#WEBRTC_ERROR_RESOURCE_FAILED
@since_tizen 6.5
@remarks The @a channel is the same object for which the callback was set.\n
The @a channel should not be released.
@paramin channel WebRTC data channel handle
@paramin error The error code
@paramin user_data The user data passed from the callback registration function
@see webrtc_create_data_channel()
@see webrtc_destroy_data_channel()
@see webrtc_data_channel_set_error_cb()
@see webrtc_data_channel_unset_error_cb()
@brief Called when a message is received from other peer via the data channel.
@since_tizen 6.5
@remarks The @a channel is the same object for which the callback was set.\n
The @a channel should not be released.\n
When @a type is #WEBRTC_DATA_CHANNEL_TYPE_STRING, @a message should be casted to char pointer.\n
When @a type is #WEBRTC_DATA_CHANNEL_TYPE_BYTES, @a message should be casted to #webrtc_bytes_data_h.
In this case, webrtc_get_data() can be used to get the data and its size inside of this callback.\n
The @a message should not be released.
@paramin channel WebRTC data channel handle
@paramin type The data type
@paramin message The message from the remote peer
@paramin user_data The user data passed from the callback registration function
@see webrtc_create_data_channel()
@see webrtc_destroy_data_channel()
@see webrtc_data_channel_set_message_cb()
@see webrtc_data_channel_unset_message_cb()
@see webrtc_get_data()
@brief Called when the data channel's underlying data transport is established.
@since_tizen 6.5
@remarks The @a channel is the same object for which the callback was set.\n
The @a channel should not be released.
@paramin channel WebRTC data channel handle
@paramin user_data The user data passed from the callback registration function
@see webrtc_create_data_channel()
@see webrtc_destroy_data_channel()
@see webrtc_data_channel_set_open_cb()
@see webrtc_data_channel_unset_open_cb()
@brief WebRTC display handle type.
@since_tizen 6.5
@remarks The pointer of this handle can be obtained from EFL UI API.\n
For example, in case of #WEBRTC_DISPLAY_TYPE_OVERLAY, elm_win_add() can be used to get the window handle.\n
In case of #WEBRTC_DISPLAY_TYPE_EVAS, evas_object_image_add() can be used to get the renderable image handle.\n
For more details, please refer to https://docs.tizen.org/application/native/guides/ui/efl/.
@brief Called when each audio or video frame is ready to be rendered via the WebRTC pipeline after the negotiation.
@since_tizen 6.5
@remarks The @a webrtc is the same object for which the callback was set.\n
The @a webrtc should not be released.\n
Use media_packet_get_buffer_data_ptr() with @a packet to get the Gstreamer buffer pointer.\n
The @a packet should be released using media_packet_destroy().
@paramin webrtc WebRTC handle
@paramin type The media type
@paramin track_id The track id
@paramin packet The media packet which has a frame data
@paramin user_data The user data passed from the callback registration function
@see webrtc_set_encoded_audio_frame_cb()
@see webrtc_unset_encoded_audio_frame_cb()
@see webrtc_set_encoded_video_frame_cb()
@see webrtc_unset_encoded_video_frame_cb()
@see media_packet_get_buffer_data_ptr()
@brief Called when an error occurs.
@details The following error codes can be received:\n
#WEBRTC_ERROR_INVALID_OPERATION\n
#WEBRTC_ERROR_CONNECTION_FAILED\n
#WEBRTC_ERROR_STREAM_FAILED\n
#WEBRTC_ERROR_RESOURCE_FAILED\n
#WEBRTC_ERROR_RESOURCE_CONFLICT
@since_tizen 6.5
@remarks The @a webrtc is the same object for which the callback was set.\n
The @a webrtc should not be released.
@paramin webrtc WebRTC handle
@paramin error The error code
@paramin state The current state of the WebRTC handle
@paramin user_data The user data passed from the callback registration function
@see webrtc_set_error_cb()
@see webrtc_unset_error_cb()
@brief Called when the WebRTC needs to send the ICE candidate message to the remote peer through the signaling channel.
@since_tizen 6.5
@remarks The @a webrtc is the same object for which the callback was set.\n
The @a webrtc should not be released.
@paramin webrtc WebRTC handle
@paramin candidate The ICE candidate message
@paramin user_data The user data passed from the callback registration function
@post @a candidate must be sent to the remote peer via the signaling channel.
@see webrtc_set_ice_candidate_cb()
@see webrtc_unset_ice_candidate_cb()
@brief Called when the WebRTC ICE connection state is changed.
@since_tizen 6.5
@remarks The @a webrtc is the same object for which the callback was set.\n
The @a webrtc should not be released.
@paramin webrtc WebRTC handle
@paramin state The ICE connection state
@paramin user_data The user data passed from the callback registration function
@see webrtc_set_ice_connection_state_change_cb()
@see webrtc_unset_ice_connection_state_change_cb()
@brief Called when the WebRTC ICE gathering state is changed.
@since_tizen 6.5
@remarks The @a webrtc is the same object for which the callback was set.\n
The @a webrtc should not be released.
@paramin webrtc WebRTC handle
@paramin state The ICE gathering state
@paramin user_data The user data passed from the callback registration function
@see webrtc_set_ice_gathering_state_change_cb()
@see webrtc_unset_ice_gathering_state_change_cb()
@brief Called when the buffer state of media packet source is changed.
@since_tizen 6.5
@paramin source_id The media source id
@paramin state The buffer state (underflow or overflow)
@paramin user_data The user data passed from the callback registration function
@see webrtc_media_packet_source_set_buffer_state_changed_cb()
@see webrtc_media_packet_source_unset_buffer_state_changed_cb()
@brief Called when the WebRTC needs session negotiation.
@since_tizen 6.5
@remarks The @a webrtc is the same object for which the callback was set.\n
The @a webrtc should not be released.
@paramin webrtc WebRTC handle
@paramin user_data The user data passed from the callback registration function
@see webrtc_set_negotiation_needed_cb()
@see webrtc_unset_negotiation_needed_cb()
@brief Called when the WebRTC peer connection state is changed.
@since_tizen 6.5
@remarks The @a webrtc is the same object for which the callback was set.\n
The @a webrtc should not be released.
@paramin webrtc WebRTC handle
@paramin state The peer connection state
@paramin user_data The user data passed from the callback registration function
@see webrtc_set_peer_connection_state_change_cb()
@see webrtc_unset_peer_connection_state_change_cb()
@brief Called when the session description is created.
@since_tizen 6.5
@remarks The @a webrtc is the same object for which the callback was set.\n
The @a webrtc should not be released.\n
@a description is a JSON string.\n
It will be {"sdp":{"type":"offer or answer","sdp":"..."}}.
@paramin webrtc WebRTC handle
@paramin description The session description
@paramin user_data The user data passed from the callback registration function
@post @a description must be set as a local description by calling webrtc_set_local_description()
@post @a description must be sent to the remote peer via the signaling channel.
@see webrtc_create_offer_async()
@see webrtc_create_answer_async()
@see webrtc_set_local_description()
@brief Called when the WebRTC signaling state is changed.
@since_tizen 6.5
@remarks The @a webrtc is the same object for which the callback was set.\n
The @a webrtc should not be released.
@paramin webrtc WebRTC handle
@paramin state The signaling state
@paramin user_data The user data passed from the callback registration function
@see webrtc_set_signaling_state_change_cb()
@see webrtc_unset_signaling_state_change_cb()
@brief Called when the WebRTC state is changed.
@since_tizen 6.5
@remarks The @a webrtc is the same object for which the callback was set.\n
The @a webrtc should not be released.
@paramin webrtc WebRTC handle
@paramin previous The previous state of the WebRTC handle
@paramin current The current state of the WebRTC handle
@paramin user_data The user data passed from the callback registration function
@see webrtc_set_state_changed_cb()
@see webrtc_unset_state_changed_cb()
@brief Called when a new track has been added to the WebRTC pipeline after the negotiation.
@since_tizen 6.5
@remarks The @a webrtc is the same object for which the callback was set.\n
The @a webrtc should not be released.
@paramin webrtc WebRTC handle
@paramin type The media type
@paramin track_id The track id
@paramin user_data The user data passed from the callback registration function
@see webrtc_set_track_added_cb()
@see webrtc_unset_track_added_cb()
@brief Called iteratively to inform all the TURN server URLs.
@since_tizen 6.5
@paramin turn_server The TURN server URL
@paramin user_data The user data passed from the callback registration function
@return @c true to continue with the next iteration of the loop,
otherwise @c false to break out of the loop
@see webrtc_foreach_turn_server()
@brief Called when IP address of client is assigned when your device is the group owner.
@details The following error codes can be delivered
#WIFI_DIRECT_ERROR_NONE
#WIFI_DIRECT_ERROR_OPERATION_FAILED
#WIFI_DIRECT_ERROR_NOT_PERMITTED
@since_tizen 2.3
@remarks The @a mac_address can be used only in the callback. To use outside, make a copy.
The @a ip_address can be used only in the callback. To use outside, make a copy.
The @a interface_address can be used only in the callback. To use outside, make a copy.
@paramin mac_address The MAC address of connection peer
@paramin ip_address The IP address of connection peer
@paramin interface_address The interface address of connection peer
@paramin user_data The user data passed from the callback registration function
@pre This callback will be invoked in the thread-default main context of the
thread from which you registered this callback using wifi_direct_set_client_ip_address_assigned_cb().
@see wifi_direct_set_client_ip_address_assigned_cb()
@see wifi_direct_unset_client_ip_address_assigned_cb()
@brief Called repeatedly when you get the information of connected peers.
@since_tizen 2.3
@remarks @a peer is valid only in this function.
@paramin peer The information of discovered peer
@paramin user_data The user data passed from foreach function
@return @c true to continue with the next iteration of the loop,
@c false to break out of the loop
@see wifi_direct_foreach_connected_peers()
@brief Called when the state of connection is changed.
@details The following error codes can be delivered
#WIFI_DIRECT_ERROR_NONE
#WIFI_DIRECT_ERROR_OPERATION_FAILED
#WIFI_DIRECT_ERROR_NOT_PERMITTED
#WIFI_DIRECT_ERROR_CONNECTION_FAILED
@since_tizen 2.3
@remarks The @a mac_address can be used only in the callback. To use outside, make a copy.
@paramin error_code The error code
@paramin connection_state The connection state
@paramin mac_address The MAC address of the connection peer
@paramin user_data The user data passed from the callback registration function
@pre wifi_direct_create_group(), wifi_direct_destroy_group(),
wifi_direct_connect(), wifi_direct_disconnect() or
wifi_direct_disconnect_all() will invoke this callback in the thread-default
main context of the thread from which you registered this callback using
using wifi_direct_set_connection_state_changed_cb().
@see wifi_direct_connect()
@see wifi_direct_disconnect()
@see wifi_direct_disconnect_all()
@see wifi_direct_set_connection_state_changed_cb()
@see wifi_direct_unset_connection_state_changed_cb()
@brief Called when the state of device is changed.
@details The following error codes can be delivered
#WIFI_DIRECT_ERROR_NONE
#WIFI_DIRECT_ERROR_OPERATION_FAILED
#WIFI_DIRECT_ERROR_NOT_PERMITTED
@since_tizen 2.3
@paramin error_code The error code
@paramin device_state The device state
@paramin user_data The user data passed from the callback registration function
@pre Either wifi_direct_activate() or wifi_direct_deactivate() will invoke
this callback in the thread-default main context of the thread from which you
registered this callback using wifi_direct_set_device_state_changed_cb().
@see wifi_direct_activate()
@see wifi_direct_deactivate()
@see wifi_direct_set_device_state_changed_cb()
@see wifi_direct_unset_device_state_changed_cb()
@brief Called repeatedly when you get the information of discovered peers.
@since_tizen 2.3
@remarks @a peer is valid only in this function.
@paramin peer The information of the discovered peer
@paramin user_data The user data passed from foreach function
@return @c true to continue with the next iteration of the loop,
@c false to break out of the loop
@see wifi_direct_foreach_discovered_peers()
@brief Called when the state of discovery is changed.
@details The following error codes can be delivered
#WIFI_DIRECT_ERROR_NONE
#WIFI_DIRECT_ERROR_OPERATION_FAILED
#WIFI_DIRECT_ERROR_NOT_PERMITTED
@since_tizen 2.3
@paramin error_code The error code
@paramin discovery_state The discovery state
@paramin user_data The user data passed from the callback registration function
@pre Either wifi_direct_start_discovery() or wifi_direct_cancel_discovery()
will invoke this callback in the thread-default main context of the thread
from which you registered this callback using wifi_direct_set_discovery_state_changed_cb().
@see wifi_direct_start_discovery()
@see wifi_direct_cancel_discovery()
@see wifi_direct_set_discovery_state_changed_cb()
@see wifi_direct_unset_discovery_state_changed_cb()
@brief Called when the peer is found.
@details The following error codes can be delivered
#WIFI_DIRECT_ERROR_NONE
#WIFI_DIRECT_ERROR_OPERATION_FAILED
#WIFI_DIRECT_ERROR_NOT_PERMITTED
@since_tizen 2.3
@remarks The @a mac_address can be used only in the callback. To use outside, make a copy.
@paramin error_code The error code
@paramin discovery_state The discovery state
@paramin mac_address The MAC address of found peer
@paramin user_data The user data passed from the callback registration function
@pre Either wifi_direct_start_discovery() or wifi_direct_cancel_discovery()
will invoke this callback in the thread-default main context of the thread
from which you registered this callback using wifi_direct_set_peer_found_cb().
@see wifi_direct_start_discovery()
@see wifi_direct_cancel_discovery()
@see wifi_direct_set_peer_found_cb()
@see wifi_direct_unset_peer_found_cb()
@brief Called when the state of connection is changed.
@details The following error codes can be delivered:\n
#WIFI_DIRECT_ERROR_NONE\n
#WIFI_DIRECT_ERROR_OPERATION_FAILED\n
#WIFI_DIRECT_ERROR_NOT_PERMITTED
@since_tizen 5.0
@paramin error_code The error code
@paramin connection_state The connection state
@paramin data_s The structure for peer data
@paramin user_data The user data passed from the callback registration function
@pre wifi_direct_create_group(), wifi_direct_destroy_group(), wifi_direct_connect(), wifi_direct_disconnect() or wifi_direct_disconnect_all() will invoke this callback
if you register this callback using wifi_direct_set_peer_info_connection_state_changed_cb().
@see wifi_direct_connect()
@see wifi_direct_disconnect()
@see wifi_direct_disconnect_all()
@see wifi_direct_set_peer_info_connection_state_changed_cb()
@see wifi_direct_unset_peer_info_connection_state_changed_cb()
@brief Called when you get the persistent groups repeatedly.
@since_tizen 2.3
@remarks The @a mac_address can be used only in the callback. To use outside, make a copy.
The @a ssid can be used only in the callback. To use outside, make a copy.
@paramin mac_address The MAC address of the persistent group owner
@paramin ssid The SSID (Service Set Identifier) of the persistent group owner
@paramin user_data The user data passed from the request function
@return @c true to continue with the next iteration of the loop, \n
@c false to break out of the loop
@pre wifi_direct_foreach_persistent_groups() will invoke this callback.
@see wifi_direct_foreach_persistent_groups()
@brief Called when the state of Service discovery is changed.
@details The following error codes can be delivered
#WIFI_DIRECT_ERROR_NONE
#WIFI_DIRECT_ERROR_OPERATION_FAILED
#WIFI_DIRECT_ERROR_NOT_PERMITTED
@since_tizen 2.3
@remarks The @a mac_address can be used only in the callback. To use outside, make a copy.
@paramin error_code The error code
@paramin service_state The service discovery state
@paramin service_type Specifies the types of service
@paramin response_data Received response
@paramin mac_address The MAC address of the connection peer
@paramin user_data User can transfer the user specific data in callback
@pre Either wifi_direct_start_service_discovery() or
wifi_direct_cancel_service_discovery() will invoke this callback in the
thread-default main context of the thread from which you registered this
callback using wifi_direct_set_service_state_changed_cb().
@see wifi_direct_start_discovery()
@see wifi_direct_cancel_discovery()
@see wifi_direct_set_discovery_state_changed_cb()
@see wifi_direct_unset_discovery_state_changed_cb()
@brief Called when the state of Wi-FI Direct is changed.
@since_tizen 3.0
@paramin state The Wi-Fi Direct state
@paramin user_data The user data passed from the callback registration function
@pre Changes in Wi-Fi Direct state will invoke this callback
if you register this callback using wifi_direct_set_state_changed_cb().
@see wifi_direct_set_state_changed_cb()
@see wifi_direct_unset_state_changed_cb()
@brief Called when you get the supported WPS (Wi-Fi Protected Setup) type repeatedly.
@since_tizen 2.3
@paramin type The type of WPS
@paramin user_data The user data passed from the request function
@return @c true to continue with the next iteration of the loop, \n
@c false to break out of the loop
@pre wifi_direct_foreach_supported_wps_types() will invoke this callback.
@see wifi_direct_foreach_supported_wps_types()
@brief Called after wifi_manager_activate() or wifi_manager_activate_with_wifi_picker_tested() is completed.
@details The following error codes can be received: \n
#WIFI_MANAGER_ERROR_NONE Successful \n
#WIFI_MANAGER_ERROR_OPERATION_FAILED Operation failed \n
#WIFI_MANAGER_ERROR_SECURITY_RESTRICTED Restricted by security system policy
@since_tizen 3.0
@paramin result The result
@paramin user_data The user data passed from wifi_manager_activate() and wifi_manager_activate_with_wifi_picker_tested()
@pre wifi_manager_activate() or wifi_manager_activate_with_wifi_picker_tested() will invoke this callback function.
@see wifi_manager_activate()
@see wifi_manager_activate_with_wifi_picker_tested()
@brief Called with an IPv6 address.
@since_tizen 4.0
@remarks If @a ipv6_address is needed outside the callback, a copy should be
made. @a ipv6_address will be freed automatically after the execution
of this callback.
@paramin ipv6_address The IPv6 address
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, \n
@c false to break out of the loop
@pre wifi_manager_ap_foreach_ipv6_address() will invoke this callback.
@see wifi_manager_ap_foreach_ipv6_address()
@brief Called with VSIE data and length of VSIE.
@since_tizen 5.0
@remarks If @a vsie is needed outside the callback, a copy should be
made. @a vsie will be freed automatically after the execution
of this callback.
@paramin vsie The vendor specific data
@paramin length The length of vendor specific data
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, \n
@c false to break out of the loop
@pre wifi_manager_ap_foreach_vsie() will invoke this callback.
@see wifi_manager_ap_foreach_vsie().
@brief Called when the BSSID scan is finished.
@details The following error codes can be received: \n
#WIFI_MANAGER_ERROR_NONE Successful \n
#WIFI_MANAGER_ERROR_OPERATION_FAILED Operation failed
@since_tizen 4.0
@paramin error_code The error code
@paramin user_data The user data passed from the callback registration function
@see wifi_manager_scan()
@see wifi_manager_bssid_scan()
@see wifi_manager_set_background_scan_cb()
@see wifi_manager_unset_background_scan_cb()
@brief Called for each found access point configuration.
@since_tizen 3.0
@remarks @a config is valid only in this function. In order to use @a config outside this function, you must copy the config with wifi_manager_config_clone().
@brief Called when the connection process is completed.
@details The following functions start the connection process and will
result in the callback being called:
@brief Called when the connection state is changed.
@since_tizen 3.0
@paramin state The connection state
@paramin ap The access point
@paramin user_data The user data passed from the callback registration function
@see wifi_manager_set_connection_state_changed_cb()
@see wifi_manager_unset_connection_state_changed_cb()
@brief Called after wifi_manager_deactivate() is completed.
@details The following error codes can be received: \n
#WIFI_MANAGER_ERROR_NONE Successful \n
#WIFI_MANAGER_ERROR_OPERATION_FAILED Operation failed \n
#WIFI_MANAGER_ERROR_SECURITY_RESTRICTED Restricted by security system policy
@since_tizen 3.0
@paramin result The result
@paramin user_data The user data passed from wifi_manager_deactivate()
@pre wifi_manager_deactivate() will invoke this callback function.
@see wifi_manager_deactivate()
@brief Called when the device state is changed.
@since_tizen 3.0
@paramin state The device state
@paramin user_data The user data passed from the callback registration function
@see wifi_manager_set_device_state_changed_cb()
@see wifi_manager_unset_device_state_changed_cb()
@brief Called after wifi_manager_disconnect() is completed.
@details The following error codes can be received: \n
#WIFI_MANAGER_ERROR_NONE Successful \n
#WIFI_MANAGER_ERROR_OPERATION_FAILED Operation failed
@since_tizen 3.0
@paramin result The result
@paramin user_data The user data passed from wifi_manager_disconnect()
@pre wifi_manager_disconnect() will invoke this callback function.
@see wifi_manager_disconnect()
@brief Called after wifi_manager_forget_ap_async() is completed.
@details The following error codes can be received: \n
#WIFI_MANAGER_ERROR_NONE Successful \n
#WIFI_MANAGER_ERROR_OPERATION_FAILED Operation failed
@since_tizen 5.0
@paramin result The result
@paramin user_data The user data passed from wifi_manager_forget_ap_async()
@pre wifi_manager_forget_ap_async() will invoke this callback function.
@see wifi_manager_forget_ap_async()
@brief Called for each found access point.
@since_tizen 3.0
@remarks @a ap is valid only in this function. In order to use @a ap outside this function, you must copy the @a ap with wifi_manager_ap_clone().
@paramin ap The access point
@paramin user_data The user data passed from the request function
@return @c true to continue with the next iteration of the loop, \n
otherwise @c false to break out of the loop
@pre wifi_manager_foreach_found_ap() will invoke this callback.
@pre wifi_manager_foreach_found_specific_ap() will invoke this callback.
@see wifi_manager_foreach_found_ap()
@see wifi_manager_foreach_found_specific_ap()
@brief Called for each found BSSID.
@since_tizen 5.0
@remarks The @a bssid can be used only in the callback. To use it outside, make a copy.
@a bssid is managed by the platform and will be released after the execution
of this callback.
@paramin bssid The BSSID
@paramin rssi The RSSI
@paramin freq The frequency
@paramin user_data The user data passed from the foreach function
@return @c true to continue with the next iteration of the loop, otherwise @c false to break out of the loop
@pre wifi_manager_foreach_found_bssid() will invoke this callback.
@brief Called when the IP conflict state is changed.
@since_tizen 5.0
@remarks @a mac should not be freed. @a mac is available only in the callback. To use
outside the callback, make a copy.
@paramin mac The destination MAC address causing conflict
@paramin state The current state
@paramin user_data The user data passed from the callback registration function
@see wifi_manager_set_ip_conflict_cb()
@see wifi_manager_unset_ip_conflict_cb()
@brief Called when the Wi-Fi Module state is changed.
@since_tizen 4.0
@paramin wifi_module_state The Wi-Fi Module state
@paramin user_data The user data passed from the callback registration function
@see wifi_manager_set_module_state_changed_cb()
@see wifi_manager_unset_module_state_changed_cb()
@brief Called when the RSSI of connected Wi-Fi is changed.
@since_tizen 3.0
@paramin rssi_level The level of RSSI
@paramin user_data The user data passed from the callback registration function
@see wifi_manager_set_rssi_level_changed_cb()
@see wifi_manager_unset_rssi_level_changed_cb()
@brief Called when the scan is finished.
@details The following error codes can be received: \n
#WIFI_MANAGER_ERROR_NONE Successful \n
#WIFI_MANAGER_ERROR_OPERATION_FAILED Operation failed \n
@since_tizen 3.0
@paramin error_code The error code
@paramin user_data The user data passed from the callback registration function
@see wifi_manager_scan()
@see wifi_manager_set_background_scan_cb()
@see wifi_manager_unset_background_scan_cb()
@brief Called when the scanning state is changed.
@since_tizen 4.0
@paramin state The wifi scanning state
@paramin user_data The user data passed from the callback registration function
@see wifi_manager_set_scan_state_changed_cb()
@see wifi_manager_unset_scan_state_changed_cb()
@brief Called when the Wi-Fi TDLS is discovered.
@since_tizen 4.0
@remarks @a peer_mac_addr is usable only in the callback. To use outside the callback, make a copy.
@paramin state The TDLS state
@paramin peer_mac_addr The MAC address of the TDLS peer
@paramin user_data The user data passed from the callback registration function
@see wifi_manager_tdls_set_discovered_cb()
@see wifi_manager_tdls_unset_discovered_cb()
