ppb_media_source_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/ppb_media_source_samsung.idl,
 *   modified Mon Dec  9 17:27:10 2013.
 */

#ifndef PPAPI_C_SAMSUNG_PPB_MEDIA_SOURCE_SAMSUNG_H_
#define PPAPI_C_SAMSUNG_PPB_MEDIA_SOURCE_SAMSUNG_H_

#include "ppapi/c/pp_array_output.h"
#include "ppapi/c/pp_bool.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_media_common_samsung.h"
#include "ppapi/c/samsung/pp_media_control_samsung.h"
#include "ppapi/c/samsung/pp_media_source_samsung.h"
#include "ppapi/c/samsung/ppp_media_control_samsung.h"
#include "ppapi/c/samsung/ppp_media_source_samsung.h"

#define PPB_MEDIASOURCE_SAMSUNG_INTERFACE_0_9 "PPB_MediaSource_Samsung;0.9"
#define PPB_MEDIASOURCE_SAMSUNG_INTERFACE PPB_MEDIASOURCE_SAMSUNG_INTERFACE_0_9

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


/**
 * @addtogroup Interfaces
 * @{
 */
/**
 * Interface used by PNaCl appliction to provide chunks of multimedia data
 * to the platform. Those chunks will be decoded and played by the platform.
 *
 * This interface inherits from PPB_MediaControl_Samsung.
 */
struct PPB_MediaSource_Samsung_0_9 {
  /**
   * Creates new instance of Media Source associated with both PPP inerfaces
   * |media_control_interface| and |media_source_interface|.
   *
   * |user_data| will be data passed to calls of methods from
   * PPP_MediaControl_Samsung and PPP_MediaSource_Samsung interfaces.
   */
  PP_Resource (*Create)(
      PP_Instance instance,
      const struct PPP_MediaControl_Samsung_0_9* media_control_interface,
      const struct PPP_MediaSource_Samsung_0_9* media_source_interface,
      void* user_data);
  /**
   * Checks if given resource is Media Source. If this method returns PP_TRUE,
   * then also PPB_MediaControl_Samsung.IsMediaControl will also return PP_TRUE.
   */
  PP_Bool (*IsMediaSource)(PP_Resource resource);
  /**
   * Binds given MediaSource to vide/audio object of given |id| present on
   * HTML page on which given module is embedded.
   */
  PP_Bool (*BindToHTMLPlayer)(PP_Resource media, struct PP_Var id);
  /**
   * Adds source for which data are appended using Append method. Added source
   * is container of type |type| encoded using codecs on |codecs| list.
   *
   * Returns status - PP_SourceAddStatus and |id| if status is OK.
   */
  PP_SourceAddStatus (*AddSource)(PP_Resource media,
                                  struct PP_Var type,
                                  struct PP_Var codecs,
                                  struct PP_Var* id);
  /**
   * Checks if given source is active i.e. it contains video, audio or
   * text (subtitle) track being played
   */
  PP_Bool (*IsSourceActive)(PP_Resource media, struct PP_Var id);
  /** Removes source of given |id| and frees associated resources with it. */
  void (*RemoveSource)(PP_Resource media, struct PP_Var id);
  /**
   * Appends data to given buffer (identified by |id|).
   * |data| argument must be a handle to PPB_Buffer_Dev_0_4 instance.
   */
  void (*Append)(PP_Resource media, struct PP_Var id, PP_Resource data);
  /** Aborts given data source */
  void (*Abort)(PP_Resource media, struct PP_Var id);
  /** Sets duration in microseconds of currently played stream */
  void (*SetDuration)(PP_Resource media, PP_MicrosecondsDelta duration);
  /** Gets duration in microseconds of currently played stream */
  PP_MicrosecondsDelta (*GetDuration)(PP_Resource media);
  /**
   * Sets end of stream. |error| argument represents whether it is just end
   * of the stream (PP_MEDIAERROR_NO_ERROR) or some kind of error occured.
   */
  void (*SetEndOfStream)(PP_Resource media, PP_MediaError error);
  /**
   * Sets a time offset (in microseconds) to be applied to subsequent
   * buffers appended to the given buffer.
   */
  PP_Bool (*SetTimestampOffset)(PP_Resource media,
                                struct PP_Var id,
                                PP_MicrosecondsDelta offset);
  /**
   * |output| - An output array which will receive
   * <code>PP_TimeRange</code> structures on success.
   *
   * The browser can not allocate memory on behalf of the plugin becaues
   * the plugin and browser may have different allocators.
   * A PP_ArrayOutput must be provided so that output will be stored in its
   * allocated buffer.
   */
  PP_Bool (*ReadTimeRanges)(PP_Resource media,
                            struct PP_Var id,
                            struct PP_ArrayOutput output);
  /**
   * Gets a current time of media.
   */
  PP_MicrosecondsDelta (*GetMediaTime)(PP_Resource media);
  /**
   * Gets a ReadyState of media.
   */
  PP_MediaReadyState (*GetReadyState)(PP_Resource media);
};

typedef struct PPB_MediaSource_Samsung_0_9 PPB_MediaSource_Samsung;
/**
 * @}
 */

#endif  /* PPAPI_C_SAMSUNG_PPB_MEDIA_SOURCE_SAMSUNG_H_ */