ppb_media_source_samsung.h

Go to the documentation of this file.

/* Copyright 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 Tue Feb  3 14:18:58 2015.
 */

#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_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_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_0_10 "PPB_MediaSource_Samsung;0.10"
#define PPB_MEDIASOURCE_SAMSUNG_INTERFACE PPB_MEDIASOURCE_SAMSUNG_INTERFACE_0_10

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


/**
 * @addtogroup Interfaces
 * @{
 */
/*
 * This interface is used to manage sources of media streams. It's aim is
 * to provide similar API as those defined in Media Source Extensions (MSE)
 * for JavaScirpt.
 * Simplified typical scenario:
 * 1. Creating Media Source
 * 2. Binding it to appropriate html media element
 * 3. Adding source(s) to Media Source.
 */
struct PPB_MediaSource_Samsung_0_10 {
  /**
   * Creates new instance of Media Source associated with both PPP interfaces
   * |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_10* 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 return PP_TRUE.
   */
  PP_Bool (*IsMediaSource)(PP_Resource resource);
  /**
   * Binds given MediaSource represented by |media| resource, to video/audio
   * object of given |id| (html element <video> or <audio>) present on HTML page
   * on which given module is embedded.
   * Execution is confirmed by calling |callback|.
   */
  int32_t (*BindToHTMLPlayer)(PP_Resource media,
                              struct PP_Var id,
                              struct PP_CompletionCallback callback);
  /**
   *Adds to MediaSource, represented by |media|, a source for which data will
   * be appended using Append method. Added source is container of type |type|
   * encoded using codecs on |codecs| list.
   * Execution is confirmed by calling |callback|.
   */
  int32_t (*AddSource)(PP_Resource media,
                       struct PP_Var type,
                       struct PP_Var codecs,
                       PP_Resource* sourceBuffer,
                       struct PP_CompletionCallback callback);
  /**
   * Removes source of given |id| and frees associated resources with it.
   * Execution is confirmed by calling |callback|.
   */
  int32_t (*RemoveSource)(PP_Resource media,
                          PP_Resource sourceBuffer,
                          struct PP_CompletionCallback callback);
  /**
   * Sets duration, in microseconds, of currently played stream
   * Execution is confirmed by calling |callback|.
   */
  int32_t (*SetDuration)(PP_Resource media,
                         PP_MicrosecondsDelta duration,
                         struct PP_CompletionCallback callback);
  /**
   * Gets duration, in microseconds, of currently played stream
   * Execution is confirmed by calling |callback|.
   */
  int32_t (*GetDuration)(PP_Resource media,
                         PP_MicrosecondsDelta* output,
                         struct PP_CompletionCallback callback);
  /**
   * Sets end of stream. |error| argument represents whether it is just end
   * of the stream (PP_MEDIAERROR_NO_ERROR) or some kind of error occurred.
   * Execution is confirmed by calling |callback|.
   */
  int32_t (*SetEndOfStream)(PP_Resource media,
                            PP_SourceEndedStatus error,
                            struct PP_CompletionCallback callback);
  /**
   * Gets a current time of media.
   * Execution is confirmed by calling |callback|.
   */
  int32_t (*GetMediaTime)(PP_Resource media,
                          PP_MicrosecondsDelta* output,
                          struct PP_CompletionCallback callback);
  /**
   * Gets a ReadyState of media.
   * Execution is confirmed by calling |callback|.
   */
  int32_t (*GetReadyState)(PP_Resource media,
                           PP_MediaReadyState* output,
                           struct PP_CompletionCallback callback);
};

typedef struct PPB_MediaSource_Samsung_0_10 PPB_MediaSource_Samsung;

struct PPB_MediaSource_Samsung_0_9 {
  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);
  PP_Bool (*IsMediaSource)(PP_Resource resource);
  PP_Bool (*BindToHTMLPlayer)(PP_Resource media, struct PP_Var id);
  PP_SourceAddStatus (*AddSource)(PP_Resource media,
                                  struct PP_Var type,
                                  struct PP_Var codecs,
                                  struct PP_Var* id);
  PP_Bool (*IsSourceActive)(PP_Resource media, struct PP_Var id);
  void (*RemoveSource)(PP_Resource media, struct PP_Var id);
  void (*Append)(PP_Resource media, struct PP_Var id, PP_Resource data);
  void (*Abort)(PP_Resource media, struct PP_Var id);
  void (*SetDuration)(PP_Resource media, PP_MicrosecondsDelta duration);
  PP_MicrosecondsDelta (*GetDuration)(PP_Resource media);
  void (*SetEndOfStream)(PP_Resource media, PP_MediaError error);
  PP_Bool (*SetTimestampOffset)(PP_Resource media,
                                struct PP_Var id,
                                PP_MicrosecondsDelta offset);
  PP_Bool (*ReadTimeRanges)(PP_Resource media,
                            struct PP_Var id,
                            struct PP_ArrayOutput output);
  PP_MicrosecondsDelta (*GetMediaTime)(PP_Resource media);
  PP_MediaReadyState (*GetReadyState)(PP_Resource media);
};
/**
 * @}
 */

#endif  /* PPAPI_C_SAMSUNG_PPB_MEDIA_SOURCE_SAMSUNG_H_ */