doc/mtp_doc.h

   1 /*
   2  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef __TIZEN_NETWORK_MTP_DOC_H__
  18 #define __TIZEN_NETWORK_MTP_DOC_H__
  19
  20 /**
  21  * @defgroup    CAPI_NETWORK_MTP_MODULE MTP
  22  * @brief       The MTP API provides functions for support PTP(Picture Transfer Protocol) subset of MTP(Media Transfer Protocol).
  23  * @ingroup     CAPI_NETWORK_FRAMEWORK
  24  *
  25  * @section CAPI_NETWORK_MTP_MODULE_HEADER Required Header
  26  * \#include <mtp.h>
  27  * @section     CAPI_NETWORK_MTP_MODULE_OVERVIEW Overview
  28  * <table>
  29  *      <tr>
  30  *              <th> API </th>
  31  *              <th> Description </th>
  32  *      </tr>
  33  *      <tr>
  34  *              <td> @ref CAPI_NETWORK_MTP_MANAGER_MODULE</td>
  35  *              <td> Provide functions to establish connection to access MTP responder device, and to Get/Delete files</td>
  36  *      </tr>
  37  *      <tr>
  38  *              <td> @ref CAPI_NETWORK_MTP_DEVICEINFO_MODULE</td>
  39  *              <td> Provide functions to gets the device information of MTP responder device</td>
  40  *      </tr>
  41  *      <tr>
  42  *              <td> @ref CAPI_NETWORK_MTP_STORAGEINFO_MODULE</td>
  43  *              <td> Provide functions to gets the storage information of MTP responder storage</td>
  44  *      </tr>
  45  *      <tr>
  46  *              <td> @ref CAPI_NETWORK_MTP_OBJECTINFO_MODULE</td>
  47  *              <td> Provide functions to gets the object information of certain file in MTP responder</td>
  48  *      </tr>
  49  * </table>
  50  *
  51  * MTP is consist of three components :
  52  * 1. MTP device
  53  * -  Meaning that the device supports MTP.
  54  * -  Having mtp-responder role.
  55  * -  Having one or more MTP storages.
  56  *
  57  * 2. MTP storage
  58  * -  Meaning that the storage in the mtp device.
  59  * -  Having zero or more MTP objects.
  60  *
  61  * 3. MTP object
  62  * -  MTP object meaning is the actual file.
  63  * -  Each file in the device has a unique handle called "Object Handle".
  64  *    This is not a unique handle each storage.
  65  * -  Mtp object is to have the parent object, so it can indicate a file hierarchy.
  66  *    If parent object is 0, then it means object is in root of storage.
  67  **/
  68
  69 /**
  70  * @defgroup    CAPI_NETWORK_MTP_MANAGER_MODULE MTP Manager
  71  * @brief       The MTP Manager API provides functions for establish connection to access MTP responder device, and to Get/Delete files.
  72  * @ingroup     CAPI_NETWORK_MTP_MODULE
  73  *
  74  * @section     CAPI_NETWORK_MTP_MANAGER_MODULE_HEADER Required Header
  75  *      \#include <mtp.h>
  76  * @section     CAPI_NETWORK_MTP_MANAGER_MODULE_OVERVIEW Overview
  77  * The MTP manager api provides following functions :\n
  78  * - Create / destroy connection to access MTP responder device\n
  79  * - Get Device list\n
  80  * - Get Storage list\n
  81  * - Get Object handles\n
  82  * - Get thumbnail\n
  83  * - Get Object\n
  84  * - Delete Object\n
  85  *
  86  * @section     CAPI_NETWORK_MTP_MANAGER_MODULE_FEATURE Related Features
  87  * This API is related with the following features:\n
  88  * - http://tizen.org/feature/network.mtp\n
  89  *
  90  * It is recommended to design feature related codes in your application for reliability.\n
  91  *
  92  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
  93  *
  94  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
  95  *
  96  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tools/native-tools/manifest-text-editor#feature"><b>Feature List</b>.</a>
  97  *
  98  */
  99
 100 /*
 101  * @defgroup    CAPI_NETWORK_MTP_DEVICEINFO_MODULE MTP Device Information
 102  * @brief       The MTP Device Information API provides functions for gets the device information of MTP responder device.
 103  * @ingroup     CAPI_NETWORK_MTP_MODULE
 104  *
 105  * @section     CAPI_NETWORK_MTP_DEVICEINFO_MODULE_HEADER Required Header
 106  * \#include <mtp.h>
 107  * @section     CAPI_NETWORK_MTP_DEVICEINFO_MODULE_OVERVIEW Overview
 108  * The MTP Device Information api provides following functions :\n
 109  * - Get device manufacturer name\n
 110  * - Get device model name\n
 111  * - Get device serial number\n
 112  * - Get device version\n
 113  *
 114  * @section     CAPI_NETWORK_MTP_DEVICEINFO_MODULE_FEATURE Related Features
 115  * This API is related with the following features:\n
 116  * - http://tizen.org/feature/network.mtp\n
 117  *
 118  * It is recommended to design feature related codes in your application for reliability.\n
 119  *
 120  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
 121  *
 122  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
 123  *
 124  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tools/native-tools/manifest-text-editor#feature"><b>Feature List</b>.</a>
 125  *
 126  */
 127
 128
 129 /*
 130  * @defgroup    CAPI_NETWORK_MTP_STORAGEINFO_MODULE MTP Storage Information
 131  * @brief       The MTP Storage Information API provides functions for gets the storage information of MTP responder storage.
 132  * @ingroup     CAPI_NETWORK_MTP_MODULE
 133  *
 134  * @section     CAPI_NETWORK_MTP_STORAGEINFO_MODULE_HEADER Required Header
 135  * \#include <mtp.h>
 136  * @section     CAPI_NETWORK_MTP_STORAGEINFO_MODULE_OVERVIEW Overview
 137  * The MTP Storage Information api provides following functions :\n
 138  * - Get storage free space\n
 139  * - Get storage description\n
 140  * - Get storage type\n
 141  * - and, more storage information\n
 142  *
 143  * @section     CAPI_NETWORK_MTP_STORAGEINFO_MODULE_FEATURE Related Features
 144  * This API is related with the following features:\n
 145  * - http://tizen.org/feature/network.mtp\n
 146  *
 147  * It is recommended to design feature related codes in your application for reliability.\n
 148  *
 149  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
 150  *
 151  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
 152  *
 153  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tools/native-tools/manifest-text-editor#feature"><b>Feature List</b>.</a>
 154  *
 155  */
 156
 157 /*
 158  * @defgroup    CAPI_NETWORK_MTP_OBJECTINFO_MODULE MTP Object Information
 159  * @brief       The MTP Manager API provides functions for gets the object information of certain file in MTP responder.
 160  * @ingroup     CAPI_NETWORK_MTP_MODULE
 161  *
 162  * @section     CAPI_NETWORK_MTP_OBJECTINFO_MODULE_HEADER Required Header
 163  * \#include <mtp.h>
 164  * @section     CAPI_NETWORK_MTP_OBJECTINFO_MODULE_OVERVIEW Overview
 165  * The MTP Object Information api provides following functions :\n
 166  * - Get object format\n
 167  * - Get object name\n
 168  * - Get object size\n
 169  * - and, more object information\n
 170  *
 171  * @section     CAPI_NETWORK_MTP_OBJECTINFO_MODULE_FEATURE Related Features
 172  * This API is related with the following features:\n
 173  * - http://tizen.org/feature/network.mtp\n
 174  *
 175  * It is recommended to design feature related codes in your application for reliability.\n
 176  *
 177  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
 178  *
 179  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
 180  *
 181  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tools/native-tools/manifest-text-editor#feature"><b>Feature List</b>.</a>
 182  *
 183  */
 184
 185 #endif