From 4a6afefc01df5082ac9145abf3cf05441c9240b9 Mon Sep 17 00:00:00 2001 From: Dongyoung Kim Date: Sun, 5 Jul 2015 14:02:43 +0900 Subject: [PATCH] Update the native api's table for 2.4 Change-Id: I6a2a74439d59e3e594b0e822812fd78d721cda20 --- .../html/native/details/tizen_apis_n.htm | 328 ++++++++++++++++----- 1 file changed, 261 insertions(+), 67 deletions(-) mode change 100644 => 100755 org.tizen.gettingstarted/html/native/details/tizen_apis_n.htm diff --git a/org.tizen.gettingstarted/html/native/details/tizen_apis_n.htm b/org.tizen.gettingstarted/html/native/details/tizen_apis_n.htm old mode 100644 new mode 100755 index 30f3730..d5647da --- a/org.tizen.gettingstarted/html/native/details/tizen_apis_n.htm +++ b/org.tizen.gettingstarted/html/native/details/tizen_apis_n.htm @@ -34,10 +34,22 @@

There are 2 types of submodules - Tizen native modules and open source modules. The integration of open source modules in the native API structure allows you to add additional features by using well-known open source libraries. This is particularly advantageous for developers who are familiar with certain libraries because they can quickly add features and use previously written code in certain cases.

-

The following figure and table define the mobile native API layout. The table describes the API modules and the functionality of all their submodule APIs within that module. The table also acts as a reference source for when you are planning a new feature for your application and need a way to efficiently compare different API modules to decide which APIs to use.

+

The following figure and tables define the Tizen native API layout. The tables describe the API modules and the functionality of all their submodule APIs within that module. The tables also act as reference sources for when you are planning a new feature for your application and need a way to efficiently compare different API modules to decide which APIs to use.

-

Figure: Mobile native API layout

-

Mobile native API layout

+ +

Figure: Native API layout

+

Native API layout

+ + + + + + + + + + +
Note
Except as noted, the mobile native APIs are available since Tizen 2.3
@@ -48,6 +60,29 @@ + + + + + + + + + + + + + + + + + + - + - + - - + + + + + + - + @@ -140,9 +179,10 @@ + - - + - + + + + + + - - + + + + + + + + + + + - - + + + + + + + + + + - - + + + + + @@ -237,6 +305,14 @@ + + + + + + + + @@ -253,10 +329,18 @@ + + + + + + + + @@ -302,7 +386,7 @@ - + @@ -333,7 +417,6 @@ - @@ -342,8 +425,8 @@ - - + + + + + @@ -377,13 +464,17 @@ + + + + - - + + + + + + - - + - + - + + + + + + + + + + - - - - + + + + + - - + - + + + + + + + +
Table: Mobile native API modules
API submodule Functionality
AccountThe account +

Documentation:

+
    +
  • Guides:
    • +
  • Tutorials:
+ 		Account ManagerThe account APIs provide CRUD (Create, Read, Update, Delete) account management functionality.
OAuth 2.0
(since 2.4)		The OAuth 2.0 APIs provide easy way to gain access token between server and client.
Sync Manager
(since 2.4)		The Sync Manager API helps applications in scheduling their data sync operations.
Application Framework The Application Framework API contains submodule APIs for application development. The submodule APIs enable application life-cycle management, usage of functionality that is exported by other applications, and access to a user's application preferences. @@ -94,16 +129,15 @@
ShortcutAdds application shortcuts to the device home screen, which is the main landing screen of the device. -Adds application shortcuts to the device home screen, which is the main landing screen of the device.
WidgetWidget
(since 2.3.1)		 Handles Tizen widget application state changes and system events. It is also used to start and exit the main event loop of widget applications.
BaseThe Base API contains submodule APIs for internationalization support and contains various open source libraries. + BaseThe Base API contains submodule APIs for internationalization support and contains various open source libraries.

Documentation:

  • Guides: Base
    • @@ -112,8 +146,13 @@
