Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(96)

Unified Diff: ppapi/c/private/ppb_video_source_private.h

Issue 14192054: Rename PPAPI Video Stream APIs. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Created 7 years, 8 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: ppapi/c/private/ppb_video_source_private.h
diff --git a/ppapi/c/private/ppb_video_source_private.h b/ppapi/c/private/ppb_video_source_private.h
new file mode 100644
index 0000000000000000000000000000000000000000..e3b20f86bc18458830c561ac01b90060748947e1
--- /dev/null
+++ b/ppapi/c/private/ppb_video_source_private.h
@@ -0,0 +1,117 @@
+/* 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 private/ppb_video_source_private.idl,
+ * modified Wed Apr 24 11:46:52 2013.
+ */
+
+#ifndef PPAPI_C_PRIVATE_PPB_VIDEO_SOURCE_PRIVATE_H_
+#define PPAPI_C_PRIVATE_PPB_VIDEO_SOURCE_PRIVATE_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_time.h"
+#include "ppapi/c/pp_var.h"
+#include "ppapi/c/private/pp_video_frame_private.h"
+
+#define PPB_VIDEOSOURCE_PRIVATE_INTERFACE_0_1 "PPB_VideoSource_Private;0.1"
+#define PPB_VIDEOSOURCE_PRIVATE_INTERFACE PPB_VIDEOSOURCE_PRIVATE_INTERFACE_0_1
+
+/**
+ * @file
+ * This file defines the <code>PPB_VideoSource_Private</code> interface for a
+ * video source resource. A video source receives video frames from a
+ * MediaStream video track.
+ */
+
+
+/**
+ * @addtogroup Interfaces
+ * @{
+ */
+/**
+ * The <code>PPB_VideoSource_Private</code> interface contains pointers to
+ * several functions for creating video source resources and using them to
+ * receive video frames from a MediaStream in the browser.
+ */
+struct PPB_VideoSource_Private_0_1 {
+ /**
+ * Creates a video source resource.
+ *
+ * @param[in] instance A <code>PP_Instance</code> identifying an 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)(PP_Instance instance);
+ /**
+ * Determines if a resource is a video source resource.
+ *
+ * @param[in] resource The <code>PP_Resource</code> to test.
+ *
+ * @return A <code>PP_Bool</code> with <code>PP_TRUE</code> if the given
+ * resource is a video source resource or <code>PP_FALSE</code> otherwise.
+ */
+ PP_Bool (*IsVideoSource)(PP_Resource resource);
+ /**
+ * Opens a video source for receiving frames.
+ *
+ * @param[in] source A <code>PP_Resource</code> corresponding to a video
+ * source resource.
+ * @param[in] stream_id A <code>PP_Var</code> holding a string uniquely
+ * identifying a MediaStream.
+ * @param[in] callback A <code>PP_CompletionCallback</code> to be called upon
+ * completion of Open().
+ *
+ * @return An int32_t containing a result code from <code>pp_errors.h</code>.
+ * Returns PP_ERROR_BADRESOURCE if source isn't a valid video source.
+ * Returns PP_ERROR_INPROGRESS if source is already open.
+ * Returns PP_ERROR_FAILED if the MediaStream doesn't exist or if there is
+ * some other browser error.
+ */
+ int32_t (*Open)(PP_Resource source,
+ struct PP_Var stream_id,
+ struct PP_CompletionCallback callback);
+ /**
+ * Receives a frame of video from the video source.
+ * The image data resource inside the returned frame will have its reference
+ * count incremented by one and must be managed by the plugin.
+ *
+ * @param[in] source A <code>PP_Resource</code> corresponding to a video
+ * source resource.
+ * @param[out] frame A <code>PP_VideoFrame_Private</code> to hold a video
+ * frame from the source.
+ * @param[in] callback A <code>PP_CompletionCallback</code> to be called upon
+ * completion of GetNextFrame().
+ *
+ * @return An int32_t containing a result code from <code>pp_errors.h</code>.
+ * Returns PP_ERROR_BADRESOURCE if source isn't a valid video source.
+ * Returns PP_ERROR_FAILED if the source is not open, or if some other
+ * browser error occurs.
+ */
+ int32_t (*ReceiveFrame)(PP_Resource source,
+ struct PP_VideoFrame_Private* frame,
+ struct PP_CompletionCallback callback);
+ /**
+ * Closes the video source.
+ *
+ * @param[in] source A <code>PP_Resource</code> corresponding to a video
+ * source resource.
+ */
+ void (*Close)(PP_Resource source);
+};
+
+typedef struct PPB_VideoSource_Private_0_1 PPB_VideoSource_Private;
+/**
+ * @}
+ */
+
+#endif /* PPAPI_C_PRIVATE_PPB_VIDEO_SOURCE_PRIVATE_H_ */
+

Powered by Google App Engine
This is Rietveld 408576698