Fixed #1536: Modify video port creation parameter to be set with actual creation prm on output

git-svn-id: http://svn.pjsip.org/repos/pjproject/trunk@4167 74dad513-b988-da41-8d7b-12977e46ad98

2 files changed, 13 insertions, 4 deletions

diff --git a/pjmedia/include/pjmedia-videodev/videodev.h b/pjmedia/include/pjmedia-videodev/videodev.h
index 235d2a3e..9238e0e3 100644
--- a/pjmedia/include/pjmedia-videodev/videodev.h
+++ b/pjmedia/include/pjmedia-videodev/videodev.h
@@ -676,7 +676,10 @@ pjmedia_vid_dev_default_param(pj_pool_t *pool,
  * 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.
+ * @param param         On input, it specifies the video device parameters
+ *                      to be used for the stream. On output, this will be
+ *                      set to the actual video device parameters used to
+ *                      open the stream.
  * @param cb            Pointer to structure containing video stream
  *                      callbacks.
  * @param user_data     Arbitrary user data, which will be given back in the
diff --git a/pjmedia/include/pjmedia/vid_port.h b/pjmedia/include/pjmedia/vid_port.h
index 3de28346..0d5e3d84 100644
--- a/pjmedia/include/pjmedia/vid_port.h
+++ b/pjmedia/include/pjmedia/vid_port.h
@@ -78,17 +78,23 @@ typedef struct pjmedia_vid_port pjmedia_vid_port;
 PJ_DECL(void) pjmedia_vid_port_param_default(pjmedia_vid_port_param *prm);
 
 /**
- * Create a video port with the specified parameter.
+ * Create a video port with the specified parameter. Video port may open
+ * the video stream with different parameter than the requested values in
+ * the \a prm.vidparam argument. Application can check the the values in
+ * the \a prm.vidparam argument to see if they have changed.
  *
  * @param pool		Pool to allocate memory from.
- * @param prm		The video port parameter.
+ * @param prm		On input, it specifies the video port parameters
+ *                      to be used. On output, prm.vidparam will be set to
+ *                      the actual video device parameters used to open the
+ *                      stream.
  * @param p_vp		Pointer to receive the result.
  *
  * @return		PJ_SUCCESS if video port has been created
  * 			successfully, or the appropriate error code.
  */
 PJ_DECL(pj_status_t) pjmedia_vid_port_create(pj_pool_t *pool,
-					     const pjmedia_vid_port_param *prm,
+					     pjmedia_vid_port_param *prm,
 					     pjmedia_vid_port **p_vp);
 
 /**