C++ Standard Library Standard C++ library.
zlib
(since 2.4)		zlib is used for in-memory compression and decompression.
EGlibcGlibc Standard C library.
Sqlite Implements a lightweight SQL relational database. This is widely used for embedded client or local storage.
ContentThe Content API module contains submodule APIs for managing the most common device media data types, such as image, audio, and video files. It provides operations to search for content, search for content information stored on the device, create playlists, download content from servers through an HTTP connection, and access the EXIF information of an image file. + ContentThe Content API module contains submodule APIs for managing the most common device media data types, such as image, audio, and video files. It provides operations to search for content, search for content information stored on the device, create playlists, download content from servers through an HTTP connection, and access the EXIF information of an image file.

Documentation:

  • Guides: Content
    • @@ -157,10 +197,15 @@
Media Content Connects and disconnects from the media content service. This connection is required to insert, update and remove media file information in the media content database. Common media data types, such as image, audio, and video can be managed through the database. Other queries, such as searching for content and content information and accessing EXIF information from image files, are also possible.
Service Adaptor
(since 2.4)		The Service Adaptor API provides developer with common interfaces like using local service for various service infra.
ContextThe Context API module contains submodule APIs to detect user information such as when a user is running with a device and device information such as gestures when a device is tilted. + ContextThe Context API module contains submodule APIs to detect user information such as when a user is running with a device and device information such as gestures when a device is tilted.

Documentation:

  • Guides: Context
    • @@ -172,9 +217,19 @@
Gesture Recognition Detects user gestures on devices, such as tilt, snap, and double-tap.
Contextual History
(since 2.4)		Allows you to query statistics and patterns derived from contextual history data.
Contextual Trigger
(since 2.4)		The contextual trigger API provides a way to define rules, each of which can trigger a specified action when the rule is satisfied.
LocationThe Location API module allows the geographical position of a device to be determined for use with location-based services. + LocationThe Location API module allows the geographical position of a device to be determined for use with location-based services.

Documentation:

Location Manager Acquires information about the geographical location of the device. It also allows the receiving of notifications about position changes, velocity changes, and when a given geographical area is left.
Geofence Manager
(since 2.4)		This Geofence Manager API provides service related to geofence(geo-fence).
Maps Service
(since 2.4)		Maps API provides a developer with a set of functions, helping to create Maps aware applications.
Messaging The Messaging API module contains submodule APIs which grant access to the messaging capabilities, such as SMS, MMS and email, of the device. @@ -204,8 +268,8 @@
MultimediaThe Multimedia API module contains submodule APIs for easily integrating an application with audio, image, and video files. It can also be used for image editing. + MultimediaThe Multimedia API module contains submodule APIs for easily integrating an application with audio, image, and video files. It can also be used for image editing.

Documentation:

Media Codec Provides interfaces for encoding and decoding audio and video data, such as AAC audio or MPEG-4 AVC video.
Media Controller
(since 2.4)		The Media Controller API provides functions for communication between the media controller server and the media controller client.
Media Tool Handles audio and video packet buffers. These buffers are utilized by the other Multimedia submodule APIs.Metadata Extractor Extracts metadata information from an input media file.
Metadata Editor
(since 2.4)		The Metadata Editor API provides functions for editing the metadata of several popular audio format.
Media Vision
(since 2.4)		Media Vision library provides functionality for barcodes detection and generation.
OpenAL Efficiently renders multichannel 3D audio.Recorder Controls the recording of multimedia content. Recording process attributes, such as setting the recording filename and file format, can also be configured with this API submodule.
Screen Mirroring
(since 2.4)		The Screen Mirroring API provides functions for screen mirroring as sink.
Sound Manager Provides functions to get and set sound parameters, such as output sound volume. Session policy, such as the handling of sound session interrupts, can also be configured with this API submodule.
Thumbnail Util
(since 2.4)		The Thumbnail Util API provides functions for creating the thumbnail from an input media file.
Tone Player Plays and stops tones.Manages the settings of Wi-Fi Direct™. This submodule API also provides functions to connect and disconnect remote devices that use Wi-Fi Direct™.
SmartcardSmartcard
(since 2.3.1)		 Provides application communication to the SE applet methods.
Account Manager An account is a collection of information representing the user of a specific account provider. This API submodule creates and manages accounts, retrieves account information, and receives account change notifications.
Calendar Manages calendars, including events and tasks. It also stores and queries calendar information.
Manages phone contact information, such as address books, persons, and phone logs.
SystemThe System API module contains submodule APIs for system management. + SystemThe System API module contains submodule APIs for system management.

