ppb_removable_storage_dev.h

Go to the documentation of this file.

/* Copyright (c) 2013 Samsung Electronics. All rights reserved.
 */

/* From dev/ppb_removable_storage_dev.idl modified Fri Jan  3 07:37:36 2014. */

#ifndef PPAPI_C_DEV_PPB_REMOVABLE_STORAGE_DEV_H_
#define PPAPI_C_DEV_PPB_REMOVABLE_STORAGE_DEV_H_

#include "ppapi/c/dev/ppb_device_ref_dev.h"
#include "ppapi/c/pp_array_output.h"
#include "ppapi/c/pp_bool.h"
#include "ppapi/c/pp_completion_callback.h"
#include "ppapi/c/pp_instance.h"
#include "ppapi/c/pp_macros.h"
#include "ppapi/c/pp_resource.h"
#include "ppapi/c/pp_stdint.h"

#define PPB_REMOVABLESTORAGE_DEV_INTERFACE_0_1 "PPB_RemovableStorage(Dev);0.1"
#define PPB_REMOVABLESTORAGE_DEV_INTERFACE \
    PPB_REMOVABLESTORAGE_DEV_INTERFACE_0_1

/**
 * @file
 * This file defines the <code>PPB_RemovableStorage_Dev</code> interface, which
 * enumarates the removable storage devices and notifies about their change.
 */


/**
 * @addtogroup Interfaces
 * @{
 */
/**
 * The <code>PPB_RemovableStorage_Dev</code> interface enumarates the removable
 * storage devices and notifies about their change.
 */
struct PPB_RemovableStorage_Dev_0_1 {
  /**
   * Creates a removable storage resource.
   *
   * @param[in] instance A <code>PP_Instance</code> identifying one instance of
   * a module.
   *
   * @return A <code>PP_Resource</code> corresponding to a removable storage
   * resource if successful, 0 if failed.
   */
  PP_Resource (*Create)(PP_Instance instance);
  /**
   * Determines if the given resource is a removable storage resource.
   *
   * @param[in] resource A <code>PP_Resource</code> containing a resource.
   *
   * @return A <code>PP_Bool</code> containing <code>PP_TRUE</code> if the given
   * resource is a removable storage resource, otherwise <code>PP_FALSE</code>.
   */
  PP_Bool (*IsRemovableStorage)(PP_Resource resource);
  /**
   * Enumerates removable storage devices.
   *
   * @param[in] removable_storage A <code>PP_Resource</code> corresponding to
   * a removable storage resource.
   * @param[in] output An output array which will receive
   * <code>PPB_RemovableStorageDeviceRef</code> resources on success. Please
   * note that the ref count of those resources has already been increased by
   * 1 for the caller.
   * @param[in] callback A <code>PP_CompletionCallback</code> to run on
   * completion.
   *
   * @return An error code from <code>pp_errors.h</code>.
   */
  int32_t (*EnumerateDevices)(PP_Resource removable_storage,
                              struct PP_ArrayOutput output,
                              struct PP_CompletionCallback callback);
  /**
   * Requests device change notifications.
   *
   * @param[in] removable_storage A <code>PP_Resource</code> corresponding to
   * a removable storage resource.
   * @param[in] callback The callback to receive notifications. If not NULL, it
   * will be called once for the currently available devices, and then every
   * time the list of available devices changes. All calls will happen on the
   * same thread as the one on which MonitorDeviceChange() is called. It will
   * receive notifications until <code>removable_storage</code> is destroyed or
   * <code>MonitorDeviceChange()</code> is called to set a new callback for
   * <code>removable_storage</code>. You can pass NULL to cancel sending
   * notifications.
   * @param[inout] user_data An opaque pointer that will be passed to
   * <code>callback</code>.
   *
   * @return An error code from <code>pp_errors.h</code>.
   */
  int32_t (*MonitorDeviceChange)(PP_Resource removable_storage,
                                 PP_MonitorDeviceChangeCallback callback,
                                 void* user_data);
  /**
   * Opens removable file system.
   *
   * @param[in] removable_storage A <code>PP_Resource</code> corresponding to
   * a removable storage resource.
   * @param[in] file_system A <code>PP_Resource</code> corresponding to a file
   * system of PP_FILESYSTEMTYPE_REMOVABLESTORAGE type.
   * @param[in] device_ref A <code>PP_Resource</code> corresponding to a device
   * reference.
   * @param[in] callback A <code>PP_CompletionCallback</code> to run on
   * completion.
   *
   * @return An error code from <code>pp_errors.h</code>.
   */
  int32_t (*Open)(PP_Resource removable_storage,
                  PP_Resource file_system,
                  PP_Resource device_ref,
                  struct PP_CompletionCallback callback);
};

typedef struct PPB_RemovableStorage_Dev_0_1 PPB_RemovableStorage_Dev;
/**
 * @}
 */

#endif  /* PPAPI_C_DEV_PPB_REMOVABLE_STORAGE_DEV_H_ */