ppb_program_schedule_samsung.h

Go to the documentation of this file.

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

/* From samsung/ppb_program_schedule_samsung.idl,
 *   modified Tue Jan 12 10:16:16 2016.
 */

#ifndef PPAPI_C_SAMSUNG_PPB_PROGRAM_SCHEDULE_SAMSUNG_H_
#define PPAPI_C_SAMSUNG_PPB_PROGRAM_SCHEDULE_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_macros.h"
#include "ppapi/c/pp_resource.h"
#include "ppapi/c/pp_stdint.h"
#include "ppapi/c/pp_time.h"
#include "ppapi/c/pp_var.h"
#include "ppapi/c/samsung/pp_epg_event_samsung.h"

#define PPB_PROGRAMSCHEDULE_SAMSUNG_INTERFACE_0_2 \
    "PPB_ProgramSchedule_Samsung;0.2"
#define PPB_PROGRAMSCHEDULE_SAMSUNG_INTERFACE \
    PPB_PROGRAMSCHEDULE_SAMSUNG_INTERFACE_0_2

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


/**
 * @addtogroup Interfaces
 * @{
 */
/**
 * Interface used to retrieve EPG events from transport stream.
 */
struct PPB_ProgramSchedule_Samsung_0_2 {
  /**
   * IsProgramSchedule() checks if provided resource is program schedule.
   *
   * @param[in] resource A <code>PP_Resource</code> identifying resource that
   * will be checked.
   *
   * @return <code>PP_TRUE<code> if resource is identifying program schedule and
   * <code>PP_FALSE<code> otherwise.
   */
  PP_Bool (*IsProgramSchedule)(PP_Resource resource);
  /**
   * GetID() provides ID of service identified by resource.
   *
   * @param[in] resource A <code>PP_Resource</code> identifying program
   * schedule resource.
   *
   * @return <code>uint64_t<code> with ID of service.
   */
  uint64_t (*GetID)(PP_Resource resource);
  /**
   * GetName() provides name of service identified by resource.
   *
   * @param[in] resource A <code>PP_Resource</code> identifying program
   * schedule resource.
   *
   * @return <code>PP_Var<code> of type string, with name of service.
   */
  struct PP_Var (*GetName)(PP_Resource resource);
  /**
   * GetType() provides type of service identified by resource.
   *
   * @param[in] resource A <code>PP_Resource</code> identifying program
   * schedule resource.
   *
   * @return <code>PP_ServiceType<code> with type of service. More information
   * in pp_epg_event.h.
   */
  PP_ServiceType (*GetType)(PP_Resource resource);
  /**
   * GetScheduledEvents() provides array of EPG events from scheduled table
   * for service associated whit program schedule resource.
   *
   * @param[in] resource A <code>PP_Resource</code> identifying program
   * schedule resource.
   *
   * @param[in] start_time <code>PP_Time</code> with beginning of
   * requested schedule.
   *
   * @param[in] end_time <code>PP_Time</code> with end of requested schedule.
   *
   * @param[in] output <code>PP_ArrayOutput</code> in which
   * <code>PP_EPGEvent</code> will be returned, ref count for vars in
   * PP_EPGEvent is increased on behalf of the plugin.
   *
   * @param[in] callback <code>PP_CompletionCallback</code> that will be run
   * when output will be ready.
   *
   * @return <code>PP_Error<code> with error code.
   */
  int32_t (*GetScheduledEvents)(PP_Resource resource,
                                PP_Time start_time,
                                PP_Time end_time,
                                struct PP_ArrayOutput output,
                                struct PP_CompletionCallback callback);
  /**
   * GetPresentFollowing() provides array of EPG events from present/following
   * table for service associated whit program schedule resource.
   *
   * @param[in] resource A <code>PP_Resource</code> identifying program
   * schedule resource.
   *
   * @param[in] output <code>PP_ArrayOutput</code> in which
   * <code>PP_EPGEvent</code> will be returned, ref count for vars in
   * PP_EPGEvent is increased on behalf of the plugin.
   *
   * @param[in] callback <code>PP_CompletionCallback</code> that will be run
   * when output will be ready.
   *
   * @return <code>PP_Error<code> with error code.
   */
  int32_t (*GetPresentFollowing)(PP_Resource resource,
                                 struct PP_ArrayOutput output,
                                 struct PP_CompletionCallback callback);
  /**
   * SetRatingLock() sets lock for displaying programs of certain rating.
   *
   * @param[in] resource A <code>PP_Resource</code> identifying program
   * schedule resource.
   *
   * @param[in] program <code>PP_EPGInfo</code> from which rating is taken
   * to be edited.
   *
   * @param[in] state <code>PP_Bool</code> of lock to be set.
   *
   * @param[in] callback <code>PP_CompletionCallback</code> that will be run
   * when output will be ready.
   *
   * @return <code>PP_Error<code> with error code.
   */
  int32_t (*SetRatingLock)(PP_Resource resource,
                           const struct PP_RatingInfo* rating_info,
                           PP_Bool set_lock,
                           struct PP_CompletionCallback callback);
  /**
   * GetRatingLock() gets lock status for displaying programs of certain rating.
   *
   * @param[in] resource A <code>PP_Resource</code> identifying program
   * schedule resource.
   *
   * @param[in] program <code>PP_EPGInfo</code> from which rating is taken
   * to be edited.
   *
   * @param[out] state <code>PP_Bool</code> of the lock.
   *
   * @param[in] callback <code>PP_CompletionCallback</code> that will be run
   * when output will be ready.
   *
   * @return <code>PP_Error<code> with error code.
   */
  int32_t (*GetRatingLock)(PP_Resource resource,
                           const struct PP_RatingInfo* rating_info,
                           PP_Bool* lock_state,
                           struct PP_CompletionCallback callback);
};

typedef struct PPB_ProgramSchedule_Samsung_0_2 PPB_ProgramSchedule_Samsung;
/**
 * @}
 */

#endif  /* PPAPI_C_SAMSUNG_PPB_PROGRAM_SCHEDULE_SAMSUNG_H_ */