ppb_source_buffer_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_source_buffer_samsung.idl,
 *   modified Wed Jan 28 10:08:02 2015.
 */

#ifndef PPAPI_C_SAMSUNG_PPB_SOURCE_BUFFER_SAMSUNG_H_
#define PPAPI_C_SAMSUNG_PPB_SOURCE_BUFFER_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/samsung/pp_media_common_samsung.h"

#define PPB_SOURCEBUFFER_SAMSUNG_INTERFACE_0_10 "PPB_SourceBuffer_Samsung;0.10"
#define PPB_SOURCEBUFFER_SAMSUNG_INTERFACE \
    PPB_SOURCEBUFFER_SAMSUNG_INTERFACE_0_10

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


/**
 * @addtogroup Interfaces
 * @{
 */
/*
 * This interface is used to manage sources of media streams and appending data
 * to them. It's aim is to provide similar API as those defined in Media Source
 * Extensions (MSE) for JavaScirpt.
 * Simplified typical scenario:
 * 1. Requesting MediaSource creates the Source Buffer
 * 2. Getting the buffer's resource id/object in the callback.
 * 3. Appending data to the buffer.
 * 4. Waiting for the callback to append next chunk (or)
 * 5. Waiting for the AppendEnd on the PPP interface to get back ranges.
 */
struct PPB_SourceBuffer_Samsung_0_10 {
  /**
   * Checks if given resource is Source Buffer.
   */
  PP_Bool (*IsSourceBuffer)(PP_Resource resource);
  /**
   * Checks if the source is active i.e. it contains video, audio or
   * text (subtitle) track being played
   */
  int32_t (*IsSourceActive)(PP_Resource buffer,
                            PP_Bool* active,
                            struct PP_CompletionCallback callback);
  /**
   * Appends data to this buffer.
   * Execution is confirmed by calling |callback|.
   * May return errors in callback:
   * - PP_OK - when Append finished without errors
   * - PP_ERROR_BADRESOURCE - when PP_Resource is invalid
   * - PP_ERROR_FAILED when Append failed
   */
  int32_t (*Append)(PP_Resource buffer,
                    const void* data,
                    uint32_t bytes_to_append,
                    struct PP_CompletionCallback callback);
  /**
   * Aborts given data source
   * Execution is confirmed by calling |callback|.
   */
  int32_t (*Abort)(PP_Resource buffer, struct PP_CompletionCallback callback);
  /**
   * Sets a time offset (in microseconds) to be applied to subsequent
   * buffers appended to the given buffer.
   */
  int32_t (*SetTimestampOffset)(PP_Resource buffer,
                                PP_MicrosecondsDelta offset,
                                struct PP_CompletionCallback callback);
  /** Gets offset in microseconds of selected stream */
  int32_t (*GetTimestampOffset)(PP_Resource buffer,
                                PP_MicrosecondsDelta* output,
                                struct PP_CompletionCallback callback);
  /**
   * Read ranges of buffered media stream.
   *
   * |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 because
   * the plugin and browser may have different allocators.
   * A PP_ArrayOutput must be provided so that output will be stored in its
   * allocated buffer.
   */
  int32_t (*ReadTimeRanges)(PP_Resource buffer,
                            struct PP_ArrayOutput output,
                            struct PP_CompletionCallback callback);
};

typedef struct PPB_SourceBuffer_Samsung_0_10 PPB_SourceBuffer_Samsung;
/**
 * @}
 */

#endif  /* PPAPI_C_SAMSUNG_PPB_SOURCE_BUFFER_SAMSUNG_H_ */