Ignore:
Timestamp:
Jul 3, 2015 6:21:30 AM (7 years ago)
Author:
ming
Message:

Re #1861: Changed pjsua API for setting the orientation using a more generic API, pjsua_vid_dev_set_setting() instead

File:
1 edited

Legend:

Unmodified
Added
Removed
  • pjproject/trunk/pjsip/include/pjsua-lib/pjsua.h

    r5118 r5125  
    66126612 
    66136613/** 
    6614  * Set the orientation of the video device. The function only works 
    6615  * for video capture device and if the device is currently active (i.e. 
    6616  * a video preview has been started or there is a video call using the device). 
    6617  * Application can check if a video device is active by calling 
    6618  * #pjsua_vid_dev_is_active(). 
     6614 * Configure the capability of a video capture device. If the device is  
     6615 * currently active (i.e. if there is a video call using the device or 
     6616 * a video preview has been started), the function will forward the setting 
     6617 * to the video device instance to be applied immediately, if it supports it. 
     6618 * 
     6619 * The setting will be saved for future opening of the video device, if the  
     6620 * "keep" argument is set to non-zero. If the video device is currently 
     6621 * inactive, and the "keep" argument is false, this function will return 
     6622 * error. 
     6623 * 
     6624 * Note: This function will only works for video capture devices. To 
     6625 * configure the setting of video renderer device instances, use 
     6626 * pjsua_vid_win API instead. 
     6627 * 
     6628 * Warning: If application refreshes the video device list, it needs to 
     6629 * manually update the settings to reflect the newly updated video device 
     6630 * indexes. See #pjmedia_vid_dev_refresh() for more information. 
     6631 * 
     6632 * See also #pjmedia_vid_stream_set_cap() for more information about setting 
     6633 * a video device capability. 
    66196634 * 
    66206635 * @param id            The video device index. 
    6621  * @param orient        Video device orientation. 
    6622  * 
    6623  * @return              PJ_SUCCESS on success, or the appropriate error code. 
    6624  */ 
    6625 PJ_DECL(pj_status_t) pjsua_vid_dev_set_orient(pjmedia_vid_dev_index id, 
    6626                                               pjmedia_orient orient); 
     6636 * @param cap           The video device capability to change. 
     6637 * @param pval          Pointer to value. Please see #pjmedia_vid_dev_cap 
     6638 *                      documentation about the type of value to be  
     6639 *                      supplied for each setting. 
     6640 * 
     6641 * @return              PJ_SUCCESS on success or the appropriate error code. 
     6642 */ 
     6643PJ_DECL(pj_status_t) pjsua_vid_dev_set_setting(pjmedia_vid_dev_index id, 
     6644                                               pjmedia_vid_dev_cap cap, 
     6645                                               const void *pval, 
     6646                                               pj_bool_t keep); 
     6647 
     6648/** 
     6649 * Retrieve the value of a video capture device setting. If the device is 
     6650 * currently active (i.e. if there is a video call using the device or 
     6651 * a video preview has been started), the function will forward the request 
     6652 * to the video device. If video device is currently inactive, and if 
     6653 * application had previously set the setting and mark the setting as kept, 
     6654 * then that setting will be returned. Otherwise, this function will return 
     6655 * error. 
     6656 * The function only works for video capture device. 
     6657 * 
     6658 * @param id            The video device index. 
     6659 * @param cap           The video device capability to retrieve. 
     6660 * @param pval          Pointer to receive the value.  
     6661 *                      Please see #pjmedia_vid_dev_cap documentation about 
     6662 *                      the type of value to be supplied for each setting. 
     6663 * 
     6664 * @return              PJ_SUCCESS on success or the appropriate error code. 
     6665 */ 
     6666PJ_DECL(pj_status_t) pjsua_vid_dev_get_setting(pjmedia_vid_dev_index id, 
     6667                                               pjmedia_vid_dev_cap cap, 
     6668                                               void *pval); 
    66276669 
    66286670/** 
Note: See TracChangeset for help on using the changeset viewer.