[farsight2/master] Add documentation for codec profiles

[Olivier Crête]

---
 gst/fsrtpconference/fs-rtp-session.c |   21 +++++++++++++++++++++
 1 files changed, 21 insertions(+), 0 deletions(-)

diff --git a/gst/fsrtpconference/fs-rtp-session.c b/gst/fsrtpconference/fs-rtp-session.c
index 4c5f5a5..dde9fd5 100644
--- a/gst/fsrtpconference/fs-rtp-session.c
+++ b/gst/fsrtpconference/fs-rtp-session.c
@@ -30,6 +30,27 @@
  * fs_conference_new_session() on a #FsRtpConference. It can be either
  * Audio or Video. It also represents data send with one and only one
  * SSRC (although if there is a SSRC collision, that SSRC may change).
+ * </para>
+ * <refsect2><title>Codec profiles</title>
+ * <para>
+ * It is possible to define "codec profiles", that is non-autodetected
+ * encoding and decoding pipelines for codecs. It is even possible to declare
+ * entirely new codecs using this method.
+ *
+ * To create a profile for a codec, add it to the codec-preferences with
+ * special optional parameters called "farsight-send-profile" and
+ * "farsight-recv-profile", these should contain gst-launch style descriptions
+ * of the encoding or decoding bin.
+ *
+ * As a special case, encoding profiles can have more than one unconnected
+ * source pad, all of these pads should produce application/x-rtp of some kind.
+ * The profile will be ignored if not ALL pads match currently negotiated
+ * codecs.
+ *
+ * Also, it is possible to declare profiles with only a decoding pipeline,
+ * you will only be able to receive from this codec, the encoding may be a
+ * secondary pad of some other codec.
+ * </para></refsect2><para>
  */
 
 #ifdef HAVE_CONFIG_H
-- 
1.5.6.5