Documentation:

  • Guides: System
    • @@ -352,6 +435,10 @@
Device Controls devices and monitors their status. For example, this submodule API can be used to control and monitor the device battery, display, and LED.
Feedback
(since 2.4)		The Feedback API provides functions to play sound or vibration associated with properties.
Media key Provides methods to handle media keys from external devices that are connected to the Tizen device, such as the volume control buttons on a headset.Manages system settings, such as the lock screen settings.
T-trace
(since 2.4)		The T-trace API provides functions for writing trace message to the system trace buffer.
dlog Sends log output and filters log messages from the dlog logging service.
TelephonyThe Telephony API module contains a submodule API to enable an application to access the telephony capabilities of the device, such as the call facility (call information and status), the network query services, and the SIM module. + TelephonyThe Telephony API module contains a submodule API to enable an application to access the telephony capabilities of the device, such as the call facility (call information and status), the network query services, and the SIM module.

Documentation:

Telephony Information Obtains call, network, and SIM information.
Phonenumber Utils
(since 2.4)		The phonenumber utils API provides methods for parsing and formatting phone numbers.
UI FrameworkThe UI Framework API module contains submodule APIs and open source libraries for 2D and 3D graphics and text. + UI FrameworkThe UI Framework API module contains submodule APIs and open source libraries for 2D and 3D graphics and text.

Documentation:

 CairoA library for 2D vector graphics drawing. Vector graphics are advantageous because they have small file sizes and can be scaled to any size without any loss of image quality.A library for 2D vector graphics drawing. Vector graphics are advantageous because they have small file sizes and can be scaled to any size without any loss of image quality. Cairo EvasGL APIs have been newly added since 2.3.1
EFLEFL EFL is a collection of libraries that are independent and can be built on top of each other to provide useful features that complement the existing environment.
EFL UTIL Gets and sets the priority order of notification windows.
EFL Extension
(since 2.3.1)		EFL Extension provides functionalities to enhance the EFL libraries. It includes device-specific features (like support for hard back key).
External Output Manager
(since 2.4)		The External Output Manager provides APIs for external outputs.
Fontconfig and Freetype A text rendering library and font-handling library to let applications find a font or closely matching font.
OpenGL ES 1.1 and 2.0Library for rendering 3D and 2D graphics in embedded systems.
Minicontrol
(since 2.4)		Provides functions for creating EFL socket window and displaying EFL socket window.
TBM Surface The Tizen Buffer Manager (TBM) surface provides functions for the graphics buffer.
UIXThe UIX API module contains submodule APIs for managing sound data, such as voice commands. + UIXThe UIX API module contains submodule APIs for managing sound data, such as voice commands.

Documentation:

  • Guides: UIX
    • @@ -436,7 +542,14 @@
TTS This API submodule provides functions for synthesizing voice from text and playing synthesized sound data.
Input Method
(since 2.4)		The Input Method API provides the functions for starting IME application lifecycle, methods to interact with current UI state of IME, and getting attributes/events.
Voice control
(since 2.4)		The Voice control API provides functions for registering command and getting notification when registered command is recognized.
Web The Web API module contains submodule APIs for browsing the Internet, tracking browsing history, downloading Web content, and manipulating JavaScript Object Notation (JSON) documents.

Documentation:

@@ -457,7 +570,7 @@
-

The following figure and table define the wearable native API layout. The table describes the API modules and the functionality of all their submodule APIs within that module. The table also acts as a reference source for when you are planning a new feature for your application and need a way to efficiently compare different API modules to decide which APIs to use.

+

The following table describes the API modules in the wearable profile and the functionality of all their submodule APIs.

@@ -469,10 +582,7 @@
- -

Figure: Wearable native API layout

-

Wearable native API layout

- + @@ -482,6 +592,25 @@ + + + + + + + + + + + + + + - - + + + + + - + @@ -575,8 +708,8 @@ - - + + + + + - - + + + + + - - - + + + + + @@ -663,6 +808,14 @@ + + + + + + + + @@ -678,11 +831,15 @@ - + + + + + @@ -742,8 +899,17 @@ - - + + + + + + - + + + + + @@ -775,15 +945,19 @@ - + + + + + - - + + + + + - - + - + - + + + + + + + + + - - - - + + + + - - + + + + + + + + +
Table: Wearable native API modules
API submodule Functionality
AccountThe account +

