Changeset 3489 for pjproject/branches/projects/2.0-dev/pjmedia/include/pjmedia-videodev/videodev.h

Timestamp:

Mar 25, 2011 8:38:26 AM (13 years ago)

Author:

bennylp

Message:

Re #1213 (Video devices):

• Video device now opens in "best effort" mode, i.e. it may open with different size and fps than requested. The actual size and fps will be reflected in the "param" upon return. The vidport must check this against any differences, and create converter accordingly.
• Removed const for param argument in vid_create_stream() API
• Currently converter in vidport will not work if vidport is opened in bidir. Converter for renderer is untested

File:

• pjproject/branches/projects/2.0-dev/pjmedia/include/pjmedia-videodev/videodev.h (modified) (2 diffs)

pjproject/branches/projects/2.0-dev/pjmedia/include/pjmedia-videodev/videodev.h

@@ -472 +472 @@
 
 /**
- * Open video stream object using the specified parameters.
+ * Open video stream object using the specified parameters. If stream is
+ * created successfully, this function will return PJ_SUCCESS and the
+ * stream pointer will be returned in the p_strm argument.
+ *
+ * The opened stream may have been opened with different size and fps
+ * than the requested values in the \a param argument. Application should
+ * check the actual size and fps that the stream was opened with by inspecting
+ * the values in the \a param argument and see if they have changed. Also
+ * if the device ID in the \a param specifies default device, it may be
+ * replaced with the actual device ID upon return.
  *
  * @param param         Sound device parameters to be used for the stream.
@@ -485 +494 @@
  */
 PJ_DECL(pj_status_t) pjmedia_vid_dev_stream_create(
-                                            const pjmedia_vid_param *param,
+                                            pjmedia_vid_param *param,
                                             const pjmedia_vid_cb *cb,
                                             void *user_data,