[farsight2/master] Add documentation for special codec ids
Olivier Crête
olivier.crete at collabora.co.uk
Tue Dec 23 15:20:11 PST 2008
---
docs/libs/farsight-libs-sections.txt | 2 ++
gst-libs/gst/farsight/fs-codec.h | 13 +++++++++++++
2 files changed, 15 insertions(+), 0 deletions(-)
diff --git a/docs/libs/farsight-libs-sections.txt b/docs/libs/farsight-libs-sections.txt
index 50f1b52..4749dbc 100644
--- a/docs/libs/farsight-libs-sections.txt
+++ b/docs/libs/farsight-libs-sections.txt
@@ -110,6 +110,8 @@ fs_media_type_to_string
FsCodec
FsCodecParameter
FsCodecPreference
+FS_CODEC_ID_ANY
+FS_CODEC_ID_DISABLE
fs_codec_new
fs_codec_destroy
fs_codec_copy
diff --git a/gst-libs/gst/farsight/fs-codec.h b/gst-libs/gst/farsight/fs-codec.h
index 29ccdff..ba0e5b1 100644
--- a/gst-libs/gst/farsight/fs-codec.h
+++ b/gst-libs/gst/farsight/fs-codec.h
@@ -62,6 +62,19 @@ typedef enum
FS_MEDIA_TYPE_LAST = FS_MEDIA_TYPE_APPLICATION
} FsMediaType;
+/**
+ * FS_CODEC_ID_ANY:
+ *
+ * If the id of a #FsCodec is #FS_CODEC_ID_ANY, then it will be replaced
+ * with a dynamic payload type at runtime
+ */
+
+/**
+ * FS_CODEC_ID_DISABLE:
+ *
+ * If the id of a #FsCodec is #FS_CODEC_ID_DISABLE, then this codec will
+ * not be used
+ */
#define FS_CODEC_ID_ANY (-1)
#define FS_CODEC_ID_DISABLE (-2)
--
1.5.6.5
More information about the farsight-commits
mailing list