Documentation:

+
    +
  • Guides:
    • +
  • Tutorials:
+ 		Account ManagerThe account APIs provide CRUD (Create, Read, Update, Delete) account management functionality.
OAuth 2.0
(since 2.4)		The OAuth 2.0 APIs provide easy way to gain access token between server and client.
Sync Manager
(since 2.4)		The Sync Manager API helps applications in scheduling their data sync operations.
Application Framework The Application Framework API contains submodule APIs for application development. The submodule APIs enable application life-cycle management, usage of functionality that is exported by other applications, and access to a user's application preferences. @@ -536,8 +665,8 @@ Handles Tizen widget application state changes and system events. It is also used to start and exit the main event loop of widget applications.
BaseThe Base API contains submodule APIs for internationalization support and contains various open source libraries. + BaseThe Base API contains submodule APIs for internationalization support and contains various open source libraries.

Documentation:

  • Guides: Base
    • @@ -546,8 +675,12 @@
C++ Standard Library Standard C++ library.
zlib
(since 2.4)		zlib is used for in-memory compression and decompression.
EGlibcGlibc Standard C library.
Implements a lightweight SQL relational database. This is widely used for embedded client or local storage.
ContentThe Content API module contains submodule APIs for managing the most common device media data types, such as image, audio, and video files. It provides operations to search for content, search for content information stored on the device, create playlists, download content from servers through an HTTP connection, and access the EXIF information of an image file. + ContentThe Content API module contains submodule APIs for managing the most common device media data types, such as image, audio, and video files. It provides operations to search for content, search for content information stored on the device, create playlists and access the EXIF information of an image file.

Documentation:

  • Guides: Content
    • @@ -588,6 +721,10 @@
Media Content Connects and disconnects from the media content service. This connection is required to insert, update and remove media file information in the media content database. Common media data types, such as image, audio, and video can be managed through the database. Other queries, such as searching for content and content information and accessing EXIF information from image files, are also possible.
Download
(Since 2.4)		Creates and manages one or more download requests. Content is downloaded from servers through an HTTP connection.
Context The Context API module contains submodule APIs to detect user information such as when a user is running with a device and device information such as gestures when a device is tilted. @@ -603,8 +740,8 @@ Detects user gestures on devices, such as tilt, snap, and double-tap.
LocationThe Location API module allows the geographical position of a device to be determined for use with location-based services. + LocationThe Location API module allows the geographical position of a device to be determined for use with location-based services.

Documentation:

Location Manager Acquires information about the geographical location of the device. It also allows the receiving of notifications about position changes, velocity changes, and when a given geographical area is left.
Maps Service
(since 2.4)		Maps API provides a developer with a set of functions, helping to create Maps aware applications.
MessagingThe Messaging API module contains submodule APIs which grant access to the messaging capabilities, such as SMS, MMS and email, of the device. + The Messaging API module contains submodule APIs which grant access to the messaging capabilities, such as SMS, MMS of the device.

Documentation:

MultimediaThe Multimedia API module contains submodule APIs for easily integrating an application with audio, image, and video files. It can also be used for image editing. + MultimediaThe Multimedia API module contains submodule APIs for easily integrating an application with audio, image, and video files. It can also be used for image editing.

Documentation:

