Changeset 3756 for pjproject/trunk/pjsip/include/pjsua-lib/pjsua.h

Timestamp:

Sep 19, 2011 8:26:35 AM (12 years ago)

Author:

bennylp

Message:

Implemented native video preview support. This closes #1340

File:

• pjproject/trunk/pjsip/include/pjsua-lib/pjsua.h (modified) (7 diffs)

pjproject/trunk/pjsip/include/pjsua-lib/pjsua.h

@@ -4692 +4692 @@
      */
     int                 snd_auto_close_time;
+
+    /**
+     * Specify whether built-in/native preview should be used if available.
+     * In some systems, video input devices have built-in capability to show
+     * preview window of the device. Using this built-in preview is preferable
+     * as it consumes less CPU power. If built-in preview is not available,
+     * the library will perform software rendering of the input. If this
+     * field is set to PJ_FALSE, software preview will always be used.
+     *
+     * Default: PJ_TRUE
+     */
+    pj_bool_t vid_preview_enable_native;
 };
 
@@ -5437 +5449 @@
     /**
      * Device ID for the video renderer to be used for rendering the
-     * capture stream for preview.
+     * capture stream for preview. This parameter is ignored if native
+     * preview is being used.
      *
      * Default: PJMEDIA_VID_DEFAULT_RENDER_DEV
@@ -5459 +5472 @@
  */
 PJ_DECL(void) pjsua_vid_preview_param_default(pjsua_vid_preview_param *p);
+
+/**
+ * Determine if the specified video input device has built-in native
+ * preview capability. This is a convenience function that is equal to
+ * querying device's capability for PJMEDIA_VID_DEV_CAP_INPUT_PREVIEW
+ * capability.
+ *
+ * @param id            The capture device ID.
+ *
+ * @return              PJ_TRUE if it has.
+ */
+PJ_DECL(pj_bool_t) pjsua_vid_preview_has_native(pjmedia_vid_dev_index id);
 
 /**
@@ -5504 +5529 @@
 {
     /**
+     * Flag to indicate whether this window is a native window,
+     * such as created by built-in preview device. If this field is
+     * PJ_TRUE, only the native window handle field of this
+     * structure is valid.
+     */
+    pj_bool_t is_native;
+
+    /**
+     * Native window handle.
+     */
+    pjmedia_vid_dev_hwnd hwnd;
+
+    /**
      * Renderer device ID.
      */
     pjmedia_vid_dev_index rdr_dev;
-
-    /**
-     * Native window handle.
-     */
-    pjmedia_vid_dev_hwnd hwnd;
 
     /**
@@ -5557 +5590 @@
 
 /**
- * Show or hide window.
+ * Show or hide window. This operation is not valid for native windows
+ * (pjsua_vid_win_info.is_native=PJ_TRUE), on which native windowing API
+ * must be used instead.
  *
  * @param wid           The video window ID.
@@ -5569 +5604 @@
 
 /**
- * Set video window position.
+ * Set video window position. This operation is not valid for native windows
+ * (pjsua_vid_win_info.is_native=PJ_TRUE), on which native windowing API
+ * must be used instead.
  *
  * @param wid           The video window ID.
@@ -5580 +5617 @@
 
 /**
- * Resize window.
+ * Resize window. This operation is not valid for native windows
+ * (pjsua_vid_win_info.is_native=PJ_TRUE), on which native windowing API
+ * must be used instead.
  *
  * @param wid           The video window ID.