Changeset 518 for pjproject/trunk/pjmedia/include/pjmedia/plc.h

Timestamp:

Jun 18, 2006 2:02:36 AM (18 years ago)

Author:

bennylp

Message:

Updated doxygen documentation to all headers in PJMEDIA

File:

• pjproject/trunk/pjmedia/include/pjmedia/plc.h (modified) (1 diff)

pjproject/trunk/pjmedia/include/pjmedia/plc.h

@@ -29 +29 @@
 /**
  * @defgroup PJMED_PLC Packet Lost Concealment
- * @ingroup PJMEDIA
+ * @ingroup PJMEDIA_FRAME_OP
  * @{
+ * This section describes PJMEDIA's implementation of Packet Lost
+ * Concealment algorithm. This algorithm is used to implement PLC for
+ * codecs that do not have built-in support for one (e.g. G.711 or GSM codecs).
  *
+ * The PLC algorithm (either built-in or external) is embedded in
+ * PJMEDIA codec instance, and application can conceal lost frames
+ * by calling <b><tt>recover()</tt></b> member of the codec's member
+ * operation (#pjmedia_codec_op).
+ *
+ * See also @ref plc_codec for more info.
  */