Changeset 531 for pjproject/trunk/pjmedia/include/pjmedia/doxygen.h
- Timestamp:
- Jun 20, 2006 3:39:07 PM (18 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
pjproject/trunk/pjmedia/include/pjmedia/doxygen.h
r518 r531 62 62 * 63 63 * \n 64 * @section main_page_get_start_sec Getting Started 65 * 66 * For those who likes to just get start coding, the @ref getting_started_pjmedia 67 * may be a good place to start. 68 * 69 * The @ref page_pjmedia_samples page describes some examples that are available 70 * in the source tree. 71 * 72 * 73 * \n 64 74 * @section pjmedia_lic Copying and Acknowledgements 65 75 * 66 * Please see @ref lic_stuffs page for the details. 76 * PJMEDIA and PJMEDIA-CODEC contains various parts obtained from other 77 * places, and each of these would have their own licensing terms. 78 * Please see @ref lic_stuffs page for details. 79 * 80 */ 81 82 /** 83 * @page pjmed_keywords_page Features Index 84 * @section pjmed_keywords Features Index 85 * 86 * <b>PJMEDIA features</b>, in no particular order (click to go to the relevant 87 * documentation): 88 * @ref lic_stuffs "Open Source media stack", 89 * @ref PJMEDIA_CLOCK, 90 * @ref PJMEDIA_CODEC, 91 * @ref enc_dec_codec, 92 * @ref plc_codec, 93 * @ref PJMEDIA_CONF, 94 * @ref PJMED_G711 "G711/G.711 (PCMA/PCMU) codec with PLC", 95 * @ref PJMED_GSM "GSM codec with PLC", 96 * @ref PJMED_L16 "linear codecs (multiple clockrate, stereo support, etc)", 97 * @ref PJMED_SPEEX "Speex codec (narrowband, wideband, ultra-wideband)", 98 * @ref PJMED_JBUF "portable, adaptive jitter buffer with PLC support", 99 * @ref PJMEDIA_MASTER_PORT, 100 * @ref PJMEDIA_NULL_PORT, 101 * @ref PJMED_PLC, 102 * @ref PJMEDIA_PORT_CONCEPT, 103 * @ref PJMEDIA_PORT_CLOCK, 104 * @ref PJMEDIA_RESAMPLE "high quality resampling/sampling rate conversion", 105 * @ref PJMEDIA_RESAMPLE_PORT, 106 * @ref PJMED_RTCP "small footprint, portable RTCP with media quality statistics", 107 * @ref PJMED_RTP "very small footprint, modular, DSP ready RTP implementation", 108 * @ref PJMEDIA_SDP "modular, small footprint, open source SDP implementation", 109 * @ref PJMEDIA_SDP_NEG "modular SDP negotiation/negotiator abstraction", 110 * @ref PJMED_SES "media session abstraction", 111 * @ref PJMEDIA_SILENCEDET, 112 * @ref PJMED_SND "portable audio/sound hardware/device abstraction for Linux, Unix, Windows, DirectSound, WinCE, Windows Mobile, MacOS X, etc.", 113 * @ref PJMED_SND_PORT, 114 * @ref PJMEDIA_SPLITCOMB, 115 * @ref PJMED_STRM "remote stream", 116 * @ref PJMEDIA_TRANSPORT_H "custom media transport abstraction", 117 * @ref PJMEDIA_TRANSPORT_UDP, 118 * @ref PJMEDIA_FILE_PLAY "WAV/WAVE file playback", 119 * @ref PJMEDIA_FILE_REC "WAV/WAVE file recording/capture", 120 * @ref PJMEDIA_WAVE "portable WAV/WAVE header manipulation" 67 121 */ 68 122 … … 326 380 */ 327 381 382 383 /** 384 @page getting_started_pjmedia Getting Started with PJMEDIA 385 386 @section getstart_init_setup_build Setting-up the Build System 387 388 @subsection subsec_build_pjmedia Building PJMEDIA and PJMEDIA-CODEC 389 390 The PJMEDIA and PJMEDIA-CODEC libraries are normally bundled in PJPROJECT 391 source tarball, and they are located in <tt><b>pjmedia</b></tt> sub-directory 392 tree. 393 394 Please follow the instructions in <tt><b>INSTALL.txt</b></tt> in the root 395 PJPROJECT directory to build all projects, including PJMEDIA and PJMEDIA-CODEC. 396 397 @subsection subsec_config_build Setting Up the Build Environment 398 399 In your project, you will need to configure the following. 400 - Add <tt><b>$pjproject/pjmedia/include</b></tt> in the search path for 401 include files. 402 - Add <tt><b>$pjproject/pjmedia/lib</b></tt> in the search path for 403 library files. 404 - Add PJMEDIA and PJMEDIA static libraries in the link command. 405 406 @subsection subsec_inc_pjmedia Include PJMEDIA and PJMEDIA-CODEC in Source Files 407 408 To include all features from PJMEDIA and PJMEDIA-CODEC, use the following: 409 410 \code 411 #include <pjlib.h> 412 #include <pjmedia.h> 413 #include <pjmedia-codec.h> 414 \endcode 415 416 Alternatively, you may include only specific parts of the library (for example 417 to speed up compilation by just a fraction), for example: 418 419 \code 420 #include <pjmedia/conference.h> 421 #include <pjmedia/jbuf.h> 422 #include <pjmedia-codec/speex.h> 423 \endcode 424 425 Note that you need to give <b>"pjmedia/"</b> and <b>"pjmedia-codec/"</b> 426 prefix to include specific files. 427 428 429 @section getstart_using Using PJMEDIA 430 431 I wish I could explain more, but for now, please have a look at the 432 @ref page_pjmedia_samples page on some examples. 433 */ 434 435 /** 436 @page page_pjmedia_samples PJMEDIA and PJMEDIA-CODEC Examples 437 438 @section pjmedia_samples_sec PJMEDIA and PJMEDIA-CODEC Examples 439 440 Please find below some PJMEDIA related examples that may help in giving 441 some more info: 442 443 - @ref page_pjmedia_samples_level_c\n 444 This is a good place to start learning about @ref PJMEDIA_PORT_CONCEPT, 445 as it shows that @ref PJMEDIA_PORT_CONCEPT are only "passive" objects 446 with <tt>get_frame()</tt> and <tt>put_frame()</tt> interface, and 447 someone has to call these to retrieve/store media frames. 448 449 - @ref page_pjmedia_samples_playfile_c\n 450 This example shows that when application connects a media port (in this 451 case a @ref PJMEDIA_FILE_PLAY) to @ref PJMED_SND_PORT, media will flow 452 automatically since the @ref PJMED_SND_PORT provides @ref PJMEDIA_PORT_CLOCK. 453 454 - @ref page_pjmedia_samples_recfile_c\n 455 Demonstrates how to capture audio from microphone to WAV file. 456 457 - @ref page_pjmedia_samples_playsine_c\n 458 Demonstrates how to create a custom @ref PJMEDIA_PORT_CONCEPT (in this 459 case a sine wave generator) and integrate it to PJMEDIA. 460 461 - @ref page_pjmedia_samples_confsample_c\n 462 This demonstrates how to use the @ref PJMEDIA_CONF. The sample program can 463 open multiple WAV files, and instruct the conference bridge to mix the 464 signal before playing it to the sound device. 465 466 - @ref page_pjmedia_samples_confbench_c\n 467 I use this to benchmark/optimize the conference bridge algorithm, but 468 readers may find the source useful. 469 470 - @ref page_pjmedia_samples_resampleplay_c\n 471 Demonstrates how to use @ref PJMEDIA_RESAMPLE_PORT to change the 472 sampling rate of a media port (in this case, a @ref PJMEDIA_FILE_PLAY). 473 474 - @ref page_pjmedia_samples_sndtest_c\n 475 This program performs some tests to the sound device to get some 476 quality parameters (such as sound jitter and clock drifts).\n 477 Screenshots on WinXP: \image html sndtest.jpg "sndtest screenshot on WinXP" 478 479 - @ref page_pjmedia_samples_streamutil_c\n 480 This example mainly demonstrates how to stream media (in this case a 481 @ref PJMEDIA_FILE_PLAY) to remote peer using RTP. 482 483 - @ref page_pjmedia_samples_siprtp_c\n 484 This is a useful program (integrated with PJSIP) to actively measure 485 the network quality/impairment parameters by making one or more SIP 486 calls (or receiving one or more SIP calls) and display the network 487 impairment of each stream direction at the end of the call. 488 The program is able to measure network quality parameters such as 489 jitter, packet lost/reorder/duplicate, round trip time, etc.\n 490 Note that the remote peer MUST support RTCP so that network quality 491 of each direction can be calculated. Using siprtp for both endpoints 492 is recommended.\n 493 Screenshots on WinXP: \image html siprtp.jpg "siprtp screenshot on WinXP" 494 495 */ 496 497 /** 498 * \page page_pjmedia_samples_siprtp_c Samples: Using SIP and Custom RTP/RTCP to Monitor Quality 499 * 500 * This source is an example to demonstrate using SIP and RTP/RTCP framework 501 * to measure the network quality/impairment from the SIP call. This 502 * program can be used to make calls or to receive calls from other 503 * SIP endpoint (or other siprtp program), and to display the media 504 * quality statistics at the end of the call. 505 * 506 * Note that the remote peer must support RTCP. 507 * 508 * The layout of the program has been designed so that custom reporting 509 * can be generated instead of plain human readable text. 510 * 511 * The source code of the file is pjsip-apps/src/samples/siprtp.c 512 * 513 * Screenshots on WinXP: \image html siprtp.jpg 514 * 515 * \includelineno siprtp.c 516 */ 517 328 518 #endif /* __PJMEDIA_DOXYGEN_H__ */ 519
Note: See TracChangeset
for help on using the changeset viewer.