ppb_service_list_samsung.h

Go to the documentation of this file.

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

/* From samsung/ppb_service_list_samsung.idl,
 *   modified Fri Aug 14 12:49:41 2015.
 */

#ifndef PPAPI_C_SAMSUNG_PPB_SERVICE_LIST_SAMSUNG_H_
#define PPAPI_C_SAMSUNG_PPB_SERVICE_LIST_SAMSUNG_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"
#include "ppapi/c/pp_var.h"
#include "ppapi/c/samsung/pp_search_criteria_samsung.h"

#define PPB_SERVICELIST_SAMSUNG_INTERFACE_0_2 "PPB_ServiceList_Samsung;0.2"
#define PPB_SERVICELIST_SAMSUNG_INTERFACE PPB_SERVICELIST_SAMSUNG_INTERFACE_0_2

/**
 * @file
 * This file defines the <code>PPB_ServiceList_Samsung</code> interface.
 */


/**
 * @addtogroup Typedefs
 * @{
 */
/**
 * Defines the callback type to receive notifacation about changes
 * in program schedule table.
 *
 * @param[inout] user_data The opaque pointer that the caller passed into
 * <code>MonitorScheduleChanges()</code>.
 */
typedef void (*PPB_ProgramSchedule_Monitoring_Callback)(void* user_data);
/**
 * @}
 */

/**
 * @addtogroup Interfaces
 * @{
 */
/**
 * Interface implemented by browser for to retriev service list.
 *
 */
struct PPB_ServiceList_Samsung_0_2 {
  /**
   * Create() creates an service list resource.
   *
   * @param[in] instance A <code>PP_Instance</code> identifying one instance
   * of a module.
   *
   * @return A <code>PP_Resource</code> containing the service list resource if
   * successful or 0 if resource cannot be created.
   */
  PP_Resource (*Create)(PP_Instance instance);
  /**
   * isServiceList() checks if provided resource is service list.
   *
   * @param[in] resource A <code>PP_Resource</code> identifying
   * resource that may be checked.
   *
   * @return <code>PP_TRUE<code> if resource identifying service
   * list and <code>PP_FALSE<code> otherwise.
   */
  PP_Bool (*IsServiceList)(PP_Resource resource);
  /**
   * GetServiceList() provides list <code>PP_Resource</code> identifying
   * available Program Schedule Resources for available services.
   *
   * @param[in] resource A <code>PP_Resource</code> identifying service
   * list resource.
   *
   * @param[in] output <code>PP_ArrayOutput</code> in which
   * <code>PP_Resource</code> will be returned.
   *
   * @param[in] callback <code>PP_CompletionCallback</code> that will
   * be run when output will be ready.
   *
   * @return <code>PP_OK<code> if succeed. Error from PP_ERROR otherwise.
   */
  int32_t (*GetServiceList)(PP_Resource resource,
                            struct PP_ArrayOutput output,
                            struct PP_CompletionCallback callback);
  int32_t (*MonitorScheduleChanges)(
      PP_Resource resource,
      PPB_ProgramSchedule_Monitoring_Callback callback,
      void* user_data);
  /**
   * FindService() finds first <code>PP_Resource</code> identifying first
   * Program Schedule Resource fitting criteria.
   *
   * @param[in] resource A <code>PP_Resource</code> identifying service
   * list resource.
   *
   * @param[in] criteria <code>PP_SearchCriteria</code> for service search.
   *
   * @param[inout] output <code>PP_Resource</code> identifying first
   * Program Schedule Resource fitting criteria.
   *
   * @param[in] callback <code>PP_CompletionCallback</code> that will
   * be run when output will be ready.
   *
   * @return <code>PP_OK<code> if succeed. Error from PP_ERROR otherwise.
   */
  int32_t (*FindService)(PP_Resource resource,
                         const struct PP_SearchCriteria* criteria,
                         PP_Resource* output,
                         struct PP_CompletionCallback callback);
  /**
   * ChangeService() changes current service to one identified by provided
   * serviceID.
   *
   * @param[in] resource A <code>PP_Resource</code> identifying service
   * list resource.
   *
   * @param[in] serviceID <code>uint32_t</code> for service identification.
   *
   * @param[in] callback <code>PP_CompletionCallback</code> that will
   * be run when output will be ready.
   *
   * @return <code>PP_OK<code> if succeed. Error from PP_ERROR otherwise.
   */
  int32_t (*ChangeService)(PP_Resource resource,
                           uint64_t serviceID,
                           struct PP_CompletionCallback callback);
};

typedef struct PPB_ServiceList_Samsung_0_2 PPB_ServiceList_Samsung;
/**
 * @}
 */

#endif  /* PPAPI_C_SAMSUNG_PPB_SERVICE_LIST_SAMSUNG_H_ */