Ignore:
Timestamp:
Jan 25, 2008 4:06:33 PM (11 years ago)
Author:
bennylp
Message:

Fixed doxygen comments everywhere

File:
1 edited

Legend:

Unmodified
Added
Removed
  • pjproject/trunk/pjmedia/include/pjmedia/transport.h

    r1735 r1748  
    5757 * #pjmedia_transport_op directly. 
    5858 * 
     59 * The connection between \ref PJMED_STRM and media transport is shown in 
     60 * the diagram below: 
     61 
     62   \image html media-transport.PNG 
     63 
     64 
    5965 * \section PJMEDIA_TRANSPORT_H_USING Using the Media Transport 
    6066 * 
     
    136142 * 
    137143 * 
     144 * \section PJMEDIA_TRANSPORT_H_EXT Media Transport Extended API 
     145  
     146   Apart from the basic interface above, the media transport provides some 
     147   more APIs: 
     148 
     149    - pjmedia_transport_media_create() 
     150   \n 
     151      This API is provided to allow the media transport to add more information 
     152      in the SDP offer, before the offer is sent to remote. Additionally, for  
     153      answerer side, this callback allows the media transport to reject the  
     154      offer before this offer is processed by the SDP negotiator.  
     155 
     156    - pjmedia_transport_media_start() 
     157    \n 
     158      This API should be called after offer and answer are negotiated, and  
     159      both SDPs are available, and before the media is started. For answerer 
     160      side, this callback will be called before the answer is sent to remote, 
     161      to allow media transport to put additional info in the SDP. For  
     162      offerer side, this callback will be called after SDP answer is  
     163      received. In this callback, the media transport has the final chance  
     164      to negotiate/validate the offer and answer before media is really  
     165      started (and answer is sent, for answerer side).  
     166 
     167    - pjmedia_transport_media_stop() 
     168    \n 
     169      This API should be called when the media is stopped, to allow the media 
     170      transport to release its resources.  
     171 
     172    - pjmedia_transport_simulate_lost() 
     173    \n 
     174      This API can be used to instruct media transport to simulate packet lost 
     175      on a particular direction. 
     176 
    138177 * \section PJMEDIA_TRANSPORT_H_IMPL Implementing Media Transport 
    139178 * 
     
    169208#include <pjmedia/sdp.h> 
    170209 
    171 /* 
     210/** 
    172211 * Forward declaration for media transport. 
    173212 */ 
     
    459498 * Remote SDP might be needed as reference when application is in deciding 
    460499 * side of negotiation (callee side), otherwise it should be NULL. 
     500 * 
     501 * This API is provided to allow the media transport to add more information 
     502 * in the SDP offer, before the offer is sent to remote. Additionally, for  
     503 * answerer side, this callback allows the media transport to reject the  
     504 * offer before this offer is processed by the SDP negotiator.  
     505 * 
    461506 * This is just a simple wrapper which calls <tt>media_create()</tt> member  
    462507 * of the transport. 
     
    466511 * @param sdp_local     Local SDP. 
    467512 * @param sdp_remote    Remote SDP. 
     513 * @param media_index   Media index in SDP. 
    468514 * 
    469515 * @return              PJ_SUCCESS on success, or the appropriate error code. 
     
    481527/** 
    482528 * Start the transport with regards to SDP negotiation result.  
     529 * This API should be called after offer and answer are negotiated, and  
     530 * both SDPs are available, and before the media is started. For answerer 
     531 * side, this callback will be called before the answer is sent to remote, 
     532 * to allow media transport to put additional info in the SDP. For  
     533 * offerer side, this callback will be called after SDP answer is  
     534 * received. In this callback, the media transport has the final chance  
     535 * to negotiate/validate the offer and answer before media is really  
     536 * started (and answer is sent, for answerer side).  
     537 * 
    483538 * This is just a simple wrapper which calls <tt>media_start()</tt> member  
    484539 * of the transport. 
     
    504559/** 
    505560 * Stop the transport.  
     561 * This API should be called when the media is stopped, to allow the media 
     562 * transport to release its resources.  
     563 * 
    506564 * This is just a simple wrapper which calls <tt>media_stop()</tt> member  
    507565 * of the transport. 
Note: See TracChangeset for help on using the changeset viewer.