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

Unified Diff: ppapi/cpp/private/video_destination_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/cpp/private/video_destination_private.h
diff --git a/ppapi/cpp/private/video_destination_private.h b/ppapi/cpp/private/video_destination_private.h
new file mode 100644
index 0000000000000000000000000000000000000000..ab63fb9a1ac2b8b4be0401ebdef4ca140628a206
--- /dev/null
+++ b/ppapi/cpp/private/video_destination_private.h
@@ -0,0 +1,87 @@
+// 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.
+
+#ifndef PPAPI_CPP_PRIVATE_VIDEO_DESTINATION_PRIVATE_H_
+#define PPAPI_CPP_PRIVATE_VIDEO_DESTINATION_PRIVATE_H_
+
+#include <string>
+
+#include "ppapi/c/pp_time.h"
+#include "ppapi/cpp/completion_callback.h"
+#include "ppapi/cpp/pass_ref.h"
+#include "ppapi/cpp/resource.h"
+
+/// @file
+/// This file defines the <code>PPB_VideoDestination_Private</code> interface
+/// for a video destination resource. A video destination sends video frames to
+/// a MediaStream video track.
+
+namespace pp {
+
+class InstanceHandle;
+class VideoFrame_Private;
+
+/// The <code>VideoDestination_Private</code> class contains methods for
+/// creating video destination resources and using them to send video frames to
+/// a MediaStream in the browser.
+class VideoDestination_Private : public Resource {
+ public:
+ /// Default constructor for creating a <code>VideoDestination_Private</code>
+ /// object.
+ VideoDestination_Private();
+
+ /// Constructor for creating a <code>VideoDestination_Private</code> for an
+ /// instance.
+ explicit VideoDestination_Private(const InstanceHandle& instance);
+
+ /// The copy constructor for <code>VideoDestination_Private</code>.
+ ///
+ /// @param[in] other A reference to a <code>VideoDestination_Private</code>.
+ VideoDestination_Private(const VideoDestination_Private& other);
+
+ /// A constructor used when you have received a PP_Resource as a return
+ /// value that has had its reference count incremented for you.
+ ///
+ /// @param[in] resource A PP_Resource corresponding to a video destination.
+ VideoDestination_Private(PassRef, PP_Resource resource);
+
+ /// Opens a video destination for sending frames.
+ ///
+ /// @param[in] stream_id A <code>Var</code> holding a string uniquely
+ /// identifying a MediaStream.
+ /// @param[in] callback A <code>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 destination isn't a valid video
+ /// destination.
+ /// Returns PP_ERROR_INPROGRESS if destination is already open.
+ /// Returns PP_ERROR_FAILED if the MediaStream doesn't exist or if there is
+ /// some other browser error.
+ int32_t Open(const Var& stream_id, const CompletionCallback& cc);
+
+ /// Sends a frame of video to the video destination.
+ ///
+ /// After this call, you should take care to release your references to the
+ /// image embedded in the video frame. If you paint to the image after
+ /// SendFrame(), there is the possibility of artifacts because the browser may
+ /// still be copying the frame to the stream.
+ ///
+ /// @param[in] frame A <code>VideoFrame_Private</code> holding the video
+ /// frame to send to the destination.
+ ///
+ /// @return An int32_t containing a result code from <code>pp_errors.h</code>.
+ /// Returns PP_ERROR_BADRESOURCE if destination isn't a valid video
+ /// destination.
+ /// Returns PP_ERROR_FAILED if destination is not open, if the video frame has
+ /// an invalid image data resource, or if some other browser error occurs.
+ int32_t SendFrame(const VideoFrame_Private& frame);
+
+ /// Closes the video destination.
+ void Close();
+};
+
+} // namespace pp
+
+#endif // PPAPI_CPP_PRIVATE_VIDEO_DESTINATION_PRIVATE_H_

Powered by Google App Engine
This is Rietveld 408576698