Changeset 3685


Ignore:
Timestamp:
Jul 26, 2011 8:48:48 AM (8 years ago)
Author:
bennylp
Message:

Re #1263 (PJSUA-LIB video API): added doxygen comments on stream_op values

File:
1 edited

Legend:

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

    r3684 r3685  
    371371 
    372372/** 
    373  * This enumeration represents video stream operation on a call. 
    374  * See also #pjsua_call_vid_strm_op_param for further info. 
    375  */ 
    376 typedef enum pjsua_call_vid_strm_op 
    377 { 
    378     /** 
    379      * Add a new video stream. 
    380      */ 
    381     PJSUA_CALL_VID_STRM_ADD, 
    382  
    383     /** 
    384      * Remove/disable an existing video stream. 
    385      */ 
    386     PJSUA_CALL_VID_STRM_REMOVE, 
    387  
    388     /** 
    389      * Change direction of a video stream. 
    390      */ 
    391     PJSUA_CALL_VID_STRM_CHANGE_DIR, 
    392  
    393     /** 
    394      * Change capture device of a video stream. 
    395      */ 
    396     PJSUA_CALL_VID_STRM_CHANGE_CAP_DEV, 
    397  
    398     /** 
    399      * Start transmitting video stream. 
    400      */ 
    401     PJSUA_CALL_VID_STRM_START_TRANSMIT, 
    402  
    403     /** 
    404      * Stop transmitting video stream. 
    405      */ 
    406     PJSUA_CALL_VID_STRM_STOP_TRANSMIT, 
    407  
    408 } pjsua_call_vid_strm_op; 
    409  
    410  
    411 /** 
    412  * Parameters for video stream operation on a call. 
    413  */ 
    414 typedef struct pjsua_call_vid_strm_op_param 
    415 { 
    416     /** 
    417      * Specify the media stream index. This can be set to -1 to denote 
    418      * the default video stream in the call, which is the first active 
    419      * video stream or any first video stream if none is active. 
    420      * 
    421      * This field is valid for all video stream operations, except 
    422      * PJSUA_CALL_VID_STRM_ADD. 
    423      * 
    424      * Default: -1 (first active video stream, or any first video stream 
    425      *              if none is active) 
    426      */ 
    427     int med_idx; 
    428   
    429     /** 
    430      * Specify the media stream direction. 
    431      * 
    432      * This field is valid for the following video stream operations: 
    433      * PJSUA_CALL_VID_STRM_ADD and PJSUA_CALL_VID_STRM_CHANGE_DIR. 
    434      * 
    435      * Default: PJMEDIA_DIR_ENCODING_DECODING 
    436      */ 
    437     pjmedia_dir dir; 
    438   
    439     /** 
    440      * Specify the video capture device ID. This can be set to 
    441      * PJMEDIA_VID_DEFAULT_CAPTURE_DEV to specify the default capture 
    442      * device as configured in the account. 
    443      * 
    444      * This field is valid for the following video stream operations: 
    445      * PJSUA_CALL_VID_STRM_ADD and PJSUA_CALL_VID_STRM_CHANGE_CAP_DEV. 
    446      * 
    447      * Default: capture device configured in account. 
    448      */ 
    449     pjmedia_vid_dev_index cap_dev; 
    450  
    451 } pjsua_call_vid_strm_op_param; 
    452  
    453  
    454 /** 
    455373 * Logging configuration, which can be (optionally) specified when calling 
    456374 * #pjsua_init(). Application must call #pjsua_logging_config_default() to 
     
    495413 
    496414    /** 
    497      * Optional callback function to be called to write log to  
     415     * Optional callback function to be called to write log to 
    498416     * application specific device. This function will be called for 
    499417     * log messages on input verbosity level. 
     
    541459typedef struct pjsua_reg_info 
    542460{ 
    543     struct pjsip_regc_cbparam   *cbparam;   /**< Parameters returned by  
     461    struct pjsip_regc_cbparam   *cbparam;   /**< Parameters returned by 
    544462                                                 registration callback. */ 
    545463} pjsua_reg_info; 
     
    548466/** 
    549467 * This structure describes application callback to receive various event 
    550  * notification from PJSUA-API. All of these callbacks are OPTIONAL,  
     468 * notification from PJSUA-API. All of these callbacks are OPTIONAL, 
    551469 * although definitely application would want to implement some of 
    552470 * the important callbacks (such as \a on_incoming_call). 
     
    578496     * This is a general notification callback which is called whenever 
    579497     * a transaction within the call has changed state. Application can 
    580      * implement this callback for example to monitor the state of  
    581      * outgoing requests, or to answer unhandled incoming requests  
     498     * implement this callback for example to monitor the state of 
     499     * outgoing requests, or to answer unhandled incoming requests 
    582500     * (such as INFO) with a final response. 
    583501     * 
     
    586504     * @param e         Transaction event that caused the state change. 
    587505     */ 
    588     void (*on_call_tsx_state)(pjsua_call_id call_id,  
     506    void (*on_call_tsx_state)(pjsua_call_id call_id, 
    589507                              pjsip_transaction *tsx, 
    590508                              pjsip_event *e); 
     
    601519    void (*on_call_media_state)(pjsua_call_id call_id); 
    602520 
    603   
    604     /**  
     521 
     522    /** 
    605523     * Notify application when media session is created and before it is 
    606524     * registered to the conference bridge. Application may return different 
     
    616534     *                      to the conference bridge. 
    617535     */ 
    618     void (*on_stream_created)(pjsua_call_id call_id,  
     536    void (*on_stream_created)(pjsua_call_id call_id, 
    619537                              pjmedia_stream *strm, 
    620                               unsigned stream_idx,  
     538                              unsigned stream_idx, 
    621539                              pjmedia_port **p_port); 
    622540 
    623     /**  
     541    /** 
    624542     * Notify application when media session has been unregistered from the 
    625543     * conference bridge and about to be destroyed. 
     
    26042522     * 
    26052523     * Regardless of the value of this setting, application can start and 
    2606      * stop outgoing video transmission with #pjsua_call_set_vid_out(). 
     2524     * stop outgoing video transmission with #pjsua_call_set_vid_strm(). 
    26072525     * 
    26082526     * Default: PJ_FALSE 
     
    33783296 
    33793297} pjsua_stream_stat; 
     3298 
     3299/** 
     3300 * This enumeration represents video stream operation on a call. 
     3301 * See also #pjsua_call_vid_strm_op_param for further info. 
     3302 */ 
     3303typedef enum pjsua_call_vid_strm_op 
     3304{ 
     3305    /** 
     3306     * Add a new video stream. This will add a new m=video line to 
     3307     * the media, regardless of whether existing video is/are present 
     3308     * or not.  This will cause re-INVITE or UPDATE to be sent to remote 
     3309     * party. The number of maximum active video streams in a call is 
     3310     * still limited by \a max_video_cnt setting in pjsua_acc_config. 
     3311     */ 
     3312    PJSUA_CALL_VID_STRM_ADD, 
     3313 
     3314    /** 
     3315     * Remove/disable an existing video stream. This will 
     3316     * cause re-INVITE or UPDATE to be sent to remote party. 
     3317     */ 
     3318    PJSUA_CALL_VID_STRM_REMOVE, 
     3319 
     3320    /** 
     3321     * Change direction of a video stream. This operation can be used 
     3322     * to activate or deactivate an existing video media. This will 
     3323     * cause re-INVITE or UPDATE to be sent to remote party. 
     3324     */ 
     3325    PJSUA_CALL_VID_STRM_CHANGE_DIR, 
     3326 
     3327    /** 
     3328     * Change capture device of a video stream.  This will not send 
     3329     * re-INVITE or UPDATE to remote party. 
     3330     */ 
     3331    PJSUA_CALL_VID_STRM_CHANGE_CAP_DEV, 
     3332 
     3333    /** 
     3334     * Start transmitting video stream. This will cause previously 
     3335     * stopped stream to start transmitting again. Note that no 
     3336     * re-INVITE/UPDATE is to be transmitted to remote since this 
     3337     * operation only operates on local stream. 
     3338     */ 
     3339    PJSUA_CALL_VID_STRM_START_TRANSMIT, 
     3340 
     3341    /** 
     3342     * Stop transmitting video stream. This will cause the stream to 
     3343     * be paused in TX direction, causing it to stop sending any video 
     3344     * packets. No re-INVITE/UPDATE is to be transmitted to remote 
     3345     * with this operation. 
     3346     */ 
     3347    PJSUA_CALL_VID_STRM_STOP_TRANSMIT, 
     3348 
     3349} pjsua_call_vid_strm_op; 
     3350 
     3351 
     3352/** 
     3353 * Parameters for video stream operation on a call. 
     3354 */ 
     3355typedef struct pjsua_call_vid_strm_op_param 
     3356{ 
     3357    /** 
     3358     * Specify the media stream index. This can be set to -1 to denote 
     3359     * the default video stream in the call, which is the first active 
     3360     * video stream or any first video stream if none is active. 
     3361     * 
     3362     * This field is valid for all video stream operations, except 
     3363     * PJSUA_CALL_VID_STRM_ADD. 
     3364     * 
     3365     * Default: -1 (first active video stream, or any first video stream 
     3366     *              if none is active) 
     3367     */ 
     3368    int med_idx; 
     3369 
     3370    /** 
     3371     * Specify the media stream direction. 
     3372     * 
     3373     * This field is valid for the following video stream operations: 
     3374     * PJSUA_CALL_VID_STRM_ADD and PJSUA_CALL_VID_STRM_CHANGE_DIR. 
     3375     * 
     3376     * Default: PJMEDIA_DIR_ENCODING_DECODING 
     3377     */ 
     3378    pjmedia_dir dir; 
     3379 
     3380    /** 
     3381     * Specify the video capture device ID. This can be set to 
     3382     * PJMEDIA_VID_DEFAULT_CAPTURE_DEV to specify the default capture 
     3383     * device as configured in the account. 
     3384     * 
     3385     * This field is valid for the following video stream operations: 
     3386     * PJSUA_CALL_VID_STRM_ADD and PJSUA_CALL_VID_STRM_CHANGE_CAP_DEV. 
     3387     * 
     3388     * Default: capture device configured in account. 
     3389     */ 
     3390    pjmedia_vid_dev_index cap_dev; 
     3391 
     3392} pjsua_call_vid_strm_op_param; 
    33803393 
    33813394 
Note: See TracChangeset for help on using the changeset viewer.