Index: ppapi/api/ppb_video_reader.idl |
diff --git a/ppapi/api/ppb_video_reader.idl b/ppapi/api/ppb_video_reader.idl |
new file mode 100644 |
index 0000000000000000000000000000000000000000..1c9858436aaf2f3a0b81e174faac87ade4c724e4 |
--- /dev/null |
+++ b/ppapi/api/ppb_video_reader.idl |
@@ -0,0 +1,89 @@ |
+/* 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. |
+ */ |
+ |
+/** |
+ * This file defines the <code>PPB_VideoReader</code> struct for a video reader |
+ * resource. |
+ */ |
+ |
+ label Chrome { |
+ M28 = 0.1 |
+ }; |
+ |
+/** |
+ * The <code>PPB_VideoReader</code> interface contains pointers to several |
+ * functions for creating video reader resources and using them to consume |
+ * streams of video frames. |
+ */ |
+interface PPB_VideoReader { |
+ /** |
+ * Creates a video reader resource. |
+ * |
+ * @param[in] instance A <code>PP_Instance</code> identifying one instance |
+ * of a module. |
+ * |
+ * @return A <code>PP_Resource</code> with a nonzero ID on success or zero on |
+ * failure. Failure means the instance was invalid. |
+ */ |
+ PP_Resource Create([in] PP_Instance instance); |
+ |
+ /** |
+ * Determines if a given resource is a video reader. |
+ * |
+ * @param[in] resource A <code>PP_Resource</code> corresponding to a resource. |
+ * |
+ * @return A <code>PP_Bool</code> with <code>PP_TRUE</code> if the given |
+ * resource is a video reader or <code>PP_FALSE</code> otherwise. |
+ */ |
+ PP_Bool IsVideoReader([in] PP_Resource resource); |
+ |
+ /** |
+ * Opens a video stream with the given id for reading. |
+ * |
+ * @param[in] reader A <code>PP_Resource</code> corresponding to a video |
+ * reader resource. |
+ * @param[in] stream_id A <code>PP_Var</code> holding a string uniquely |
+ * identifying the stream. This string is application defined. |
+ * @param[in] callback A <code>PP_CompletionCallback</code> to be called upon |
+ * completion of Open(). |
+ * |
+ * @return An int32_t containing an error code from <code>pp_errors.h</code>. |
+ * Returns PP_ERROR_BADRESOURCE if reader isn't a valid video reader. |
+ * Returns PP_ERROR_INPROGRESS if the reader has already opened a stream. |
+ */ |
+ int32_t Open([in] PP_Resource reader, |
+ [in] PP_Var stream_id, |
juberti
2013/04/05 18:46:12
In the latest proposal I changed this to be an [ou
bbudge
2013/04/05 20:50:24
I'll change it in a follow on patch.
On 2013/04/05
|
+ [in] PP_CompletionCallback callback); |
+ |
+ /** |
+ * Gets the next frame of video from the reader's open stream. The image data |
+ * resource returned in the frame will have its reference count incremented by |
+ * one and must be managed by the plugin. |
+ * |
+ * @param[in] reader A <code>PP_Resource</code> corresponding to a video |
+ * reader resource. |
+ * @param[out] frame A <code>PP_VideoFrame</code> to hold a video frame to |
+ * read from the open stream. |
+ * @param[in] callback A <code>PP_CompletionCallback</code> to be called upon |
+ * completion of GetNextFrame(). |
+ * |
+ * @return An int32_t containing an error code from <code>pp_errors.h</code>. |
+ * Returns PP_ERROR_BADRESOURCE if reader isn't a valid video reader. |
+ * Returns PP_ERROR_FAILED if the reader has not opened a stream, if the video |
+ * frame has an invalid image data resource, or if some other error occurs. |
+ */ |
+ int32_t GetFrame([in] PP_Resource reader, |
+ [out] PP_VideoFrame frame, |
+ [in] PP_CompletionCallback callback); |
+ |
+ /** |
+ * Closes the reader's video stream. |
+ * |
+ * @param[in] reader A <code>PP_Resource</code> corresponding to a video |
+ * reader resource. |
+ */ |
+ void Close([in] PP_Resource reader); |
+}; |
+ |