Media Codec Provides interfaces for encoding and decoding audio and video data, such as AAC audio or MPEG-4 AVC video.
Media Controller
(since 2.4)		The Media Controller API provides functions for communication between the media controller server and the media controller client.
Media Tool Handles audio and video packet buffers. These buffers are utilized by the other Multimedia submodule APIs.Metadata Extractor Extracts metadata information from an input media file.
Metadata Editor
(since 2.4)		The Metadata Editor API provides functions for editing the metadata of several popular audio format.
Media Vision
(since 2.4)		Media Vision library provides functionality for barcodes detection and generation.
OpenAL Efficiently renders multichannel 3D audio.
Recorder Controls the recording of multimedia content. Recording process attributes, such as setting the recording filename and file format, can also be configured with this API submodule.
Sound Manager Provides functions to get and set sound parameters, such as output sound volume. Session policy, such as the handling of sound session interrupts, can also be configured with this API submodule.
Thumbnail Util
(since 2.4)		The Thumbnail Util API provides functions for creating the thumbnail from an input media file.
Tone Player Plays and stops tones.Retrieves and displays privilege information. This can be used to show a user the privileges that an application contains when they are downloading it onto their device. This is so that they are aware of the resources which the application may access.
SystemThe System API module contains submodule APIs for system management. + SocialThe Social API module contains submodule APIs to manage personal data, such as contacts and calendars on a device. +

Documentation:

+ 		Contacts
(Since 2.4)		Manages phone contact information, such as address books, persons, and phone logs.
SystemThe System API module contains submodule APIs for system management.

Documentation:

  • Guides: System
    • @@ -752,7 +918,11 @@
Device Controls devices and monitors their status. For example, this submodule API can be used to control and monitor the device battery, display, and LED.
Feedback
(since 2.4)		The Feedback API provides functions to play sound or vibration associated with properties.
Media key Provides methods to handle media keys from external devices that are connected to the Tizen device, such as the volume control buttons on a headset.
System Settings Manages system settings, such as the lock screen settings.
T-trace
(since 2.4)		The T-trace API provides functions for writing trace message to the system trace buffer.
dlog Sends log output and filters log messages from the dlog logging service.
TelephonyThe Telephony API module contains a submodule API to enable an application to access the telephony capabilities of the device, such as the call facility (call information and status), the network query services, and the SIM module. + TelephonyThe Telephony API module contains a submodule API to enable an application to access the telephony capabilities of the device, such as the call facility (call information and status), the network query services, and the SIM module.

Documentation:

Telephony Information Obtains call, network, and SIM information.
Phonenumber Utils
(since 2.4)		The phonenumber utils API provides methods for parsing and formatting phone numbers.
UI FrameworkThe UI Framework API module contains submodule APIs and open source libraries for 2D and 3D graphics and text. + UI FrameworkThe UI Framework API module contains submodule APIs and open source libraries for 2D and 3D graphics and text.

Documentation:

 CairoA library for 2D vector graphics drawing. Vector graphics are advantageous because they have small file sizes and can be scaled to any size without any loss of image quality.A library for 2D vector graphics drawing. Vector graphics are advantageous because they have small file sizes and can be scaled to any size without any loss of image quality. This module also includes Cairo EvasGL APIs which have been designed to support hardware-accelerated rendering.
EFLEFL EFL is a collection of libraries that are independent and can be built on top of each other to provide useful features that complement the existing environment.
EFL UTIL Gets and sets the priority order of notification windows.
EFL ExtensionEFL Extension provides functionalities to enhance the EFL libraries. It includes device-specific features (like support for hard back key).
External Output Manager
(since 2.4)		The External Output Manager provides APIs for external outputs.
Fontconfig and Freetype A text rendering library and font-handling library to let applications find a font or closely matching font.
OpenGL ES 1.1 and 2.0Library for rendering 3D and 2D graphics in embedded systems.
Minicontrol
(since 2.4)		Provides functions for creating EFL socket window and displaying EFL socket window.
TBM Surface The Tizen Buffer Manager (TBM) surface provides functions for the graphics buffer.
UIXThe UIX API module contains submodule APIs for managing sound data, such as voice commands. + UIXThe UIX API module contains submodule APIs for managing sound data, such as voice commands.

Documentation:

  • Guides: UIX
    • @@ -836,6 +1022,14 @@
TTS This API submodule provides functions for synthesizing voice from text and playing synthesized sound data.
Input Method
(since 2.4)		The Input Method API provides the functions for starting IME application lifecycle, methods to interact with current UI state of IME, and getting attributes/events.
Voice control
(since 2.4)		The Voice control API provides functions for registering command and getting notification when registered command is recognized.
Web The Web API module contains submodule APIs for browsing the Internet, tracking browsing history, downloading Web content, and manipulating JavaScript Object Notation (JSON) documents. -- 2.7.4