ppapi/api/private/ppb_camera_capabilities_private.idl

   1 /* Copyright 2014 The Chromium Authors. All rights reserved.
   2  * Use of this source code is governed by a BSD-style license that can be
   3  * found in the LICENSE file.
   4  */
   5
   6 /**
   7  * This file defines the PPB_CameraCapabilities_Private interface for
   8  * establishing an image capture configuration resource within the browser.
   9  */
  10
  11 [generate_thunk]
  12
  13 label Chrome {
  14   M42 = 0.1
  15 };
  16
  17 /**
  18  * The <code>PPB_CameraCapabilities_Private</code> interface contains pointers
  19  * to several functions for getting the image capture capabilities within the
  20  * browser.
  21  */
  22 [version=0.1]
  23 interface PPB_CameraCapabilities_Private {
  24   /**
  25    * IsCameraCapabilities() determines if the given resource is a
  26    * <code>PPB_CameraCapabilities_Private</code>.
  27    *
  28    * @param[in] resource A <code>PP_Resource</code> corresponding to an image
  29    * capture capabilities resource.
  30    *
  31    * @return A <code>PP_Bool</code> containing <code>PP_TRUE</code> if the given
  32    * resource is an <code>PP_CameraCapabilities_Private</code> resource,
  33    * otherwise <code>PP_FALSE</code>.
  34    */
  35   PP_Bool IsCameraCapabilities(
  36       [in] PP_Resource resource);
  37
  38   /**
  39    * GetSupportedVideoCaptureFormats() returns the supported video capture
  40    * formats for the given <code>PPB_CameraCapabilities_Private</code>.
  41    *
  42    * @param[in] capabilities A <code>PP_Resource</code> corresponding to an
  43    * image capture capabilities resource.
  44    * @param[out] array_size The size of preview size array.
  45    * @param[out] formats An array of <code>PP_VideoCaptureFormat</code>
  46    * corresponding to the supported video capture formats. The ownership of the
  47    * array belongs to <code>PPB_CameraCapabilities_Private</code> and the caller
  48    * should not free it. When a PPB_CameraCapabilities_Private is deleted, the
  49    * array returning from this is no longer valid.
  50    */
  51   void GetSupportedVideoCaptureFormats(
  52       [in] PP_Resource capabilities,
  53       [out] uint32_t array_size,
  54       [out, size_is(array_size)] PP_VideoCaptureFormat[] formats);
  55 };