program_schedule_samsung.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015 Samsung Electronics, Visual Display Division.
 * All Rights Reserved.
 *
 * @author  Mikolaj Kamionka <m.kamionka@samsung.com>
 *
 * Use of this source code is governed by a BSD-style license that can be
 * found in the Chromium-LICENSE file.
 */

#ifndef PPAPI_CPP_SAMSUNG_PROGRAM_SCHEDULE_SAMSUNG_H_
#define PPAPI_CPP_SAMSUNG_PROGRAM_SCHEDULE_SAMSUNG_H_

#include "ppapi/c/pp_time.h"
#include "ppapi/c/samsung/ppb_program_schedule_samsung.h"
#include "ppapi/cpp/completion_callback.h"
#include "ppapi/cpp/resource.h"
#include "ppapi/cpp/var.h"

namespace pp {

class InstanceHandle;

class ProgramScheduleSamsung : public Resource {
public:

  ProgramScheduleSamsung();

  ProgramScheduleSamsung(PP_Resource resource);

  ProgramScheduleSamsung(PassRef, PP_Resource resource);

  ProgramScheduleSamsung(const ProgramScheduleSamsung& other);
  /**
   * GetID() provides ID of service identified by resource.
   *
   * @return <code>uint64_t<code> with ID of service.
   */
  uint64_t GetID();
  /**
   * GetName() providing name of service identified by resource.
   *
   * @return <code>PP_Var<code> of type string, with name of service.
   */
  Var GetName();
  /**
   * GetType() providing type of service identified by resource.
   *
   * @return <code>PP_ServiceType<code> with type of service. More information
   * in pp_epg_event.h.
   */
  PP_ServiceType GetType();
  /**
   * GetScheduledEvents() providing array of EPG events from scheduled table
   * for service associated whit 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] callback <code>CompletionCallbackWithOutput</code> that will
   * be run when output will be ready.
   *
   * @return <code>PP_Error<code> with error code.
   */
  int32_t GetScheduledEvents(PP_Time start_time, PP_Time end_time,
      const CompletionCallbackWithOutput< std::vector<PP_EPGEvent> >&
      callback);
  /**
   * GetPresentFollowing() providing array of EPG events from present/following
   * table for service associated with program schedule resource.
   *
   * @param[in] callback <code>CompletionCallbackWithOutput</code> that will
   * be run when output will be ready.
   *
   * @return <code>PP_Error<code> with error code.
   */
  int32_t GetPresentFollowing(
      const CompletionCallbackWithOutput< std::vector<PP_EPGEvent> >&
      callback);
  /**
   * GetProgramGenre() gets genre of certain program from the service
   * associated with program schedule resource.
   *
   * @param[in] event <code>PP_EPGEvent</code> to get genre of event.
   *
   * @param[in] callback <code>CompletionCallbackWithOutput</code> that will
   * be run when output will be ready.
   *
   * @return <code>PP_Error<code> with error code.
   */
  int32_t GetProgramGenre(const struct PP_EPGEvent* event,
      const CompletionCallbackWithOutput<PP_ProgramGenre>& callback);
  /**
   * SetRatingLock() sets lock for displaying programs of certain rating.
   *
   * @param[in] program <code>PP_RatingInfo</code> from which rating is taken
   *
   * @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(const struct PP_RatingInfo* ratingInfo, PP_Bool setLock,
      const CompletionCallback& callback);
  /**
   * GetRatingLock() gets lock status for displaying programs of certain rating.
   *
   * @param[in] program <code>PP_RatingInfo</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.R
   */
  int32_t GetRatingLock(const struct PP_RatingInfo* ratingInfo,
      const CompletionCallbackWithOutput< PP_Bool >& callback);
};

}  // namespace pp


#endif /* PPAPI_CPP_SAMSUNG_PROGRAM_SCHEDULE_SAMSUNG_H_ */