Chromium Code Reviews| Index: ppapi/cpp/private/camera_capabilities_private.h |
| diff --git a/ppapi/cpp/private/camera_capabilities_private.h b/ppapi/cpp/private/camera_capabilities_private.h |
| new file mode 100644 |
| index 0000000000000000000000000000000000000000..0283c4f568885db616b553d4d526133df499f303 |
| --- /dev/null |
| +++ b/ppapi/cpp/private/camera_capabilities_private.h |
| @@ -0,0 +1,93 @@ |
| +/* Copyright 2014 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_CAMERA_CAPABILITIES_PRIVATE_H_ |
| +#define PPAPI_CPP_PRIVATE_CAMERA_CAPABILITIES_PRIVATE_H_ |
| + |
| +#include "ppapi/c/private/ppb_camera_capabilities_private.h" |
| +#include "ppapi/cpp/resource.h" |
| +#include "ppapi/cpp/size.h" |
| + |
| +/// @file |
| +/// This file defines the CameraCapabilities_Private interface for |
| +/// establishing an image capture configuration resource within the browser. |
| +namespace pp { |
| + |
| +/// The <code>CameraCapabilities_Private</code> interface contains methods for |
| +/// getting the image capture capabilities within the browser. |
| +class CameraCapabilities_Private : public Resource { |
| + public: |
| + /// Default constructor for creating an is_null() |
| + /// <code>CameraCapabilities_Private</code> object. |
| + CameraCapabilities_Private(); |
| + |
| + /// The copy constructor for <code>CameraCapabilities_Private</code>. |
| + /// |
| + /// @param[in] other A reference to a <code>CameraCapabilities_Private |
| + /// </code>. |
| + CameraCapabilities_Private(const CameraCapabilities_Private& other); |
| + |
| + /// Constructs a <code>CameraCapabilities_Private</code> from a <code> |
| + /// Resource</code>. |
| + /// |
| + /// @param[in] resource A <code>PPB_CameraCapabilities_Private</code> |
| + /// resource. |
| + explicit CameraCapabilities_Private(const Resource& resource); |
| + |
| + /// Constructs a <code>CameraCapabilities_Private</code> that outputs given |
| + /// frames to a new video track, which will be consumed by Javascript. |
|
Justin Chuang
2014/08/14 16:33:44
Wrong comments.
wuchengli
2014/08/15 08:18:00
Done.
|
| + explicit CameraCapabilities_Private(const InstanceHandle& instance); |
| + |
| + /// A constructor used when you have received a <code>PP_Resource</code> as a |
| + /// return value that has had 1 ref added for you. |
| + /// |
| + /// @param[in] resource A <code>PPB_CameraCapabilities_Private</code> |
| + /// resource. |
| + CameraCapabilities_Private(PassRef, PP_Resource resource); |
| + |
| + // Destructor. |
| + ~CameraCapabilities_Private(); |
| + |
| + /// GetSupportedPreviewSizes() returns the supported preview sizes for the |
| + /// given <code>CameraCapabilities_Private</code>. |
| + /// |
| + /// @param[in] capabilities A <code>Resource</code> corresponding to an |
| + /// image capture capabilities resource. |
|
Justin Chuang
2014/08/14 16:33:44
remove this @param
wuchengli
2014/08/15 08:18:00
Done.
|
| + /// @param[out] array_size The size of preview size array. |
| + /// @param[out] An array of <code>PP_Size</code> corresponding to the |
| + /// supported preview sizes in pixels. The ownership of the array belongs to |
| + /// <code>CameraCapabilities_Private</code> and the caller should not |
| + /// free it. When a CameraCapabilities_Private is deleted, the array |
| + /// returning from this is no longer valid. |
| + void GetSupportedPreviewSizes(int32_t* array_size, Size** preview_sizes); |
|
Justin Chuang
2014/08/14 16:33:44
Not sure if it's better to replace both args with
wuchengli
2014/08/15 08:18:00
Good suggestion. Done.
|
| + |
| + /// GetSupportedJpegSize() returns the supported JPEG sizes for the given |
| + /// <code>CameraCapabilities_Private</code>. |
| + /// |
| + /// @param[in] capabilities A <code>Resource</code> corresponding to an |
| + /// image capture capabilities resource. |
|
Justin Chuang
2014/08/14 16:33:44
ditto, redundant @param
wuchengli
2014/08/15 08:18:00
Done.
|
| + /// @param[out] array_size The size of preview size array. |
| + /// @param[out] An array of <code>PP_Size</code> corresponding to the |
| + /// supported JPEG image sizes in pixels. The ownership of the array |
| + /// belongs to <code>CameraCapabilities_Private</code> and the caller should |
| + /// not free it. When a CameraCapabilities_Private is deleted, the array |
| + /// returning from this is no longer valid. |
| + void GetSupportedJpegSizes(int32_t* array_size, Size** jpeg_sizes); |
|
Justin Chuang
2014/08/14 16:33:44
Ditto
wuchengli
2014/08/15 08:18:00
Done.
|
| + |
| + /// IsCameraCapabilities() determines if the given resource is a |
| + /// <code>CameraCapabilities_Private</code>. |
| + /// |
| + /// @param[in] resource A <code>Resource</code> corresponding to an image |
| + /// capture capabilities resource. |
| + /// |
| + /// @return True if the given resource is an <code> |
| + /// CameraCapabilities_Private</code> resource, otherwise false. |
|
Justin Chuang
2014/08/14 16:33:44
s/True/true/ (for C++ keyword)
wuchengli
2014/08/15 08:18:00
Done. Some ppapi classes use True and some use tru
|
| + static bool IsCameraCapabilities(const Resource& resource); |
| +}; |
| + |
| +} // namespace pp |
| + |
| +#endif /* PPAPI_CPP_PRIVATE_CAMERA_CAPABILITIES_PRIVATE_H_ */ |
| + |