ppp_media_control_samsung.h

Go to the documentation of this file.

/* Copyright (c) 2013 The Chromium Authors. All rights reserved.
 * Use of this source code is governed by a BSD-style license that can be
 * found in the LICENSE file.
 */

/* From samsung/ppp_media_control_samsung.idl,
 *   modified Wed Oct 26 12:20:59 2016.
 */

#ifndef PPAPI_C_SAMSUNG_PPP_MEDIA_CONTROL_SAMSUNG_H_
#define PPAPI_C_SAMSUNG_PPP_MEDIA_CONTROL_SAMSUNG_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/samsung/pp_media_common_samsung.h"
#include "ppapi/c/samsung/pp_media_control_samsung.h"

#define PPP_MEDIACONTROL_SAMSUNG_INTERFACE_0_9 "PPP_MediaControl_Samsung;0.9"
#define PPP_MEDIACONTROL_SAMSUNG_INTERFACE \
    PPP_MEDIACONTROL_SAMSUNG_INTERFACE_0_9

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


/**
 * @addtogroup Interfaces
 * @{
 */
/**
 * Interface allowing application to receive various events regarding
 * media playback (i.e. player state changes, duration update, media time
 * position changes etc.).
 *
 * All methods from this interface accepts |user_data| as the first parameter
 * which is set when registering interface.
 */
struct PPP_MediaControl_Samsung_0_9 {
  /**
   * Method called when controller handling particular stream/clip finish
   * transition to PLAYING state.
   *
   * |timestamp| - current time of media
   */
  void (*Play)(PP_Instance instance,
               PP_Resource media,
               PP_MicrosecondsDelta timestamp,
               void* user_data);
  /**
   * Method called when controller handling particular stream finish
   * transition to PAUSED state.
   */
  void (*Pause)(PP_Instance instance, PP_Resource media, void* user_data);
  /**
   * Signals that end of media has been reached, |error| argument of
   * PP_MediaError type signals if this is caused by some sort of error.
   */
  void (*Ended)(PP_Instance instance,
                PP_Resource media,
                PP_MediaError error,
                void* user_data);
  /**
   * Method called when played media playback time has been changed explicitly.
   */
  void (*Seeking)(PP_Instance instance,
                  PP_Resource media,
                  PP_MicrosecondsDelta seek_time,
                  void* user_data);
  /**
   * Method called when played stream duration has been changed.
   * |duration| is total stream duration in microseconds.
   */
  void (*DurationChange)(PP_Instance instance,
                         PP_Resource media,
                         PP_MicrosecondsDelta duration,
                         void* user_data);
  /**
   * Method called periodically while playing media to signal advance of
   * playback time. Minimal resolution of callback is 0.5s.
   * |media_times| represents current media time in microseconds from beginning
   * of the stream/clip.
   */
  void (*TimeUpdate)(PP_Instance instance,
                     PP_Resource media,
                     PP_MicrosecondsDelta media_time,
                     void* user_data);
  /**
   * Method called when media playback rate is changed.
   * |plaback_rate| represent current rate of playback media
   */
  void (*RateChange)(PP_Instance instance,
                     PP_Resource media,
                     float playback_rate,
                     void* user_data);
};

typedef struct PPP_MediaControl_Samsung_0_9 PPP_MediaControl_Samsung;
/**
 * @}
 */

#endif  /* PPAPI_C_SAMSUNG_PPP_MEDIA_CONTROL_SAMSUNG_H_ */